en-US/CloudNaming-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>GetCloudNamingSupportedTypes</command:name> <command:verb>GetCloudNamingSupportedTypes</command:verb> <command:noun></command:noun> <maml:description> <maml:para>Get supported Azure resource types from the CloudNaming module</maml:para> </maml:description> </command:details> <maml:description> <maml:para>List or search supported cloud resource types from the CloudNaming module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>GetCloudNamingSupportedTypes</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>configFilePath</maml:name> <maml:description> <maml:para>OPTIONAL: The custom configuration file to use. If not specified, the default configuration file 'CloudNaming.json' from the module directory will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>searchString</maml:name> <maml:description> <maml:para>OPTIONAL: Resource type search string. Regular Expression is supported. i.e. '^virtual machine$'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>cloud</maml:name> <maml:description> <maml:para>OPTIONAL: Cloud Provider to search for. i.e. 'Azure'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>cloud</maml:name> <maml:description> <maml:para>OPTIONAL: Cloud Provider to search for. i.e. 'Azure'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>configFilePath</maml:name> <maml:description> <maml:para>OPTIONAL: The custom configuration file to use. If not specified, the default configuration file 'CloudNaming.json' from the module directory will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>searchString</maml:name> <maml:description> <maml:para>OPTIONAL: Resource type search string. Regular Expression is supported. i.e. '^virtual machine$'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> GetCloudNamingSupportedTypes | convertfrom-json | format-table</dev:code> <dev:remarks> <maml:para>Get all supported resource types from the CloudNaming module</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> GetCloudNamingSupportedTypes -searchString '^virtual' | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Search supported resource types from all supported Cloud providers using a regular expression and convert the output to an array of objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> GetCloudNamingSupportedTypes -cloud 'azure' -searchString '^virtual machine' | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Search supported resource types for Azure using a regular expression and convert the output to an array of objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> GetCloudNamingSupportedTypes -cloud 'azure' -configFilePath 'c:\temp\config.json' | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Search supported resource types for Azure from a custom configuration file and convert the output to an array of objects.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/tyconsulting/CloudNaming-Module/wiki/GetCloudNamingSupportedTypes-Command</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>GetCloudResourceName</command:name> <command:verb>GetCloudResourceName</command:verb> <command:noun></command:noun> <maml:description> <maml:para>Generate cloud resource names based on predefined naming standard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generate cloud resource names based on predefined naming standard. Output is a deserialized Json payload. You can use ConvertFrom-Json cmdlet to convert the output into an object or an array of objects</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>GetCloudResourceName</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>appIdentifier</maml:name> <maml:description> <maml:para>Specify the application identifier</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>associatedResourceName</maml:name> <maml:description> <maml:para>Associated resource name. Used for resource types such as managed disks and NICs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>associatedResourceType</maml:name> <maml:description> <maml:para>Associated resource type. Used for resource types such as private endpoints and public IPs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>cloud</maml:name> <maml:description> <maml:para>Cloud Provider</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="businessUnit"> <maml:name>company</maml:name> <maml:description> <maml:para>OPTIONAL: Company or Business Unit name. If not specified, the first value defined in the allowedValue section in the configuration file is the default value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>configFilePath</maml:name> <maml:description> <maml:para>OPTIONAL: The custom configuration file to use. If not specified, the default configuration file 'CloudNaming.json' from the module directory will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>environment</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the environment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>instanceCount</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the instance count. Default value is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>location</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the location or region of the cloud provider</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>startInstanceNumber</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the starting instance number. Default value is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>type</maml:name> <maml:description> <maml:para>OPTIONAL: Cloud resource type. If not specified, all supported types will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>workloadType</maml:name> <maml:description> <maml:para>Workload Type. Used for resource types such as Virtual Machines. i.e. 'db', 'app', 'web', 'etc'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>appIdentifier</maml:name> <maml:description> <maml:para>Specify the application identifier</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>associatedResourceName</maml:name> <maml:description> <maml:para>Associated resource name. Used for resource types such as managed disks and NICs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>associatedResourceType</maml:name> <maml:description> <maml:para>Associated resource type. Used for resource types such as private endpoints and public IPs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>cloud</maml:name> <maml:description> <maml:para>Cloud Provider</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="businessUnit"> <maml:name>company</maml:name> <maml:description> <maml:para>OPTIONAL: Company or Business Unit name. If not specified, the first value defined in the allowedValue section in the configuration file is the default value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>configFilePath</maml:name> <maml:description> <maml:para>OPTIONAL: The custom configuration file to use. If not specified, the default configuration file 'CloudNaming.json' from the module directory will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>environment</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the environment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>instanceCount</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the instance count. Default value is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>location</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the location or region of the cloud provider</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>startInstanceNumber</maml:name> <maml:description> <maml:para>OPTIONAL: Specify the starting instance number. Default value is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>type</maml:name> <maml:description> <maml:para>OPTIONAL: Cloud resource type. If not specified, all supported types will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>workloadType</maml:name> <maml:description> <maml:para>Workload Type. Used for resource types such as Virtual Machines. i.e. 'db', 'app', 'web', 'etc'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> GetCloudResourceName -cloud 'azure' -company 'abc' -environment 'p01' -location 'aue' -appIdentifier 'test' -startInstanceNumber 1 -instanceCount 2</dev:code> <dev:remarks> <maml:para>Generate 2 names for each supported resource types with starting sequence number of 1 and the following additional parameters:</maml:para> <maml:para>-Cloud: Azure</maml:para> <maml:para>-Company: abc</maml:para> <maml:para>-environment: p01</maml:para> <maml:para>-appIdentifier: test</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> GetCloudResourceName -cloud 'azure' -type 'sa' -company 'abc' -environment 'p01' -appIdentifier 'test'</dev:code> <dev:remarks> <maml:para>Generate 1 name for Azure storage account with default starting sequence number of 1 and the following additional parameters:</maml:para> <maml:para>-Company: abc</maml:para> <maml:para>-environment: p01</maml:para> <maml:para>-location: aue</maml:para> <maml:para>-appIdentifier: test</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> GetCloudResourceName -cloud 'azure' -type 'sa', 'kv' -company 'abc' -environment 'p01' -location aue -appIdentifier 'test' -startInstanceNumber 2 -instanceCount 3 | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Generate 3 names for Storage Account and Key Vault for Azure with starting sequence number of 2 and the following additional parameters, and convert output to an array of objects:</maml:para> <maml:para>-Company: abc</maml:para> <maml:para>-environment: p01</maml:para> <maml:para>-location: aue</maml:para> <maml:para>-appIdentifier: test</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> GetCloudResourceName -cloud 'azure' -type 'sub' -company 'abc' -workloadType 'pl' -environment 'p01' -appIdentifier 'corp' | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Generate 1 name for an Azure subscription with the following parameters, and convert output to an array of objects:</maml:para> <maml:para>-Company: abc</maml:para> <maml:para>-workloadType lz</maml:para> <maml:para>-environment: p01</maml:para> <maml:para>-appIdentifier: corp</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> GetCloudResourceName -cloud 'aws' -type 'ec2' -workloadType 'db' -location 'aue' -environment 'p01' -appIdentifier 'bizapp' | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Generate 1 name for an AWS EC2 instance with the following parameters, and convert output to an array of objects:</maml:para> <maml:para>-workloadType: db</maml:para> <maml:para>-location: aue</maml:para> <maml:para>-environment: p01</maml:para> <maml:para>-appIdentifier: bizapp</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS C:\> GetCloudResourceName -cloud 'gcp' -type 'proj' -environment 'p01' -appIdentifier 'bizapp' | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Generate 1 name for a GCP project, and convert output to an array of objects:</maml:para> <maml:para>-environment: p01</maml:para> <maml:para>-appIdentifier: bizapp</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>PS C:\> GetCloudResourceName -cloud 'azure' -configFilePath 'C:\Temp\config.json' -type 'sub' -company 'IT' -workloadType 'pl' -environment 'p01' -appIdentifier 'corp' | ConvertFrom-Json</dev:code> <dev:remarks> <maml:para>Generate 1 name for an Azure subscription using a custom configuration file with the following parameters, and convert output to an array of objects:</maml:para> <maml:para>-ConfigFilePath: C:\temp\config.json</maml:para> <maml:para>-Company or BusinessUnit: IT</maml:para> <maml:para>-workloadType pl</maml:para> <maml:para>-environment: p01</maml:para> <maml:para>-appIdentifier: corp</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/tyconsulting/CloudNaming-Module/wiki/GetCloudResourceName-Command</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>NewCloudNamingConfigFile</command:name> <command:verb>NewCloudNamingConfigFile</command:verb> <command:noun></command:noun> <maml:description> <maml:para>Create a new custom configuration file for the CloudNaming module to use.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new custom configuration file from the default configuration file. This is useful if you want to use a custom configuration file for the CloudNaming module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>NewCloudNamingConfigFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>configFilePath</maml:name> <maml:description> <maml:para>The path to the custom configuration file to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>force</maml:name> <maml:description> <maml:para>Overwrite existing file if exists.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>configFilePath</maml:name> <maml:description> <maml:para>The path to the custom configuration file to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>force</maml:name> <maml:description> <maml:para>Overwrite existing file if exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> NewCloudNamingConfigFile -configFilePath C:\Temp\CustomCloudNamingConfig.json</dev:code> <dev:remarks> <maml:para>Create a custom configuration file for the CloudNaming module at C:\Temp\CustomCloudNamingConfig.json</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> NewCloudNamingConfigFile -configFilePath C:\Temp\CustomCloudNamingConfig.json -force</dev:code> <dev:remarks> <maml:para>Create a custom configuration file for the CloudNaming module at C:\Temp\CustomCloudNamingConfig.json and overwrite existing file if it exists.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/tyconsulting/CloudNaming-Module/wiki/NewCloudNamingConfigFile-Command</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |