Kelverion.Azure.Infrastructure.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!-- Module: Kelverion.Azure.Infrastructure Version: 1.0 --> <!--All Commands--> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-AzureKaResource</command:name> <maml:description> <maml:para>Retrieve and filter Azure resources for the configured subscription.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureKaResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-AzureKaResource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more resource filters. For example: @([PSCustomObject]@{'Id'='ResourceGroup';'Operator'='EqualTo';'Value'='<resource group name>'})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="GetById"> <!--NAME: GetById--> <maml:name>Get-AzureKaResource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource to be retrieved. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="GetByTagName"> <!--NAME: GetByTagName--> <maml:name>Get-AzureKaResource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the name of a resource tag. Only resources with this tag name will be retrieved.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="GetByTagNameAndValue"> <!--NAME: GetByTagNameAndValue--> <maml:name>Get-AzureKaResource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the name of a resource tag. Only resources with this tag name will be retrieved.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagValue</maml:name> <maml:description> <maml:para>Specifies the value of a resource tag. Only resources with this tag value will be retrieved.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more resource filters. For example: @([PSCustomObject]@{'Id'='ResourceGroup';'Operator'='EqualTo';'Value'='<resource group name>'})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource to be retrieved. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the name of a resource tag. Only resources with this tag name will be retrieved.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagValue</maml:name> <maml:description> <maml:para>Specifies the value of a resource tag. Only resources with this tag value will be retrieved.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns Azure resources.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-AzureKaResourceGroup</command:name> <maml:description> <maml:para>Retrieve Azure resource groups for the configured subscription.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureKaResourceGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-AzureKaResourceGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="GetByName"> <!--NAME: GetByName--> <maml:name>Get-AzureKaResourceGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a resource group to be retrieved.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="GetByTagName"> <!--NAME: GetByTagName--> <maml:name>Get-AzureKaResourceGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the value of a resource group tag. Only resource groups with this tag name will be retrieved.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="GetByTagNameAndValue"> <!--NAME: GetByTagNameAndValue--> <maml:name>Get-AzureKaResourceGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the value of a resource group tag. Only resource groups with this tag name will be retrieved.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagValue</maml:name> <maml:description> <maml:para>Specifies the value of a resource group tag. Only resource groups with this tag value will be retrieved.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a resource group to be retrieved.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the value of a resource group tag. Only resource groups with this tag name will be retrieved.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagValue</maml:name> <maml:description> <maml:para>Specifies the value of a resource group tag. Only resource groups with this tag value will be retrieved.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns azure resource groups.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Move-AzureKaResource</command:name> <maml:description> <maml:para>Move an Azure resource to a new resource group.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Move</command:verb> <command:noun>AzureKaResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Move-AzureKaResource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource to be moved. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewResourceGroupId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource group where the resource is to be moved. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource to be moved. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewResourceGroupId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource group where the resource is to be moved. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>New ID for the resource.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-AzureKaResourceDeployment</command:name> <maml:description> <maml:para>Deploy an Azure Resource Manager (ARM) template to create one or more Azure resources.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureKaResourceDeployment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-AzureKaResourceDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeploymentName</maml:name> <maml:description> <maml:para>The name for the new deployment. Deployment names do not have to be unique, but if an existing deployment name is specified, the new deployment will overwrite the existing deployment.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location for the new deployment. When specified, location template parameters will be set to this value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>Specifies the resource group name for the new deployment.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>ARM template to be deployed, in JSON format.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies values for parameters defined in the template.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeploymentName</maml:name> <maml:description> <maml:para>The name for the new deployment. Deployment names do not have to be unique, but if an existing deployment name is specified, the new deployment will overwrite the existing deployment.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location for the new deployment. When specified, location template parameters will be set to this value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>Specifies the resource group name for the new deployment.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>ARM template to be deployed, in JSON format.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies values for parameters defined in the template.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns Deployment ID. Returns deployment outputs specific to the specified ARM template.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-AzureKaResource</command:name> <maml:description> <maml:para>Removes an existing Azure resource.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureKaResource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Remove-AzureKaResource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource to be removed. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>Specifies the API version to use when removing the resource.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource to be removed. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>Specifies the API version to use when removing the resource.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Remove operation outputs.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-AzureKaResourceTag</command:name> <maml:description> <maml:para>Removes an Azure resource tag.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureKaResourceTag</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Remove-AzureKaResourceTag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Name of the tag to be removed.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitSeconds</maml:name> <maml:description> <maml:para>Number of seconds to wait while verifying that the tag has been removed. When not specified, or set to 0, the cmdlet does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Name of the tag to be removed.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitSeconds</maml:name> <maml:description> <maml:para>Number of seconds to wait while verifying that the tag has been removed. When not specified, or set to 0, the cmdlet does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID of the resource from which the tag has been removed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-AzureKaVm</command:name> <maml:description> <maml:para>Removes an existing Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureKaVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-AzureKaVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ResourceId"> <maml:name>VmId</maml:name> <maml:description> <maml:para>Specifies the ID of a VM to be removed. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/virtualMachines/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveDisks</maml:name> <maml:description> <maml:para>Specifies that virtual machine disks should be removed.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveNics</maml:name> <maml:description> <maml:para>Specifies that virtual machine network interface cards should be removed.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemovePublicIps</maml:name> <maml:description> <maml:para>Specifies that virtual machine public IP addresses associated with network cards should be removed.</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></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ResourceId"> <maml:name>VmId</maml:name> <maml:description> <maml:para>Specifies the ID of a VM to be removed. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/virtualMachines/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveDisks</maml:name> <maml:description> <maml:para>Specifies that virtual machine disks should be removed.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveNics</maml:name> <maml:description> <maml:para>Specifies that virtual machine network interface cards should be removed.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemovePublicIps</maml:name> <maml:description> <maml:para>Specifies that virtual machine public IP addresses associated with network cards should be removed.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> </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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-AzureKaResourceTag</command:name> <maml:description> <maml:para>Sets a resource tag value on an existing Azure resource. The resource tag is created if it doesn’t exist.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureKaResourceTag</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Set-AzureKaResourceTag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the tag name for the tag that is to be set.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagValue</maml:name> <maml:description> <maml:para>Specifies the tag value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitSeconds</maml:name> <maml:description> <maml:para>Number of seconds to wait while verifying that the tag has been set. When not specified, or set to 0, the cmdlet does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies the ID of a resource. Must be in the form /subscriptions/{subscription-guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}[/{parent-resource-type}/{parent-resource-name}]*/{resource-type}/{resource-name}</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagName</maml:name> <maml:description> <maml:para>Specifies the tag name for the tag that is to be set.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TagValue</maml:name> <maml:description> <maml:para>Specifies the tag value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitSeconds</maml:name> <maml:description> <maml:para>Number of seconds to wait while verifying that the tag has been set. When not specified, or set to 0, the cmdlet does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID of the resource to which the tag was added.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> </helpItems> |