Networking/Microsoft.WindowsAzure.Commands.ServiceManagement.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureCertificate</command:name> <maml:description> <maml:para>Uploads a service certificate for the specified cloud service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureCertificate</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service to which you are adding a certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CertToDeploy</maml:name> <maml:description> <maml:para>Specifies the certificate to deploy. You can specify the path file name of a certificate file (*.cer, *. pfx, etc) or an X.509 Certificate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the certificate password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service to which you are adding a certificate.</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="1"> <maml:name>CertToDeploy</maml:name> <maml:description> <maml:para>Specifies the certificate to deploy. You can specify the path file name of a certificate file (*.cer, *. pfx, etc) or an X.509 Certificate object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>Password</maml:name> <maml:description> <maml:para>Specifies the certificate password.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureCertificate -serviceName "MyService" -certToDeploy myCertificate.pfx –password 123</dev:code> <dev:remarks> <maml:para>This command uploads myCertificate.pfx certificate to the specified cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureCertificate -serviceName "MyService" -certToDeploy myCertificate.cer</dev:code> <dev:remarks> <maml:para>This command uploads myCertificate.cer certificate to the specified cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureCertificate -serviceName "MyService" -certToDeploy (Get-Item cert:\CurrentUser\MY\1D6E34B526723E06C235BE8E5547784BF12C9F39)</dev:code> <dev:remarks> <maml:para>This command uploads the specified certificate to the specified cloud service, using the Get-Item Windows PowerShell cmdlet to get the certificate object.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureDataDisk</command:name> <maml:description> <maml:para>Adds a new data disk to a virtual machine object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureDataDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Add-AzureDataDisk cmdlet adds a new data disk to a virtual machine object. Use the –CreateNew parameter to create a new data disk with a specified size and label, and then attach it. Use the –Import parameter to attach an existing disk from the image repository. Use the –ImportFrom parameter to attach an existing disk from a blob in a storage account.The cmdlet allows you to specify the host-cache mode of attached data disks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureDataDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CreateNew</maml:name> <maml:description> <maml:para>Specify to create a new data disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DiskSizeInGB</maml:name> <maml:description> <maml:para>Specifies the logical disk size in gigabytes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DiskLabel</maml:name> <maml:description> <maml:para>Specifies the disk label when creating a new data disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Specifies the Logical Unit Number (LUN) location for the data drive in the virtual machine. Valid LUN values are 0-15 and each data disk must have a unique LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Optional. Specifies the Location of the blob in a Microsoft Azure storage account where the data disk will be stored. If no location is specified, the data disk will be stored in the vhds container within the default storage account for the current subscription. If a vhds container doesn’t exist, the container is created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host level caching settings of the disk. Possible values are: None, ReadOnly and ReadWrite.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object where the data disk will attach.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureDataDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Import</maml:name> <maml:description> <maml:para>Imports an existing data disk from the disk library.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the data disk in the disk repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Specifies the Logical Unit Number (LUN) location for the data drive in the virtual machine. Valid LUN values are 0-15 and each data disk must have a unique LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host level caching settings of the disk. Possible values are: None, ReadOnly and ReadWrite.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object where the data disk will attach.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureDataDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ImportFrom</maml:name> <maml:description> <maml:para>Imports an existing data disk from a blob in a storage acount.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DiskLabel</maml:name> <maml:description> <maml:para>Specifies the disk label when creating a new data disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Specifies the Logical Unit Number (LUN) location for the data drive in the virtual machine. Valid LUN values are 0-15 and each data disk must have a unique LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Optional. Specifies the Location of the blob in a Microsoft Azure storage account where the data disk will be stored. If no location is specified, the data disk will be stored in the vhds container within the default storage account for the current subscription. If a vhds container doesn’t exist, the container is created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host level caching settings of the disk. Possible values are: None, ReadOnly and ReadWrite.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object where the data disk will attach.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CreateNew</maml:name> <maml:description> <maml:para>Specify to create a new data disk.</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="1"> <maml:name>DiskSizeInGB</maml:name> <maml:description> <maml:para>Specifies the logical disk size in gigabytes.</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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DiskLabel</maml:name> <maml:description> <maml:para>Specifies the disk label when creating a new data disk.</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="3"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Specifies the Logical Unit Number (LUN) location for the data drive in the virtual machine. Valid LUN values are 0-15 and each data disk must have a unique LUN.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Optional. Specifies the Location of the blob in a Microsoft Azure storage account where the data disk will be stored. If no location is specified, the data disk will be stored in the vhds container within the default storage account for the current subscription. If a vhds container doesn’t exist, the container is created</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>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host level caching settings of the disk. Possible values are: None, ReadOnly and ReadWrite.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object where the data disk will attach.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</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>Import</maml:name> <maml:description> <maml:para>Imports an existing data disk from the disk library.</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="true (ByPropertyName)" position="1"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the data disk in the disk repository.</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>ImportFrom</maml:name> <maml:description> <maml:para>Imports an existing data disk from a blob in a storage acount.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM "myservice" -Name "MyVM" ` | Add-AzureDataDisk -Import -DiskName "MyExistingDisk" -LUN 0 ` | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This example gets a virtual machine object for the virtual machine named “MyVM” in the “myservice” cloud service, updates the virtual machine object by attaching an existing data disk from the repository using the disk name, and then updates the Microsoft Azure virtual machine.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM "myservice" -Name "MyVM" ` | Add-AzureDataDisk -CreateNew -DiskSizeInGB 128 -DiskLabel "main" -LUN 0 ` | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This example updates the virtual machine by creating the new blank data disk “MyNewDisk.vhd” in the vhds container within the default storage account of the currently active subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM "myservice" -Name "Database" ` | Add-AzureDataDisk -ImportFrom -MediaLocation ` "https://mystorage.blob.core.windows.net/mycontainer/MyExistingDisk.vhd" ` -DiskLabel "main" -LUN 0 ` | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This example updates a virtual machine by attaching an existing data disk from a storage location.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureVMConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureDataDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureDisk</command:name> <maml:description> <maml:para>Adds a new disk to the Microsoft Azure disk repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Add-AzureDisk cmdlet adds a new disk to the Microsoft Azure disk repository in the current subscription. This disk is bootable if the optional –OS parameter is specified. If not specified, the disk is a data disk. The required parameters are DiskName and MediaLocation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the physical location of the disk in Microsoft Azure storage. This link refers to a blob page in the current subscription and storage account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a disk label.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OS</maml:name> <maml:description> <maml:para>If specified, the disk is bootable. The OS parameter accepts either "Windows" or "Linux" values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the disk.</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="true (ByPropertyName)" position="1"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the physical location of the disk in Microsoft Azure storage. This link refers to a blob page in the current subscription and storage account.</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="true (ByPropertyName)" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a disk label.</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>Disk name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OS</maml:name> <maml:description> <maml:para>If specified, the disk is bootable. The OS parameter accepts either "Windows" or "Linux" values.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DiskContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureDisk -DiskName "MyWinDisk" -MediaLocation "http://yourstorageaccount.blob.core.azure.com/vhds/winserver-system.vhd" -Label "BootDisk" -OS "Windows"</dev:code> <dev:remarks> <maml:para>This example adds a new, bootable Windows disk.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureDisk -DiskName "MyDataDisk" -MediaLocation "http://yourstorageaccount.blob.core.azure.com/vhds/winserver-data.vhd" -Label "DataDisk"</dev:code> <dev:remarks> <maml:para>This example adds a new data disk.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureDisk -DiskName "MyLinuxDisk" -MediaLocation "http://yourstorageaccount.blob.core.azure.com/vhds/linuxsys.vhd" -OS "Linux"</dev:code> <dev:remarks> <maml:para>This example adds a new Linux boot disk. The disk name and label are the same.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureDns</command:name> <maml:description> <maml:para>Adds a DNS server to an existing cloud service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureDns</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Add-AzureDns cmdlet adds a DNS server to an existing cloud service. It accepts three parameters: Name, IPAddress and ServiceName. The Name parameter is a friendly name, not necessarily a DNS resolvable name, the IPAddress is the IP address of the DNS server, and the ServiceName is the name of the cloud service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureDns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a friendly name to identify the DNS server. This name is not necessarily a fully qualified domain name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Specifies the IP address of the DNS server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a friendly name to identify the DNS server. This name is not necessarily a fully qualified domain 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="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Specifies the IP address of the DNS server</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="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service</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>PipelineVariable</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureDns -ServiceName "myservice" -IPAddress 10.1.2.4 -Name "mydns"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command adds a DNS server "mydns" to the specified cloud service</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Add-AzureEndpoint </command:name> <maml:description> <maml:para>Add endpoint to the persistent VM object.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureEndpoint</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Protocol</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LocalPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultProbe</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LBSetName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbePort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbeProtocol</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DirectServerReturn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para>The Internal LoadBalancer Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancerDistribution</maml:name> <maml:description> <maml:para> Load Balancer distribution algorithm The value can be sourceIP: 2 tuple affinity (Source IP, Destination IP) sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol) none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol). This is the default value </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbeIntervalInSeconds</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbePath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbeTimeoutInSeconds</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublicPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>The VirtualIPName parameter allows you to associate a virtual IP to your endpoint. Your Cloud Service can have multiple virtual IPs. virtual IPs can be created with the add-azureVirtualIP cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Protocol</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LocalPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoProbe</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DirectServerReturn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para>The Internal LoadBalancer Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancerDistribution</maml:name> <maml:description> <maml:para> Load Balancer distribution algorithm The value can be sourceIP: 2 tuple affinity (Source IP, Destination IP) sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol) none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol). This is the default value </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublicPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>The VirtualIPName parameter allows you to associate a virtual IP to your endpoint. Your Cloud Service can have multiple virtual IPs. virtual IPs can be created with the add-azureVirtualIP cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> <dev:type> <maml:name>NetworkAclObject</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>DefaultProbe</maml:name> <maml:description> <maml:para>Not Specified</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>DirectServerReturn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</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>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</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>InternalLoadBalancerName</maml:name> <maml:description> <maml:para>The Internal LoadBalancer 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>LBSetName</maml:name> <maml:description> <maml:para> </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>LoadBalancerDistribution</maml:name> <maml:description> <maml:para> Load Balancer distribution algorithm The value can be sourceIP: 2 tuple affinity (Source IP, Destination IP) sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol) none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol). This 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LocalPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para> </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>NoProbe</maml:name> <maml:description> <maml:para>Not Specified</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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>ProbeIntervalInSeconds</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>ProbePath</maml:name> <maml:description> <maml:para> </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>ProbePort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>ProbeProtocol</maml:name> <maml:description> <maml:para> </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>ProbeTimeoutInSeconds</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Protocol</maml:name> <maml:description> <maml:para> </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>PublicPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>VirtualIPName</maml:name> <maml:description> <maml:para>The VirtualIPName parameter allows you to associate a virtual IP to your endpoint. Your Cloud Service can have multiple virtual IPs. virtual IPs can be created with the add-azureVirtualIP cmdlet.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName "mySvc" -Name "MyVM1" | Add-AzureEndpoint -Name "HttpIn" -Protocol "tcp" -PublicPort 80 -LocalPort 8080 | Update-AzureVM </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This command retrieves the configuration of a virtual machine and adds a new endpoint named 'HttpIn' configured with public port 80 and local port 8080. The changed configuration is passed through the pipeline to Update-AzureVM to update the virtual machine.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName "myLBSvc" -Name "MyVM2" | Add-AzureEndpoint -Name "HttpIn" -Protocol "tcp" -PublicPort 80 -LocalPort 8080 -LBSetName "WebFarm" -ProbePort 80 -ProbeProtocol "http" -ProbePath '/' | Update-AzureVM </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This command retrieves the configuration of a virtual machine and adds a new endpoint named 'HttpIn' configured with public port 80 and local port 8080. The endpoint belongs to the shared load-balanced group named "WebFarm" and its availability is monitored by an HTTP probe on port 80, path '/'. The changed configuration is pass through the pipeline to Update-AzureVM to update the virtual machine.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> get-azurevm -ServiceName "mySvc" -Name "MyVM1" | Add-AzureEndpoint -Name "HttpIn" -Protocol "tcp" -LocalPort 8080 -PublicPort 80 -VirtualIPName "MyVip" | Update-AzureVM </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This command associates a virtual IP to a cloud service to an endpoint</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureInternalLoadBalancer</command:name> <maml:description> <maml:para>Add-AzureInternalLoadBalancer [-InternalLoadBalancerName] <string> [-ServiceName] <string> [<CommonParameters>] Add-AzureInternalLoadBalancer [-InternalLoadBalancerName] <string> [-ServiceName] <string> [-SubnetName] <string> [<CommonParameters>] Add-AzureInternalLoadBalancer [-InternalLoadBalancerName] <string> [-ServiceName] <string> [-SubnetName] <string> [-StaticVNetIPAddress] <ipaddress> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureInternalLoadBalancer</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Add-InternalLoadbalancer cmdlet provides users the ability to add an Internal Loadbalancer configuration to a cloud service. For the users using Virtual network, they are allowed to specify a subnet or even the IP address directly of the internal load balancer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>StaticVNetIPAddress</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="2"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="3"> <maml:name>StaticVNetIPAddress</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureInternalLoadBalancer -ServiceName MyWebsite1 -InternalLoadBalancerName MyILB</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Adds an internal load balancer object to a deployment</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureInternalLoadBalancer -ServiceName MyWebsite1 -InternalLoadBalancerName MyILB -SubnetName FrontEndSubnet</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Adds an internal load balancer object to a deployment in a Virtual Network. Specifies the Subnet in the VNet from which the load balancer IP should be allocated.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureInternalLoadBalancer -ServiceName MyWebsite1 -InternalLoadBalancerName MyILB -ServiceName svc1 -SubnetName FrontEndSubnet -StaticVNetIPAddress 192.168.4.7</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Adds an internal load balancer object to a deployment in a Virtual Network. Specifies the Subnet in the VNet and the exact IP address from that subnet that should be allocated to the internal load balancer.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureProvisioningConfig</command:name> <maml:description> <maml:para>Adds the provisioning configuration to a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureProvisioningConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Add-AzureProvisioningConfig cmdlet adds configuration information to a virtual machine configuration used to create a new Virtual Machine. Different provisioning configurations are supported including standalone Windows servers, Windows servers joined to an Active Directory domain, and Linux-based servers. When creating an Active Directory domain joined server, the provisioning configuration must specify the fully qualified domain name of the Active Directory domain, as well as the domain credentials of a user with permission to join the machine to the domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureProvisioningConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableGuestAgent</maml:name> <maml:description> <maml:para>To disable IaaS provision guest agent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomDataFile</maml:name> <maml:description> <maml:para>This parameter takes a file name as an argument. PowerShell will then base64 encode the contents of the file and send it along with the provisioning configuration information. The file must be less than 64KB or the Azure API will not accept the request. On Windows this data ends up in %SYSTEMDRIVE%\AzureData\CustomData.bin as a binary file. On Linux, this data is passed to the VM via the ovf-env.xml file, which is copied to the /var/lib/waagent directory during provisioning. The agent will also place the base-64 encoded data in /var/lib/waagent/CustomData during provisioning.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Windows</maml:name> <maml:description> <maml:para>Specify to create a standalone Windows provisioning configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdminUsername</maml:name> <maml:description> <maml:para>Specifies the Administrator account to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password of the administrator account for the role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetPasswordOnFirstLogon</maml:name> <maml:description> <maml:para>If specified, forces the user to change their password on first logon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableAutomaticUpdates</maml:name> <maml:description> <maml:para>If specified, the configuration will have automatic updates disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoRDPEndpoint</maml:name> <maml:description> <maml:para>If specified, create the virtual machine without a remote desktop endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Specifies the Microsoft Time Zone value to use to set the time zone for the virtual machine. Examples are: "Pacific Standard Time" and "Canada Central Standard Time".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Certificates</maml:name> <maml:description> <maml:para>Specifies a set of certificates to install in the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CertificateSettingList</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableWinRMHttp</maml:name> <maml:description> <maml:para>Enables WinRM over http.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableWinRMHttps</maml:name> <maml:description> <maml:para>Disables WinRM on https which is added by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WinRMCertificate</maml:name> <maml:description> <maml:para>Certificate that will be associated with WinRM endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>X509Certificates</maml:name> <maml:description> <maml:para>X509 certificates that will be deployed to hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">X509Certificate2[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExportPrivateKey</maml:name> <maml:description> <maml:para>Prevents the private key from being uploaded</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoWinRMEndpoint</maml:name> <maml:description> <maml:para>Prevents the WinRM endpoint from being added</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureProvisioningConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableGuestAgent</maml:name> <maml:description> <maml:para>To disable IaaS provision guest agent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Linux</maml:name> <maml:description> <maml:para>Specify to create a Linux provisioning configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LinuxUser</maml:name> <maml:description> <maml:para>Specifies the Linux administrative account name to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableSSH</maml:name> <maml:description> <maml:para>If specified, the virtual machine is created with SSH disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoSSHEndpoint</maml:name> <maml:description> <maml:para>If specified, create the virtual machine without an SSH endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoSSHPassword</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SSHPublicKeys</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHPublicKeyList</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SSHKeyPairs</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHKeyPairList</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomDataFile</maml:name> <maml:description> <maml:para>This parameter takes a file name as an argument. PowerShell will then base64 encode the contents of the file and send it along with the provisioning configuration information. The file must be less than 64KB or the Azure API will not accept the request. On Windows this data ends up in %SYSTEMDRIVE%\AzureData\CustomData.bin as a binary file. On Linux, this data is passed to the VM via the ovf-env.xml file, which is copied to the /var/lib/waagent directory during provisioning. The agent will also place the base-64 encoded data in /var/lib/waagent/CustomData during provisioning.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password of the administrator account for the role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureProvisioningConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableGuestAgent</maml:name> <maml:description> <maml:para>To disable IaaS provision guest agent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomDataFile</maml:name> <maml:description> <maml:para>This parameter takes a file name as an argument. PowerShell will then base64 encode the contents of the file and send it along with the provisioning configuration information. The file must be less than 64KB or the Azure API will not accept the request. On Windows this data ends up in %SYSTEMDRIVE%\AzureData\CustomData.bin as a binary file. On Linux, this data is passed to the VM via the ovf-env.xml file, which is copied to the /var/lib/waagent directory during provisioning. The agent will also place the base-64 encoded data in /var/lib/waagent/CustomData during provisioning.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdminUsername</maml:name> <maml:description> <maml:para>Specifies the Administrator account to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WindowsDomain</maml:name> <maml:description> <maml:para>Specify to create a provisioning configuration for a Windows server joined to an Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password of the administrator account for the role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetPasswordOnFirstLogon</maml:name> <maml:description> <maml:para>If specified, forces the user to change their password on first logon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableAutomaticUpdates</maml:name> <maml:description> <maml:para>If specified, the configuration will have automatic updates disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoRDPEndpoint</maml:name> <maml:description> <maml:para>If specified, create the virtual machine without a remote desktop endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeZone</maml:name> <maml:description> <maml:para>Specifies the Microsoft Time Zone value to use to set the time zone for the virtual machine. Examples are: "Pacific Standard Time" and "Canada Central Standard Time".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Certificates</maml:name> <maml:description> <maml:para>Specifies a set of certificates to install in the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CertificateSettingList</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JoinDomain</maml:name> <maml:description> <maml:para>Specifies the fully qualified domain name (FQDN) of the Windows domain to join.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Specifies the name of the domain of the account with permission to add the computer to a domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainUserName</maml:name> <maml:description> <maml:para>Specifies the name of the user account with permission to add the computer to a domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainPassword</maml:name> <maml:description> <maml:para>Specifies the password of the user account with permission to add the computer to a domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MachineObjectOU</maml:name> <maml:description> <maml:para>Specifies the fully qualified name of the organizational unit (OU) in which the computer account is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableWinRMHttp</maml:name> <maml:description> <maml:para>Enables WinRM over http.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableWinRMHttps</maml:name> <maml:description> <maml:para>Disables WinRM on https which is added by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WinRMCertificate</maml:name> <maml:description> <maml:para>Certificate that will be associated with WinRM endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>X509Certificates</maml:name> <maml:description> <maml:para>X509 certificates that will be deployed to hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">X509Certificate2[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExportPrivateKey</maml:name> <maml:description> <maml:para>Prevents the private key from being uploaded</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoWinRMEndpoint</maml:name> <maml:description> <maml:para>Prevents the WinRM endpoint from being added</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</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>DisableGuestAgent</maml:name> <maml:description> <maml:para>To disable IaaS provision guest agent.</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>CustomDataFile</maml:name> <maml:description> <maml:para>This parameter takes a file name as an argument. PowerShell will then base64 encode the contents of the file and send it along with the provisioning configuration information. The file must be less than 64KB or the Azure API will not accept the request. On Windows this data ends up in %SYSTEMDRIVE%\AzureData\CustomData.bin as a binary file. On Linux, this data is passed to the VM via the ovf-env.xml file, which is copied to the /var/lib/waagent directory during provisioning. The agent will also place the base-64 encoded data in /var/lib/waagent/CustomData during provisioning.</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>Windows</maml:name> <maml:description> <maml:para>Specify to create a standalone Windows provisioning configuration.</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>AdminUsername</maml:name> <maml:description> <maml:para>Specifies the Administrator account 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password of the administrator account for the role.</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>ResetPasswordOnFirstLogon</maml:name> <maml:description> <maml:para>If specified, forces the user to change their password on first logon.</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>DisableAutomaticUpdates</maml:name> <maml:description> <maml:para>If specified, the configuration will have automatic updates disabled.</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>NoRDPEndpoint</maml:name> <maml:description> <maml:para>If specified, create the virtual machine without a remote desktop endpoint.</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>TimeZone</maml:name> <maml:description> <maml:para>Specifies the Microsoft Time Zone value to use to set the time zone for the virtual machine. Examples are: "Pacific Standard Time" and "Canada Central Standard Time".</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>Certificates</maml:name> <maml:description> <maml:para>Specifies a set of certificates to install in the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CertificateSettingList</command:parameterValue> <dev:type> <maml:name>CertificateSettingList</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>EnableWinRMHttp</maml:name> <maml:description> <maml:para>Enables WinRM over http.</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>DisableWinRMHttps</maml:name> <maml:description> <maml:para>Disables WinRM on https which is added by default.</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>WinRMCertificate</maml:name> <maml:description> <maml:para>Certificate that will be associated with WinRM endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>X509Certificates</maml:name> <maml:description> <maml:para>X509 certificates that will be deployed to hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">X509Certificate2[]</command:parameterValue> <dev:type> <maml:name>X509Certificate2[]</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>NoExportPrivateKey</maml:name> <maml:description> <maml:para>Prevents the private key from being uploaded</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>NoWinRMEndpoint</maml:name> <maml:description> <maml:para>Prevents the WinRM endpoint from being added</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="named"> <maml:name>Linux</maml:name> <maml:description> <maml:para>Specify to create a Linux provisioning configuration.</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>LinuxUser</maml:name> <maml:description> <maml:para>Specifies the Linux administrative account name 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableSSH</maml:name> <maml:description> <maml:para>If specified, the virtual machine is created with SSH disabled.</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>NoSSHEndpoint</maml:name> <maml:description> <maml:para>If specified, create the virtual machine without an SSH endpoint.</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>NoSSHPassword</maml:name> <maml:description> <maml:para>Not Specified</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>SSHPublicKeys</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHPublicKeyList</command:parameterValue> <dev:type> <maml:name>LinuxProvisioningConfigurationSet+SSHPublicKeyList</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>SSHKeyPairs</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHKeyPairList</command:parameterValue> <dev:type> <maml:name>LinuxProvisioningConfigurationSet+SSHKeyPairList</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>WindowsDomain</maml:name> <maml:description> <maml:para>Specify to create a provisioning configuration for a Windows server joined to an Active Directory domain.</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="named"> <maml:name>JoinDomain</maml:name> <maml:description> <maml:para>Specifies the fully qualified domain name (FQDN) of the Windows domain to join.</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>Domain</maml:name> <maml:description> <maml:para>Specifies the name of the domain of the account with permission to add the computer to a domain.</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>DomainUserName</maml:name> <maml:description> <maml:para>Specifies the name of the user account with permission to add the computer to a domain.</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>DomainPassword</maml:name> <maml:description> <maml:para>Specifies the password of the user account with permission to add the computer to a domain.</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>MachineObjectOU</maml:name> <maml:description> <maml:para>Specifies the fully qualified name of the organizational unit (OU) in which the computer account is created.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyNonDomainVM" -InstanceSize Small -ImageName $img ` | Add-AzureProvisioningConfig -Windows -Pass word $Password -AdminUsername PsTestAdmin ` | New-AzureVM -ServiceName $svcName</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Windows standalone virtual machine and adds it to the specified service. WinRM Https listener is enabled by default on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyDomainVM" -InstanceSize Small -ImageName $img ` | Add-AzureProvisioningConfig -WindowsDomain -Password $Password -AdminUsername PsTestAdmin -ResetPasswordOnFirstLogon -JoinDomain "contoso.com" -Domain "contoso" -DomainUserName "domainadminuser" -DomainPassword "domainPassword" -MachineObjectOU 'OU=AzureVMs,DC=contoso,DC=com' | New-AzureVM -ServiceName $svcName</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new, domain-joined Windows virtual machine and adds it to the specified service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyLinuxVM" -InstanceSize Small -ImageName $LnxImg ` | Add-AzureProvisioningConfig -Linux -LinuxUser $linuxUser -Password $Password ` | New-AzureVM -ServiceName $svcName</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Linux virtual machine and adds it to the specified service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $certs = Get-ChildItem Cert:\CurrentUser\My New-AzureVMConfig -Name "MyNonDomainVM" -InstanceSize Small -ImageName $img ` | Add-AzureProvisioningConfig -Windows -Password $Password -AdminUsername PsTestAdmin -WinRMCertificate $certs[0] -X509Certificates $certs[1], $certs[2] ` | New-AzureVM -ServiceName $svcName -WaitForBoot</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Windows standalone virtual machine and adds it to the specified service. WinRM Https listener is enabled by default on the VM. WaitForBoot option enables to wait for VM to boot. WinRMCertificate and X509Certificates are uploaded to hosted service by New-AzureVM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyNonDomainVM" -InstanceSize Small -ImageName $img ` | Add-AzureProvisioningConfig -Windows -Password $Password -AdminUsername PsTestAdmin -EnableWinRMHttp ` | New-AzureVM -ServiceName $svcName -WaitForBoot</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Windows standalone virtual machine and adds it to the specified service. Both WinRM Https and Http listener is enabled on the VM. WaitForBoot option enables to wait for VM to boot.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyNonDomainVM" -InstanceSize Small -ImageName $img ` | Add-AzureProvisioningConfig -Windows -Password $Password -AdminUsername PsTestAdmin -DisableWinRMHttps ` | New-AzureVM -ServiceName $svcName -WaitForBoot</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Windows standalone virtual machine and adds it to the specified service. WinRM Https listener is not enabled on the VM. WaitForBoot option enables to wait for VM to boot.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $certs = Get-ChildItem Cert:\CurrentUser\My New-AzureVMConfig -Name "MyNonDomainVM" -InstanceSize Small -ImageName $img ` | Add-AzureProvisioningConfig -Windows -Password $Password -AdminUsername PsTestAdmin -X509Certificates $certs[0], $certs[1] -NoExportPrivateKey ` | New-AzureVM -ServiceName $svcName -WaitForBoot</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Windows standalone virtual machine and adds it to the specified service. WinRM Https listener is enabled by default on the VM. WaitForBoot option enables to wait for VM to boot. WinRMCertificate and X509Certificates are uploaded to hosted service by New-AzureVM. PrivateKeys are removed from X509Certificates before uploading them.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 8 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyNonDomainVM" -InstanceSize Small -ImageName $img ` | Add-AzureProvisioningConfig -Windows -Pass word $Password -AdminUsername PsTestAdmin ` | New-AzureVM -ServiceName $svcName -DisableGuestAgent</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Windows standalone virtual machine without enabling the provision guest agent and adds it to the specified service. WinRM Https listener is enabled by default on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureVhd</command:name> <maml:description> <maml:para>Uploads a VHD file from an on premise machine to a blob in a cloud storage account in Microsoft Azure</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureVhd</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Add-AzureVhd cmdlet allows to upload on premise VHD images to a blob storage account as fixed VHD images. It has parameters to configure the upload process such as specifying the number of uploader threads that will be used or overwriting a blob which already exists in the specified destination uri. For on premise VHD images, patching scenario is also supported so that diff disk images can be uploaded without having to upload the already uploaded base images. SAS Uri is supported as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureVhd</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>A Uri to a blob in Microsoft Azure Blob Storage. Shared Access Signature (SAS) in Uri input is supported as well, however in patching scenarios destination cannot be a SAS Uri.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LocalFilePath</maml:name> <maml:description> <maml:para>File path of the local Vhd file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>NumberOfUploaderThreads</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>BaseImageUriToPatch</maml:name> <maml:description> <maml:para>A Uri to a base image blob in Microsoft Azure Blob Storage. Shared Access Signature (SAS) in Uri input is supported as well.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>OverWrite</maml:name> <maml:description> <maml:para>Determines to delete the existing blob in the specified destination uri if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>A Uri to a blob in Microsoft Azure Blob Storage. Shared Access Signature (SAS) in Uri input is supported as well, however in patching scenarios destination cannot be a SAS Uri.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LocalFilePath</maml:name> <maml:description> <maml:para>File path of the local Vhd file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>NumberOfUploaderThreads</maml:name> <maml:description> <maml:para> </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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>BaseImageUriToPatch</maml:name> <maml:description> <maml:para>A Uri to a base image blob in Microsoft Azure Blob Storage. Shared Access Signature (SAS) in Uri input is supported as well.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>OverWrite</maml:name> <maml:description> <maml:para>Determines to delete the existing blob in the specified destination uri if it 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumberOfThreads</maml:name> <maml:description> <maml:para>Determines the number of uploader threads that will be used during upload.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>8</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureVhd -Destination http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd -LocalFilePath C:\vhd\MyWin7Image.vhd</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command uploads the vhd file on premise as a fixed disk to the specified blob by destination uri.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureVhd -Destination http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd -LocalFilePath C:\vhd\MyWin7Image.vhd -Overwrite</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Overwrite option tells the cmdlet to delete if there is a blob already in the specified destination uri.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureVhd -Destination http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd -LocalFilePath C:\vhd\MyWin7Image.vhd -NumberOfThreads 32</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------NumberOfThreads allows to change the default number of uploader threads, which is 8.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Add-AzureVhd -Destination "http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd?st=2013-01-09T22%3A15%3A49Z&amp;se=2013-01-09T23%3A10%3A49Z&amp;sr=b&amp;sp=w&amp;sig=13T9Ow%2FRJAMmhfO%2FaP3HhKKJ6AY093SmveOSIV4%2FR7w%3D" -LocalFilePath C:\vhd\win7baseimage.vhd</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Destination is provided with a SAS signature in the querystring of the Uri. SAS signature should have Read,Write, and Delete permissions.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name> Add-AzureVMImage </command:name> <maml:description> <maml:para>The Add-AzureVMImage cmdlet adds a new operating system (OS) image or a new VM Image to the image repository. The image should be a sysprep'd or generalized image.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureVMImage</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureVMImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the image being added to the image repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the location of the physical blob page where the image resides. This is a link to a blob page in the current subscription's storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label to give the image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Specifies the End User License Aggreement, recommended value is a URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the OS image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>ImageFamily</maml:name> <maml:description> <maml:para>Specifies a value that can be used to group OS images.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>PublishedDate</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>PrivacyUri</maml:name> <maml:description> <maml:para>Specifies the URI that points to a document that contains the privacy policy related to the OS image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>RecommendedVMSize</maml:name> <maml:description> <maml:para>Specifies the size to use for the virtual machine that is created from the OS image. Values are: "Medium", "Large", and "ExtraLarge", "A5", "A6",, "A7".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>IconName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>SmallIconName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="13"> <maml:name>ShowInGui</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureVMImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the image being added to the image repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>OS</maml:name> <maml:description> <maml:para>Specifies the operating system version of the image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label to give the image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Specifies the End User License Aggreement, recommended value is a URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the OS image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>ImageFamily</maml:name> <maml:description> <maml:para>Specifies a value that can be used to group OS images.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>PublishedDate</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>PrivacyUri</maml:name> <maml:description> <maml:para>Specifies the URI that points to a document that contains the privacy policy related to the OS image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>RecommendedVMSize</maml:name> <maml:description> <maml:para>Specifies the size to use for the virtual machine that is created from the OS image. Values are: "Medium", "Large", and "ExtraLarge", "A5", "A6",, "A7".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>IconName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>SmallIconName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="13"> <maml:name>ShowInGui</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the OS image.</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="true (ByValue, ByPropertyName)" position="2"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> <dev:type> <maml:name>VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Specifies the End User License Aggreement, recommended value is a URL.</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="true (ByPropertyName)" position="11"> <maml:name>IconName</maml:name> <maml:description> <maml:para>Not Specified</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="true (ByPropertyName)" position="7"> <maml:name>ImageFamily</maml:name> <maml:description> <maml:para>Specifies a value that can be used to group OS images.</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="true (ByPropertyName)" position="1"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the image being added to the image repository.</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="true (ByPropertyName)" position="4"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label to give the image.</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="true (ByPropertyName)" position="2"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the location of the physical blob page where the image resides. This is a link to a blob page in the current subscription's storage.</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="true (ByPropertyName)" position="3"> <maml:name>OS</maml:name> <maml:description> <maml:para>Specifies the operating system version of the image.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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="true (ByPropertyName)" position="9"> <maml:name>PrivacyUri</maml:name> <maml:description> <maml:para>Specifies the URI that points to a document that contains the privacy policy related to the OS image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>PublishedDate</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>RecommendedVMSize</maml:name> <maml:description> <maml:para>Specifies the size to use for the virtual machine that is created from the OS image. Values are: "Medium", "Large", and "ExtraLarge", "A5", "A6",, "A7".</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="true (ByPropertyName)" position="13"> <maml:name>ShowInGui</maml:name> <maml:description> <maml:para>Not Specified</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="true (ByPropertyName)" position="12"> <maml:name>SmallIconName</maml:name> <maml:description> <maml:para>Not Specified</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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OSImageContext</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $s = New-AzureVMImageDiskConfigSet Set-AzureVMImageOSDiskConfig -DiskConfig $s -HostCaching ReadWrite -OSState 'Generalized' -OS 'Windows' -MediaLink $link # A Uri link to the vhd in your storage account Set-AzureVMImageDataDiskConfig -DiskConfig $s -DataDiskName test1 -HostCaching ReadWrite -Lun 0 -MediaLink $link1 Set-AzureVMImageDataDiskConfig -DiskConfig $s -DataDiskName test4 -HostCaching ReadWrite -Lun 0 -MediaLink $link Remove-AzureVMImageDataDiskConfig -DiskConfig $s -DataDiskName test4 $imgname = 'testCREATEvmimage2'; Add-AzureVMImage -ImageName $imgname -Label test1 -Description test1 -DiskConfig $s -Eula 'http://www.test.com' -ImageFamily Windows -PublishedDate (Get-Date) -PrivacyUri 'http://www.test.com' -RecommendedVMSize Small -IconName test1 -SmallIconName test2 -ShowInGui </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> Adds a VM Image to image repository </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Export-AzureVM</command:name> <maml:description> <maml:para>Exports a Microsoft Azure virtual machine state to a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Export-AzureVM cmdlet exports the state of a virtual machine to an xml file. Note: Using Export-AzureVM, followed by Remove-AzureVM and then Import-AzureVM to recreate a virtual machine can cause the resultant virtual machine to have a different IP address than the original.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that hosts the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose state you are exporting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path and file name to which the virtual machine state will be saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that hosts the 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine whose state you are exporting.</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="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path and file name to which the virtual machine state will be saved.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Export-AzureVM -ServiceName $MyService -Name $MyRole -Path "C:\vms\VMstate.xml"</dev:code> <dev:remarks> <maml:para>This command exports the state of the $MyRole virtual machine to the “VMstate.xml” file.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureAclConfig</command:name> <maml:description> <maml:para>Gets the ACL configuration object from an existing Azure VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAclConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureAclConfig cmdlet gets the ACL configuration object from an existing Azure VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAclConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object for which the endpoint will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object for which the endpoint will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS> $acl = Get-AzureVM -ServiceName "myservice" -Name "MyVM" | Get-AzureAclConfig -EndpointName "Web"</dev:code> <dev:remarks> <maml:para>This command will get the ACL configuration from the VM with name "MyVM".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureAffinityGroup</command:name> <maml:description> <maml:para>Returns an object that represents a Microsoft Azure affinity group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAffinityGroup</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureAffinityGroup cmdlet returns an affinity group object that includes the affinity group name, location, label, description and the storage and hosted services that are part of the affinity group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAffinityGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Affinity Group name. A name is assigned to the affinity group at the time of creation. Note that names for affinity groups created through the Management Portal are typically GUIDs and that the UI shows its label.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Affinity Group name. A name is assigned to the affinity group at the time of creation. Note that names for affinity groups created through the Management Portal are typically GUIDs and that the UI shows its label.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffinityGroup</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureAffinityGroup -Name "MyGroup1"</dev:code> <dev:remarks> <maml:para>This example list the properties of the "MyGroup1" affinity group.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureCertificate</command:name> <maml:description> <maml:para>Gets a certificate object from the specified Microsoft Azure service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureCertificate</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that has the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Specifies the algorithm used to create the certificate thumbprint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Specifies the thumbprint that identifies the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that has the certificate.</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="true (ByPropertyName)" position="named"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Specifies the algorithm used to create the certificate thumbprint.</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="true (ByPropertyName)" position="named"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Specifies the thumbprint that identifies the certificate.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CertificateContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$MyAzureCert = Get-AzureCertificate -ServiceName "MyService"</dev:code> <dev:remarks> <maml:para>This command gets the certificate object from the specified cloud service, and stores it in the $MyAzureCert variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$MyAzureCert = Get-AzureCertificate -ServiceName "MyService" `-Thumbprint <CertThumbprint></dev:code> <dev:remarks> <maml:para>This command gets the certificate object identified by the specified thumbprint from the specified hosted service, and stores it in the $MyAzureCert variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureDataDisk</command:name> <maml:description> <maml:para>Gets a Microsoft Azure data disk object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureDataDisk cmdlet gets an object that represents the Microsoft Azure data disks on the specified virtual machine. To get a specific data disk object, specify the disk's LUN.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureDataDisk</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Lun</maml:name> <maml:description> <maml:para>Specifies the LUN where the data disk resides.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which to get data disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Lun</maml:name> <maml:description> <maml:para>Specifies the LUN where the data disk resides.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which to get data disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM "myservice" –Name "MyVM" | Get-AzureDataDisk</dev:code> <dev:remarks> <maml:para>This command gets the "MyVM" virtual machine running on the "myservice" cloud service, and then gets a list of the data disks mounted on the virtual machine.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$dDisk = ( Get-AzureVM "myservice" -Name "MyVM" ` | Get-AzureDataDisk -LUN 2 )</dev:code> <dev:remarks> <maml:para>This command gets a data disk object, $dDisk, that represents the data disk mounted at LUN 2 on the Database virtual machine running on the Microsoft Azure service "myservice".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM "MyService" –Name "MyVM" | Get-AzureDataDisk –LUN 1</dev:code> <dev:remarks> <maml:para>This command removes the data disk at LUN 1 on the "MyVM" virtual machine running on the Microsoft Azure service "MyService".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureDataDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureDataDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDataDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureDeployment</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDeployment</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureDeployment -ServiceName "MyService"</dev:code> <dev:remarks> <maml:para>This command will return the details of the production deployment of "MyService".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureDeployment -ServiceName "MyService" -Slot Staging</dev:code> <dev:remarks> <maml:para>This command returns the details of the staging deployment of "MyService".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Move-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureDisk</command:name> <maml:description> <maml:para>Gets an object with information on disks in the Microsoft Azure disk repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureDisk cmdlet retrieves an object with information about the disks stored in the Microsoft Azure disk repository for the current subscription. It returns a list object with information for all disks in the repository, or with information on a specific disk if its disk name is specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the disk in the disk repository to return information about.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the disk in the disk repository to return information about.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureDisk -DiskName MyDataDisk</dev:code> <dev:remarks> <maml:para>This command retrieves data about the "MyDataDisk" disk from the disk repository.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureDisk</dev:code> <dev:remarks> <maml:para>This command retrieves data for all the disks in the disk repository.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureDisk | Where-Object {$_.AttachedTo –eq $null } ` | Format-Table –auto "DiskName","DiskSizeInGB","MediaLink"</dev:code> <dev:remarks> <maml:para>This command gets data for all of the disks in the disk repository that are not currently attached to a virtual machine and then formats the list as a table.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureDns</command:name> <maml:description> <maml:para>Gets an object with the DNS settings for the Microsoft Azure deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDns</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureDNS cmdlet gets the DNS settings for a Microsoft Azure deployment. The returned settings are "name" (a friendly name) and "Address" which is the IP address of the DNS server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureDns</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DnsSettings object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsSettings</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DnsSettings object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsSettings</command:parameterValue> <dev:type> <maml:name>DnsSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureDeployment -ServiceName "MySvc1" -Slot "Production" | Get-AzureDNS</dev:code> <dev:remarks> <maml:para>This command gets the production DNS settings for the specified deployment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureEndpoint</command:name> <maml:description> <maml:para>Gets an object with information about the endpoints assigned to a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureEndpoint</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureEndpoint cmdlet returns an object with information about the endpoints that are assigned to a Microsoft Azure virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the input endpoint from which information will be retrieved. If the Name parameter is omitted, information about all endpoints assigned to the specified virtual machine is retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which endpoint information will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the input endpoint from which information will be retrieved. If the Name parameter is omitted, information about all endpoints assigned to the specified virtual machine is 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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which endpoint information will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM –ServiceName “MyService” –Name “MyVM” | Get-AzureEndpoint</dev:code> <dev:remarks> <maml:para>This command gets endpoint information for the virtual machine “MyVM”.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureInternalLoadBalancer</command:name> <maml:description> <maml:para>Get-AzureInternalLoadBalancer [-ServiceName] <string> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureInternalLoadBalancer</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Returns the details of the Internal Load balancer configuration on the deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.InternalLoadBalancerContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureService -ServiceName ILBINVNet | Get-AzureInternalLoadBalancer</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Returns information on the internal load balancer configuration on the deployment</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureLocation</command:name> <maml:description> <maml:para>Gets the available data center locations for the current Microsoft Azure subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureLocation</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureLocation cmdlet returns a list object with the available Microsoft Azure data centers and their properties for the current Microsoft Azure subscription. Before running this cmdlet, you need to set your current subscription with Select-AzureSubscription and Set-AzureSubscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureLocation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureLocation</dev:code> <dev:remarks> <maml:para>This command gets a list of available data centers, and their properties, for the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureOSDisk</command:name> <maml:description> <maml:para>Gets the operating system disk object for the specified Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureOSDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureOSDisk cmdlet gets an object representing the operating system disk of the specified virtual machine object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureOSDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object whose operating system disk object you want to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object whose operating system disk object you want to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM –ServiceName “MyService” –Name “MyVM” | Get-AzureOSDisk</dev:code> <dev:remarks> <maml:para>This command gets the operating system disk object for the "MyVM" virtual machine.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureOSVersion</command:name> <maml:description> <maml:para>Returns an object with all the available Microsoft Azure guest operating systems.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureOSVersion</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureOSVersion cmdlet returns a list object with all the available Microsoft Azure guest operating systems.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureOSVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureOSVersion</dev:code> <dev:remarks> <maml:para>This command retrieves an object containing a list of all versions of the guest operating system that are available in the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureOSVersion | Format-Table –auto "Family", "FamilyLabel", "Version"</dev:code> <dev:remarks> <maml:para>This command retrieves an object containing a list of all versions of the guest operating system that are available in the current subscription, and formats them in a table showing the OS Family, OS Family Label, and Version.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzurePublicIP</command:name> <maml:description> <maml:para>Get-AzurePublicIP [[-PublicIPName] <string>] -VM <IPersistentVM> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzurePublicIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Returns the Instance Level Public IP information on the virtual machine. To obtain the IP Address of the Public IP use Get-AzureVM cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzurePublicIP</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PublicIPName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PublicIPName</maml:name> <maml:description> <maml:para> </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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.AssignPublicIPCollection</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName FTPInAzure -Name FTPInstance | Get-AzurePublicIP</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Returns the Public IP information on the virtual machine. To get the IP address of the public ip, use Get-AzureVM</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRemoteDesktopFile</command:name> <maml:description> <maml:para>Gets a remote desktop connection file (.RDP) for the specified Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRemoteDesktopFile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureRemoteDesktopFile cmdlet downloads and saves a remote desktop connection (RDP) file to a local disk file. The cmdlet can optionally launch a remote desktop connection to the specified virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRemoteDesktopFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the virtual machine to download an RDP file for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Specifies the path and name of the downloaded RDP file on the local disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRemoteDesktopFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the virtual machine to download an RDP file for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Specifies the path and name of the downloaded RDP file on the local disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Launch</maml:name> <maml:description> <maml:para>When specified, launches a remote desktop session to the specified virtual machine.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the virtual machine to download an RDP file for.</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="true (ByPropertyName)" position="2"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Specifies the path and name of the downloaded RDP file on the local disk.</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="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service 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="3"> <maml:name>Launch</maml:name> <maml:description> <maml:para>When specified, launches a remote desktop session to the specified virtual machine.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureRemoteDesktopFile -ServiceName "myservice" -Name "MyVM-01_IN_0" -LocalPath "c:\temp\MyVM01.rdp"</dev:code> <dev:remarks> <maml:para>This command gets an RDP file for the "MyVM-01_IN_0" virtual machine running on the "myservice" service and stores it as "c:\temp\MyVM01.rdp".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureRemoteDesktopFile -ServiceName "myservice" -Name "MyVM-01_IN_0" –Launch</dev:code> <dev:remarks> <maml:para>This command gets an RDP connection file for the "MyVM-01_IN_0" virtual machine running on the "myservice" service and launches a remote desktop connection to the specified virtual machine. The RDP file is deleted when the connection is closed.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureReservedIP</command:name> <maml:description> <maml:para>Get the Reserved IP by its name or lists all the Reserved IPs in the subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureReservedIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get the reserved IP by its name or list all of them in the subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureReservedIP</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureReservedIP</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------List all the reserved IP(s) in this subscription.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureReservedIP -ReservedIPName $ipName</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Get the reserved IP by the name in this subscription.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRole</command:name> <maml:description> <maml:para>Returns a list of roles in your Microsoft Azure service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRole</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureRole cmdlet returns a list object with details on the roles in your Microsoft Azure service. If the RoleName parameter is specified, Get-AzureRole returns details on that role only. If the InstanceDetails parameter is specified, additional, instance specific details are returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure deployment environment. Choices are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>When specified, returns details only on the specified role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>InstanceDetails</maml:name> <maml:description> <maml:para>When specified, returns details about the instances on each role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service.</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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure deployment environment. Choices are "Production" or "Staging".</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="true (ByPropertyName)" position="2"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>When specified, returns details only on the specified role.</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="true (ByPropertyName)" position="3"> <maml:name>InstanceDetails</maml:name> <maml:description> <maml:para>When specified, returns details about the instances on each role.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureRole –ServiceName "MySvc1" –Slot Production</dev:code> <dev:remarks> <maml:para>This command returns an object with details on all the production roles running on the "MySvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureRole –ServiceName "MySvc1" –Slot Staging –RoleName "MyTestVM3"</dev:code> <dev:remarks> <maml:para>This command returns an object with details on the "MyTestVM3" role, running on the staging environment of the "MySvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureRole –ServiceName "MySvc1" –Slot Production –RoleName "MyTestVM2" -InstanceDetails</dev:code> <dev:remarks> <maml:para>This command returns an object with details on the instances of the "MyTestVM2" role running in the production environment on the "MySvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureRole –ServiceName "MySvc1" –Slot Production -InstanceDetails ` | Format-Table –Auto "InstanceName", "InstanceSize", "InstanceStatus"</dev:code> <dev:remarks> <maml:para>This command returns a table of the instance name, size, and status of all role instances running in the production environment on the "MySvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureRole</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRoleSize</command:name> <maml:description> <maml:para>Get the role size information for the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRoleSize</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get the role size information for the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRoleSize</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>The role size name, e.g. ExtraSmall, Small, Large, ExtraLarge, A5, A6, A7, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>The role size name, e.g. ExtraSmall, Small, Large, ExtraLarge, A5, A6, A7, 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureRoleSize InstanceSize : A6 RoleSizeLabel : Cores : 4 MemoryInMb : 28672 SupportedByWebWorkerRoles : True SupportedByVirtualMachines : True OperationDescription : Get-AzureRoleSize OperationId : c5ed7b3a-03b3-548d-876b-6688c5b29cce OperationStatus : Succeeded InstanceSize : A7 RoleSizeLabel : Cores : 8 MemoryInMb : 57344 SupportedByWebWorkerRoles : True SupportedByVirtualMachines : True OperationDescription : Get-AzureRoleSize OperationId : c5ed7b3a-03b3-548d-876b-6688c5b29cce OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureRoleSize -InstanceSize A7 InstanceSize : A7 RoleSizeLabel : Cores : 8 MemoryInMb : 57344 SupportedByWebWorkerRoles : True SupportedByVirtualMachines : True OperationDescription : Get-AzureRoleSize OperationId : c5ed7b3a-03b3-548d-876b-6688c5b29cce OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureService | Get-AzureVM | Get-AzureRoleSize # Output of the role size information for all VMs in all the cloud services</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureService</command:name> <maml:description> <maml:para>Returns an object with information about the cloud services for the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureService</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureService cmdlet returns a list object with all of the Microsoft Azure cloud services associated with the current subscription. If the ServiceName parameter is specified, Get-AzureService will return information on only the matching service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>If specified, returns information on the specified service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>If specified, returns information on the specified service.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>HostedServiceContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureService</dev:code> <dev:remarks> <maml:para>This command returns a list object that contains information about all of the Microsoft Azure services associated with the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureService –ServiceName $MySvc</dev:code> <dev:remarks> <maml:para>This command returns information about the $MySvc service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureService | Get-Member</dev:code> <dev:remarks> <maml:para>This command displays the properties and methods that are available from the Get-AzureService cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureServiceADDomainExtension</command:name> <maml:description> <maml:para>This cmdlet gets the cloud service AD domain extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceADDomainExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets the cloud service AD domain extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceADDomainExtension -ServiceName $svc</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command returns the information of the cloud service AD domain extensions enabled on the roles of a certain deployment.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureServiceAntimalwareConfig</command:name> <maml:description> <maml:para>Gets configuration details for the Microsoft Antimalware extension for a service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceAntimalwareConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureServiceAntimalwareConfig cmdlet gets the antimalware configuration and monitoring configuration details associated with the Microsoft Antimalware extension for a cloud service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceAntimalwareConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</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> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get configuration for a service --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureServiceAntimalwareConfig -ServiceName "ContosoService03"</dev:code> <dev:remarks> <maml:para>This command returns the antimalware configuration object for the specified service name. Because this command does not specify the Slot parameter, the command gets the configuration for the default slot, Production. For services that have monitoring enabled, the command also returns a monitoring configuration object.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get configuration for a service for the Staging slot --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureServiceAntimalwareConfig -ServiceName "ContosoService03" -Slot Staging</dev:code> <dev:remarks> <maml:para>This command returns the antimalware configuration object for the specified service name. Because this command specifies a value of Staging for the Slot parameter, the command gets the configuration for the Staging slot. For services that have monitoring enabled, the command also returns a monitoring configuration object.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=402839</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureServiceAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureServiceAvailableExtension</command:name> <maml:description> <maml:para>Get information for the latest available extensions for hosted services.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceAvailableExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get information for the latest available extensions for hosted services.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceAvailableExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureServiceAvailableExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>AllVersions</maml:name> <maml:description> <maml:para>Specify to list all versions of an extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureServiceAvailableExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension 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="true (ByPropertyName)" position="1"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</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="true (ByPropertyName)" position="2"> <maml:name>AllVersions</maml:name> <maml:description> <maml:para>Specify to list all versions of an extension.</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="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceAvailableExtension ProviderNameSpace : Microsoft.Windows.Azure.Extensions ExtensionName : RDP Version : 1.0 Label : Microsoft Azure Remote Desktop Extension Description : Microsoft Azure Remote Desktop Extension HostingResources : WebOrWorkerRole ThumbprintAlgorithm : sha1 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PublicConfig"><xs:complexType><xs:sequence><xs:element name="UserName" type="xs:string" minOccurs="1" /><xs:element name="Expiration" type="xs:string" minOccurs="1" /></xs:sequence></xs:complexType></xs:element></xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PrivateConfig"><xs:complexType><xs:sequence><xs:element name="Password" type="xs:string" /></xs:sequence></xs:complexType></xs:element></xs:schema> OperationDescription : Get-AzureServiceAvailableExtension OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceAvailableExtension -ProviderNamespace Microsoft.Windows.Azure.Extensions -ExtensionName RDP -AllVersions ProviderNameSpace : Microsoft.Windows.Azure.Extensions ExtensionName : RDP Version : 1.0.0.1 Label : Microsoft Azure Remote Desktop Extension Description : Microsoft Azure Remote Desktop Extension HostingResources : WebOrWorkerRole ThumbprintAlgorithm : sha1 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PublicConfig"><xs:complexType><xs:sequence><xs:element name="UserName" type="xs:string" minOccurs="1" /><xs:element name="Expiration" type="xs:string" minOccurs="1" /></xs:sequence></xs:complexType></xs:element></xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PrivateConfig"><xs:complexType><xs:sequence><xs:element name="Password" type="xs:string" /></xs:sequence></xs:complexType></xs:element></xs:schema> OperationDescription : Get-AzureServiceAvailableExtension OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceAvailableExtension -ProviderNamespace Microsoft.Windows.Azure.Extensions -ExtensionName RDP -Version 1.0.0.1 ProviderNameSpace : Microsoft.Windows.Azure.Extensions ExtensionName : RDP Version : 1.0.0.1 Label : Microsoft Azure Remote Desktop Extension Description : Microsoft Azure Remote Desktop Extension HostingResources : WebOrWorkerRole ThumbprintAlgorithm : sha1 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PublicConfig"><xs:complexType><xs:sequence><xs:element name="UserName" type="xs:string" minOccurs="1" /><xs:element name="Expiration" type="xs:string" minOccurs="1" /></xs:sequence></xs:complexType></xs:element></xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PrivateConfig"><xs:complexType><xs:sequence><xs:element name="Password" type="xs:string" /></xs:sequence></xs:complexType></xs:element></xs:schema> OperationDescription : Get-AzureServiceAvailableExtension OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureServiceDiagnosticsExtension</command:name> <maml:description> <maml:para>This cmdlet gets the cloud service diagnostics extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceDiagnosticsExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets the cloud service diagnostics extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceDiagnosticsExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceDiagnosticsExtension -ServiceName $svc</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command returns the information of the cloud service diagnostics extensions enabled on the roles of the Production deployment in the service $svc.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureServiceExtension</command:name> <maml:description> <maml:para>This cmdlet gets existing cloud service extensions that are applied on a deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets existing cloud service extensions that are applied on a deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="2"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension 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="true (ByPropertyName)" position="3"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceExtension -ServiceName $svc -Slot Production -ExtensionName RDP -ProviderNamespace Microsoft.Windows.Azure.Extensions</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Get existing RDP extensions applied on all roles in the production deployment slot.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceExtension -ServiceName $svc -Slot Production -Role WebRole1 -ExtensionName RDP -ProviderNamespace Microsoft.Windows.Azure.Extensions</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Get existing RDP extensions applied on the 'WebRole1' role in the production deployment slot.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureServiceRemoteDesktopExtension</command:name> <maml:description> <maml:para>This cmdlet gets the cloud service remote desktop extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceRemoteDesktopExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets the cloud service remote desktop extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceRemoteDesktopExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceRemoteDesktopExtension -ServiceName $svc</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command returns the information of the cloud service remote desktop extensions enabled on the roles of a certain deployment.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureStaticVNetIP</command:name> <maml:description> <maml:para>Get the static VNet IP address information from a VM object, if any.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStaticVNetIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get the static VNet IP address information from a VM object, if any.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStaticVNetIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureStorageAccount</command:name> <maml:description> <maml:para>Gets the storage accounts for the current Microsoft Azure subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStorageAccount</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureStorageAccount cmdlet returns an object with the details about the storage accounts for the current subscription. If the StorageAccountName parameter is specified, then only that storage account is returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStorageAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns only the specified storage account object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>If specified, the cmdlet returns only the specified storage account object.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureStorageAccount</dev:code> <dev:remarks> <maml:para>This command returns an object with all the storage accounts associated with the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureStorageAccount –StorageAccountName "mystore1"</dev:code> <dev:remarks> <maml:para>This command returns an object with only the "mystore1" account information.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureStorageAccount | Format-Table -auto @{Label="Name";Expression={$_.StorageAccountName}},"Label","Location"</dev:code> <dev:remarks> <maml:para>This command returns an object with all the storage accounts associated with the current subscription, and outputs them as a table showing the account name, the account label, and the storage location.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureStorageKey</command:name> <maml:description> <maml:para>Returns the primary and secondary storage account keys for a Microsoft Azure storage account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStorageKey</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureStorageKey cmdlet returns an object with the storage account name, the primary account key, and the secondary account key of the specified Microsoft Azure storage account as properties.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStorageKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies the storage account name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies the storage account 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureStorageKey –StorageAccountName "mystore1"</dev:code> <dev:remarks> <maml:para>This command gets an object with the primary and secondary storage keys for the "mystore1" storage account.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $myStoreKey = (Get-AzureStorageKey –StorageAccountName "mystore1").Primary</dev:code> <dev:remarks> <maml:para>This command puts the primary storage account key for the "mystore1" storage account in the $myStoreKey variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureStorageKey</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureSubnet</command:name> <maml:description> <maml:para>Gets a list of subnets associated with the specified Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSubnet</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureSubnet cmdlet returns a list the subnets associated with the specified virtual machine. Use Get-AzureVM to specify the virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSubnet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which to get the subnet list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which to get the subnet list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$myVM = Get-AzureVM –ServiceName "MySvc" –Name "MyVM" C:\PS>Get-AzureSubnet –VM $myVM</dev:code> <dev:remarks> <maml:para>This example gets the Microsoft Azure subnets for the virtual machine "MyVM" running in "MySvc"</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVM</command:name> <maml:description> <maml:para>Retrieves information from one or more Microsoft Azure virtual machines.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVM cmdlet retrieves information about virtual machines running in Microsoft Azure. It returns an object with information on a specific virtual machine, or if no virtual machine is specified, for all the virtual machines in the specified service of the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVM</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the cloud service for which to return virtual machine information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine for which to retrieve information. If this parameter is not provided, the cmdlet returns a list object with information about all the virtual machines in the specified service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the cloud service for which to return virtual machine information.</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="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine for which to retrieve information. If this parameter is not provided, the cmdlet returns a list object with information about all the virtual machines in the specified service.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName "MySvc1" -Name "MyVM1"</dev:code> <dev:remarks> <maml:para>This command returns an object with information on the "MyVM1" virtual machine running in the "MySvc1" cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName "MySvc1"</dev:code> <dev:remarks> <maml:para>This command retrieves a list object with information on all of the virtual machines running in the "MySvc1" cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName "MySvc1" ` | Format-Table –auto "Name",@{Expression={$_.InstanceUpgradeDomain};Label="UpgDom";Align="Right"},"InstanceStatus"</dev:code> <dev:remarks> <maml:para>This command displays a table showing the virtual machines running on the "MySvc1" service, their Upgrade Domain, and the current status of each machine.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureVMConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMAccessExtension</command:name> <maml:description> <maml:para>This cmdlet gets the VMAccess extension (if any) applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMAccessExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets the VMAccess extension (if any) applied on the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMAccessExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMAccessExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This cmdlet gets the VMAccess extension (if any) applied on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMAvailableExtension</command:name> <maml:description> <maml:para>Get information for the latest available extensions for VMs.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMAvailableExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get information for the latest available extensions for VMs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMAvailableExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureVMAvailableExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>AllVersions</maml:name> <maml:description> <maml:para>Specify to list all versions of an extension.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureVMAvailableExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension 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="true (ByPropertyName)" position="1"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</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="true (ByPropertyName)" position="2"> <maml:name>AllVersions</maml:name> <maml:description> <maml:para>Specify to list all versions of an extension.</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="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMAvailableExtension Publisher : Microsoft.Compute ExtensionName : VMAccessAgent Version : 1.0 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PublicConfig"> <xs:complexType> <xs:sequence> <xs:element name="UserName" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PrivateConfig"> <xs:complexType> <xs:sequence> <xs:element name="Password" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> SampleConfig : OperationDescription : Get-AzureVMAvailableExtension OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMAvailableExtension -Publisher Microsoft.Compute -ExtensionName VMAccessAgent -AllVersions Publisher : Microsoft.Compute ExtensionName : VMAccessAgent Version : 1.0.2 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PublicConfig"> <xs:complexType> <xs:sequence> <xs:element name="UserName" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PrivateConfig"> <xs:complexType> <xs:sequence> <xs:element name="Password" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> SampleConfig : OperationDescription : Get-AzureVMAvailableExtension OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx OperationStatus : Succeeded Publisher : Microsoft.Compute ExtensionName : VMAccessAgent Version : 1.0.3 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PublicConfig"> <xs:complexType> <xs:sequence> <xs:element name="UserName" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PrivateConfig"> <xs:complexType> <xs:sequence> <xs:element name="Password" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> SampleConfig : OperationDescription : Get-AzureVMAvailableExtension OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMAvailableExtension -Publisher Microsoft.Compute -ExtensionName VMAccessAgent -Version 1.0.3 Publisher : Microsoft.Compute ExtensionName : VMAccessAgent Version : 1.0.3 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PublicConfig"> <xs:complexType> <xs:sequence> <xs:element name="UserName" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="PrivateConfig"> <xs:complexType> <xs:sequence> <xs:element name="Password" type="xs:string" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> SampleConfig : OperationDescription : Get-AzureVMAvailableExtension OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMBGInfoExtension</command:name> <maml:description> <maml:para>This cmdlet gets the BGInfo extension (if any) applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMBGInfoExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets the BGInfo extension (if any) applied on the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMBGInfoExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMBGInfoExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This cmdlet gets the BGInfo extension (if any) applied on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMCustomScriptExtension</command:name> <maml:description> <maml:para>Get Azure VM Custom Script Extension Information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMCustomScriptExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get Azure VM Custom Script Extension Information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMCustomScriptExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMCustomScriptExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMDiagnosticsExtension</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMDiagnosticsExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMDiagnosticsExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Get-AzureVMDscExtension </command:name> <maml:description> <maml:para>Gets the settings of the DSC extension on a particular VM.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMDscExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Gets the settings of the DSC extension on a particular VM.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMDscExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>VM</maml:name> <maml:description> <maml:para>The Virtual Machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the DSC extension that Get-AzureVMDSCExtension will get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the DSC extension that Get-AzureVMDSCExtension will get the settings from.</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="true (ByValue, ByPropertyName)" position="1"> <maml:name>VM</maml:name> <maml:description> <maml:para>The Virtual Machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.VirtualMachineDscExtensionContext</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Get-AzureVMDscExtensionStatus </command:name> <maml:description> <maml:para>Get the DSC Extension status for all the vm's deployed in a cloud service or for a particular vm in the service.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMDscExtensionStatus</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Get the DSC Extension status for all the vm's deployed in a cloud service or for a particular vm in the service.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMDscExtensionStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Name of the service </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the vm </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureVMDscExtensionStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="3"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVMRoleContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the vm </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="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Name of the service </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="true (ByValue, ByPropertyName)" position="3"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVMRoleContext</command:parameterValue> <dev:type> <maml:name>PersistentVMRoleContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.VirtualMachineDscExtensionStatusContext</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMExtension</command:name> <maml:description> <maml:para>This cmdlet gets resource extensions applied on VMs.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets resource extensions applied on VMs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureVMExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference 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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension 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="true (ByPropertyName)" position="2"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</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="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName $svc -Name $vm | Get-AzureVMExtension;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Get the resource extensions applied on the VM '$vm'.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMImage</command:name> <maml:description> <maml:para>The Get-AzureVMImage cmdlet gets the properties on one or a list of OS or VM image in the image repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMImage</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVMImage cmdlet returns one or a list of OS or VM object(s) with information on one or more operating system images stored in the image repository. The cmdlet returns information for all images in the repository, or about a specific image if its image name is provided.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMImage</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the OS or VM image in the image repository. If not specified, all the images will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the OS or VM image in the image repository. If not specified, all the images 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMImage -ImageName MyImage</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command retrieves the "MyImage" OS or VM image object from the current image repository.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMImage</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command retrieves all the OS and VM images from the current image repository.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $subsId = <MySubscriptionID> C:\PS>$cert = Get-AzureCertificate cert:\LocalMachine\MY\<CertificateThumbprint> C:\PS>$MyOSImages = Get-AzureVMImage</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command sets the subscription context and then retrieves all the images from the image repository.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMImageDiskConfigSet</command:name> <maml:description> <maml:para>This cmdlet returns an object for disk configuration set, which is from the input image context.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMImageDiskConfigSet</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet returns an object for disk configuration set, which is from the input image context.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMImageDiskConfigSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ImageContext</maml:name> <maml:description> <maml:para>The VM image context.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OSImageContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ImageContext</maml:name> <maml:description> <maml:para>The VM image context.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OSImageContext</command:parameterValue> <dev:type> <maml:name>OSImageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMImage -ImageName $img | Get-AzureVMImageDiskConfigSet</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMMicrosoftAntimalwareExtension</command:name> <maml:description> <maml:para>Gets the Microsoft Antimalware extension details for a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMMicrosoftAntimalwareExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVMMicrosoftAntimalwareExtension cmdlet gets the Microsoft Antimalware extension details for a virtual machine. This cmdlet gets details for virtual machines that have the extension turned on programmatically by using the Set-AzureVMMicrosoftAntimalwareExtension cmdlet. The cmdlet gets the JavaScript Object Notation (JSON) equivalent for the configuration. If monitoring is turned on, the cmdlet also gets an XML representation of the antimalware monitoring configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMMicrosoftAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VirtualMachineMicrosoftAntimalwareExtensionContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get information for the extension for a virtual machine --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureVM -ServiceName "ContosoService03" -Name "ContosoVM22" | Get-AzureVMMicrosoftAntimalwareExtension</dev:code> <dev:remarks> <maml:para>This command gets details for the Microsoft Antimalware extension for a virtual machine. The command uses the Get-AzureVM cmdlet to get the specified virtual machine object, and then passes the object to the current cmdlet by using the pipeline operator. Get-AzureVMMicrosoftAntimalwareExtension gets configuration information for the extension.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The configuration information for monitoring appears in the output field labeled AntimalwareMonitoringConfiguration.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=402840</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVMMicrosoftAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureVMMicrosoftAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVMPuppetExtension</command:name> <maml:description> <maml:para>This cmdlet gets the Puppet extension (if any) applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMPuppetExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet gets the Puppet extension (if any) applied on the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMPuppetExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMPuppetExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This cmdlet gets the Puppet extension (if any) applied on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVNetConfig</command:name> <maml:description> <maml:para>Gets the Microsoft Azure virtual network configuration from the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVNetConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVNetConfig retrieves the virtual network configuration of the current Microsoft Azure subscription. If the ExportToFile parameter is specified, a network configuration file is created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVNetConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportToFile</maml:name> <maml:description> <maml:para>Specifies the path and file name of a network configuration file to be created from the settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportToFile</maml:name> <maml:description> <maml:para>Specifies the path and file name of a network configuration file to be created from the settings.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVNetConfig</dev:code> <dev:remarks> <maml:para>This command gets the virtual network configuration of the current Microsoft Azure subscription and displays it.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVNetConfig -ExportToFile "c:\temp\MyAzNets.netcfg"</dev:code> <dev:remarks> <maml:para>This command retrieves the virtual network configuration of the current Microsoft Azure subscription and then saves it to a local file.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVNetSite</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVNetConnection</command:name> <maml:description> <maml:para>Returns an object with all of the virtual network connections to the specified Microsoft Azure virtual network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVNetConnection</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVNetConnections cmdlet returns an object with all of the current active connections to the specified Microsoft Azure virtual network.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVNetConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual network from which to return connections.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual network from which to return connections.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVNetConnection –VNetName "VNet1"</dev:code> <dev:remarks> <maml:para>Gets a list of all of the current connections to the "VNet1" virtual network.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Start-VirtualNetworkGateway</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>End-VirtualNetworkGateway</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVNetGateway</command:name> <maml:description> <maml:para>Retrieves an object with information about a Microsoft Azure virtual network gateway.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVNetGateway</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVNetGateway cmdlet retrieves an object with information about a Microsoft Azure virtual network gateway from the current Microsoft Azure subscription. A virtual network gateway is a connection between a local network site with a VPN device and a Microsoft Azure virtual network.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVNetGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the virtual network name whose virtual network gateway object will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the virtual network name whose virtual network gateway object 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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-VNetGateway –VnetName "MyVNet01"</dev:code> <dev:remarks> <maml:para>This command gets a Microsoft Azure virtual network gateway object from the "MyVNet01" virtual network.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVNetGatewayKey</command:name> <maml:description> <maml:para>Returns a shared key that can be used to configure a VPN device.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVNetGatewayKey</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVNetGatewayKey cmdlet returns the shared key used by the VPN device on the specified LocalNetworkSiteName to authenticate to the Microsoft Azure Virtual Network Gateway for the specified Microsoft Azure virtual network.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVNetGatewayKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure virtual network that the VPN device connects to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LocalNetworkSiteName</maml:name> <maml:description> <maml:para>Specifies the local network site name for which to retrieve a shared key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure virtual network that the VPN device connects to.</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="1"> <maml:name>LocalNetworkSiteName</maml:name> <maml:description> <maml:para>Specifies the local network site name for which to retrieve a shared key.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVNetGatewayKey –VNetName "MyVirtualNetwork" –LocalNetworkSiteName "MyBranchOffice"</dev:code> <dev:remarks> <maml:para>This command retrieves a shared-key to allow the VPN device at the specified local network site to authenticate to the specified virtual network.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureVNetSite</command:name> <maml:description> <maml:para>Returns an object describing Microsoft Azure virtual networks.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVNetSite</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureVNetSite cmdlet returns a list object with information about Microsoft Azure virtual networks for the current subscription.. If you specify a virtual network name, only information for that virtual network is returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVNetSite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies a virtual network name to return information about.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies a virtual network name to return information about.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVNetSite</dev:code> <dev:remarks> <maml:para>This example retrieves information about all the virtual networks in the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVNetSite –VNetName "MyProductionNetwork"</dev:code> <dev:remarks> <maml:para>This example retrieves information on the "MyProductionNetwork" virtual network only.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureWinRMUri</command:name> <maml:description> <maml:para>Retrieves the uri to WinRM https listener to a VM or a list of VMs in a hosted service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWinRMUri</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Retrieves the uri to WinRM https listener to a VM or a list of VMs in a hosted service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWinRMUri</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that hosts the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to which the WinRM Uri is generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that hosts the 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to which the WinRM Uri is generated.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureWinRMUri -ServiceName MyService -Name MyVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Returns a URI to WinRM https listener to the specified VM in the specified service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureWinRMUri -ServiceName MyService</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Returns a list of URIs to WinRM https listeners to the VMs in the specified service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureQuickVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-AzureVM</command:name> <maml:description> <maml:para>Imports a Microsoft Azure virtual machine state from a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Import-AzureVM cmdlet imports the previously saved state of a virtual machine from an xml file. This cmdlet is useful when you want to subsequently create a new virtual machine from the imported data. Note: Using Export-AzureVM, followed by Remove-AzureVM and then Import-AzureVM to recreate a virtual machine can cause the resultant virtual machine to have a different IP address than the original.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the file with the previously saved virtual machine state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the file with the previously saved virtual machine state.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Import-AzureVM -Path "C:\VMstate.xml" | New-AzureVM –ServiceName "mynewsvc"</dev:code> <dev:remarks> <maml:para>This command imports the state of a virtual machine from the "myvm.xml" file, and then creates a new virtual machine in the specified cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Export-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Move-AzureDeployment</command:name> <maml:description> <maml:para>Swaps the deployments in production and staging.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>AzureDeployment</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Move-AzureDeployment swaps the virtual IP addresses (VIPs) of deployments in production and staging environments. A deployment currently running in the staging environment will be swapped to the production environment, and a deployment running in the production environment will be swapped to the staging environment. If there is a deployment in the staging environment and no deployment in the production environment, the deployment will move to production. If there is no deployment in the staging environment, the cmdlet will fail.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-AzureDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the service whose production and staging deployments will be swapped.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the service whose production and staging deployments will be swapped.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Move-AzureDeployment -ServiceName "myservice"</dev:code> <dev:remarks> <maml:para>This command swaps the deployments of the "myservice" service between the production and stanging environments.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureAclConfig</command:name> <maml:description> <maml:para>Creates a new empty ACL configuration object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureAclConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureAclConfig cmdlet creates a new empty ACL configuration object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureAclConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS> $acl = New-AzureAclConfig</dev:code> <dev:remarks> <maml:para>This command will create a new empty ACL configuration object.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureAffinityGroup</command:name> <maml:description> <maml:para>Creates a new affinity group for the current Microsoft Azure subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureAffinityGroup</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureAffinityGroup cmdlet creates a new affinity group in the current subscription. An affinity group places your services and their resources together in a Microsoft Azure data center. The affinity group members are grouped together for optimal performance. Affinity groups are defined at the subscription level and are available to any subsequent cloud services or storage accounts that you create. Services can be added to an affinity group only at the time of creation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureAffinityGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new affinity group that is unique to the subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the affinity group. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the affinity group. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Required if AffinityGroup is not specified. The Location parameter specifies the geographical location of the data center where the affinity group will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new affinity group that is unique to the subscription.</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>Label</maml:name> <maml:description> <maml:para>Specifies a label for the affinity group. The label may be up to 100 characters in length.</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>The same one as the Name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the affinity group. The description may be up to 1024 characters in length.</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>Location</maml:name> <maml:description> <maml:para>Required if AffinityGroup is not specified. The Location parameter specifies the geographical location of the data center where the affinity group will be created.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>New-AzureAffinityGroup -Name South1 -Location "South Central US" -Label "South Region" -Description "Affinity group for production applications in southern region."</dev:code> <dev:remarks> <maml:para>This command creates a new affinity group named "South1" in the "South Central US" region and specifies both a label and a description.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureCertificateSetting</command:name> <maml:description> <maml:para>Creates a setting object to insert an existing certificate into new Microsoft Azure virtual machines.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureCertificateSetting</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureCertificateSetting cmdlet creates a certificate setting object for a certificate that has already been added to Microsoft Azure. This certificate setting object can be used by New-AzureProvisioningConfig when creating the configuration object for a new virtual machine using New-AzureVM, or when creating a new virtual machine with New-AzureQuickVM. When included as part of a virtual machine creation script, this adds the specified certificate to the new virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureCertificateSetting</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StoreName</maml:name> <maml:description> <maml:para>Specifies the Certificate Store to place the certificate in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Specifies the thumbprint of the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StoreName</maml:name> <maml:description> <maml:para>Specifies the Certificate Store to place the certificate in.</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="1"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Specifies the thumbprint of the certificate.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$myWinCert = New-AzureCertificateSetting –Thumbprint "D7BECD4D63EBAF86023BB4F1A5FBF5C2C924902A" –StoreName "My"</dev:code> <dev:remarks> <maml:para>This command creates a certificate setting object for an existing certificate and then stores the object in a variable for later use.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureCertificate –ServiceName "MySvc" –CertToDeploy "C:\temp\MyWinCert.cer" C:\PS>$myWinCert = New-AzureCertificateSetting –Thumbprint "D7BECD4D63EBAF86023BB4F1A5FBF5C2C924902A" –StoreName "My" C:\PC>New-AzureVMConfig -Name "MyVM2" -InstanceSize Small -ImageName $winImage ` | Add-AzureProvisioningConfig -Windows -Certificates $myWinCert -Password 'pass@word1' ` | New-AzureVM -ServiceName "MySvc"</dev:code> <dev:remarks> <maml:para>This command adds a certificate to the Microsoft Azure service, and then creates a new Windows virtual machine that uses the certificate.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureDeployment</command:name> <maml:description> <maml:para>Creates a new deployment from a service comprising web roles and worker roles.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDeployment</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureDeployment cmdlet creates a new deployment based on package files (.cspkg) and a service configuration files (.cscfg). Use the New-AzureVM cmdlet to create a new deployment based on Microsoft Azure virtual machines. There should not be an existing deployment with the same name nor in the same deployment environment when executing this command. If there is, the command will fail.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies Microsoft Azure service name for the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Package</maml:name> <maml:description> <maml:para>Specifies the path or URI to a .cspkg blob in a storage within the same subscription/project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the path and file name of a service configuration file (.cscfg).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment where the deployment is created. Acceptable values are Staging or Production. If not specified, Production is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies the label name for the new deployment. If not specified, a Globally Unique Identifier (GUID) is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the deployment name. If not specified, a Global Unique Identifier is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStart</maml:name> <maml:description> <maml:para>Specifies that the new deployment will not be started when it is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TreatWarningsAsError</maml:name> <maml:description> <maml:para>Causes warning messages to be treated as errors, resulting in the deployment failing on warnings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExtensionConfiguration</maml:name> <maml:description> <maml:para>Optional array of extension configuration objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ExtensionConfigurationInput[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies Microsoft Azure service name for the 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="1"> <maml:name>Package</maml:name> <maml:description> <maml:para>Specifies the path or URI to a .cspkg blob in a storage within the same subscription/project.</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="2"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the path and file name of a service configuration file (.cscfg).</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="true (ByPropertyName)" position="3"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment where the deployment is created. Acceptable values are Staging or Production. If not specified, Production is 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>Production</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies the label name for the new deployment. If not specified, a Globally Unique Identifier (GUID) is 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>The same as Name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the deployment name. If not specified, a Global Unique Identifier is 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>Guid</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotStart</maml:name> <maml:description> <maml:para>Specifies that the new deployment will not be started when it is created.</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>TreatWarningsAsError</maml:name> <maml:description> <maml:para>Causes warning messages to be treated as errors, resulting in the deployment failing on warnings.</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExtensionConfiguration</maml:name> <maml:description> <maml:para>Optional array of extension configuration objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ExtensionConfigurationInput[]</command:parameterValue> <dev:type> <maml:name>ExtensionConfigurationInput[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureDeployment -ServiceName "myservice" -Slot "Production" -Package "https://mystorage.blob.core.windows.net/mycontainer/MyPackage.cspkg" -Configuration "c:\packages\mypackage.cscfg" -Label "MyDeployment"</dev:code> <dev:remarks> <maml:para>This example creates a new deployment based on a package location and a configuration path.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureDeployment -ServiceName $svc -Package $pkg -Configuration $cnfg -Slot Production -ExtensionConfiguration $rdpConfig</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>This example installs the extension configuration in the specified Cloud Service and applies them on roles.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVMConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureDns</command:name> <maml:description> <maml:para>Creates a DNS settings object to be used when creating a Microsoft Azure deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDns</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureDNS cmdlet creates a DNS settings object for use by the New-AzureVM cmdlet. It accepts two parameters: Name and Address. The Name parameter is a friendly name, not necessarily a DNS resolvable name, and the Address parameter is the IP address of the DNS server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureDns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a friendly name to identify the DNS server. This name is not necessarily a fully qualified domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Specifies the IP address of the DNS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a friendly name to identify the DNS server. This name is not necessarily a fully qualified domain 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="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Specifies the IP address of the DNS server.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$dns1 = New-AzureDns –Name "dns1" –address "10.1.2.4"</dev:code> <dev:remarks> <maml:para>This command creates a new Microsoft Azure DNS settings object.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$dns1 = New-AzureDns –Name "dns1" –address "10.1.2.4" C:\PS>New-AzureVM –ServiceName $MyService –AffinityGroup $MyAG –VnetName $VNet1 –DnsSettings $dns1 –VMs $MyVMconfig</dev:code> <dev:remarks> <maml:para>This command creates a new Microsoft Azure DNS settings object that is then used during the creation of a virtual machine with the New-AzureVM cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureInternalLoadBalancerConfig</command:name> <maml:description> <maml:para>New-AzureInternalLoadBalancerConfig [-InternalLoadBalancerName] <string> [<CommonParameters>] New-AzureInternalLoadBalancerConfig [-InternalLoadBalancerName] <string> [-SubnetName] <string> [-StaticVNetIPAddress] <ipaddress> [<CommonParameters>] New-AzureInternalLoadBalancerConfig [-InternalLoadBalancerName] <string> [-SubnetName] <string> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureInternalLoadBalancerConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-InternalLoadbalancerConfig creates a local object that can be used later during creation of a new azure virtual machine deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureInternalLoadBalancerConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureInternalLoadBalancerConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureInternalLoadBalancerConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>StaticVNetIPAddress</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="2"> <maml:name>StaticVNetIPAddress</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.InternalLoadBalancerConfig</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $myilbconfig = New-AzureInternalLoadBalancerConfig -InternalLoadBalancerName "MyILB" -SubnetName "FrontEndSubnet"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Creates a local Internal load balancer object that can be referenced later in the New-AzureVM operation</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> New-AzureQuickVM </command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureQuickVM</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>The New-AzureQuickVM sets the configuration for a new virtual machine and creates the virtual machine. It can create a new Microsoft Azure service, or deploy the new virtual machine into an existing service if neither -Location or -AffinityGroup is specified.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>New-AzureQuickVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the operating system image to use to create the operating system disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Linux</maml:name> <maml:description> <maml:para>Specify to create a Linux virtual machine.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> Specifies the new or existing service name. If the service does not exist, this parameter will create it for you. Use the -Location or -AffinityGroup parameter to specify where to create the service. If the service exists, the -Location or -AffinityGroup parameter is not needed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure affinity group the virtual machine will reside in. Only valid for a new cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AvailabilitySetName</maml:name> <maml:description> <maml:para>Specify the availability set to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomDataFile</maml:name> <maml:description> <maml:para> This parameter takes a file name as an argument. PowerShell will then base64 encode the contents of the file and send it along with the provisioning configuration information. The file must be less than 64KB or the Azure API will not accept the request. On Windows this data ends up in %SYSTEMDRIVE%\AzureData\CustomData.bin as a binary file. On Linux, this data is passed to the VM via the ovf-env.xml file, which is copied to the /var/lib/waagent directory during provisioning. The agent will also place the base-64 encoded data in /var/lib/waagent/CustomData during provisioning. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableGuestAgent</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DNS Server object that defines the DNS settings for the new deployment. Use New-AzureDNS to create the DNS server object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DnsServer[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host caching mode to use. Supported options are: "ReadOnly" and "ReadWrite".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the instance. Allowed values are ExtraSmall, Small, Medium, Large, ExtraLarge, A5, A6, A7, A8, A9, Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LinuxUser</maml:name> <maml:description> <maml:para>Specifies the Linux administrative account name to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </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 Microsoft Azure data center location that will host the virtual machine. When specified, New-AzureQuickVM will create a new Microsoft Azure service in the specified location. Only valid for a new cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure storage location to use for the virtual machines disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the administrative account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SSHKeyPairs</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHKeyPairList</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SSHPublicKeys</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHPublicKeyList</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubnetNames</maml:name> <maml:description> <maml:para>Specifies a list of subnet names the virtual machine will use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of a virtual network the virtual machine will use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForBoot</maml:name> <maml:description> <maml:para>Waits for VM to reach ReadyRole state. Cmdlet fails if VM falls in one of the following states while waiting: "FailedStartingVM", "ProvisioningFailed", "ProvisioningTimeout".</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureQuickVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the operating system image to use to create the operating system disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> Specifies the new or existing service name. If the service does not exist, this parameter will create it for you. Use the -Location or -AffinityGroup parameter to specify where to create the service. If the service exists, the -Location or -AffinityGroup parameter is not needed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Windows</maml:name> <maml:description> <maml:para>Include to create a Windows virtual machine.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdminUsername</maml:name> <maml:description> <maml:para>Specifies the Administrator account to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure affinity group the virtual machine will reside in. Only valid for a new cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AvailabilitySetName</maml:name> <maml:description> <maml:para>Specify the availability set to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Certificates</maml:name> <maml:description> <maml:para>Specifies a certificate list to use for creating the service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CertificateSettingList</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomDataFile</maml:name> <maml:description> <maml:para> This parameter takes a file name as an argument. PowerShell will then base64 encode the contents of the file and send it along with the provisioning configuration information. The file must be less than 64KB or the Azure API will not accept the request. On Windows this data ends up in %SYSTEMDRIVE%\AzureData\CustomData.bin as a binary file. On Linux, this data is passed to the VM via the ovf-env.xml file, which is copied to the /var/lib/waagent directory during provisioning. The agent will also place the base-64 encoded data in /var/lib/waagent/CustomData during provisioning. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableGuestAgent</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableWinRMHttps</maml:name> <maml:description> <maml:para>Disables WinRM on https which is added by default.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DNS Server object that defines the DNS settings for the new deployment. Use New-AzureDNS to create the DNS server object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DnsServer[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnableWinRMHttp</maml:name> <maml:description> <maml:para>Enables WinRM over http.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host caching mode to use. Supported options are: "ReadOnly" and "ReadWrite".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the instance. Allowed values are ExtraSmall, Small, Medium, Large, ExtraLarge, A5, A6, A7, A8, A9, Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </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 Microsoft Azure data center location that will host the virtual machine. When specified, New-AzureQuickVM will create a new Microsoft Azure service in the specified location. Only valid for a new cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure storage location to use for the virtual machines disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExportPrivateKey</maml:name> <maml:description> <maml:para>Prevents the private key from being uploaded</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoWinRMEndpoint</maml:name> <maml:description> <maml:para>Prevents the WinRM endpoint from being added</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for the administrative account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubnetNames</maml:name> <maml:description> <maml:para>Specifies a list of subnet names the virtual machine will use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of a virtual network the virtual machine will use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForBoot</maml:name> <maml:description> <maml:para>Waits for VM to reach ReadyRole state. Cmdlet fails if VM falls in one of the following states while waiting: "FailedStartingVM", "ProvisioningFailed", "ProvisioningTimeout".</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WinRMCertificate</maml:name> <maml:description> <maml:para>Certificate that will be associated with WinRM endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>X509Certificates</maml:name> <maml:description> <maml:para>X509 certificates that will be deployed to hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">X509Certificate2[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdminUsername</maml:name> <maml:description> <maml:para>Specifies the Administrator account 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure affinity group the virtual machine will reside in. Only valid for a new cloud service.</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>AvailabilitySetName</maml:name> <maml:description> <maml:para>Specify the availability set to use.</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>Certificates</maml:name> <maml:description> <maml:para>Specifies a certificate list to use for creating the service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CertificateSettingList</command:parameterValue> <dev:type> <maml:name>CertificateSettingList</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>CustomDataFile</maml:name> <maml:description> <maml:para> This parameter takes a file name as an argument. PowerShell will then base64 encode the contents of the file and send it along with the provisioning configuration information. The file must be less than 64KB or the Azure API will not accept the request. On Windows this data ends up in %SYSTEMDRIVE%\AzureData\CustomData.bin as a binary file. On Linux, this data is passed to the VM via the ovf-env.xml file, which is copied to the /var/lib/waagent directory during provisioning. The agent will also place the base-64 encoded data in /var/lib/waagent/CustomData during provisioning. </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>DisableGuestAgent</maml:name> <maml:description> <maml:para>Not Specified</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>DisableWinRMHttps</maml:name> <maml:description> <maml:para>Disables WinRM on https which is added by default.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DNS Server object that defines the DNS settings for the new deployment. Use New-AzureDNS to create the DNS server object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DnsServer[]</command:parameterValue> <dev:type> <maml:name>DnsServer[]</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>EnableWinRMHttp</maml:name> <maml:description> <maml:para>Enables WinRM over http.</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>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host caching mode to use. Supported options are: "ReadOnly" and "ReadWrite".</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>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the operating system image to use to create the operating system disk.</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="true (ByPropertyName)" position="named"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the instance. Allowed values are ExtraSmall, Small, Medium, Large, ExtraLarge, A5, A6, A7, A8, A9, Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14.</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>Linux</maml:name> <maml:description> <maml:para>Specify to create a Linux virtual machine.</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>LinuxUser</maml:name> <maml:description> <maml:para>Specifies the Linux administrative account name 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> </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 Microsoft Azure data center location that will host the virtual machine. When specified, New-AzureQuickVM will create a new Microsoft Azure service in the specified location. Only valid for a new cloud service.</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>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure storage location to use for the virtual machines disks.</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>Name</maml:name> <maml:description> <maml:para>Specifies the name of the 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoExportPrivateKey</maml:name> <maml:description> <maml:para>Prevents the private key from being uploaded</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>NoWinRMEndpoint</maml:name> <maml:description> <maml:para>Prevents the WinRM endpoint from being added</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>Password</maml:name> <maml:description> <maml:para>Specifies the password for the administrative account.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Not Specified</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>ServiceName</maml:name> <maml:description> <maml:para> Specifies the new or existing service name. If the service does not exist, this parameter will create it for you. Use the -Location or -AffinityGroup parameter to specify where to create the service. If the service exists, the -Location or -AffinityGroup parameter is not needed. </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>SSHKeyPairs</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHKeyPairList</command:parameterValue> <dev:type> <maml:name>LinuxProvisioningConfigurationSet+SSHKeyPairList</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>SSHPublicKeys</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LinuxProvisioningConfigurationSet+SSHPublicKeyList</command:parameterValue> <dev:type> <maml:name>LinuxProvisioningConfigurationSet+SSHPublicKeyList</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubnetNames</maml:name> <maml:description> <maml:para>Specifies a list of subnet names the virtual machine will use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of a virtual network the virtual machine will use.</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>WaitForBoot</maml:name> <maml:description> <maml:para>Waits for VM to reach ReadyRole state. Cmdlet fails if VM falls in one of the following states while waiting: "FailedStartingVM", "ProvisioningFailed", "ProvisioningTimeout".</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="named"> <maml:name>Windows</maml:name> <maml:description> <maml:para>Include to create a Windows virtual machine.</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>WinRMCertificate</maml:name> <maml:description> <maml:para>Certificate that will be associated with WinRM endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>X509Certificates</maml:name> <maml:description> <maml:para>X509 certificates that will be deployed to hosted service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">X509Certificate2[]</command:parameterValue> <dev:type> <maml:name>X509Certificate2[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> New-AzureQuickVM -Windows -ServiceName "MySvc1" -name "MyWinVM1" -ImageName $image -Password $adminPasswd -AdminUsername PsTestAdmin -WaitForBoot </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This example creates a new Windows virtual machine in an existing service from an image. (Use Get-AzureVMImage to get a list of images.) Optional WaitForBoot flag blocks New-AzureVM till the VM boots.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $certs = Get-ChildItem Cert:\CurrentUser\My New-AzureQuickVM -Windows -ServiceName "MySvc1" -name "MyWinVM1" -ImageName $image -Password $adminPasswd -AdminUserName PsTestAdmin -WinRMCertificate $certs[0] -X509Certificates $certs[1], $certs[2] -WaitForBoot </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> This example creates a new Windows virtual machine in an existing service from an image. WinRM Https listener is enabled by default on the VM. WaitForBoot option enables to wait for VM to boot. WinRMCertificate and X509Certificates are uploaded to hosted service by New-AzureQuickVM. </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> New-AzureQuickVM -Linux -ServiceName "MySvc2" -name "MyLxVM1" -ImageName $image -LinuxUser $user -Password $adminPasswd -Location $dclocation </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This example creates a new Linux virtual machine from an image, and creates a new service to host it.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $dclocations = Get-AzureLocation $images = Get-AzureVMImage New-AzureQuickVM -Windows -InstanceSize "Large" -ServiceName "MySvc3" -name "MyWinVM1" -ImageName $images[4].imagename -Password $adminPasswd -AdminUsername PSTestAdmin -location $dclocations[0].name </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> This example gets a list of data center locations, and a list of virtual machine images, and then creates a new large Windows virtual machine and a new service. </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $dclocations = Get-AzureLocation $images = Get-AzureVMImage New-AzureQuickVM -Windows -InstanceSize "Large" -ServiceName "MySvc3" -name "MyWinVM1" -ImageName $images[4].imagename -Password $adminPasswd -AdminUsername PSTestAdmin -location $dclocations[0].name -ReservedIPName $ipName </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> This example creates a new Windows virtual machine with a Reserved IP </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> New-AzureReservedIP </command:name> <maml:description> <maml:para>Create a Reserved IP.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureReservedIP</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Create a reserved IP.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>New-AzureReservedIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Label</maml:name> <maml:description> <maml:para>Reserved IP Label</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location where the Reserved IP should be created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Use the VirtualIPName parameter to reserve an existing VIP in your deployment. If not specified, you will reserve a new VIP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Deployment slot [Staging | Production].</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureReservedIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Reserved IP Label</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location where the Reserved IP should be created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Label</maml:name> <maml:description> <maml:para>Reserved IP Label</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="3"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location where the Reserved IP should be created</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="1"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP 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="4"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Service 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="6"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Deployment slot [Staging | Production].</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="5"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Use the VirtualIPName parameter to reserve an existing VIP in your deployment. If not specified, you will reserve a new VIP.</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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> New-AzureReservedIP -ReservedIPName $name -Label $label -Location $location </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Create a new Reserved IP in the Subscription which can be used for Creating Cloud Services (Web/Worker/Virtual Machines) </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> New-AzureReservedIP -ReservedIPName resip14 -Location "West Europe" -ServiceName piptestwesteurope </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Existing VIP (Virtual IP) on the given service can be reserved. </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Set-AzureReservedIPAssociation </command:name> <maml:description> <maml:para>This cmdlet associates a Reserved IP Address to an existing VM's or a cloud service's VIP (Virtual IP). ReservedIPName is the name of the reserved IP in the subscription. It has to be a free IP, (i.e. not in use). </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureReservedIPAssociation</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>The cmdlet provides means to associate a Reserved IP Address to a running VM or cloud service. The ReservedIP Address should not be in use at the time of invocation of this cmdlet. The Reserved IP and the VM/CloudService has to be in the same region. The operation will take about 30 seconds to complete, after which the VM/Service will be accessible via the Reserved IP.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureReservedIPAssociation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>The Name of the Reserved IP that is being associated with the VM/Service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> Name of the service which has the deployment with which we want to associate the Reserved IP </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Use the VirtualIPName paramter to associate a reserved IP with an existing VIP. See Add-AzureVirtualIP to add VIPs to your Cloud Service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Deployment slot [Staging | Production].</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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>Profile</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>The Name of the Reserved IP that is being associated with the VM/Service.</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="true (ByPropertyName)" position="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Deployment slot [Staging | Production].</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>Production</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Use the VirtualIPName paramter to associate a reserved IP with an existing VIP. See Add-AzureVirtualIP to add VIPs to your Cloud Service.</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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Set-AzureReservedIPAssociation -ReservedIPName resip14 -ServiceName piptestwesteurope </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>'resip14' will be assigned to the service 'piptestwesteurope'. 'resip14' is a reserved IP in the West Europe region. </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://msdn.microsoft.com/en-us/library/azure/dn690120.aspx</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Remove-AzureReservedIPAssociation </command:name> <maml:description> <maml:para>This cmdlet removes the association of the Reserved IP Address from the VM/Cloud Service. </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureReservedIPAssociation</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>This cmdlet dis-associates a reserved IP Address from a VM or Cloud Service. When the operation completes, the Reserved Ip Address will become free and the VM/VIP will get a dynamic public Ip Address from the Azure Inventory.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureReservedIPAssociation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Use VirtualIPName parameter to remove the association from a given virtual IP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use this flag to bypass warning messages when removing the Reserved IP association.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Force</maml:name> <maml:description> <maml:para>Use this flag to bypass warning messages when removing the Reserved IP association.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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>Profile</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para> </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>Production</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Use VirtualIPName parameter to remove the association from a given virtual IP.</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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Remove-AzureReservedIPAssociation -ReservedIPName resip14 -ServiceName piptestwesteurope </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>resip14 will be disassociated from service piptestwesteurope. piptestwesteurope will be assigned a new dynamic VIP.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>https://msdn.microsoft.com/en-us/library/azure/dn690120.aspx</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Add-AzureVirtualIP </command:name> <maml:description> <maml:para>Add a virtual IP to your Cloud Service. Add-AzureVirtualIP [-ServiceName] <string> [-VirtualIPName] <string> [-Profile <AzureProfile>] [<CommonParameters>] </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureVirtualIP</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>The Add-AzureVirtualIP cmdlet adds a new virtual IP (VIP) to your service. the new vitual IP has a name but is not allocated an IP address. The IP address is only allocated when you associate an endpoint to the VIP. See Add-AzureEndpoint for more details Your subscription will only be charged for extra VIPs once they are associated with an endpoint.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureVirtualIP</maml:name> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para>Not Specified</maml:para> <maml:para>The following values are permitted for this object type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>SilentlyContinue</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Stop</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Continue</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Inquire</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para>Not Specified</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="" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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="" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Enter the name of a cloud service. This parameter is required.</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="" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Enter the name of your virtual IP. This parameter is required.</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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Add-AzureVirtualIP -VirtualIPName "MyVip" -ServiceName "mySvc" <Output>OperationDescription OperationId OperationStatus -------------------- ----------- --------------- Add-AzureVirtualIP 4bd7b638-d2e7-216f-ba38-5221233d70ce Succeeded </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Add a virtual IP to your service</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Remove-AzureVirtualIP </command:name> <maml:description> <maml:para>Deletes a virtual IP from your Cloud Service. Remove-AzureVirtualIP [-ServiceName] <string> [-VirtualIPName] <string> [-Force] [-Profile <AzureProfile>] [<CommonParameters>] </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVirtualIP</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>The Remove-AzureVirtualIP cmdlet deletes a new virtual IP (VIP) to your Cloud Service. The operation succeeds only if the virtual IP has no endpoints associated to it.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVirtualIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SilentlyContinue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stop</command:parameterValue> <command:parameterValue required="false" variableLength="false">Continue</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inquire</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para> </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>InformationAction</maml:name> <maml:description> <maml:para>Not Specified</maml:para> <maml:para>The following values are permitted for this object type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>SilentlyContinue</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Stop</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Continue</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Inquire</dev:value> <maml:description> <maml:para> </maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para>Not Specified</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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>Profile</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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="2"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para> </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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Remove-AzureVirtualIP -VirtualIPName "MyVip" -ServiceName "mySvc" </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Remove a virtual IP from your Cloud Service</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureService</command:name> <maml:description> <maml:para>Creates a new Microsoft Azure service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureService</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureService cmdlet creates a new Microsoft Azure service in the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the new service. The name must be unique to the subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the affinity group associated with the subscription. An affinity group is required if the Location isn't specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the service. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the service. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReverseDnsFqdn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the new service. The name must be unique to the subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location for the service. A location is required if there isn't a specified Affinity Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the service. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the service. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReverseDnsFqdn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the new service. The name must be unique to the subscription.</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="true (ByPropertyName)" position="1"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the affinity group associated with the subscription. An affinity group is required if the Location isn't specified.</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="2"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the service. The label may be up to 100 characters in length.</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>Service name</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the service. The description may be up to 1024 characters in length.</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="true (ByPropertyName)" position="4"> <maml:name>ReverseDnsFqdn</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location for the service. A location is required if there isn't a specified Affinity Group.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>New-AzureService -ServiceName "MySvc1" -Label "MyTestService" -Location "South Central US"</dev:code> <dev:remarks> <maml:para>This command creates a new service named "MySvc1" in the South Central US location.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>New-AzureService -ServiceName "MySvc1" -AffinityGroup NorthRegion</dev:code> <dev:remarks> <maml:para>This command creates a new service named "MySvc1" using the NorthRegion affinity group.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureServiceADDomainExtensionConfig</command:name> <maml:description> <maml:para>This cmdlet generates the configuration for AD Domain extension for cloud services.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureServiceADDomainExtensionConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet generates the configuration for AD Domain extension for cloud services.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureServiceADDomainExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Options</maml:name> <maml:description> <maml:para>The unsigned integer join option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JoinOptions</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceADDomainExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>JoinOption</maml:name> <maml:description> <maml:para>The join option enumeration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceADDomainExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>WorkgroupName</maml:name> <maml:description> <maml:para>The workgroup name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceADDomainExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>WorkgroupName</maml:name> <maml:description> <maml:para>The workgroup name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceADDomainExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>JoinOption</maml:name> <maml:description> <maml:para>The join option enumeration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceADDomainExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Options</maml:name> <maml:description> <maml:para>The unsigned integer join option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JoinOptions</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="3"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain 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="true (ByPropertyName)" position="4"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</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="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Options</maml:name> <maml:description> <maml:para>The unsigned integer join option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JoinOptions</command:parameterValue> <dev:type> <maml:name>JoinOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</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="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="7"> <maml:name>JoinOption</maml:name> <maml:description> <maml:para>The join option enumeration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>WorkgroupName</maml:name> <maml:description> <maml:para>The workgroup 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="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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="true (ByValue, ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $extensionCfg = New-AzureServiceADDomainExtensionConfig -Role WorkerRole1 -DomainName $domain -Credential $cred -JoinOption 35; New-AzureDeployment -ServiceName $cloudSvc -Slot Production -Package $pkg -Configuration $config -ExtensionConfiguration $extensionCfg;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureServiceDiagnosticsExtensionConfig</command:name> <maml:description> <maml:para>This cmdlet generates configuration of diagnostics extension for specified role(s) or all roles.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureServiceDiagnosticsExtensionConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet generates configuration of diagnostics extension for specified role(s) or all roles.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureServiceDiagnosticsExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the diagnostics configuration for. If not specified the diagnostics configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceDiagnosticsExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the diagnostics configuration for. If not specified the diagnostics configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the diagnostics configuration for. If not specified the diagnostics configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="3"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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="3"> <maml:name>DiagnosticsConfiguration</maml:name> <maml:description> <maml:para>Configuration for Microsoft Azure diagnostics. The schema is: <?xml version="1.0" encoding="utf-8"?> <xs:schema id="DiagnosticsConfigSchema" targetNamespace="http://schemas.microsoft.com/ServiceHosting/2010/10/DiagnosticsConfiguration" elementFormDefault="qualified" xmlns="http://schemas.microsoft.com/ServiceHosting/2010/10/DiagnosticsConfiguration" xmlns:wad="http://schemas.microsoft.com/ServiceHosting/2010/10/DiagnosticsConfiguration" xmlns:mstns="http://tempuri.org/XMLSchema.xsd" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="PositiveDuration"> <xs:restriction base="xs:duration"> <xs:minInclusive value="PT0S" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="LogLevel"> <xs:restriction base="xs:string"> <xs:enumeration value="Undefined" /> <xs:enumeration value="Verbose" /> <xs:enumeration value="Information" /> <xs:enumeration value="Warning" /> <xs:enumeration value="Error" /> <xs:enumeration value="Critical" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="ContainerName"> <xs:restriction base="xs:string"> <xs:pattern value="[a-z0-9][a-z0-9\-]{1,61}[a-z0-9]" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="locale"> <xs:restriction base="xs:string"> </xs:restriction> </xs:simpleType> <xs:simpleType name="displayName"> <xs:restriction base="xs:string"> </xs:restriction> </xs:simpleType> <xs:simpleType name="AbsolutePathWithEnvironmentExpansion"> <xs:restriction base="xs:string"> <xs:pattern value="([a-zA-Z]:\)?([^&lt;&gt;:&quot;/|?*]+)*(\)?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="RelativePathWithEnvironmentExpansion"> <xs:restriction base="xs:string"> <xs:pattern value="([^&lt;&gt;:&quot;/\|?*]+)(\([^&lt;&gt;:&quot;/\|?*]+))*(\)?" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="PerformanceCounterPath"> <xs:restriction base="xs:string"> <xs:pattern value="\.*" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="EventNameType"> <xs:restriction base="xs:string"> <xs:pattern value="[a-zA-Z][_a-zA-Z0-9]{0,59}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="CrashDumpType" > <xs:restriction base="xs:string"> <xs:enumeration value="Mini"/> <xs:enumeration value="Full"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="NamedElementNameString"> <xs:restriction base="xs:string"> <xs:pattern value="^[a-zA-Z_][^\\/\:\*\?\&quot;\&lt;\&gt;\|]*(?&lt;![\.\s])$" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="format"> <xs:restriction base="xs:string"> <xs:enumeration value="Manifest" /> <xs:enumeration value="EventSource" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="directoryQuotaPercentage"> <xs:restriction base="xs:integer"> <xs:minInclusive value="0"/> <xs:maxInclusive value="100"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="guidType"> <xs:annotation> <xs:documentation> A GUID. Brackets (and only brakets) before and/or after are ignored. e.g. {12345678-1234-1234-1234-123456789abc}, {12345678-1234-1234-1234-123456789abc, 12345678-1234-1234-1234-123456789abc} and 12345678-1234-1234-1234-123456789abc are valid. </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:pattern value="^(\{){0,1}[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}(\}){0,1}$"/> </xs:restriction> </xs:simpleType> <xs:attributeGroup name="BasicConfiguration"> <xs:attribute name="scheduledTransferPeriod" type="PositiveDuration" use="optional" default="PT0S"> <xs:annotation> <xs:documentation> The interval between scheduled transfers for this data, rounded up to the nearest minute. </xs:documentation> </xs:annotation> </xs:attribute> </xs:attributeGroup> <xs:attributeGroup name="ETWConfiguration"> <xs:attribute name="scheduledTransferPeriod" type="PositiveDuration" use="optional" default="PT0S"> <xs:annotation> <xs:documentation> The interval between scheduled transfers for this data, rounded up to the nearest minute. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="scheduledTransferLogLevelFilter" type="LogLevel" use="optional" default="Undefined"> <xs:annotation> <xs:documentation> The minimum log severity to transfer. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="provider" type="xs:string" use="required"> <xs:annotation> <xs:documentation> The provider guid or class name for event source </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="scheduledTransferKeywordFilter" type="xs:unsignedLong" use="optional" default="0" > <xs:annotation> <xs:documentation> The keyword to filter by </xs:documentation> </xs:annotation> </xs:attribute> </xs:attributeGroup> <xs:attributeGroup name="LogLevel"> <xs:attribute name="scheduledTransferLogLevelFilter" type="LogLevel" use="optional" default="Undefined"> <xs:annotation> <xs:documentation> The minimum log severity to transfer. </xs:documentation> </xs:annotation> </xs:attribute> </xs:attributeGroup> <xs:attributeGroup name="DirectoryAttributes"> <xs:attribute name="containerName" type="wad:ContainerName" use="required"> <xs:annotation> <xs:documentation> The name of the container where the content of the directory is to be transferred. </xs:documentation> </xs:annotation> </xs:attribute> </xs:attributeGroup> <xs:attributeGroup name="CrashDumpConfiguration"> <xs:attribute name="directoryQuotaPercentage" type="directoryQuotaPercentage" use="optional" default="10"> <xs:annotation> <xs:documentation> The percentage of directory quota used by crashdumps </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="dumpType" type="CrashDumpType" use="optional" default="Mini"> <xs:annotation> <xs:documentation> The type of crashdump </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="containerName" type="wad:ContainerName" use="optional" default="wad-crashdumps"> <xs:annotation> <xs:documentation> The blob container to store the crashdumps </xs:documentation> </xs:annotation> </xs:attribute> </xs:attributeGroup> <xs:complexType name="LogsBase"> <xs:attributeGroup ref="BasicConfiguration" /> </xs:complexType> <xs:complexType name="EtwEventsBase"> <xs:attributeGroup ref="ETWConfiguration" /> </xs:complexType> <xs:complexType name ="CrashDumpsBase"> <xs:attributeGroup ref="CrashDumpConfiguration"/> </xs:complexType> <xs:complexType name="EtwManifestProviderConfiguration"> <xs:complexContent> <xs:extension base="EtwEventsBase"> <xs:sequence> <xs:element maxOccurs="unbounded" name="Event" minOccurs="0"> <xs:complexType> <xs:attribute name="id" type="xs:int" use="required"> <xs:annotation> <xs:documentation> The id of the ETW event that is to be collected </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="eventDestination" type="EventNameType" use="optional"> <xs:annotation> <xs:documentation> The name of the table in which the event data will be stored. If this attribute is not defined the table's name is 'Event'+'MD5 of the provider'+EventId#. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> <xs:element name="DefaultEvents" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:attribute name="eventDestination" type="EventNameType" use="optional"> <xs:annotation> <xs:documentation> The name of the table in which the event data will be stored. If this attribute is not defined the table's name is 'Default'+'MD5 of the provider'+EventId#. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="EtwEventSourceProviderConfiguration"> <xs:complexContent> <xs:extension base="EtwEventsBase"> <xs:sequence> <xs:element maxOccurs="unbounded" name="Event" minOccurs="0"> <xs:complexType> <xs:attribute name="id" type="xs:int" use="required"> <xs:annotation> <xs:documentation> The id of the ETW event that is to be collected </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="eventDestination" type="EventNameType" use="optional"> <xs:annotation> <xs:documentation> The name of the table in which the event data will be stored. If this attribute is not defined the table's name is 'Event'+'MD5 of the provider'+EventId#. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> <xs:element name="DefaultEvents" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:attribute name="eventDestination" type="EventNameType" use="optional"> <xs:annotation> <xs:documentation> The name of the table in which the event data will be stored. If this attribute is not defined the table's name is 'Default'+'MD5 of the provider'+EventId#. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="EtwProviders"> <xs:sequence maxOccurs="unbounded"> <xs:element name="EtwEventSourceProviderConfiguration" type="EtwEventSourceProviderConfiguration" minOccurs="0" > <xs:annotation> <xs:documentation> ETW collection by event source </xs:documentation> </xs:annotation> </xs:element> <xs:element name="EtwManifestProviderConfiguration" type="EtwManifestProviderConfiguration" minOccurs="0"> <xs:annotation> <xs:documentation> ETW collection by manifest </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="CrashDumpConfiguration"> <xs:attribute name="processName" type="xs:string" use="required"> <xs:annotation> <xs:documentation> The name of the process to to monitor for crashes. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="CrashDumps"> <xs:complexContent> <xs:extension base="CrashDumpsBase"> <xs:sequence maxOccurs="unbounded"> <xs:element name="CrashDumpConfiguration" type="CrashDumpConfiguration"> <xs:annotation> <xs:documentation> The crashdump to collect </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DiagnosticInfrastructureLogs"> <xs:complexContent> <xs:extension base="LogsBase"> <xs:attributeGroup ref="LogLevel" /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DirectoryBase" /> <xs:complexType name="DirectoryAbsolute"> <xs:complexContent> <xs:extension base="DirectoryBase"> <xs:attribute name="path" type="AbsolutePathWithEnvironmentExpansion" use="required"> <xs:annotation> <xs:documentation> The absolute path to the directory to monitor. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="expandEnvironment" type="xs:boolean" use="required"> <xs:annotation> <xs:documentation> If true, then environment variables in the path will be expanded. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DirectoryLocalResource"> <xs:complexContent> <xs:extension base="DirectoryBase"> <xs:attribute name="relativePath" type="RelativePathWithEnvironmentExpansion" use="required"> <xs:annotation> <xs:documentation> The path relative to the local resource to monitor. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="name" type="NamedElementNameString" use="required"> <xs:annotation> <xs:documentation> The local resource that contains the directory to monitor. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DirectoryConfiguration"> <xs:choice> <xs:element name="Absolute" type="DirectoryAbsolute"> <xs:annotation> <xs:documentation> The absolute path to the directory to monitor. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="LocalResource" type="DirectoryLocalResource"> <xs:annotation> <xs:documentation> The path relative to a local resource to monitor. </xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:attributeGroup ref="DirectoryAttributes" /> </xs:complexType> <xs:complexType name="SpecialLogDirectory"> <xs:attributeGroup ref="DirectoryAttributes" /> </xs:complexType> <xs:complexType name="DataSources"> <xs:sequence> <xs:element name="DirectoryConfiguration" type="DirectoryConfiguration" maxOccurs="unbounded"> <xs:annotation> <xs:documentation> The directory of log files to monitor. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="Directories"> <xs:complexContent> <xs:extension base="LogsBase"> <xs:all> <xs:element name="IISLogs" type="SpecialLogDirectory" minOccurs="0"> <xs:annotation> <xs:documentation> The IIS log directory. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="FailedRequestLogs" type="SpecialLogDirectory" minOccurs="0"> <xs:annotation> <xs:documentation> The failed request log directory. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="DataSources" type="DataSources" minOccurs="0"> <xs:annotation> <xs:documentation> Additional log directories. </xs:documentation> </xs:annotation> </xs:element> </xs:all> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="annotation"> <xs:attribute name="displayName" type="displayName" use="required"> <xs:annotation> <xs:documentation> The display name for the performance counter. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="locale" type="locale" use="optional" default="en-US"> <xs:annotation> <xs:documentation> The locale for the performance counter diplay name. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="PerformanceCounterConfiguration"> <xs:sequence minOccurs="0"> <xs:element maxOccurs="unbounded" name="annotation" type="annotation"> <xs:annotation> <xs:documentation> The display name and locale for the performance counter </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="counterSpecifier" type="PerformanceCounterPath" use="required"> <xs:annotation> <xs:documentation> The path to the performance counter to collect. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="sampleRate" type="PositiveDuration" use="required"> <xs:annotation> <xs:documentation> The rate at which the performance counter should be sampled. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="unit" type="xs:string" use="optional"> <xs:annotation> <xs:documentation> The unit for the performance counter for display purposes. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="PerformanceCounters"> <xs:complexContent> <xs:extension base="LogsBase"> <xs:sequence maxOccurs="unbounded"> <xs:element name="PerformanceCounterConfiguration" type="PerformanceCounterConfiguration"> <xs:annotation> <xs:documentation> The performance counter to collect. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DataSource"> <xs:attribute name="name" type="xs:string" use="required"> <xs:annotation> <xs:documentation> An XPath expression specifying the logs to collect. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:complexType name="WindowsEventLog"> <xs:complexContent> <xs:extension base="LogsBase"> <xs:sequence maxOccurs="unbounded"> <xs:element name="DataSource" type="DataSource"> <xs:annotation> <xs:documentation> The event log to monitor. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DiagnosticMonitorConfiguration"> <xs:all> <xs:element name="DiagnosticInfrastructureLogs" type="DiagnosticInfrastructureLogs" minOccurs="0"> <xs:annotation> <xs:documentation> Configures the logs generated by the underlying diagnostics infrastructure. The diagnostic infrastructure logs are useful for troubleshooting the diagnostics system itself. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="Directories" type="Directories" minOccurs="0"> <xs:annotation> <xs:documentation> Describes the configuration of a directory to which file-based logs are written. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="PerformanceCounters" type="PerformanceCounters" minOccurs="0"> <xs:annotation> <xs:documentation> Configures performance counter collection. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="WindowsEventLog" type="WindowsEventLog" minOccurs="0"> <xs:annotation> <xs:documentation> Configures Windows event log collection. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="EtwProviders" type="EtwProviders" minOccurs="0"> <xs:annotation> <xs:documentation> Configures ETW event collection. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="CrashDumps" type="CrashDumps" minOccurs="0"> <xs:annotation> <xs:documentation> Configures crashdump collection. </xs:documentation> </xs:annotation> </xs:element> </xs:all> <xs:attribute name="overallQuotaInMB" type="xs:unsignedInt" use="optional" default="5120"> <xs:annotation> <xs:documentation> The total amount of file system storage allocated for all logging buffers. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="useProxyServer" type="xs:boolean" use="optional" default="true"> <xs:annotation> <xs:documentation> Force the Monitoring Agent to use the specified IE proxy server if specified. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> <xs:element name="PublicConfig"> <xs:complexType> <xs:all> <xs:element name="WadCfg"> <xs:complexType> <xs:sequence> <xs:element name="DiagnosticMonitorConfiguration" type="DiagnosticMonitorConfiguration" minOccurs="1" maxOccurs="1" /> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="LocalResourceDirectory" minOccurs="0" maxOccurs="1" type="DirectoryAbsolute" /> <xs:element name="StorageAccount" minOccurs="0" maxOccurs="1" type="xs:string" /> </xs:all> </xs:complexType> </xs:element> </xs:schema></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">xmldocument</command:parameterValue> <dev:type> <maml:name>xmldocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account diagnostics will use to store diagnostics data such as performance counter data and file logs.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $wadConfig = New-AzureServiceDiagnosticExtensionConfig -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Creates an object that has the service extension object default for all roles that will be installed with the deployment and the role configuration.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $wadConfig = New-AzureServiceDiagnosticExtensionConfig -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML -Role "WebRole1"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Creates an object that has the service extension object for a specific role that will be installed with the deployment and the role configuration.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureServiceExtensionConfig</command:name> <maml:description> <maml:para>This cmdlet creates a cloud service extension configuration for a deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureServiceExtensionConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a cloud service extension configuration for a deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureServiceExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension's Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension's Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="3"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="4"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension's Provider Namespace.</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="true (ByPropertyName)" position="5"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</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="true (ByPropertyName)" position="6"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</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="true (ByPropertyName)" position="7"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureServiceExtensionConfig -ExtensionName 'RDP' -Version '1.0' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Create the Remote Desktop Extension configuration in version 1.0 for all roles in the cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureServiceExtensionConfig -Role WebRole1 -ExtensionName 'RDP' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Create the Remote Desktop Extension configuration for the 'WebRole1' role in the cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureServiceRemoteDesktopExtensionConfig</command:name> <maml:description> <maml:para>This cmdlets generates configuration of remote desktop extension for any deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureServiceRemoteDesktopExtensionConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlets generates configuration of remote desktop extension for any deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureServiceRemoteDesktopExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to enable for remote desktop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>A date time object that allows the user to specify when the user account will expire.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureServiceRemoteDesktopExtensionConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to enable for remote desktop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>A date time object that allows the user to specify when the user account will expire.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="1"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="3"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to enable for remote desktop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>A date time object that allows the user to specify when the user account will expire.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Version</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $rdpConfig = New-AzureServiceRemoteDesktopExtensionConfig -Credential $cred</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Creates an object that has the service extension object default for all roles that will be installed with the deployment and the role configuration.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $rdpConfig = New-AzureServiceRemoteDesktopExtensionConfig -Credential $cred -Role "WebRole1"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Creates an object that has the service extension object for a specific role that will be installed with the deployment and the role configuration.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureSSHKey</command:name> <maml:description> <maml:para>Creates a SSH Key object to insert an existing certificate into new Linux-based Microsoft Azure virtual machines.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSSHKey</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureSSHKey cmdlet creates an SSH Key object for a certificate that has already been added to Microsoft Azure. This SSH Key object can then be used by New-AzureProvisioningConfig when creating the configuration object for a new virtual machine using New-AzureVM, or when creating a new virtual machine with New-AzureQuickVM. When included as part of a virtual machine creation script, this adds the specified SSH Public Key or Key Pair to the new virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSSHKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyPair</maml:name> <maml:description> <maml:para>When specified, creates an object for inserting an SSH Key Pair into the new virtual machine configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Fingerprint</maml:name> <maml:description> <maml:para>Specifies the fingerprint of the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to store the SSH Public Key or Key Pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureSSHKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PublicKey</maml:name> <maml:description> <maml:para>When specified, creates an object for inserting an SSH Public Key into the new virtual machine configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Fingerprint</maml:name> <maml:description> <maml:para>Specifies the fingerprint of the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to store the SSH Public Key or Key Pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyPair</maml:name> <maml:description> <maml:para>When specified, creates an object for inserting an SSH Key Pair into the new virtual machine configuration.</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="1"> <maml:name>Fingerprint</maml:name> <maml:description> <maml:para>Specifies the fingerprint of the certificate.</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="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to store the SSH Public Key or Key Pair.</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>PublicKey</maml:name> <maml:description> <maml:para>When specified, creates an object for inserting an SSH Public Key into the new virtual machine configuration.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$myLxCert = New-AzureSSHKey –Fingerprint "D7BECD4D63EBAF86023BB4F1A5FBF5C2C924902A" –Path "/home/username/.ssh/authorized_keys"</dev:code> <dev:remarks> <maml:para>This command creates a certificate setting object for an existing certificate and then stores the object in a variable for later use.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Add-AzureCertificate –ServiceName "MySvc" –CertToDeploy "C:\temp\MyLxCert.cer" C:\PS>$myLxCert = New-AzureSSHKey –Fingerprint "D7BECD4D63EBAF86023BB4F1A5FBF5C2C924902A" –Path "/home/username/.ssh/authorized_keys" C:\PC>New-AzureVMConfig -Name "MyVM2" -InstanceSize Small -ImageName $LxImage ` | Add-AzureProvisioningConfig -Linux -LinuxUser $lxUser -SSHPublicKeys $myLxCert -Password 'pass@word1' ` | New-AzureVM -ServiceName "MySvc"</dev:code> <dev:remarks> <maml:para>This command adds a certificate to the Microsoft Azure service, and then creates a new Linux virtual machine that uses the certificate.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureProvisioningConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVMConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureQuickVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureStorageAccount</command:name> <maml:description> <maml:para>Creates a new storage account in a Microsoft Azure subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureStorageAccount</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureStorageAccount cmdlet creates an account that provides access to Microsoft Azure storage services. A storage account is a globally unique resource within the storage system. The account is the parent namespace for the Blob, Queue, and Table services.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureStorageAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies a name for the storage account. The storage account name must be unique to Microsoft Azure and must be between 3 and 24 characters in length and use lowercase letters and numbers only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the storage account. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the storage account. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the name of an existing affinity group in the current subscription. You can specify either a Location or an AffinityGroup parameter, but not both.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of the storage account. Valid values are Standard_LRS Standard_ZRS Standard_GRS Standard_RAGRS Premium_LRS If this parameter is not specified, a default value of Standard_GRS is used Note: Standard_ZRS or Premium_LRS accounts cannot be changed to other account types, and vice versa.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureStorageAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies a name for the storage account. The storage account name must be unique to Microsoft Azure and must be between 3 and 24 characters in length and use lowercase letters and numbers only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the storage account. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the storage account. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure data center location where the storage account is created. You can include either a Location or an AffinityGroup parameter, but not both.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of the storage account. Valid values are Standard_LRS Standard_ZRS Standard_GRS Standard_RAGRS Premium_LRS If this parameter is not specified, a default value of Standard_GRS is used Note: Standard_ZRS or Premium_LRS accounts cannot be changed to other account types, and vice versa.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies a name for the storage account. The storage account name must be unique to Microsoft Azure and must be between 3 and 24 characters in length and use lowercase letters and numbers only.</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="true (ByPropertyName)" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the storage account. The label may be up to 100 characters in length.</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="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the storage account. The description may be up to 1024 characters in length.</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="true (ByPropertyName)" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the name of an existing affinity group in the current subscription. You can specify either a Location or an AffinityGroup parameter, but not both.</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>Type</maml:name> <maml:description> <maml:para>Specifies the type of the storage account. Valid values are Standard_LRS Standard_ZRS Standard_GRS Standard_RAGRS Premium_LRS If this parameter is not specified, a default value of Standard_GRS is used Note: Standard_ZRS or Premium_LRS accounts cannot be changed to other account types, and vice versa.</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="true (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure data center location where the storage account is created. You can include either a Location or an AffinityGroup parameter, but not both.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureStorageAccount -StorageAccountName "azure1" -Label "AzureOne" -AffinityGroup "prodapps"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Creates a new storage account named "azure1" and assigns it to the "prodapps" affinity group.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureStorageAccount -StorageAccountName "azuretwo" -Label "AzureTwo" -Location "North Central US"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Creates a new storage account named "azuretwo" in the "North Central US" data center location.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureStorageKey</command:name> <maml:description> <maml:para>Regenerates storage keys for a Microsoft Azure storage account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureStorageKey</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureStorageKey cmdlet regenerates the primary or secondary key for a Microsoft Azure storage account. It returns an object with the storage account name, primary key, and secondary key as properties.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureStorageKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyType</maml:name> <maml:description> <maml:para>Specifies which key to regenerate. Supported values are "Primary" and "Secondary".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure storage account to regenerate a key for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyType</maml:name> <maml:description> <maml:para>Specifies which key to regenerate. Supported values are "Primary" and "Secondary".</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="true (ByPropertyName)" position="1"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure storage account to regenerate a key for.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StorageServiceKeys</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureStorageKey –KeyType "Primary" –StorageAccountName "mystore1"</dev:code> <dev:remarks> <maml:para>This command regenerate the primary storage key for the "mystore1" storage account.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $myStoreKey = New-AzureStorageKey –KeyType "Secondary" –StorageAccountName "mystore1"</dev:code> <dev:remarks> <maml:para>This command regenerate the secondary storage key for the "mystore1" storage account and stores the updated storage account key information in $myStoreKey.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureVM</command:name> <maml:description> <maml:para>Creates a new Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureVM cmdlet adds a new virtual machine to an existing Microsoft Azure service, or creates a new virtual machine and service in the current subscription if either the -Location or -AffinityGroup is specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the new or existing service name. If the service does not exist, this parameter will create it for you. Use the -Location or -AffinityGroup parameter to specify where to create the service. If the service exists, the -Location or -AffinityGroup parameter is not needed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeploymentLabel</maml:name> <maml:description> <maml:para>Specifies a label for the deployment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeploymentName</maml:name> <maml:description> <maml:para>Specifies a deployment name. If not specified, the service name will be used as the deployment name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the virtual network name where the new virtual machine will be deployed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DNS Server object that defines the DNS settings for the new deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DnsServer[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>InternalLoadBalancerConfig</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InternalLoadBalancerConfig</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VMs</maml:name> <maml:description> <maml:para>A list of virtual machine objects to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersistentVM[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForBoot</maml:name> <maml:description> <maml:para>Waits for VM to reach "ReadyRole" state. Cmdlet fails if VM falls in one of the following states while waiting: "FailedStartingVM", "ProvisioningFailed", "ProvisioningTimeout".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the new or existing service name. If the service does not exist, this parameter will create it for you. Use the -Location or -AffinityGroup parameter to specify where to create the service. If the service exists, the -Location or -AffinityGroup parameter is not needed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location where the new service will be hosted. This parameter should not be used if you are using a service that already exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure affinity group the cloud service will reside in. Only valid when creating a new cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceLabel</maml:name> <maml:description> <maml:para>Specifies a label for the new service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReverseDnsFqdn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceDescription</maml:name> <maml:description> <maml:para>Specifies a description for the new service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeploymentLabel</maml:name> <maml:description> <maml:para>Specifies a label for the deployment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeploymentName</maml:name> <maml:description> <maml:para>Specifies a deployment name. If not specified, the service name will be used as the deployment name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the virtual network name where the new virtual machine will be deployed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DNS Server object that defines the DNS settings for the new deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DnsServer[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>InternalLoadBalancerConfig</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InternalLoadBalancerConfig</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VMs</maml:name> <maml:description> <maml:para>A list of virtual machine objects to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersistentVM[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForBoot</maml:name> <maml:description> <maml:para>Waits for VM to reach "ReadyRole" state. Cmdlet fails if VM falls in one of the following states while waiting: "FailedStartingVM", "ProvisioningFailed", "ProvisioningTimeout".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the new or existing service name. If the service does not exist, this parameter will create it for you. Use the -Location or -AffinityGroup parameter to specify where to create the service. If the service exists, the -Location or -AffinityGroup parameter is not needed.</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="true (ByPropertyName)" position="named"> <maml:name>DeploymentLabel</maml:name> <maml:description> <maml:para>Specifies a label for the 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="true (ByPropertyName)" position="named"> <maml:name>DeploymentName</maml:name> <maml:description> <maml:para>Specifies a deployment name. If not specified, the service name will be used as the deployment 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>VNetName</maml:name> <maml:description> <maml:para>Specifies the virtual network name where the new virtual machine will be deployed.</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="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>DnsSettings</maml:name> <maml:description> <maml:para>Specifies a DNS Server object that defines the DNS settings for the new deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">DnsServer[]</command:parameterValue> <dev:type> <maml:name>DnsServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>InternalLoadBalancerConfig</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InternalLoadBalancerConfig</command:parameterValue> <dev:type> <maml:name>InternalLoadBalancerConfig</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VMs</maml:name> <maml:description> <maml:para>A list of virtual machine objects to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PersistentVM[]</command:parameterValue> <dev:type> <maml:name>PersistentVM[]</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>WaitForBoot</maml:name> <maml:description> <maml:para>Waits for VM to reach "ReadyRole" state. Cmdlet fails if VM falls in one of the following states while waiting: "FailedStartingVM", "ProvisioningFailed", "ProvisioningTimeout".</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="true (ByPropertyName)" position="named"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP 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="true (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location where the new service will be hosted. This parameter should not be used if you are using a service that already exists.</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="true (ByPropertyName)" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure affinity group the cloud service will reside in. Only valid when creating a new cloud service.</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="true (ByPropertyName)" position="named"> <maml:name>ServiceLabel</maml:name> <maml:description> <maml:para>Specifies a label for the new service.</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="true (ByPropertyName)" position="named"> <maml:name>ReverseDnsFqdn</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="named"> <maml:name>ServiceDescription</maml:name> <maml:description> <maml:para>Specifies a description for the new service.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyNewVM" -InstanceSize ExtraSmall -ImageName (Get-AzureVMImage)[4].ImageName ` | Add-AzureProvisioningConfig -Windows -Password $adminPassword -AdminUsername PsTestAdmin` | New-AzureVM -ServiceName "MySvc2" -AffinityGroup "Contoso" -WaitForBoot</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Microsoft Azure virtual machine, "MyNewVM", and a new Microsoft Azure service, "MySvc2". Optional WaitForBoot flag blocks New-AzureVM till the VM boots. Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MySUSEVM2" -InstanceSize ExtraSmall -ImageName (Get-AzureVMImage)[7].ImageName ` | Add-AzureProvisioningConfig -Linux -LinuxUser $lxUser -Password $adminPassword -AdminUsername PsTestAdmin` | New-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example adds a new Linux virtual machine to an existing service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $Images = Get-AzureVMImage $myImage = $Images[4] $myVM = New-AzureVMConfig -Name "MyVM2" -InstanceSize ExtraSmall -ImageName $myImage.ImageName ` | Add-AzureProvisioningConfig -Windows -Password $adminPassword ` | Add-AzureDataDisk -CreateNew -DiskSizeInGB 50 -DiskLabel "DataDisk50" -LUN 0</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example builds a new virtual machine configuration and then creates the virtual machine with New-AzureVM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "MyNewVM" -InstanceSize ExtraSmall -ImageName (Get-AzureVMImage)[4].ImageName ` | Add-AzureProvisioningConfig -Windows -Password $adminPassword -AdminUsername PsTestAdmin` | New-AzureVM -ServiceName "MySvc2" -AffinityGroup "Contoso" -ReservedIPName $ipName</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example creates a new Microsoft Azure virtual machine, "MyNewVM", and a new Microsoft Azure service, "MySvc2", using a reserved IP on the VM deployment</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> New-AzureVMConfig </command:name> <maml:description> <maml:para>Creates a new Windows Azure virtual machine configuration object.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureVMConfig</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>The New-AzureVMConfig cmdlet creates a new virtual machine configuration object. This object can then be used to perform a new deployment, as well as to add a new virtual machine to an existing deployment.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>New-AzureVMConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the instance. Allowed values are ExtraSmall, Small, Medium, Large, ExtraLarge, A5, A6, A7, A8, A9, Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host caching mode for the operating system disk. Supported values are: "ReadOnly" and "ReadWrite".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AvailabilitySetName</maml:name> <maml:description> <maml:para>Specifies the name of the availability set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label to assign to the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies a name for the operating system disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the Windows Azure storage location for the new virtual machine disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureVMConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the instance. Allowed values are ExtraSmall, Small, Medium, Large, ExtraLarge, A5, A6, A7, A8, A9, Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host caching mode for the operating system disk. Supported values are: "ReadOnly" and "ReadWrite".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AvailabilitySetName</maml:name> <maml:description> <maml:para>Specifies the name of the availability set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label to assign to the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine image to use for the operating system disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>DiskLabel</maml:name> <maml:description> <maml:para>Specifies a label for the operating system disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the Windows Azure storage location for the new virtual machine disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AvailabilitySetName</maml:name> <maml:description> <maml:para>Specifies the name of the availability 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="8"> <maml:name>DiskLabel</maml:name> <maml:description> <maml:para>Specifies a label for the operating system disk.</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="6"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies a name for the operating system disk.</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="3"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host caching mode for the operating system disk. Supported values are: "ReadOnly" and "ReadWrite".</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="6"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine image to use for the operating system disk.</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="true (ByPropertyName)" position="2"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the instance. Allowed values are ExtraSmall, Small, Medium, Large, ExtraLarge, A5, A6, A7, A8, A9, Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14.</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="true (ByPropertyName)" position="5"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label to assign to the 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MediaLocation</maml:name> <maml:description> <maml:para>Specifies the Windows Azure storage location for the new virtual machine disk.</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="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> Description </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> Description </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureVMImageDiskConfigSet</command:name> <maml:description> <maml:para>This cmdlet returns a new object for disk configuration set, which would be passed to the image update cmdlet. It encapsulates the OSDiskConfig and the DataDiskConfig object. Use the Set-AzureVMImageOSDiskConfig and Set-AzureVMImageDataDiskConfig cmdlets to set the OS Disk and Data Disk properties for the VM Image.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureVMImageDiskConfigSet</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet returns a new object for disk configuration set, which would be passed to the image update cmdlet. It encapsulates the OSDiskConfig and the DataDiskConfig object. Use the Set-AzureVMImageOSDiskConfig and Set-AzureVMImageDataDiskConfig cmdlets to set the OS Disk and Data Disk properties for the VM Image.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureVMImageDiskConfigSet</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $s = New-AzureDiskConfigSet # returns DiskConfigSet object; $s = Set-AzureOSDiskConfig -DiskConfig $s -HostCaching ReadWrite # returns DiskConfigSet object; $s = Set-AzureDataDiskConfig -DiskConfig $s -Name 'test' -HostCaching 'ReadWrite' -LUN 0 # returns DiskConfigSet object # Final step - Update the VM Image Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1 -DiskConfigSet $s; # OR $s | Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureVNetGateway</command:name> <maml:description> <maml:para>Creates a new Microsoft Azure Virtual Network Gateway to the specified Microsoft Azure virtual network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureVNetGateway</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureVNetGateway cmdlet creates a new virtual network gateway for the specified Microsoft Azure virtual network. A virtual network gateway is a VPN endpoint for connecting to a Microsoft Azure virtual network.After the virtual network gateway has been created, you can get the shared key to allow you to configure the VPN device at the local network site to authenticate to the gateway with the Get-AzureVNetGatewayKey cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureVNetGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual network for which the gateway is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GatewayType</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GatewayType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual network for which the gateway is created.</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="1"> <maml:name>GatewayType</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GatewayType</command:parameterValue> <dev:type> <maml:name>GatewayType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>New-AzureVNetGateway –VNetName "MyProdNet"</dev:code> <dev:remarks> <maml:para>This command creates a new VPN endpoint for the "MyProdNet" network.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Publish-AzureVMDscConfiguration </command:name> <maml:description> <maml:para>Uploads a Desired State Configuration script to Azure blob storage, which later can be applied to Azure Virtual Machines using the Set-AzureVMDscExtension cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>AzureVMDscConfiguration</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Uploads a Desired State Configuration script to Azure blob storage, which later can be applied to Azure Virtual Machines using the Set-AzureVMDscExtension cmdlet.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Publish-AzureVMDscConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ConfigurationPath</maml:name> <maml:description> <maml:para>Path to a file containing one or more configurations. The file can be a PowerShell script (.ps1 file), module (.psm1 file), or an archive (.zip file) containing a set of PowerShell modules, each module in a separate directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalPath</maml:name> <maml:description> <maml:para>Path to a file or a directory to include in the configuration archive</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConfigurationArchivePath</maml:name> <maml:description> <maml:para>Path to a local ZIP file to write the configuration archive to. When this parameter is used, the configuration script is not uploaded to Azure blob storage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConfigurationDataPath</maml:name> <maml:description> <maml:para>Path to a .psd1 file that specifies the data for the Configuration</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>By default Publish-AzureVMDscConfiguration will not overwrite any existing blobs or files. Use -Force to overwrite them.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipDependencyDetection</maml:name> <maml:description> <maml:para>Excludes DSC resource dependencies from the configuration archive</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Outputs the blob url for configuration archive path</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-ASMVMDscConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>ConfigurationPath</maml:name> <maml:description> <maml:para>Path to a file containing one or more configurations. The file can be a PowerShell script (.ps1 file), module (.psm1 file), or an archive (.zip file) containing a set of PowerShell modules, each module in a separate directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalPath</maml:name> <maml:description> <maml:para>Path to a file or a directory to include in the configuration archive</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">string[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConfigurationDataPath</maml:name> <maml:description> <maml:para>Path to a .psd1 file that specifies the data for the Configuration</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ContainerName</maml:name> <maml:description> <maml:para>Name of the Azure Storage Container the configuration is uploaded to. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>By default Publish-AzureVMDscConfiguration will not overwrite any existing blobs or files. Use -Force to overwrite them.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipDependencyDetection</maml:name> <maml:description> <maml:para>Excludes DSC resource dependencies from the configuration archive</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>The Azure Storage Context that provides the security settings used to upload the configuration script to the container specified by ContainerName. This context should provide write access to the container. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageEndpointSuffix</maml:name> <maml:description> <maml:para>Suffix for the storage end point, e.g. core.windows.net</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Outputs the blob url for configuration archive path</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalPath</maml:name> <maml:description> <maml:para>Path to a file or a directory to include in the configuration archive</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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>ConfigurationArchivePath</maml:name> <maml:description> <maml:para>Path to a local ZIP file to write the configuration archive to. When this parameter is used, the configuration script is not uploaded to Azure blob storage.</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>ConfigurationDataPath</maml:name> <maml:description> <maml:para>Path to a .psd1 file that specifies the data for the Configuration</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="true (ByValue, ByPropertyName)" position="1"> <maml:name>ConfigurationPath</maml:name> <maml:description> <maml:para>Path to a file containing one or more configurations. The file can be a PowerShell script (.ps1 file), module (.psm1 file), or an archive (.zip file) containing a set of PowerShell modules, each module in a separate directory.</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="true (ByPropertyName)" position="named"> <maml:name>ContainerName</maml:name> <maml:description> <maml:para>Name of the Azure Storage Container the configuration is uploaded to. </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>windows-powershell-dsc</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>By default Publish-AzureVMDscConfiguration will not overwrite any existing blobs or files. Use -Force to overwrite them.</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>SkipDependencyDetection</maml:name> <maml:description> <maml:para>Excludes DSC resource dependencies from the configuration archive.</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="true (ByPropertyName)" position="named"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>The Azure Storage Context that provides the security settings used to upload the configuration script to the container specified by ContainerName. This context should provide write access to the container. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageEndpointSuffix</maml:name> <maml:description> <maml:para>Suffix for the storage end point, e.g. core.windows.net</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</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 /> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</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 /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Outputs the blob url for configuration archive path</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:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Publish-AzureVMDscConfiguration .\MyConfiguration.ps1 </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This command creates a ZIP package for the given script and any dependent resource modules and uploads it to Azure Storage. By default the command does no produce any output; use the -Verbose option to display an indication of the operations performed by the command</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Publish-AzureVMDscConfiguration .\MyConfiguration.ps1 -ConfigurationArchivePath .\MyConfiguration.ps1.zip </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This command creates a ZIP package for the given script and any dependent resource modules and stores it in the local file .\MyConfiguration.ps1.zip.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Publish-AzureVMDscConfiguration -ConfigurationPath 'C:\Sample.ps1 -SkipDependencyDetection </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Use -SkipDependencyDetection to skip adding modules to the configuration archive</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Publish-AzureVMDscConfiguration -ConfigurationPath C:\Sample.ps1 -ConfigurationDataPath 'C:\SampleData.psd1' </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Adding configuration data to the archive</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Publish-AzureVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -AdditionalPath @("C:\ContentDir1", "C:\File.txt") -ConfigurationDataPath "C:\SampleData.psd1" </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Adding additional content (files or directories) used by the configuration</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureAclConfig</command:name> <maml:description> <maml:para>Remove the ACL configuration object from an existing Azure VM configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureAclConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureAclConfig cmdlet removes the ACL configuration object from an existing Azure VM configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureAclConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object for which the endpoint will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object for which the endpoint will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS> $acl = Get-AzureVM -ServiceName "myservice" -Name "MyVM" | Remove-AzureAclConfig -EndpointName "Web" | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command will remove the ACL configuration from "MyVM".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureAffinityGroup</command:name> <maml:description> <maml:para>Deletes an affinity group in the specified subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureAffinityGroup</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureAffinityGroup cmdlet deletes an affinity group in the subscription. You can't delete an affinity group that has any members. You must first delete all the members of an affinity group and then use Remove-AzureAffinityGroup to delete the affinity group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureAffinityGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the affinity group to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the affinity group to delete.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureAffinityGroup -name "South1"</dev:code> <dev:remarks> <maml:para>This command deletes the 'South1' affinity group in the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureAvailabilitySet</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureAvailabilitySet</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureAvailabilitySet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureCertificate</command:name> <maml:description> <maml:para>Deletes the specified certificate from the Microsoft Azure service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureCertificate</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service with which the certificate is associated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Specifies the algorithm used to create the certificate thumbprint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Specifies the thumbprint that identifies the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service with which the certificate is associated.</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="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Specifies the algorithm used to create the certificate thumbprint.</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="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>Specifies the thumbprint that identifies the certificate.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureCertificate -ServiceName "MyService" -Thumbprint '5383CE0343CB6563281CA97C1B5D712209CFFA97'</dev:code> <dev:remarks> <maml:para>This command removes the certificate object identified by the specified thumbprint from the specified cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-Certificate -ServiceName "MyService" | Remove-AzureCertificate</dev:code> <dev:remarks> <maml:para>This command removes all certificates from the specified cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-Certificate –ServiceName "MyService" -ThumbprintAlgorithm "sha1" ` | Remove-AzureCertificate</dev:code> <dev:remarks> <maml:para>This command removes all certificates that use the "sha1" thumbprint algorithm from the specified cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureCertificate</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureDataDisk</command:name> <maml:description> <maml:para>Removes a data disk from a virtual machine object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDataDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureDataDisk cmdlet detaches a data disk from a virtual machine. The data disk blob is not removed from the storage account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureDataDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Specifies the slot where the data disk to be detached is currently mounted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>Specify to remove the data disk and the underlying disk blob.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the slot where the data disk to be detached is currently mounted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Specifies the slot where the data disk to be detached is currently mounted.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>Specify to remove the data disk and the underlying disk blob.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the slot where the data disk to be detached is currently mounted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName MyDemoService01 -Name MyDemoVM01 | Remove-AzureDataDisk -LUN 0</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command gets the virtual machine object with the name "MyDemoVM01" running on the "MyDemoService01" cloud service, and then detaches the data disk at LUN 0 from virtual machine object.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName MyDemoService01 -Name MyDemoVM01 | Remove-AzureDataDisk -LUN 0 -DeleteVHD | Update-AzureVM This command gets the virtual machine object with the name "MyDemoVM01" running on the "MyDemoService01" cloud service, then detaches the data disk at LUN 0 from virtual machine object. It also updates the VM in the cloud and then delete the underlying VHD(s).</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureDataDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureDataDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureDeployment</command:name> <maml:description> <maml:para>Deletes the specified deployment of a Microsoft Azure service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDeployment</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureDeployment cmdlet deletes the specified deployment of a Microsoft Azure cloud service. The deployment should be in the suspended state.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the service whose deployment will be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the deployment environment from which the deployment of the specified Microsoft Azure service will be deleted. Choices are Staging or Production. If no slot is specified, the production environment is assumed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>Specify to remove the deployment and the underlying disk blob(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the service whose deployment will be deleted.</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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the deployment environment from which the deployment of the specified Microsoft Azure service will be deleted. Choices are Staging or Production. If no slot is specified, the production environment is assumed.</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="2"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>Specify to remove the deployment and the underlying disk blob(s).</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="3"> <maml:name>Force</maml:name> <maml:description> <maml:para> </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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureDeployment -ServiceName "myservice"</dev:code> <dev:remarks> <maml:para>This command removes the deployment of the Microsoft Azure service "myservice" from the production environment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureDeployment -ServiceName "myservice" -DeleteVHD</dev:code> <dev:remarks> <maml:para>This command removes the deployment of the Microsoft Azure service "myservice" from the production environment, and the underlying VHD(s).</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureDisk</command:name> <maml:description> <maml:para>Removes a disk from the Microsoft Azure disk repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureDisk cmdlet removes a disk from the Microsoft Azure disk repository in the current subscription. By default, this does not delete the associated physical VHD file from the blob storage location. To delete the associated physical VHD, specify the DeleteVHD parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the data disk in the disk repository to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>Removes the underlying VHD from blob storage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Name of the data disk in the disk repository to remove.</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>DeleteVHD</maml:name> <maml:description> <maml:para>Removes the underlying VHD from blob storage.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureDisk -DiskName "MyDataDisk"</dev:code> <dev:remarks> <maml:para>This example removes the "MyDataDisk" disk from the disk repository but does not remove the VHD from Microsoft Azure storage.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureDisk -DiskName "MyDataDisk" –DeleteVHD</dev:code> <dev:remarks> <maml:para>This example removes the "MyDataDisk" disk from the disk repository and also removes the VHD from Microsoft Azure storage.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureDns</command:name> <maml:description> <maml:para>Removes a DNS server to an existing cloud service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDns</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureDns cmdlet removes the specified DNS server from a cloud service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureDns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS server to be removed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS server 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="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service</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="2"> <maml:name>Force</maml:name> <maml:description> <maml:para> </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>PipelineVariable</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureDns -ServiceName "myservice" -Name "mydns"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command removes the DNS server "mydns" from the specified cloud service</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureEndpoint</command:name> <maml:description> <maml:para>Deletes an endpoint from a Microsoft Azure virtual machine object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureEndpoint</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureEndpoint cmdlet deletes an endpoint from a specified virtual machine object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint to be deleted from the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which the endpoint will be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint to be deleted from the 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object from which the endpoint will be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM –ServiceName "MyService" –Name “MyVM” | Remove-AzureEndpoint –Name "HttpIn" | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command deletes the endpoint "HttpIn" from the "MyVM" virtual machine.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureInternalLoadBalancer</command:name> <maml:description> <maml:para>Remove-AzureInternalLoadBalancer [-ServiceName] <string> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureInternalLoadBalancer</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureInternalLoadbalancer cmdlet removes the internal load balancer configuration from a deployment, if there are endpoints still referring to the internal load balancer the remove operation will fail</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureInternalLoadBalancer -ServiceName "ILBInVNet"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removes the Internal load balancer configuration from the deployment.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzurePublicIP</command:name> <maml:description> <maml:para>Remove-AzurePublicIP [[-PublicIPName] <string>] -VM <IPersistentVM> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzurePublicIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Removed Public IP configuration from the virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzurePublicIP</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PublicIPName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PublicIPName</maml:name> <maml:description> <maml:para> </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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.IPersistentVM</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName FTPInAzure -Name FTPInstance | Remove-AzurePublicIP | Update-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removes the public ip configuration from the virtual machine.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureReservedIP</command:name> <maml:description> <maml:para>Remove the Reserved IP by its name.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureReservedIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Remove the reserved IP by its name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureReservedIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReservedIPName</maml:name> <maml:description> <maml:para>Reserved IP 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="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Not Specified</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureReservedIP -ReservedIPName $name</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Deletes the Reserved IP from the Subscription by name</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureServiceADDomainExtension</command:name> <maml:description> <maml:para>This cmdlet removes the cloud service AD domain extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureServiceADDomainExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the cloud service AD domain extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all AD Domain configurations from the cloud service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="2"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all AD Domain configurations from the cloud service.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceADDomainExtension -ServiceName $svc</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removing the configured AD domain extension from all roles of a cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceADDomainExtension -ServiceName $svc -Role "WebRole1"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removing the configured AD domain extension from the role 'WebRole1' of a cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureServiceAntimalwareExtension</command:name> <maml:description> <maml:para>Removes the antimalware configuration from a cloud service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureServiceAntimalwareExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureServiceAntimalwareExtension cmdlet removes the antimalware configuration and any associated antimalware monitoring from the Microsoft Antimalware extension associated with a cloud service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureServiceAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies an array of roles. The default value is all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>EndpointSuffix</maml:name> <maml:description> <maml:para>Specifies the storage endpoint suffix.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureServiceAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>EndpointSuffix</maml:name> <maml:description> <maml:para>Specifies the storage endpoint suffix.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</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="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies an array of roles. The default value is all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>EndpointSuffix</maml:name> <maml:description> <maml:para>Specifies the storage endpoint suffix.</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> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>This cmdlet removes only the configuration associated with the specified role. It does not uninstall or remove any already running instances of the Microsoft Antimalware extension from roles. To return these roles to a start state that does not have Microsoft Antimalware running, first remove the configuration by using this cmdlet, and then reimage or redeploy the service.</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove the extension --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureServiceAntimalwareExtension -ServiceName "ContosoService03"</dev:code> <dev:remarks> <maml:para>This command removes the antimalware extension and monitoring of associated antimalware events from the service named ContosoService03.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Remove the extension for the Staging slot --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureServiceAntimalwareExtension -ServiceName "ContosoService03" -Slot "Staging"</dev:code> <dev:remarks> <maml:para>This command removes the antimalware extension and monitoring of associated antimalware events from all roles in the staging slot of the service named ContosoService03.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Remove the extension for a specified slot and role --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureServiceAntimalwareExtension -ServiceName "ContosoService03" -Slot "Production" -Role "web role"</dev:code> <dev:remarks> <maml:para>This command removes the antimalware extension and monitoring of associated antimalware events from the service named ContosoService03 in the specified slot and role.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=402841</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureServiceDiagnosticsExtension</command:name> <maml:description> <maml:para>This cmdlet removes the cloud service diagnostics extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureServiceDiagnosticsExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the cloud service diagnostics extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureServiceDiagnosticsExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureServiceDiagnosticsExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all RDP configurations from the cloud service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="2"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all RDP configurations from the cloud service.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceDiagnosticsExtension -ServiceName $svc</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removing the configured diagnostics extension from all roles of a cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceDiagnosticsExtension -ServiceName $svc -Role "WebRole1"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removing the configured diagnostics extension from the role 'WebRole1' of a cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureServiceExtension</command:name> <maml:description> <maml:para>This cmdlet removes given cloud service extensions that are applied on a deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureServiceExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes given cloud service extensions that are applied on a deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureServiceExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the extension for. If not specified the extension is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureServiceExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all configurations from the cloud service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the extension for. If not specified the extension is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="3"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension 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="true (ByPropertyName)" position="4"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension Provider Namespace.</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="4"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all configurations from the cloud service.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceExtension -ServiceName $svc -Slot Production -ExtensionName RDP -ProviderNamespace Microsoft.Windows.Azure.Extensions</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Remove the existing RDP extension applied on all roles.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceExtension -ServiceName $svc -Slot Production -ExtensionName RDP -ProviderNamespace Microsoft.Windows.Azure.Extensions -UninstallConfiguration</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Remove the existing RDP extension applied on all roles, and uninstall it from the cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureServiceRemoteDesktopExtension</command:name> <maml:description> <maml:para>This cmdlet removes the cloud service remote desktop extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureServiceRemoteDesktopExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the cloud service remote desktop extension applied on all roles or named roles at a certain deployment slot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureServiceRemoteDesktopExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureServiceRemoteDesktopExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all RDP configurations from the cloud service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="2"> <maml:name>UninstallConfiguration</maml:name> <maml:description> <maml:para>If specified uninstall all RDP configurations from the cloud service.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceRemoteDesktopExtension -ServiceName $svc</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removing the configured remote desktop extension from all roles of a cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureServiceRemoteDesktopExtension -ServiceName $svc -Role "WebRole1"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Removing the configured remote desktop extension from the role 'WebRole1' of a cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureStaticVNetIP</command:name> <maml:description> <maml:para>Remove the static VNet IP address information from a VM object, if any.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureStaticVNetIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Remove the static VNet IP address information from a VM object, if any.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureStaticVNetIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureStorageAccount</command:name> <maml:description> <maml:para>Deletes the specified storage account from a subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureStorageAccount</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureStorageAccount cmdlet removes an account from a Microsoft Azure subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureStorageAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The name of the storage account 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureStorageAccount -StorageAccountName "mystore1"</dev:code> <dev:remarks> <maml:para>This command removes the "mystore1" storage account from the specified subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureStorageAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVM</command:name> <maml:description> <maml:para>Removes a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureVM cmdlet deletes a Microsoft Azure virtual machine. This process doesn’t delete the underlying .vhd files of the disks mounted on that virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine being removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>Specify to remove the VM and the underlying disk blob(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name from which the virtual machine is being removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine being 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="2"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>Specify to remove the VM and the underlying disk blob(s).</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="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name from which the virtual machine is being 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureVM -ServiceName "MySvc1" -Name "MyVM"</dev:code> <dev:remarks> <maml:para>This command removes the "MyVM" virtual machine running in the "MySvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVM -ServiceName "MySvc1" -Name "MyVM" -DeleteVHD</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command removes the "MyVM" virtual machine running in the "MySvc1" service, and the underlying VHD(s).</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureVMConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMAccessExtension</command:name> <maml:description> <maml:para>This cmdlet removes the VMAcess extension (if any) applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMAccessExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the VMAcess extension (if any) applied on the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMAccessExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVMAccessExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This cmdlet removes the VMAcess extension (if any) applied on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMBGInfoExtension</command:name> <maml:description> <maml:para>This cmdlet removes the BGInfo extension (if any) applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMBGInfoExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the BGInfo extension (if any) applied on the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMBGInfoExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVMBGInfoExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This cmdlet removes the BGInfo extension (if any) applied on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMCustomScriptExtension</command:name> <maml:description> <maml:para>Remove Azure VM Custom Script Extension from a VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMCustomScriptExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Remove Azure VM Custom Script Extension from a VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMCustomScriptExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVMCustomScriptExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Remove Azure VM Custom Script Extension from a VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMDiagnosticsExtension</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMDiagnosticsExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMDiagnosticsExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name> Remove-AzureVMDscExtension </command:name> <maml:description> <maml:para>Removes DSC extension handler from a given virtual machine(s) in a cloud service. Output of this cmdlet needs to be piped to Update-AzureVM cmdlet. To get detailed output -Verbose flag need to be specified. </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMDscExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Removes DSC extension handler from a given virtual machine(s) in a cloud service. Output of this cmdlet needs to be piped to Update-AzureVM cmdlet. To get detailed output -Verbose flag need to be specified.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMDscExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</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>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</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>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</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:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> - <maml:description> - <maml:para></maml:para> - </maml:description> - </dev:type> <maml:description> </maml:description> - </command:returnValue> - </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVMDscExtension -VM $vm | Update-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Remove Azure VM DSC Extension from a VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMExtension</command:name> <maml:description> <maml:para>This cmdlet removes resource extensions from VMs.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes resource extensions from VMs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureVMExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureVMExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Specify to remove all extensions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension 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="true (ByPropertyName)" position="2"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension Publisher.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference 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="true (ByPropertyName)" position="1"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Specify to remove all extensions.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $vm = Remove-AzureVMExtension -VM $vm -ExtensionName $ext -Publisher $pub;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Remove a given extension with the name and publisher</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $vm = Remove-AzureVMExtension -VM $vm -RemoveAll;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Remove all extensions.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMImage</command:name> <maml:description> <maml:para>Removes an OS or VM image from the Image Repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMImage</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Removes an OS or VM image from the Image Repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the OS or VM image to remove from the image repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>When specified, the physical VHD image blob is deleted from the storage account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Specifies the OS or VM image to remove from the image repository.</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="1"> <maml:name>DeleteVHD</maml:name> <maml:description> <maml:para>When specified, the physical VHD image blob is deleted from the storage account.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVMImage -ImageName MyOSImage</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command removes the "MyOSImage" image from the image repository.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVMImage -ImageName MyOSImage -DeleteVHD</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command removes the "MyOSImage" image from the image repository and also deletes the physical VHD image from the storage account.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $subsId = &amp;lt;MySubscriptionID&amp;gt; $cert = Get-AzureCertificate cert:\LocalMachine\MY\&amp;lt;CertificateThumbprint&amp;gt; Get-AzureVMImage ` | Where-Object {$_.Label -match "Beta" }` | Foreach-Object {Remove-AzureVMImage -ImageName $_.name }</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command sets the subscription context and then removes all the images from the image repository whose Label includes "Beta".</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureVMImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVMImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVMImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMImageDataDiskConfig</command:name> <maml:description> <maml:para>This cmdlet removes the Data Disk Config from the DiskConfigSet object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMImageDataDiskConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMImageDataDiskConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>DataDiskName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureVMImageDataDiskConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Lun</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> <dev:type> <maml:name>VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>DataDiskName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>Lun</maml:name> <maml:description> <maml:para> </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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $s = New-AzureDiskConfigSet # returns DiskConfigSet object; $s = Set-AzureDataDiskConfig -DiskConfig $s -HostCaching ReadWrite # returns DiskConfigSet object; Remove-AzureVMImageDataDiskConfig -DiskConfig $s # removes the Data DiskConfig object from the DiskConfigSet object</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMImageOSDiskConfig</command:name> <maml:description> <maml:para>This cmdlet removes the OS Disk Config from the DiskConfigSet object</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMImageOSDiskConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMImageOSDiskConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>The disk config object that encapsulates the OS Disk and Data Disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>The disk config object that encapsulates the OS Disk and Data Disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> <dev:type> <maml:name>VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $s = New-AzureDiskConfigSet # returns DiskConfigSet object; $s = Set-AzureOSDiskConfig -DiskConfig $s -HostCaching ReadWrite # returns DiskConfigSet object; Remove-AzureVMImageOSDiskConfig -DiskConfig $s # removes the OS DiskConfig object from the DiskConfigSet object</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMMicrosoftAntimalwareExtension</command:name> <maml:description> <maml:para>Removes the Microsoft Antimalware extension from a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMMicrosoftAntimalwareExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureVMMicrosoftAntimalwareExtension cmdlet removes the Microsoft Antimalware extension from a virtual machine. If monitoring was turned on, this cmdlet also removes the collection of Microsoft Antimalware events.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMMicrosoftAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para>To avoid interfering with monitoring for other applications or services, this cmdlet removes only the collection of Microsoft Antimalware events. It does not change other application configurations or the default monitoring configuration.</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove the extension --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureVM -ServiceName "ContosoService03" -Name "ContosoVM22" | Remove-AzureVMMicrosoftAntimalwareExtension | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command removes the Microsoft Antimalware extension. The command uses the Get-AzureVM cmdlet to get the specified virtual machine object, and then passes the object to the current cmdlet by using the pipeline operator. Remove-AzureVMMicrosoftAntimalwareExtension removes the extension. The command passes the result to the Update-AzureVM cmdlet to update the virtual machine.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=402842</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVMMicrosoftAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureVMMicrosoftAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVMPuppetExtension</command:name> <maml:description> <maml:para>This cmdlet removes the Puppet extension (if any) applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMPuppetExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the Puppet extension (if any) applied on the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMPuppetExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Remove-AzureVMPuppetExtension -VM $vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This cmdlet removes the Puppet extension (if any) applied on the VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVNetConfig</command:name> <maml:description> <maml:para>Deletes the network configuration from the current Microsoft Azure subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVNetConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureVNetConfig cmdlet removes all virtual network settings from the current Microsoft Azure subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVNetConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureVNetConfig</dev:code> <dev:remarks> <maml:para>This command removes the virtual network configuration from the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVNetSite</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureVNetGateway</command:name> <maml:description> <maml:para>Removes the Microsoft Azure virtual network gateway to the specified virtual network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVNetGateway</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureVNetGateway cmdlet removes the virtual network gateway to the specified Microsoft Azure virtual network. A virtual network gateway is a VPN endpoint for connecting to a virtual network. If you remove the virtual network gateway, the underlying virtual network is unaffected and still in place, allowing you to create a new gateway with New-VNetGateway. However, the shared key for the gateway will be different, requiring reconfiguration of the VPN device at the local network site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVNetGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual network to remove the gateway from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the virtual network to remove the gateway from.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Remove-AzureVNetGateway –VNetName "MyProdNet"</dev:code> <dev:remarks> <maml:para>This command removes the virtual network gateway (VPN endpoint) from the "MyProdNet" virtual network.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Reset-AzureRoleInstance</command:name> <maml:description> <maml:para>Requests a reboot or reimage of a single role instance or all role instances of a specific role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>AzureRoleInstance</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The ReSet-AzureRoleInstance cmdlet requests a reboot or a reimage of a role instance that is running in a deployment. This operation executes synchronously. When you reboot a role instance, Microsoft Azure takes the instance offline, restarts the underlying operating system for that instance, and brings the instance back online. Any data that is written to the local disk persists across reboots. Any data that is in-memory is lost. Reimaging a role instance results in different behavior depending on the type of role. For a web or worker role, when the role is reimaged, Microsoft Azure takes the role offline and writes a fresh installation of the Microsoft Azure guest operating system to the virtual machine. The role is then brought back online. For a VM role, when the role is reimaged, Microsoft Azure takes the role offline, reapplies the custom image that you provided for it, and brings the role back online. Microsoft Azure attempts to maintain data in any local storage resources when the role is reimaged; however, in case of a transient hardware failure, the local storage resource may be lost. If your application requires that data persist, writing to a durable data source, such as a Microsoft Azure drive, is recommended. Any data that is written to a local directory other than that defined by the local storage resource will be lost when the role is reimaged.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-AzureRoleInstance</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment environment where the role instances are running. Supported values are "Production" and "Staging". You can include either a DeploymentName or Slot parameter, but not both.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>InstanceName</maml:name> <maml:description> <maml:para>Specifies the name of the role instance to reimage or reboot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Reboot</maml:name> <maml:description> <maml:para>If this parameter is specified, reboots the specified role instance or, if none is specified, all role instances. You must include either a Reboot or Reimage parameter, but not both.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Reimage</maml:name> <maml:description> <maml:para>If this parameter is specified, reimages the specified role instance or, if none is specified, all role instances. You must include either a Reboot or Reimage parameter, but not both.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the service.</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="true (ByPropertyName)" position="named"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment environment where the role instances are running. Supported values are "Production" and "Staging". You can include either a DeploymentName or Slot parameter, but not both.</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="true (ByPropertyName)" position="named"> <maml:name>InstanceName</maml:name> <maml:description> <maml:para>Specifies the name of the role instance to reimage or reboot.</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="true (ByPropertyName)" position="named"> <maml:name>Reboot</maml:name> <maml:description> <maml:para>If this parameter is specified, reboots the specified role instance or, if none is specified, all role instances. You must include either a Reboot or Reimage parameter, but not both.</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="true (ByPropertyName)" position="named"> <maml:name>Reimage</maml:name> <maml:description> <maml:para>If this parameter is specified, reimages the specified role instance or, if none is specified, all role instances. You must include either a Reboot or Reimage parameter, but not both.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>ReSet-AzureRoleInstance -ServiceName "MySvc1" -Slot Staging -InstanceName "MyWebRole_IN_0" –reboot</dev:code> <dev:remarks> <maml:para>This command reboots the "MyWebRole_IN_0" role instance in the staging deployment of the "MySvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>ReSet-AzureRoleInstance -ServiceName "MySvc1" -Slot Staging –Reimage</dev:code> <dev:remarks> <maml:para>This command reimages the role instances in the staging deployment of the MyTodo cloud service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>ReSet-AzureRoleInstance -ServiceName "MySvc1" -Slot "Production –Reimage</dev:code> <dev:remarks> <maml:para>This command reimages all role instances in the production deployment of the "MySvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Restart-AzureVM</command:name> <maml:description> <maml:para>Restarts a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Restart-AzureVM cmdlet requests a reboot of a virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restart-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to restart.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to restart.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Restart-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>A virtual machine object that identifies the virtual machine to restart.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to restart.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to restart.</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="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to restart.</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="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>A virtual machine object that identifies the virtual machine to restart.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> <dev:type> <maml:name>PersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Restart-AzureVM -ServiceName "myservice1" –Name "MyVM"</dev:code> <dev:remarks> <maml:para>This command restarts the "MyVM" virtual machine running in the "myservice1" Microsoft Azure service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName "myservice1" -Name "MyVM" | Restart-AzureVM</dev:code> <dev:remarks> <maml:para>This command retrieves the virtual machine object for the virtual machine whose name is "MyVM" and then restarts it.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Save-AzureVhd</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>AzureVhd</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Save-AzureVhd cmdlet allows to download VHD images stored in a blob in to a file. It has parameters to configure the download process such as specifying the number of downloader threads that will be used or overwriting the file which already exists in the specified file path. Save-AzureVhd doesn't do any VHD format conversion and the blob is downloaded as it is.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AzureVhd</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Source</maml:name> <maml:description> <maml:para>Uri to the blob in Microsoft Azure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalFilePath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NumberOfThreads</maml:name> <maml:description> <maml:para>Determines the number of download threads that will be used during download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StorageKey</maml:name> <maml:description> <maml:para>Storage key of the blob storage account. If it is not provided, Save-AzureVhd tries to determine the storage key of the account in Source Uri from Microsoft Azure Cloud.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>OverWrite</maml:name> <maml:description> <maml:para>Determines to delete the file specified by LocalFilePath file if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Source</maml:name> <maml:description> <maml:para>Uri to the blob in Microsoft Azure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalFilePath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NumberOfThreads</maml:name> <maml:description> <maml:para>Determines the number of download threads that will be used during download.</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>8</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StorageKey</maml:name> <maml:description> <maml:para>Storage key of the blob storage account. If it is not provided, Save-AzureVhd tries to determine the storage key of the account in Source Uri from Microsoft Azure Cloud.</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="true (ByPropertyName)" position="5"> <maml:name>OverWrite</maml:name> <maml:description> <maml:para>Determines to delete the file specified by LocalFilePath file if it 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Save-AzureVhd -Source http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd -LocalFilePath C:\vhd\MyWin7Image.vhd</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Downloads the specified blob to the specified local file path.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Save-AzureVhd -Source http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd -LocalFilePath C:\vhd\MyWin7Image.vhd -Overwrite</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Overwrite options tells to delete if local file exists.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Save-AzureVhd -Source http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd -LocalFilePath C:\vhd\MyWin7Image.vhd -NumberOfThreads 32</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------NumberOfThreads allows to override the default number of threads, which is 8, used to download.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Save-AzureVhd -Source http://mytestaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd -LocalFilePath C:\vhd\MyWin7Image.vhd -StorageKey zNvcH0r5vAGmC5AbwEtpcyWCMyBd3eMDbdaa4ua6kwxq6vTZH3Y+sw==</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------If storage key is specified, Save-AzureVhd doesn't attempt to get the storage key from Microsoft Azure Cloud and uses the provided the key in download.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Save-AzureVMImage</command:name> <maml:description> <maml:para>Save OS or VM images from existing VMs. For capturing a VM Image, use the -OSState parameter.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>AzureVMImage</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Save OS or VM images from existing VMs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AzureVMImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The Service Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The VM Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ImageLabel</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>OSState</maml:name> <maml:description> <maml:para>The OS State for VM Image only: 'Generalized' or 'Specialized'. The use of this parameter indicates your intent to capture VM Image to Azure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The Service 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="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The VM 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="true (ByPropertyName)" position="2"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Not Specified</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="true (ByPropertyName)" position="3"> <maml:name>ImageLabel</maml:name> <maml:description> <maml:para>Not Specified</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="true (ByPropertyName)" position="4"> <maml:name>OSState</maml:name> <maml:description> <maml:para>The OS State for VM Image only: 'Generalized' or 'Specialized'. The use of this parameter indicates your intent to capture VM Image to 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureAclConfig</command:name> <maml:description> <maml:para>Sets the ACL configuration object on an existing Azure VM configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureAclConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureAclConfig cmdlet sets the ACL configuration object from an existing Azure VM configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureAclConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddRule</maml:name> <maml:description> <maml:para>Indicates that a rule should be added.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Action</maml:name> <maml:description> <maml:para>Specifies this rules action. Must be either Permit or Deny.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoteSubnet</maml:name> <maml:description> <maml:para>Specifies the remote subnet for this rule. Must be a valid CIDR Address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Order</maml:name> <maml:description> <maml:para>Specifies the processing order for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>The ACL configuration object to add this rule to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureAclConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveRule</maml:name> <maml:description> <maml:para>Indicates that a rule should be removed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the rule ID to remove from the given ACL configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>The ACL configuration object to add this rule to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureAclConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetRule</maml:name> <maml:description> <maml:para>Indicates that a rule should be changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>RuleId</maml:name> <maml:description> <maml:para>Specifies the rule ID to remove from the given ACL configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Action</maml:name> <maml:description> <maml:para>Specifies this rules action. Must be either Permit or Deny.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoteSubnet</maml:name> <maml:description> <maml:para>Specifies the remote subnet for this rule. Must be a valid CIDR Address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Order</maml:name> <maml:description> <maml:para>Specifies the processing order for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for this rule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>The ACL configuration object to add this rule to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddRule</maml:name> <maml:description> <maml:para>Indicates that a rule should be added.</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>Action</maml:name> <maml:description> <maml:para>Specifies this rules action. Must be either Permit or Deny.</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="1"> <maml:name>RemoteSubnet</maml:name> <maml:description> <maml:para>Specifies the remote subnet for this rule. Must be a valid CIDR Address.</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="2"> <maml:name>Order</maml:name> <maml:description> <maml:para>Specifies the processing order for this rule.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description for this rule.</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="true (ByValue)" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>The ACL configuration object to add this rule to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> <dev:type> <maml:name>NetworkAclObject</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>RemoveRule</maml:name> <maml:description> <maml:para>Indicates that a rule 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>RuleId</maml:name> <maml:description> <maml:para>Specifies the rule ID to remove from the given ACL configuration.</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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetRule</maml:name> <maml:description> <maml:para>Indicates that a rule should be changed.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS> $acl = New-AzureAclConfig C:\PS> Set-AzureAclConfig -AddRule -ACL $acl Permit 172.0.0.0/8 100 "Rule Description"</dev:code> <dev:remarks> <maml:para>This command will create a new ACL configuration and add a new rule to the configuration.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS> $acl = Get-AzureVM -ServiceName "MyService" -Name "MyVM" | Get-AzureAclConfig -EndpointName "Web" C:\PS> Set-AzureAclConfig –SetRule -ID 0 -ACL $acl -Order 102 -Description "New Description" C:\PS> Get-AzureVM -ServiceName "MyService" -Name "MyVM" | Set-AzureEndpoint -ACL $acl -Name "Web" | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command will get the ACL Configuration of the endpoint "Web" on "MyVM" and set the Order of the first ACL rule to 102, and change it's description, then update the VM.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS> $acl = Get-AzureVM -ServiceName "MyService" -Name "MyVM" | Get-AzureAclConfig -EndpointName "Web" C:\PS> Set-AzureAclConfig –RemoveRule -ID 0 -ACL $acl C:\PS> Get-AzureVM -ServiceName "MyService" -Name "MyVM" | Set-AzureEndpoint -ACL $acl -Name "Web" | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command will get the ACL Configuration of the endpoint "Web" on "MyVM" and remove the first ACL rule, then update the VM.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAclConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureAffinityGroup</command:name> <maml:description> <maml:para>Updates the properties of a Microsoft Azure affinity group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureAffinityGroup</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureAffinityGroup cmdlet updates properties of the specified affinity group. The properties that can be changed are the Label and the Description.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureAffinityGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the affinity group to change the properties of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the affinity group. The label can be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the affinity group. The description can be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the affinity group to change the properties of.</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>Label</maml:name> <maml:description> <maml:para>Specifies a label for the affinity group. The label can be up to 100 characters in length.</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>Description</maml:name> <maml:description> <maml:para>Specifies the description of the affinity group. The description can be up to 1024 characters in length.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Set-AzureAffinityGroup -Name "MyGroup1" -Label "SouthUSProduction" -Description "Production applications for Southern US locations"</dev:code> <dev:remarks> <maml:para>This command sets the label of the affinity group MyGroup1 to "SouthUSProduction" and sets the description to "Production applications for Southern US locations"</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAffinityGroup</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureAvailabilitySet</command:name> <maml:description> <maml:para>Sets the availability set name of an Azure VM after deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureAvailabilitySet</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureAvailabilitySet cmdlet sets the availability set name of an Azure VM after deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureAvailabilitySet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>AvailabilitySetName</maml:name> <maml:description> <maml:para>Name of the availability set on the virtual machine</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>An Azure VM configuration to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>AvailabilitySetName</maml:name> <maml:description> <maml:para>Name of the availability set on the 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>An Azure VM configuration to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName "MyAzureCS" -Name "MyVM" | Set-AzureAvailabilitySetName "MyASet" | Update-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Adds the VM to an availability set "MyAset"</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureDataDisk</command:name> <maml:description> <maml:para>Sets the host-cache mode on an existing data disk object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureDataDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureDataDisk cmdlet updates the cache attributes of an existing data disk object on a Microsoft Azure virtual machine. The possible host caching values are: None, ReadOnly, and ReadWrite. You can specify which data disk to update by specifying its logical unit number (LUN).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureDataDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Sets the host level caching settings of the disk. Possible values are: None, ReadOnly and ReadWrite.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Numerical value that defines the slot where the data drive is mounted in the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The virtual machine where the data disk is mounted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureDataDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the DataDiskConfiguration being referenced to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ResizedSizeInGB</maml:name> <maml:description> <maml:para>Resize the new data disk to a larger size.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The virtual machine where the data disk is mounted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>The Name of the DataDiskConfiguration being referenced to.</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>HostCaching</maml:name> <maml:description> <maml:para>Sets the host level caching settings of the disk. Possible values are: None, ReadOnly and ReadWrite.</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="1"> <maml:name>LUN</maml:name> <maml:description> <maml:para>Numerical value that defines the slot where the data drive is mounted in the virtual machine.</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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ResizedSizeInGB</maml:name> <maml:description> <maml:para>Resize the new data disk to a larger size.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The virtual machine where the data disk is mounted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM "myservice" ` | Set-AzureDataDisk -VM "MyVM" -LUN 2 -HostCaching ReadOnly | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command gets the virtual machines running on the "myservice" cloud service, and then sets the data disk at LUN 2 of the "MyVM" virtual machine to use ReadOnly host caching.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM "myservice" -Name "MyVM" ` | Get-AzureDataDisk ` | Set-AzureDataDisk -HostCaching ReadWrite ' | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command gets an object representing the "MyVM" virtual machine running on the "myservice" cloud service, gets an object or objects representing all the data disks on the virtual machine, and then sets the host caching mode of those data disks to ReadWrite.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureDataDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureDeployment</command:name> <maml:description> <maml:para>Sets status, upgrade mode, and configuration settings of a Microsoft Azure deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureDeployment</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureDeployment cmdlet sets the status, configuration settings, or upgrade mode of a Microsoft Azure deployment. With the -Status parameter, you can change the status of the deployment to either "Running" or "Suspended". With the -Config parameter, you can update the .cscfg file, and with the -Upgrade parameter, you set the upgrade mode and update configuration files. Use the Set-AzureWalkUpgradeDomain cmdlet to actually initiate the upgrade.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Upgrade</maml:name> <maml:description> <maml:para>When specified, requests an upgrade to the Microsoft Azure deployment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Package</maml:name> <maml:description> <maml:para>Specifies the full path to the upgrade package (.cspkg) file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the path to the new configuration (.cscfg) file when performing an upgrade or configuration change.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Specifies the mode of upgrade. Supported values are: "Auto", "Manual", and "Simultaneous".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a new label for the upgraded deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of the role to upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Force</maml:name> <maml:description> <maml:para>When specified, sets the upgrade to a forced upgrade.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>ExtensionConfiguration</maml:name> <maml:description> <maml:para>When specified, requests an upgrade to the Microsoft Azure deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ExtensionConfigurationInput[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Config</maml:name> <maml:description> <maml:para>When specified, modifies the .cscfg file for the deployment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the path to the new configuration (.cscfg) file when performing an upgrade or configuration change.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>ExtensionConfiguration</maml:name> <maml:description> <maml:para>When specified, requests an upgrade to the Microsoft Azure deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ExtensionConfigurationInput[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureDeployment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Status</maml:name> <maml:description> <maml:para>When specified, requests a status change for the Microsoft Azure deployment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NewStatus</maml:name> <maml:description> <maml:para>Specifies the target status for the deployment. Supported values are "Running" or "Suspended".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Upgrade</maml:name> <maml:description> <maml:para>When specified, requests an upgrade to the Microsoft Azure deployment.</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="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="2"> <maml:name>Package</maml:name> <maml:description> <maml:para>Specifies the full path to the upgrade package (.cspkg) file.</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="3"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the path to the new configuration (.cscfg) file when performing an upgrade or configuration change.</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="true (ByPropertyName)" position="4"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="5"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Specifies the mode of upgrade. Supported values are: "Auto", "Manual", and "Simultaneous".</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="6"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a new label for the upgraded 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="7"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of the role to upgrade.</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="8"> <maml:name>Force</maml:name> <maml:description> <maml:para>When specified, sets the upgrade to a forced upgrade.</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>ExtensionConfiguration</maml:name> <maml:description> <maml:para>When specified, requests an upgrade to the Microsoft Azure deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ExtensionConfigurationInput[]</command:parameterValue> <dev:type> <maml:name>ExtensionConfigurationInput[]</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>Config</maml:name> <maml:description> <maml:para>When specified, modifies the .cscfg file for the deployment.</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>Status</maml:name> <maml:description> <maml:para>When specified, requests a status change for the Microsoft Azure deployment.</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="3"> <maml:name>NewStatus</maml:name> <maml:description> <maml:para>Specifies the target status for the deployment. Supported values are "Running" or "Suspended".</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureDeployment -Status -ServiceName "MySvc1" -Slot "Production" -NewStatus "Running"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command sets the status of the deployment in the production environment to Running.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureDeployment -Config -ServiceName "MySvc1" -Slot "Staging" -Configuration "C:\Temp\MyServiceConfig.Cloud.csfg"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command updates the deployment in the staging environment with a new configuration file.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureDeployment -Upgrade -ServiceName "MySvc1" -Mode Auto -Package "C:\Temp\MyApp.cspkg" -Configuration "C:\Temp\MyServiceConfig.Cloud.csfg"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command sets the upgrade mode to Auto and specifies an upgrade package and a new configuration file.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureDeployment –ServiceName –Mode Automatic $svc -Package $pkg -Configuration $cnfg -Slot Production -ExtensionConfiguration $wadConfig</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example installs the extension configuration in the specified Cloud Service and applies them on roles.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDeployment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureDns</command:name> <maml:description> <maml:para>Updates the IP Address of the specified DNS server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureDns</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureDns cmdlets updates the IP Address of the specified DNS server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureDns</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS server to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Specifies the IP address of the DNS server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS server to be updated</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="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Specifies the IP address of the DNS server</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="2"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service</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>PipelineVariable</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureDns -ServiceName "myservice" -IPAddress 10.1.2.5 -Name "mydns"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command updates the IP Address of the DNS server "mydns"</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Set-AzureEndpoint </command:name> <maml:description> <maml:para>The Set-AzureInputEndpoint cmdlet updates an existing endpoint assigned to a virtual machine. You can specify updates to an endpoint that is not load balanced, which only a single virtual machine uses.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureEndpoint</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Specifies the protocol of the endpoint. Acceptable values are "tcp" or "udp".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LocalPort</maml:name> <maml:description> <maml:para>Specifies the local (private) port that will be used for the endpoint. Applications within the virtual machine listen to this port to service input requests over the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object for which the endpoint will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>An ACL to apply to the endpoint on update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DirectServerReturn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para>TCP Idle timeout in minutes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancerDistribution</maml:name> <maml:description> <maml:para> Load Balancer distribution algorithm The value can be sourceIP: 2 tuple affinity (Source IP, Destination IP) sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol) none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol). This is the default value </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublicPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>The VirtualIPName parameter allows you to associate a virtual IP to your endpoint. Your Cloud Service can have multiple virtual IPs. virtual IPs can be created with the add-azureVirtualIP cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>An ACL to apply to the endpoint on update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> <dev:type> <maml:name>NetworkAclObject</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>DirectServerReturn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</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>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para>TCP Idle timeout in minutes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>InternalLoadBalancerName</maml:name> <maml:description> <maml:para>Not Specified</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>LoadBalancerDistribution</maml:name> <maml:description> <maml:para> Load Balancer distribution algorithm The value can be sourceIP: 2 tuple affinity (Source IP, Destination IP) sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol) none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol). This 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LocalPort</maml:name> <maml:description> <maml:para>Specifies the local (private) port that will be used for the endpoint. Applications within the virtual machine listen to this port to service input requests over the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the endpoint.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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="2"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Specifies the protocol of the endpoint. Acceptable values are "tcp" or "udp".</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>PublicPort</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</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>VirtualIPName</maml:name> <maml:description> <maml:para>The VirtualIPName parameter allows you to associate a virtual IP to your endpoint. Your Cloud Service can have multiple virtual IPs. virtual IPs can be created with the add-azureVirtualIP cmdlet.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object for which the endpoint will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName "MyService" -Name "MyVM" | Set-AzureEndpoint -Name "Web" -PublicPort 443 -LocalPort 443 -Protocol "tcp" | Update-AzureVM </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This command updates the input endpoint named "Web" assigned to the virtual machine "MyVM" to listen on Port 443</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureInternalLoadBalancer</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureInternalLoadBalancer</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>StaticVNetIPAddress</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureInternalLoadBalancer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="2"> <maml:name>SubnetName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="3"> <maml:name>StaticVNetIPAddress</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Set-AzureLoadBalancedEndpoint </command:name> <maml:description> <maml:para>Updates all of the endpoints in a given load balancer set within a Windows Azure Service.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureLoadBalancedEndpoint</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>The Set-AzureLoadBalancedEndpoint cmdlet updates all of the endpoints in a given load balancer set within a Windows Azure Service.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureLoadBalancedEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Windows Azure service containing the endpoint that will be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LBSetName</maml:name> <maml:description> <maml:para>Specifies the name of the load balancer set to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbePath</maml:name> <maml:description> <maml:para>Specifies relative path to the HTTP Probe.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbeProtocolHTTP</maml:name> <maml:description> <maml:para>Specifies that a HTTP Probe should be used.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbeProtocolTCP</maml:name> <maml:description> <maml:para>Specifies that a TCP Probe should be used.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>An ACL to apply to the endpoint on update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DirectServerReturn</maml:name> <maml:description> <maml:para>Enable/Disable Direct Server Return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para>TCP Idle timeout in minutes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InternalLoadBalancerName</maml:name> <maml:description> <maml:para>The Internal Load Balancer Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancerDistribution</maml:name> <maml:description> <maml:para> Load Balancer distribution algorithm The value can be sourceIP: 2 tuple affinity (Source IP, Destination IP) sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol) none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol). This is the default value </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalPort</maml:name> <maml:description> <maml:para>Specifies the local (private) port that will be used for the endpoint. Applications within the virtual machine listen to this port to service input requests over the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbeIntervalInSeconds</maml:name> <maml:description> <maml:para>Specifies the probe polling interval in seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbePort</maml:name> <maml:description> <maml:para>Specifies the port that the load balancer probe will use. If not specified, Windows Azure will assign the endpoints local port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProbeTimeoutInSeconds</maml:name> <maml:description> <maml:para>Specifies the probe polling timeout in seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Specifies the protocol of the endpoint. Acceptable values are "TCP" or "UDP".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublicPort</maml:name> <maml:description> <maml:para>Specifies the public port that the endpoint will use. If not specified, Windows Azure will assign an available free port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VirtualIPName</maml:name> <maml:description> <maml:para>Use this parameter to update your load balancer to use a specific VIP. See Add-AzureVirtualIP to add VIPs to your Cloud Service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACL</maml:name> <maml:description> <maml:para>An ACL to apply to the endpoint on update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NetworkAclObject</command:parameterValue> <dev:type> <maml:name>NetworkAclObject</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>DirectServerReturn</maml:name> <maml:description> <maml:para>Enable/Disable Direct Server Return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para>TCP Idle timeout in minutes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>InternalLoadBalancerName</maml:name> <maml:description> <maml:para>The Internal Load Balancer 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>LBSetName</maml:name> <maml:description> <maml:para>Specifies the name of the load balancer set to update.</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>LoadBalancerDistribution</maml:name> <maml:description> <maml:para> Load Balancer distribution algorithm The value can be sourceIP: 2 tuple affinity (Source IP, Destination IP) sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol) none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol). This 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LocalPort</maml:name> <maml:description> <maml:para>Specifies the local (private) port that will be used for the endpoint. Applications within the virtual machine listen to this port to service input requests over the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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>ProbeIntervalInSeconds</maml:name> <maml:description> <maml:para>Specifies the probe polling interval in seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>ProbePath</maml:name> <maml:description> <maml:para>Specifies relative path to the HTTP Probe.</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>ProbePort</maml:name> <maml:description> <maml:para>Specifies the port that the load balancer probe will use. If not specified, Windows Azure will assign the endpoints local port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>ProbeProtocolHTTP</maml:name> <maml:description> <maml:para>Specifies that a HTTP Probe should be used.</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="named"> <maml:name>ProbeProtocolTCP</maml:name> <maml:description> <maml:para>Specifies that a TCP Probe should be used.</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>ProbeTimeoutInSeconds</maml:name> <maml:description> <maml:para>Specifies the probe polling timeout in seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>Protocol</maml:name> <maml:description> <maml:para>Specifies the protocol of the endpoint. Acceptable values are "TCP" or "UDP".</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>PublicPort</maml:name> <maml:description> <maml:para>Specifies the public port that the endpoint will use. If not specified, Windows Azure will assign an available free port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Windows Azure service containing the endpoint that will be modified.</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>VirtualIPName</maml:name> <maml:description> <maml:para>Use this parameter to update your load balancer to use a specific VIP. See Add-AzureVirtualIP to add VIPs to your Cloud Service.</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> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Set-AzureLoadBalancedEndpoint -ServiceName "MyService" -LBSetName "LBSet1" -Protocol tcp -LocalPort 80 -ProbeProtocolTCP -ProbePort 8080 </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This command will update all endpoints in the load balancer set "LBSet1" to use the TCP protocol and private port 80, and will set the load balancer probe to use the TCP protocol on port 8080.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Set-AzureLoadBalancedEndpoint -ServiceName myService -LBSetName myLBSet -VirtualIPName Vip1 </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>You can update your load balancer to use a different VIP. For instance, if you run this command, you will change the load balancing set to use a VIP named Vip1</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureOSDisk</command:name> <maml:description> <maml:para>Updates the host-cache mode of a Microsoft Azure virtual machine operating system disk.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureOSDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureOSDisk cmdlet updates the host-cache mode of a virtual machine's operating system disk. The supported host cache modes are "ReadOnly" and "ReadWrite".Caution: Running Set-AzureOSDisk on a running virtual machine will cause the virtual machine to reboot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureOSDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host cache attribute for the operating system disk. Acceptable values are: "ReadOnly" and "ReadWrite".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine for which to update the operating system disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ResizedSizeInGB</maml:name> <maml:description> <maml:para>Resize the new OSVirtualHardDisk to a larger size. ResizedSizeInGB must be larger than the underlying OS Image's LogicalSizeInGB. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para>Specifies the host cache attribute for the operating system disk. Acceptable values are: "ReadOnly" and "ReadWrite".</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine for which to update the operating system disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ResizedSizeInGB</maml:name> <maml:description> <maml:para>Resize the new OSVirtualHardDisk to a larger size. ResizedSizeInGB must be larger than the underlying OS Image's LogicalSizeInGB. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName $mySvc1 -name "MyTestVM2" | Set-AzureOSDisk –HostCaching "ReadOnly"</dev:code> <dev:remarks> <maml:para>This command sets the host cache mode of the operating system disk of the VM named "MyTestVM2" to ReadOnly.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$myVM2 = Get-AzureVM -ServiceName $mySvc1 -name "MyTestVM2" C:\PS>Set-AzureOSDisk "ReadWrite" –VM $myVM2</dev:code> <dev:remarks> <maml:para>This command updates the host-cache mode of the operating system disk attached to the VM named "MyTestVM2" to ReadWrite.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureOSDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureVMImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVMImage</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzurePublicIP</command:name> <maml:description> <maml:para>Set-AzurePublicIP [-PublicIPName] <string> [[-IdleTimeoutInMinutes] <int>] [[-DomainNameLabel] <string>] -VM <IPersistentVM> [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzurePublicIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Adds a new Public IP to the virtual machine. The public ip is really assigned when the virtual machine is updated. An optional DomainNameLabel will automatically create a corresponding DNS entry for the public IP.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzurePublicIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PublicIPName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para>TCP Idle timeout in minutes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DomainNameLabel</maml:name> <maml:description> <maml:para>The name to use when creating a corresponding DNS entry for a public IP address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PublicIPName</maml:name> <maml:description> <maml:para> </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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IdleTimeoutInMinutes</maml:name> <maml:description> <maml:para>TCP Idle timeout in minutes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DomainNameLabel</maml:name> <maml:description> <maml:para> </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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.IPersistentVM</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName FTPInAzure -Name FTPInstance | Set-AzurePublicIP -PublicIPName ftpip | Update-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Requests for a public IP to be assigned to the virtual machine. The public ip allocation happens during update VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "FTPInstance" -InstanceSize Small -ImageName $images[50].ImageName | Add-AzureProvisioningConfig -Windows -AdminUsername xyz -Password abcd123! | Set-AzurePublicIP -PublicIPName "ftpip" | New-AzureVM -ServiceName "FTPinAzure" -Location "North Central US"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Requests for a public IP to be assigned during VM creation.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName FTPInAzure -Name FTPInstance | Set-AzurePublicIP -PublicIPName ftpip -DomainNameLabel ipname | Update-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Requests for a public IP to be assigned to the virtual machine. The public ip allocation happens during update VM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> New-AzureVMConfig -Name "FTPInstance" -InstanceSize Small -ImageName $images[50].ImageName | Add-AzureProvisioningConfig -Windows -AdminUsername xyz -Password abcd123! | Set-AzurePublicIP -PublicIPName "ftpip" -DomainNameLabel ipname | New-AzureVM -ServiceName "FTPinAzure" -Location "North Central US"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Requests for a public IP to be assigned during VM creation and for the public IP address to be created with a corresponding DNS entry.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRole</command:name> <maml:description> <maml:para>Sets the number of instances of a Microsoft Azure role to run.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRole</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureRole cmdlet sets the number of instances of a specified role to run in a Microsoft Azure deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the deployment environment of the deployment to be modified. Choices are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of the role to set the number of instances for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of role instances to run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service.</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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the deployment environment of the deployment to be modified. Choices are "Production" or "Staging".</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="true (ByPropertyName)" position="2"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>Specifies the name of the role to set the number of instances for.</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="3"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of role instances to run.</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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Set-AzureRole –ServiceName "MySvc1" –Slot "Production" –RoleName "MyTestRole3" –Count 3</dev:code> <dev:remarks> <maml:para>This command sets the "MyTestRole3" role running in production on the "MySvc1" service to three instances.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureService</command:name> <maml:description> <maml:para>Sets or updates the label and description of the specified Microsoft Azure service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureService</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureService cmdlet assigns a label and description to a service in the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Label</maml:name> <maml:description> <maml:para>Sets a label for the Microsoft Azure service. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Sets a description for the Microsoft Azure service. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ReverseDnsFqdn</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service to be updated.</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="true (ByPropertyName)" position="1"> <maml:name>Label</maml:name> <maml:description> <maml:para>Sets a label for the Microsoft Azure service. The label may be up to 100 characters in length.</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="true (ByPropertyName)" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Sets a description for the Microsoft Azure service. The description may be up to 1024 characters in length.</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="true (ByPropertyName)" position="3"> <maml:name>ReverseDnsFqdn</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Set-AzureService -ServiceName "MySvc1" -Label "MyTestSvc1" -Description "My service for testing out new configurations"</dev:code> <dev:remarks> <maml:para>This command sets the label to "MyTestSvc1" and the description to "My service for testing out new configurations" for the "MyTestSvc1" service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureService</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureServiceADDomainExtension</command:name> <maml:description> <maml:para>Set AD Domain Extension for Cloud Service</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceADDomainExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Set AD Domain Extension for Cloud Service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Options</maml:name> <maml:description> <maml:para>The unsigned integer join option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JoinOptions</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>JoinOption</maml:name> <maml:description> <maml:para>The join option enumeration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>WorkgroupName</maml:name> <maml:description> <maml:para>The workgroup name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>WorkgroupName</maml:name> <maml:description> <maml:para>The workgroup name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>JoinOption</maml:name> <maml:description> <maml:para>The join option enumeration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceADDomainExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Options</maml:name> <maml:description> <maml:para>The unsigned integer join option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JoinOptions</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The cloud service 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="5"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The AD domain 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="true (ByPropertyName)" position="6"> <maml:name>Restart</maml:name> <maml:description> <maml:para>Whether to restart the computer if the join operation succeeded.</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="true (ByPropertyName)" position="7"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to join the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>UnjoinDomainCredential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to unjoin the AD domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Options</maml:name> <maml:description> <maml:para>The unsigned integer join option.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">JoinOptions</command:parameterValue> <dev:type> <maml:name>JoinOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>OUPath</maml:name> <maml:description> <maml:para>The OU path for AD domain join operation.</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="true (ByPropertyName)" position="12"> <maml:name>Version</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="10"> <maml:name>JoinOption</maml:name> <maml:description> <maml:para>The join option enumeration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>WorkgroupName</maml:name> <maml:description> <maml:para>The workgroup 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="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureServiceAntimalwareExtension</command:name> <maml:description> <maml:para>Configures the Microsoft Antimalware extension for cloud services.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceAntimalwareExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureServiceAntimalwareExtension cmdlet configures the Microsoft Antimalware extension for a cloud service. You can specify values that override and supplement values in the XML configuration, such as storage account context.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies an array of roles. The default value is all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>AntimalwareConfiguration</maml:name> <maml:description> <maml:para>Specifies an XmlDocument object that contains the Microsoft Antimalware configuration. This object must not be $Null or empty. The configuration object must include, at a minimum, the following content to enable the Microsoft Antimalware extension: <AntimalwareConfig><AntimalwareEnabled>true</AntimalwareEnabled></AntimalwareConfig></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">XmlDocument</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Monitoring</maml:name> <maml:description> <maml:para>Specifies whether to collect Microsoft Antimalware events. Valid values are: -- ON. Collect Microsoft Antimalware events to storage context. -- OFF. Do not collect Microsoft Antimalware events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies an Azure storage context for Microsoft Antimalware monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies an array of roles. The default value is all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>AntimalwareConfiguration</maml:name> <maml:description> <maml:para>Specifies an XmlDocument object that contains the Microsoft Antimalware configuration. This object must not be $Null or empty. The configuration object must include, at a minimum, the following content to enable the Microsoft Antimalware extension: <AntimalwareConfig><AntimalwareEnabled>true</AntimalwareEnabled></AntimalwareConfig></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">XmlDocument</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Monitoring</maml:name> <maml:description> <maml:para>Specifies whether to collect Microsoft Antimalware events. Valid values are: -- ON. Collect Microsoft Antimalware events to storage context. -- OFF. Do not collect Microsoft Antimalware events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies an Azure storage context for Microsoft Antimalware monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service.</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies a deployment slot. Valid values are: -- Production -- Staging The default value is Production.</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="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>Specifies an array of roles. The default value is all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>AntimalwareConfiguration</maml:name> <maml:description> <maml:para>Specifies an XmlDocument object that contains the Microsoft Antimalware configuration. This object must not be $Null or empty. The configuration object must include, at a minimum, the following content to enable the Microsoft Antimalware extension: <AntimalwareConfig><AntimalwareEnabled>true</AntimalwareEnabled></AntimalwareConfig></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">XmlDocument</command:parameterValue> <dev:type> <maml:name>XmlDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Monitoring</maml:name> <maml:description> <maml:para>Specifies whether to collect Microsoft Antimalware events. Valid values are: -- ON. Collect Microsoft Antimalware events to storage context. -- OFF. Do not collect Microsoft Antimalware events.</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies an Azure storage context for Microsoft Antimalware monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Enable the extension --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>[System.Xml.XmlDocument] $XmlConfig = New-Object System.Xml.XmlDocument PS C:\> $XmlConfig.load('C:\configuration\contosoVM.xml') PS C:\> Set-AzureServiceAntimalwareExtension -ServiceName "ContosoService03" -AntimalwareConfiguration $XmlConfig Operation succeeded</dev:code> <dev:remarks> <maml:para>The first two commands create an XmlDocument object that contains a configuration for the Microsoft Antimalware extension, and then stores it in the $XmlConfig variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The third command enables the Microsoft Antimalware extension for the service named ContosoService03, by using the configuration stored in $XmlConfig. Because the command does not specify the Slot parameter, the cmdlet uses the default value, Production.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Enable the extension for the Staging slot --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>[System.Xml.XmlDocument] $XmlConfig = New-Object System.Xml.XmlDocument PS C:\> $XmlConfig.load('C:\configuration\contosoVM.xml') PS C:\> Set-AzureServiceAntimalwareExtension -ServiceName "ContosoService03" -Slot "Staging" -AntimalwareConfiguration $XmlConfig Operation succeeded</dev:code> <dev:remarks> <maml:para>The first two commands create an XmlDocument object that contains a configuration for the Microsoft Antimalware extension, and then stores it in the $XmlConfig variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The third command enables the Microsoft Antimalware extension for the service named ContosoService03, by using the configuration stored in $XmlConfig. This command specifies a value of Staging for the Slot parameter.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Enable the extension with monitoring --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>[System.Xml.XmlDocument] $XmlConfig = New-Object System.Xml.XmlDocument PS C:\> $XmlConfig.load('C:\configuration\contosoVM.xml') PS C:\> $StorageContext = New-AzureStorageContext -StorageAccountName "contosostoragemain" -StorageAccountKey (Get-AzureStorageKey -StorageAccountName "Contosostoragemain").Primary PS C:\> Set-AzureServiceAntimalwareExtension -ServiceName "ContosoService03" -AntimalwareConfiguration $XmlConfig -Monitoring ON -StorageContext $StorageContext</dev:code> <dev:remarks> <maml:para>The first two commands create an XmlDocument object that contains a configuration for the Microsoft Antimalware extension, and then stores it in the $XmlConfig variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The third command creates an AzureStorageContext object by using the New-AzureStorageContext cmdlet, and then stores it in the $StorageContext variable.The final command enables the Microsoft Antimalware extension for the service named ContosoService03, by using the configuration stored in $XmlConfig. This command also specifies a value of ON for the Monitoring parameter and specifies the Azure storage context stored in $StorageContext. The values specified by these parameters override any corresponding values for these parameters that were specified within the XML configuration.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=402843</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureStorageContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureServiceAntimalwareConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureServiceAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureServiceDiagnosticsExtension</command:name> <maml:description> <maml:para>This cmdlet enables diagnostics extension on specified role(s) or all roles on a deployed service or at deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceDiagnosticsExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet enables diagnostics extension on specified role(s) or all roles on a deployed service or at deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceDiagnosticsExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the diagnostics configuration for. If not specified the diagnostics configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> Configuration for Microsoft Azure diagnostics. You can download the schema by doing: (Get-AzureServiceAvailableExtension -ExtensionName 'PaaSDiagnostics' -ProviderNamespace 'Microsoft.Azure.Diagnostics').PublicConfigurationSchema | Out-File -Encoding utf8 -FilePath 'WadConfig.xsd' </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceDiagnosticsExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the diagnostics configuration for. If not specified the diagnostics configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> Configuration for Microsoft Azure diagnostics. You can download the schema by doing: (Get-AzureServiceAvailableExtension -ExtensionName 'PaaSDiagnostics' -ProviderNamespace 'Microsoft.Azure.Diagnostics').PublicConfigurationSchema | Out-File -Encoding utf8 -FilePath 'WadConfig.xsd' </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the diagnostics configuration for. If not specified the diagnostics configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="5"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> Configuration for Microsoft Azure diagnostics. You can download the schema by doing: (Get-AzureServiceAvailableExtension -ExtensionName 'PaaSDiagnostics' -ProviderNamespace 'Microsoft.Azure.Diagnostics').PublicConfigurationSchema | Out-File -Encoding utf8 -FilePath 'WadConfig.xsd' </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="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureServiceDiagnosticExtension -ServiceName $svc -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Setting default diagnostic configuration for all roles.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureServiceDiagnosticExtension -ServiceName $svc -StorageAccountName $name -DiagnosticConfiguration $wadConfigXML -Role "WebRole1"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Setting diagnostic configuration for WebRole1.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureServiceExtension</command:name> <maml:description> <maml:para>This cmdlet adds a cloud service extension to a deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet adds a cloud service extension to a deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension's Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension's Provider Namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="5"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="6"> <maml:name>ProviderNamespace</maml:name> <maml:description> <maml:para>The Extension's Provider Namespace.</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="true (ByPropertyName)" position="7"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</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="true (ByPropertyName)" position="8"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</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="true (ByPropertyName)" position="9"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureServiceExtension -Service $svc -Slot Production -ExtensionName 'RDP' -Version '1.0' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Set the Remote Desktop Extension in version 1.0 for all roles in the cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureServiceExtension -Service $svc -Slot Production -Role WebRole1 -ExtensionName 'RDP' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Set the Remote Desktop Extension for the 'WebRole1' role in the cloud service.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureServiceRemoteDesktopExtension</command:name> <maml:description> <maml:para>This cmdlet enables remote desktop extension on specified role(s) or all roles on a deployed service or at deployment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceRemoteDesktopExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet enables remote desktop extension on specified role(s) or all roles on a deployed service or at deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceRemoteDesktopExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to enable for remote desktop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>A date time object that allows the user to specify when the user account will expire.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceRemoteDesktopExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to enable for remote desktop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>A date time object that allows the user to specify when the user account will expire.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name of the 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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Role</maml:name> <maml:description> <maml:para>An optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="3"> <maml:name>X509Certificate</maml:name> <maml:description> <maml:para>An x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> <dev:type> <maml:name>X509Certificate2</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>Thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.</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="true (ByPropertyName)" position="5"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials (user name/password) to enable for remote desktop.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Expiration</maml:name> <maml:description> <maml:para>A date time object that allows the user to specify when the user account will expire.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Version</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="3"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Setting default remote desktop configuration for all roles.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds -Role "WebRole1"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Setting remote desktop configuration for WebRole1.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureStaticVNetIP</command:name> <maml:description> <maml:para>Set the static VNet IP address information to a VM object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureStaticVNetIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Set the static VNet IP address information to a VM object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureStaticVNetIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Static VNet IP Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>Static VNet IP Address</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> # Prerequisite: VNet has been set up with SubNet # Set-AzureVNetConfig -ConfigurationPath $vnetConfigPath; $vm = New-AzureVMConfig -Name $vmname -ImageName $img -InstanceSize $sz | Add-AzureProvisioningConfig -Windows -Password $pwd -AdminUsername $usr; $vm = Set-AzureSubNet -VM $vm -SubNetNames $sn; Set-AzureStaticVNETIP -IPAddress $ip -VM $vm; New-AzureVM -ServiceName $svc -VMs $vm -VNETName $vnetName -Location $loc;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureStorageAccount</command:name> <maml:description> <maml:para>Updates the properties of a storage account in a Microsoft Azure subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureStorageAccount</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureStorageAccount cmdlet updates the properties of a Microsoft Azure storage account in the current subscription. Properties that can be set are: "Label", "Description", "Type" and "GeoReplicationEnabled".</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureStorageAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies the name of the storage account to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the storage account. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the storage account. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeoReplicationEnabled</maml:name> <maml:description> <maml:para>Specifies whether the storage account is created with the geo-replication enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureStorageAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies the name of the storage account to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the storage account. The label may be up to 100 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the storage account. The description may be up to 1024 characters in length.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of the storage account. Valid values are Standard_LRS Standard_ZRS Standard_GRS Standard_RAGRS Premium_LRS If this parameter is not specified, a default value of Standard_GRS is used Note: The GeoReplicationEnabled parameter functionality is the same as specifying Standard_GRS in Type parameter Standard_ZRS or Premium_LRS accounts cannot be changed to other account types, and vice versa.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>Specifies the name of the storage account to be updated.</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>Label</maml:name> <maml:description> <maml:para>Specifies a label for the storage account. The label may be up to 100 characters in length.</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>Description</maml:name> <maml:description> <maml:para>Specifies a description for the storage account. The description may be up to 1024 characters in length.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeoReplicationEnabled</maml:name> <maml:description> <maml:para>Specifies whether the storage account is created with the geo-replication enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>Type</maml:name> <maml:description> <maml:para>Specifies the type of the storage account. Valid values are Standard_LRS Standard_ZRS Standard_GRS Standard_RAGRS Premium_LRS If this parameter is not specified, a default value of Standard_GRS is used Note: The GeoReplicationEnabled parameter functionality is the same as specifying Standard_GRS in Type parameter Standard_ZRS or Premium_LRS accounts cannot be changed to other account types, and vice versa.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>New-AzureStorageAccount, Get-AzureStorageAccount, Remove-AzureStorageAccount</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureStorageAccount -StorageAccountName qatest1 -Label "QATestAccnt" -Description "QA test storage account"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command updates the label and description of the 'qatest1' storage account in the specified subscription.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureStorageAccount -StorageAccountName qatest1 -GeoReplicationEnabled $false</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command disables the geo-replication of the 'qatest1' storage account in the specified subscription.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureStorageAccount -StorageAccountName qatest1 -GeoReplicationEnabled $true</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command enables the geo-replication of the 'qatest1' storage account in the specified subscription.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureSubnet</command:name> <maml:description> <maml:para>Defines the subnet list for a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSubnet</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureSubnet cmdlet sets the subnet list for a virtual machine configuration. Use with New-AzureVM to set the subnets for a virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSubnet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SubnetNames</maml:name> <maml:description> <maml:para>Specifies the list of subnet names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SubnetNames</maml:name> <maml:description> <maml:para>Specifies the list of subnet names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>New-AzureVMConfig –Name "MyVM" –ImageName $image –InstanceSize "Small" ` | Add-AzureProvisioningConfig –Windows –Password $passwd ` | Set-AzureSubnet "PubSubnet","PrivSubnet" ` | New-AzureVM –ServiceName "MySvc"</dev:code> <dev:remarks> <maml:para>This example adds a subnet to the virtual machine configuration and then creates the virtual machine "MyVM".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMAccessExtension</command:name> <maml:description> <maml:para>This cmdlet sets the VMAccess extension for the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMAccessExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet sets the VMAccess extension for the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMAccessExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name for resetting the VM's credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for resetting the VM's credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMAccessExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMAccessExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name for resetting the VM's credential.</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="true (ByPropertyName)" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for resetting the VM's credential.</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="true (ByPropertyName)" position="3"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</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="true (ByPropertyName)" position="4"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</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="true (ByPropertyName)" position="1"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</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="5"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMBGInfoExtension</command:name> <maml:description> <maml:para>This cmdlet sets the BGInfo extension for the VM. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMBGInfoExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet sets the BGInfo extension for the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMBGInfoExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMBGInfoExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</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="true (ByPropertyName)" position="2"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</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="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMCustomScriptExtension</command:name> <maml:description> <maml:para>Set Azure VM Custom Script Extension Information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMCustomScriptExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Set Azure VM Custom Script Extension Information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMCustomScriptExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ContainerName</maml:name> <maml:description> <maml:para>The container name within the storage account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The names of the blob files in the specified container.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The storage account name in the current subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>StorageEndpointSuffix</maml:name> <maml:description> <maml:para>The storage service endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Run</maml:name> <maml:description> <maml:para>The command to run by the extension on the VM, currently only "powershell.exe" is supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>Argument</maml:name> <maml:description> <maml:para>Argument for the command to run on the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMCustomScriptExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMCustomScriptExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMCustomScriptExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FileUri</maml:name> <maml:description> <maml:para>The URLs of the blob files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Run</maml:name> <maml:description> <maml:para>The command to run by the extension on the VM, currently only "powershell.exe" is supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>Argument</maml:name> <maml:description> <maml:para>Argument for the command to run on the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</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="true (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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="true (ByPropertyName)" position="2"> <maml:name>ContainerName</maml:name> <maml:description> <maml:para>The container name within the storage account.</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The names of the blob files in the specified container.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true (ByPropertyName)" position="4"> <maml:name>StorageAccountName</maml:name> <maml:description> <maml:para>The storage account name in the current subscription.</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="true (ByPropertyName)" position="5"> <maml:name>StorageEndpointSuffix</maml:name> <maml:description> <maml:para>The storage service endpoint.</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="true (ByPropertyName)" position="6"> <maml:name>StorageAccountKey</maml:name> <maml:description> <maml:para>The storage account key</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="true (ByPropertyName)" position="7"> <maml:name>Run</maml:name> <maml:description> <maml:para>The command to run by the extension on the VM, currently only "powershell.exe" is supported.</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="true (ByPropertyName)" position="8"> <maml:name>Argument</maml:name> <maml:description> <maml:para>Argument for the command to run on the VM.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</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="true (ByPropertyName)" position="2"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FileUri</maml:name> <maml:description> <maml:para>The URLs of the blob files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="9"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $x = Set-AzureVMCustomScriptExtension -VM $x -ContainerName 'test' -FileName 'script1.ps1','script2.ps1' -Run 'script1.ps1' -Argument 'arg1 arg2'; New-AzureVM -Location 'West US' -ServiceName $svc -VM $x;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureVMCustomScriptExtension -VM $vm -FileUri 'http://foo1.blob.core.windows.net/bar/script1.ps1','http://foo2.blob.core.windows.net/baz/script2.ps1' -Run 'script1.ps1' -Argument 'arg1 arg2'; Update-AzureVM -ServiceName $svc -Name $name -VM vm;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMDiagnosticsExtension</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMDiagnosticsExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMDiagnosticsExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Disable</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMDiagnosticsExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Disable</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DiagnosticsConfigurationPath</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="1"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="3"> <maml:name>Disable</maml:name> <maml:description> <maml:para> </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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMDscExtension</command:name> <maml:description> <maml:para>Configure the Windows PowerShell Desired State Configuration extension on a VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMDscExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Configure the Windows PowerShell Desired State Configuration extension on a VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMDscExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ConfigurationArgument</maml:name> <maml:description> <maml:para>A hashtable specifying the arguments to the configuration function. The keys correspond to the parameter names and the values to the parameter values. Supported types for values include: primitive types, string, array and PSCredential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ConfigurationDataPath</maml:name> <maml:description> <maml:para>The path to a .psd1 file that specifies the data for the configuration function. This file must contain a hashtable as described in http://technet.microsoft.com/en-us/library/dn249925.aspx.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ConfigurationArchive</maml:name> <maml:description> <maml:para>The name of the configuration package (.zip file) that was previously uploaded by Publish-AzureVMDscConfiguration. This parameter must specify only the name of the file, without any path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ConfigurationName</maml:name> <maml:description> <maml:para>Name of the configuration script or module that will be invoked by the DSC Extension. The value of this parameter must be the name of one of the configurations functions contained in the scripts or modules packaged in the ConfigurationArchive. If omitted, this parameter will default to the name of the file given by the ConfigurationArchive parameter, excluding any extension, for example if ConfigurationArchive is "SalesWebSite.ps1.zip", the default value for ConfigurationName will be "SalesWebSite".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ContainerName</maml:name> <maml:description> <maml:para>Name of the Azure Storage Container where the ConfigurationArchive is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>By default Set-AzureVMDscExtension will not overwrite any existing blobs. Use -Force to overwrite them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>The Azure Storage Context that provides the security settings used to access the configuration script. This context should provide read access to the container specified by ContainerName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the DSC Extension to use. If not given, it will default to "1.*"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageEndpointSuffix</maml:name> <maml:description> <maml:para>The DNS endpoint suffix for all storage services, e.g. "core.windows.net".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>WmfVersion</maml:name> <maml:description> <maml:para>Specifies the version of the Windows Management Framework (WMF) to install on the VM. The DSC Azure Extension depends on DSC features that are only available in the WMF updates. This parameter specifies which version of the update to install on the VM. The possible values are "4.0","latest" and "5.0PP". A value of "4.0" will install KB3000850 (http://support.microsoft.com/kb/3000850) on Windows 8.1 or Windows Server 2012 R2, or WMF 4.0 (http://www.microsoft.com/en-us/download/details.aspx?id=40855) on other versions of Windows if a newer version isnt already installed. A value of "5.0PP" will install the latest release of WMF 5.0PP (http://go.microsoft.com/fwlink/?LinkId=398175). A value of "latest" will install the latest WMF, currently WMF 5.0PP. The default value is "latest"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</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="true (ByPropertyName)" position="named"> <maml:name>ConfigurationArgument</maml:name> <maml:description> <maml:para>A hashtable specifying the arguments to the configuration function. The keys correspond to the parameter names and the values to the parameter values. Supported types for values include: primitive types, string, array and PSCredential.</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="true (ByPropertyName)" position="named"> <maml:name>ConfigurationDataPath</maml:name> <maml:description> <maml:para>The path to a .psd1 file that specifies the data for the configuration function. This file must contain a hashtable as described in http://technet.microsoft.com/en-us/library/dn249925.aspx.</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="true (ByPropertyName)" position="1"> <maml:name>ConfigurationArchive</maml:name> <maml:description> <maml:para>The name of the configuration package (.zip file) that was previously uploaded by Publish-AzureVMDscConfiguration. This parameter must specify only the name of the file, without any path.</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="true (ByPropertyName)" position="named"> <maml:name>ConfigurationName</maml:name> <maml:description> <maml:para>Name of the configuration script or module that will be invoked by the DSC Extension. The value of this parameter must be the name of one of the configurations functions contained in the scripts or modules packaged in the ConfigurationArchive. If omitted, this parameter will default to the name of the file given by the ConfigurationArchive parameter, excluding any extension, for example if ConfigurationArchive is "SalesWebSite.ps1.zip", the default value for ConfigurationName will be "SalesWebSite".</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="true (ByPropertyName)" position="named"> <maml:name>ContainerName</maml:name> <maml:description> <maml:para>Name of the Azure Storage Container where the ConfigurationArchive is located.</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>WindowsPowerShellDSC</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>By default Set-AzureVMDscExtension will not overwrite any existing blobs. Use -Force to overwrite them.</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="true (ByPropertyName)" position="named"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>The Azure Storage Context that provides the security settings used to access the configuration script. This context should provide read access to the container specified by ContainerName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the DSC Extension to use. If not given, it will default to "1.*"</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>1.*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StorageEndpointSuffix</maml:name> <maml:description> <maml:para>The DNS endpoint suffix for all storage services, e.g. "core.windows.net".</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</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>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</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>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</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="true (ByPropertyName)" position="named"> <maml:name>WmfVersion</maml:name> <maml:description> <maml:para>Specifies the version of the Windows Management Framework (WMF) to install on the VM. The DSC Azure Extension depends on DSC features that are only available in the WMF updates. This parameter specifies which version of the update to install on the VM. The possible values are "4.0","latest" and "5.0PP". A value of "4.0" will install KB3000850 (http://support.microsoft.com/kb/3000850) on Windows 8.1 or Windows Server 2012 R2, or WMF 4.0 (http://www.microsoft.com/en-us/download/details.aspx?id=40855) on other versions of Windows if a newer version isnt already installed. A value of "5.0PP" will install the latest release of WMF 5.0PP (http://go.microsoft.com/fwlink/?LinkId=398175). A value of "latest" will install the latest WMF, currently WMF 5.0PP. The default value is "latest"</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>latest</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureVMDscExtension -VM $vm -ConfigurationArchive MyConfiguration.ps1.zip -ConfigurationName MyConfiguration -ConfigurationArgument @{ Path = 'C:\MyDirectory' } DeploymentName : my-vm-svc Name : my-vm Label : VM : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM InstanceStatus : ReadyRole IpAddress : 10.10.10.10 InstanceStateDetails : PowerState : Started InstanceErrorCode : InstanceFaultDomain : 0 InstanceName : my-vm InstanceUpgradeDomain : 0 InstanceSize : Small AvailabilitySetName : DNSName : http://my-vm-svc.cloudapp.net/ Status : ReadyRole GuestAgentStatus : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus ResourceExtensionStatusList : {Microsoft.Compute.BGInfo} PublicIPAddress : PublicIPName : ServiceName : my-vm-svc OperationDescription : Get-AzureVM OperationId : a0217a7af900c1f8a212299a3333cdbd6 OperationStatus : OK</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command configures the DSC extension on a VM. The "MyConfiguration.ps1.zip" package must have been previously uploaded to Azure storage using the Publish-AzureVMDscConfiguration command and includes the "MyConfiguration.ps1" script and the modules it depends on. The "MyConfiguration" argument indicates the specific DSC configuration within the script to execute. The -ConfigurationArgument parameter specifies a hashtable with the arguments that will be passed to the configuration function.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $vm | Set-AzureVMDscExtension -ConfigurationArchive MyConfiguration.ps1.zip -ConfigurationName MyConfiguration -ConfigurationArgument @{ Credential = Get-Credential } -ConfigurationDataPath MyConfigurationData.psd1 DeploymentName : my-vm-svc Name : my-vm Label : VM : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM InstanceStatus : ReadyRole IpAddress : 10.10.10.10 InstanceStateDetails : PowerState : Started InstanceErrorCode : InstanceFaultDomain : 0 InstanceName : my-vm InstanceUpgradeDomain : 0 InstanceSize : Small AvailabilitySetName : DNSName : http://my-vm-svc.cloudapp.net/ Status : ReadyRole GuestAgentStatus : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus ResourceExtensionStatusList : {Microsoft.Compute.BGInfo, Microsoft.Powershell.DSC} PublicIPAddress : PublicIPName : ServiceName : my-vm-svc OperationDescription : Get-AzureVM OperationId : a0217a7af900c1f8a212299a3333cdbd7 OperationStatus : OK</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------You can pass -VM parameter from the pipeline. -ConfigurationArgument parameter supports PSCredential as a value. -ConfigurationDataPath parameter takes path to .psd1 file with ConfigurationData hashtable.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMExtension</command:name> <maml:description> <maml:para>This cmdlet sets resource extensions for VMs.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet sets resource extensions for VMs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension's Publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension's Publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublicConfigPath</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivateConfigPath</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublicConfigPath</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivateConfigPath</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ExtensionName</maml:name> <maml:description> <maml:para>The Extension 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="true (ByPropertyName)" position="2"> <maml:name>Publisher</maml:name> <maml:description> <maml:para>The Extension's Publisher.</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="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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="true (ByPropertyName)" position="4"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</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="true (ByPropertyName)" position="5"> <maml:name>PublicConfiguration</maml:name> <maml:description> <maml:para>The public configuration text.</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="true (ByPropertyName)" position="6"> <maml:name>PrivateConfiguration</maml:name> <maml:description> <maml:para>The private configuration text.</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="true (ByPropertyName)" position="7"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</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="true (ByPropertyName)" position="8"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Not Specified</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublicConfigPath</maml:name> <maml:description> <maml:para>Not Specified</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="true (ByPropertyName)" position="6"> <maml:name>PrivateConfigPath</maml:name> <maml:description> <maml:para>Not Specified</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="11"> <maml:name>ForceUpdate</maml:name> <maml:description> <maml:para>Re-apply a configuration to an extension when the configuration has not been updated.</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMImageDataDiskConfig</command:name> <maml:description> <maml:para>Allows you to update the Data Disk properties on the VM Image</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMImageDataDiskConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMImageDataDiskConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>The disk config object that encapsulates the OS Disk and Data Disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>DataDiskName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Lun</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>The disk config object that encapsulates the OS Disk and Data Disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> <dev:type> <maml:name>VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>DataDiskName</maml:name> <maml:description> <maml:para> </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="true (ByPropertyName)" position="2"> <maml:name>Lun</maml:name> <maml:description> <maml:para> </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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $s = New-AzureDiskConfigSet # returns DiskConfigSet object; $s = Set-AzureOSDiskConfig -DiskConfig $s -HostCaching ReadWrite # returns DiskConfigSet object; $s = Set-AzureDataDiskConfig -DiskConfig $s -Name 'test' -HostCaching 'ReadWrite' -LUN 0 # returns DiskConfigSet object # Final step - Update the VM Image Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1 -DiskConfigSet $s; # OR $s | Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMImageOSDiskConfig</command:name> <maml:description> <maml:para>Allows you to update the OS Disk properties on the VM Image</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMImageOSDiskConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMImageOSDiskConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> <dev:type> <maml:name>VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>HostCaching</maml:name> <maml:description> <maml:para> </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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.ServiceManagement.Model.VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $s = New-AzureDiskConfigSet # returns DiskConfigSet object; $s = Set-AzureOSDiskConfig -DiskConfig $s -HostCaching ReadWrite # returns DiskConfigSet object; $s = Set-AzureDataDiskConfig -DiskConfig $s -Name 'test' -HostCaching 'ReadWrite' -LUN 0 # returns DiskConfigSet object # Final step - Update the VM Image Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1 -DiskConfigSet $s; # OR $s | Update-AzureVMImage -ImageName testvmimage2 -Label test1 -Description test1;</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMMicrosoftAntimalwareExtension</command:name> <maml:description> <maml:para>Configures the Microsoft Antimalware extension for a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMMicrosoftAntimalwareExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureVMMicrosoftAntimalwareExtension cmdlet configures the Microsoft Antimalware extension for a virtual machine. You can enable, disable, or uninstall the extension.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMMicrosoftAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>AntimalwareConfigFile</maml:name> <maml:description> <maml:para>Specifies the absolute path to the Microsoft Antimalware configuration file. Do not specify this parameter if you specify the AntimalwareConfiguration parameter. The configuration file must include, at a minimum, the following content to enable the Microsoft Antimalware extension: { "AntimalwareEnabled": true }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the extension version as a string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Monitoring</maml:name> <maml:description> <maml:para>Specifies whether to collect Microsoft Antimalware events. Valid values are: -- ON. Collect Microsoft Antimalware events to storage context. -- OFF. Do not collect Microsoft Antimalware events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies an Azure storage context for Microsoft Antimalware monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMMicrosoftAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>AntimalwareConfiguration</maml:name> <maml:description> <maml:para>Specifies a string object that contains the Microsoft Antimalware configuration. This object must not be $Null or empty. Do not specify this parameter if you specify the AntimalwareConfigFile parameter. The configuration object must include, at a minimum, the following content to enable the Microsoft Antimalware extension: { "AntimalwareEnabled": true }Microsoft Antimalware JSON configuration sample: { "AntimalwareEnabled": true, "RealtimeProtectionEnabled": true, "ScheduledScanSettings": { "isEnabled": true, "day": 1, "time": 120, "scanType": "Full" }, "Exclusions": { "Extensions": ".ext1;.ext2", "Paths": "c:\excluded-path-1;c:\excluded-path-2", "Processes": "excludedproc1.exe;excludedproc2.exe" } } Notes: AntimalwareEnabled is a required parameter. Values: true= Enable. false= Error out as false is not a supported value RealtimeProtectionEnabled: true/false. true = Enable. false = Disable. Default is true ScheduledScanSettings: isEnabled=true/false day=0-8 (0-daily, 1-Sunday, 2-Monday, ...., 7-Saturday, 8-Disabled) time=0-1440 (measured in minutes after midnight - 60->1AM, 120 -> 2AM, ... ) scanType="Quick" or "Full" (Default is Quick) Note: If isEnabled=true is the only setting provided, the following defaults are set: day=7 (Saturday), time=120 (2 AM), scanType="Quick" Exclusions: Multiple exclusions in the same list are specified by using semicolon delimiters. If no exclusions are specified, then the existing exclusions, if any, are overwritten by blank on the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the extension version as a string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Monitoring</maml:name> <maml:description> <maml:para>Specifies whether to collect Microsoft Antimalware events. Valid values are: -- ON. Collect Microsoft Antimalware events to storage context. -- OFF. Do not collect Microsoft Antimalware events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies an Azure storage context for Microsoft Antimalware monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMMicrosoftAntimalwareExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the extension version as a string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Indicates that the cmdlet disables the Microsoft Antimalware extension. To re-enable the extension on the same virtual machine, run Set-AzureVMMicrosoftAntimalwareExtension without the Disable parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMMicrosoftAntimalwareExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uninstalls the Microsoft Antimalware extension from the virtual machine. If monitoring was turned on, the cmdlet also removes the collection of Microsoft Antimalware events.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVMMicrosoftAntimalwareExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Monitoring</maml:name> <maml:description> <maml:para>Specifies whether to collect Microsoft Antimalware events. Valid values are: -- ON. Collect Microsoft Antimalware events to storage context. -- OFF. Do not collect Microsoft Antimalware events.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies an Azure storage context for Microsoft Antimalware monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>NoConfig</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>AntimalwareConfigFile</maml:name> <maml:description> <maml:para>Specifies the absolute path to the Microsoft Antimalware configuration file. Do not specify this parameter if you specify the AntimalwareConfiguration parameter. The configuration file must include, at a minimum, the following content to enable the Microsoft Antimalware extension: { "AntimalwareEnabled": true }</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the extension version as a string.</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Monitoring</maml:name> <maml:description> <maml:para>Specifies whether to collect Microsoft Antimalware events. Valid values are: -- ON. Collect Microsoft Antimalware events to storage context. -- OFF. Do not collect Microsoft Antimalware events.</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies an Azure storage context for Microsoft Antimalware monitoring.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine as an IPersistentVM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>AntimalwareConfiguration</maml:name> <maml:description> <maml:para>Specifies a string object that contains the Microsoft Antimalware configuration. This object must not be $Null or empty. Do not specify this parameter if you specify the AntimalwareConfigFile parameter. The configuration object must include, at a minimum, the following content to enable the Microsoft Antimalware extension: { "AntimalwareEnabled": true }Microsoft Antimalware JSON configuration sample: { "AntimalwareEnabled": true, "RealtimeProtectionEnabled": true, "ScheduledScanSettings": { "isEnabled": true, "day": 1, "time": 120, "scanType": "Full" }, "Exclusions": { "Extensions": ".ext1;.ext2", "Paths": "c:\excluded-path-1;c:\excluded-path-2", "Processes": "excludedproc1.exe;excludedproc2.exe" } } Notes: AntimalwareEnabled is a required parameter. Values: true= Enable. false= Error out as false is not a supported value RealtimeProtectionEnabled: true/false. true = Enable. false = Disable. Default is true ScheduledScanSettings: isEnabled=true/false day=0-8 (0-daily, 1-Sunday, 2-Monday, ...., 7-Saturday, 8-Disabled) time=0-1440 (measured in minutes after midnight - 60->1AM, 120 -> 2AM, ... ) scanType="Quick" or "Full" (Default is Quick) Note: If isEnabled=true is the only setting provided, the following defaults are set: day=7 (Saturday), time=120 (2 AM), scanType="Quick" Exclusions: Multiple exclusions in the same list are specified by using semicolon delimiters. If no exclusions are specified, then the existing exclusions, if any, are overwritten by blank on the system.</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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Indicates that the cmdlet disables the Microsoft Antimalware extension. To re-enable the extension on the same virtual machine, run Set-AzureVMMicrosoftAntimalwareExtension without the Disable parameter.</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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Uninstall</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uninstalls the Microsoft Antimalware extension from the virtual machine. If monitoring was turned on, the cmdlet also removes the collection of Microsoft Antimalware events.</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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>NoConfig</maml:name> <maml:description> <maml:para> </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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Enable the extension by using a configuration file --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureVM -ServiceName "ContosoService03" -Name "ContosoVM22" | Set-AzureVMMicrosoftAntimalwareExtension -AntimalwareConfigFile 'C:\configuration\contosoVM.json' | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command enables the Microsoft Antimalware extension by using a configuration file. The command uses the Get-AzureVM cmdlet to get the specified virtual machine object, and then passes the object to the current cmdlet by using the pipeline operator.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The AntimalwareConfigFile parameter specifies a configuration file for the Microsoft Antimalware extension. Set-AzureVMMicrosoftAntimalwareExtension applies the configuration that the file specifies to the virtual machine, and then passes the result to the Update-AzureVM cmdlet to update the virtual machine.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Enable the extension and enable monitoring --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$StorageContext = New-AzureStorageContext -StorageAccountName "contosostoragemain" -StorageAccountKey (Get-AzureStorageKey -StorageAccountName "Contosostoragemain").Primary PS C:\> Get-AzureVM -ServiceName "ContosoService03" -Name"ContosoVM22" | Set-AzureVMMicrosoftAntimalwareExtension -AntimalwareConfigFile 'C:\configuration\contosoVM.json" -Monitoring ON -StorageContext $StorageContext | Update-AzureVM</dev:code> <dev:remarks> <maml:para>The first command creates an AzureStorageContext object by using the New-AzureStorageContext cmdlet, and then stores it in the $StorageContext variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The second command enables the Microsoft Antimalware extension, and enables monitoring. The command uses Get-AzureVM to get the specified virtual machine object, and then passes the object to the current cmdlet.The command specifies a value of ON for the Monitoring parameter and specifies the Azure storage context stored in $StorageContext, and then passes the result to the Update-AzureVM cmdlet.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Enable the extension by specifying a configuration object --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$config_string = [IO.File]::ReadAllText('C:\configuration\contosoVM.json') PS C:\> Get-AzureVM -ServiceName "ContosoService03" -Name "ContosoVM22" | Set-AzureVMMicrosoftAntimalwareExtension -AntimalwareConfiguration $config_string | Update-AzureVM</dev:code> <dev:remarks> <maml:para>The first command creates a string object by reading a JSON configuration for the Microsoft Antimalware extension, and then storing it in the $config_string variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The AntimalwareConfiguration parameter specifies the configuration information stored in $config_string. Set-AzureVMMicrosoftAntimalwareExtension applies that configuration to the virtual machine, and then passes the result to the Update-AzureVM cmdlet.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4: Disable the extension --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureVM -ServiceName "ContosoService03" -Name "ContosoVM22" | Set-AzureVMMicrosoftAntimalwareExtension -Disable | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command disables the extension without removing it. The command uses Get-AzureVM to get the specified virtual machine object, and then passes the object to the current cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>Set-AzureVMMicrosoftAntimalwareExtension disables the Microsoft Antimalware extension for the virtual machine, and then passes the result to Update-AzureVM.To re-enabled the extension on the same virtual machine, run Set-AzureVMMicrosoftAntimalwareExtension cmdlet without specifying the Disable parameter.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5: Remove the extension --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureVM -ServiceName "ContosoService03" -Name"ContosoVM22" | Set-AzureVMMicrosoftAntimalwareExtension -Uninstall | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This command removes the Microsoft Antimalware extension from the virtual machine. The command uses Get-AzureVM to get the specified virtual machine object, and then passes the object to the current cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>Set-AzureVMMicrosoftAntimalwareExtension uninstalls the extension. If monitoring was turned on, the cmdlet also removes the collection of Microsoft Antimalware events. The command passes the result to Update-AzureVM.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=402844</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureStorageContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVMMicrosoftAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVMMicrosoftAntimalwareExtension</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMPuppetExtension</command:name> <maml:description> <maml:para>This cmdlet sets the Puppet extension for the VM.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMPuppetExtension</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet sets the Puppet extension for the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMPuppetExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>PuppetMasterServer</maml:name> <maml:description> <maml:para>The FQDN of puppet master server..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>PuppetMasterServer</maml:name> <maml:description> <maml:para>The FQDN of puppet master server..</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="true (ByPropertyName)" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Extension Version.</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="true (ByPropertyName)" position="3"> <maml:name>Disable</maml:name> <maml:description> <maml:para>To Set the Extension State to 'Disable'.</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="true (ByPropertyName)" position="6"> <maml:name>ReferenceName</maml:name> <maml:description> <maml:para>The extension's reference name. This is a user-defined string that can be used to refer to an extension. It is specified when the extension is added to the VM for the first time. For subsequent updates, user should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension will be returned using the Get-AzureVM cmdlet.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------Description</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVMSize</command:name> <maml:description> <maml:para>Sets the size of a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMSize</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureVMSize cmdlet updates the size of a Virtual Machine. It has two parameters: "InstanceSize", which is the new size of the virtual machine, and "VM", which is a virtual machine object retrieved by using the Get-AzureVM cmdlet. The result of Set-AzureVMSize can be piped to the Update-AzureVM cmdlet or stored in a variable for later use. No actual change is made until Update-AzureVM is executed. Note: This cmdlet will require the virtual machine to be re-provisioned and it might get a new IP address.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMSize</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the machine. Supported values are "ExtraSmall", "Small", "Medium", "Large", "ExtraLarge", "A5", "A6",, "A7".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine to set the size of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>InstanceSize</maml:name> <maml:description> <maml:para>Specifies the size of the machine. Supported values are "ExtraSmall", "Small", "Medium", "Large", "ExtraLarge", "A5", "A6",, "A7".</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machine to set the size of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName "MySvc1" -Name "MyVM3" | Set-AzureVMSize "Small" | Update-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example updates a virtual machine to "Small". size.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> $MyVM = Get-AzureVM -ServiceName "MySvc1" -Name "MyVM3" | Set-AzureVMSize "Small" Update-AzureVM -ServiceName "MySvc1" -Name "MyVM3 -VM $MyVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example uses an intermediate variable to perform the same function as Example 1.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVNetConfig</command:name> <maml:description> <maml:para>Updates the virtual network settings for a Microsoft Azure cloud service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVNetConfig</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureVNetConfig cmdlet updates the network configuration for the current Microsoft Azure subscription by specifying a path to anetwork configuration file (.netcfg). The network configuration file defines DNS servers and subnets for cloud services within a subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVNetConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConfigurationPath</maml:name> <maml:description> <maml:para>Specifies the path and file name of a network configuration file (.netcfg).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConfigurationPath</maml:name> <maml:description> <maml:para>Specifies the path and file name of a network configuration file (.netcfg).</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Set-AzureVNetConfig -ConfigurationPath "c:\temp\MyAzNets.netcfg"</dev:code> <dev:remarks> <maml:para>This command updates the network configuration of the current Microsoft Azure subscription to that in the local file "c:\temp\MyAzNets.netcfg".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>$subsId = "5bea2bc2-88a5-44b8-abe1-3e76733b6783" C:\PS>$cert = Get-Item cert:\LocalMachine\MY\82F105B2DA81149204A6257A9A91EC452B8C52C3 C:\PS>Set-AzureVNetConfig -ConfigurationPath "c:\temp\MyAzNets.netcfg"</dev:code> <dev:remarks> <maml:para>This example sets the Microsoft Azure subscription, and then updates the network configuration of that subscription using the configuration defined in the local file "c:\temp\MyAzNets.netcfg".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureVNetSite</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVNetConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVNetGateway</command:name> <maml:description> <maml:para>Enables or disables a Microsoft Azure Virtual Network Gateway.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVNetGateway</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureVNetGateway cmdlet enables or disables a virtual network gateway for the specified Microsoft Azure virtual network. A virtual network gateway is a virtual private network (VPN) endpoint for connecting to a virtual network.The Set-AzureVNetGateway cmdlet supports two functional parameters: Connect and Disconnect. These parameters allow you to enable or disable the VPN connection between the specified LocalNetworkSiteName and the specified virtual network.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVNetGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connect</maml:name> <maml:description> <maml:para>Enables the VPN connection between the specified virtual network and the local network site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure virtual network to connect or disconnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalNetworkSiteName</maml:name> <maml:description> <maml:para>Specifies the name of the local network site for which the VPN connection will be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureVNetGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Disconnect</maml:name> <maml:description> <maml:para>Disables the VPN connection between the specified virtual network and the local network site.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure virtual network to connect or disconnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalNetworkSiteName</maml:name> <maml:description> <maml:para>Specifies the name of the local network site for which the VPN connection will be enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connect</maml:name> <maml:description> <maml:para>Enables the VPN connection between the specified virtual network and the local network site.</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="1"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure virtual network to connect or disconnect.</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="2"> <maml:name>LocalNetworkSiteName</maml:name> <maml:description> <maml:para>Specifies the name of the local network site for which the VPN connection will be enabled or disabled.</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>Disconnect</maml:name> <maml:description> <maml:para>Disables the VPN connection between the specified virtual network and the local network site.</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="1"> <maml:name>Test</maml:name> <maml:description> <maml:para> </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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureVNetGateway -Connect –VnetName "MyProdNet" –LocalNetworkSiteName "MyBranchOffice"</dev:code> <dev:remarks> <maml:para>This command enables the virtual network gateway between the Microsoft Azure virtual network, "MyProdNet" and the VPN device for the local network site, "MyBranchOffice".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureVNetGateway -Disconnect –VnetName "MyProdNet" –LocalNetworkSiteName "MyBranchOffice"</dev:code> <dev:remarks> <maml:para>This command disables the virtual network gateway between the Microsoft Azure virtual network, "MyProdNet" and the VPN device for the local network site "MyBranchOffice".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureVNetGatewayKey</command:name> <maml:description> <maml:para>Sets the IPsec/IKE pre-shared key for the cross premises site-to-site VPN tunnel between the Azure virtual network and your on-premises local site.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVNetGatewayKey</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Th Set-AzureVNetGatewayKey cmdlet sets the IPsec/IKE pre-shared key for the cross premises site-to-site VPN tunnel between the Azure virtual network and your on-premises local site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVNetGatewayKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure virtual network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LocalNetworkSiteName</maml:name> <maml:description> <maml:para>Specifies the name of the local network site to which the VPN tunnel connects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SharedKey</maml:name> <maml:description> <maml:para>Specifies the value of the new IPsec/IKE pre-shared key. The SharedKey is an alphanumeric string of 1-128 letters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>Specifies the name of the Azure virtual network.</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="1"> <maml:name>LocalNetworkSiteName</maml:name> <maml:description> <maml:para>Specifies the name of the local network site to which the VPN tunnel connects.</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="2"> <maml:name>SharedKey</maml:name> <maml:description> <maml:para>Specifies the value of the new IPsec/IKE pre-shared key. The SharedKey is an alphanumeric string of 1-128 letters.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureVNetGatewayKey -VNetName "MyAzureVirtualNetwork" -LocalNetworkSiteName "MyOnPremSite" -SharedKey "a1b2c3d4"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command sets the IPsec/IKE pre-shared key between your virtual network "MyAzureVirtualNetwork" and the on-premise site "MyOnPremSite" to "a1b2c3d4".</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureWalkUpgradeDomain</command:name> <maml:description> <maml:para>Walks the specified upgrade domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureWalkUpgradeDomain</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureWalkUpgradeDomain cmdlet initiates the actual upgrade of a Microsoft Azure deployment. The upgrade package and configuration are set by using the Set-AzureDeployment cmdlet with the -Upgrade switch.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureWalkUpgradeDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name to upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specified the environment of the deployment to upgrade. Supported values are "Staging" and "Production".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DomainNumber</maml:name> <maml:description> <maml:para>Specifies the upgrade domain to upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the Microsoft Azure service name to upgrade.</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="true (ByPropertyName)" position="1"> <maml:name>Slot</maml:name> <maml:description> <maml:para>Specified the environment of the deployment to upgrade. Supported values are "Staging" and "Production".</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="2"> <maml:name>DomainNumber</maml:name> <maml:description> <maml:para>Specifies the upgrade domain to upgrade.</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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>ManagementOperationContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Set-AzureWalkUpgradeDomain –ServiceName "MySvc1" –slot "Production" –UpgradeDomain 2</dev:code> <dev:remarks> <maml:para>This example initiates the upgrade of Upgrade Domain 2 of the production deployment of the "MySvc1" service</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Start-AzureVM</command:name> <maml:description> <maml:para>Starts a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Start-AzureVM cmdlet requests the start of a Microsoft Azure virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine object that identifies the virtual machine to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to start.</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="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to start.</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="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine object that identifies the virtual machine to start.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> <dev:type> <maml:name>PersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Start-AzureVM -ServiceName "myservice1" -Name "MyVM"</dev:code> <dev:remarks> <maml:para>This command starts the "MyVM" virtual machine running in the "myservice1" Microsoft Azure service.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName "myservice1" -Name "DatabaseServer" | Start-AzureVM</dev:code> <dev:remarks> <maml:para>This command retrieves the virtual machine object for the VM whose name is "DatabaseServer" and then requests a start for it.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Stop-AzureVM</command:name> <maml:description> <maml:para>Shuts down a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Stop-AzureVM cmdlet requests a shutdown of a virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to shut down. Use a wildcard "*" to stop multiple VMs asynchronously. With a wild card, Stop-AzureVM cmdlet calls ShutdownRoles operation (http://msdn.microsoft.com/en-us/library/azure/dn469421.aspx), instead of ShutdownRole operation (http://msdn.microsoft.com/en-us/library/azure/jj157195.aspx ).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>StayProvisioned</maml:name> <maml:description> <maml:para>Keeps the VM provisioned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the deallocation of last VM in a deployment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to shut down.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine object that identifies the virtual machine to shut down.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>StayProvisioned</maml:name> <maml:description> <maml:para>Keeps the VM provisioned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the deallocation of last VM in a deployment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to shut down.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to shut down. Use a wildcard "*" to stop multiple VMs asynchronously. With a wild card, Stop-AzureVM cmdlet calls ShutdownRoles operation (http://msdn.microsoft.com/en-us/library/azure/dn469421.aspx), instead of ShutdownRole operation (http://msdn.microsoft.com/en-us/library/azure/jj157195.aspx ).</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="2"> <maml:name>StayProvisioned</maml:name> <maml:description> <maml:para>Keeps the VM provisioned.</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="3"> <maml:name>Force</maml:name> <maml:description> <maml:para>Allows the deallocation of last VM in a deployment.</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="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service that contains the virtual machine to shut down.</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="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine object that identifies the virtual machine to shut down.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> <dev:type> <maml:name>PersistentVM</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>PipelineVariable</maml:name> <maml:description> <maml:para>Not Specified</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Stop-AzureVM -ServiceName "myservice1" -Name "MyVM"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command shuts down the "MyVM" virtual machine running in the "myservice1" Microsoft Azure service and deprovisions it. If it is the last VM in deployment, then confirmation pop-up window is displayed with a warning that deprovisioning will cause loss deployment VIP.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVM -ServiceName "myservice1" -Name "MyVM" | Stop-AzureVM</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command retrieves the virtual machine object for the VM whose name is "MyVM" and then shuts it down and deprovisions it. If it is the last VM in deployment, then confirmation pop-up window is displayed with a warning that deprovisioning will cause loss deployment VIP.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Stop-AzureVM -ServiceName "myservice1" -Name "MyVM" -StayProvisioned</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command shuts down the "MyVM" virtual machine running in the "myservice1" Microsoft Azure service and keeps the VM provisioned.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Stop-AzureVM -ServiceName "myservice1" -Name "MyVM" -Force</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command shuts down the "MyVM" virtual machine running in the "myservice1" Microsoft Azure service even if it is the last VM in the deployment.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Stop-AzureVM -ServiceName "PSTestService" -Name "*" -Force</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This command shuts down multiple VMs asynchronously in the "PSTestService"</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Test-AzureStaticVNetIP</command:name> <maml:description> <maml:para>Test the availability of a static virtual network IP address, and get a list of suggestion if the queried one not available.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>AzureStaticVNetIP</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Test the availability of a static virtual network IP address, and get a list of suggestion if the queried one not available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-AzureStaticVNetIP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>The Name of a Virtual Network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>The query of static VNet IPAddress.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>VNetName</maml:name> <maml:description> <maml:para>The Name of a Virtual Network.</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="1"> <maml:name>IPAddress</maml:name> <maml:description> <maml:para>The query of static VNet IPAddress.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Update-AzureDisk</command:name> <maml:description> <maml:para>Updates the label of a disk in the Microsoft Azure disk repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>AzureDisk</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Update-AzureDisk cmdlet changes the label associated with a disk in the disk repository of the current Microsoft Azure subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AzureDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the disk in the disk repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies the new label of the disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ResizedSizeInGB</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>DiskName</maml:name> <maml:description> <maml:para>Specifies the name of the disk in the disk repository.</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="true (ByPropertyName)" position="1"> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies the new label of the disk.</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="2"> <maml:name>ResizedSizeInGB</maml:name> <maml:description> <maml:para>Resizes the underlying blob to the indicated size in GB.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DiskContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Update-AzureDisk –DiskName "MyOSDisk" -Label "DoNotUse"</dev:code> <dev:remarks> <maml:para>This command updates the label of the disk named "MyOSDisk" to "DoNotUse".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Update-AzureVM</command:name> <maml:description> <maml:para>Modifies the configuration of a Microsoft Azure virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>AzureVM</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Update-AzureVM cmdlet accepts update information for the specified virtual machine and initiates the update. You can add or remove data disks, modify the cache mode of data or operating system disks, change the network endpoints, or change the size of the virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AzureVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The virtual machine object that includes updated settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the virtual machine to be updated.</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="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The virtual machine object that includes updated settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PersistentVM</command:parameterValue> <dev:type> <maml:name>PersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Specifies the name of the Microsoft Azure service.</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> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName "MySvc1" -Name "MyVM3" ` | Set-AzureVMSize –InstanceSize "Medium" ` | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This example changes the size of the virtual machine "MyVM3", running in "MySvc1", to "Medium".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> C:\PS>Get-AzureVM -ServiceName "MySvc1" -Name "MyVM3" ` | Add-AzureDataDisk -CreateNew -MediaLocation "https://MyaccountStore1.blob.core.azure.com/vhds/MyNewDisk.vhd" -DiskSizeInGB 128 -DiskLabel "Data-128" -LUN 0 ` | Update-AzureVM</dev:code> <dev:remarks> <maml:para>This example adds a new data disk to the virtual machine "MyVM3", running in "MySvc1".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVMConfig</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureVM</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureVMSize</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Update-AzureVMImage</command:name> <maml:description> <maml:para>The Update-AzureVMImage cmdlet updates the properties on an OS or VM image in the image repository. It returns an image object with information about the updated image.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Update</command:verb> <command:noun>AzureVMImage</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AzureVMImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Name of the image to update in the image repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Label</maml:name> <maml:description> <maml:para>The new label of the image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Specifies the End User License Aggreement, recommended value is a URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the OS image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ImageFamily</maml:name> <maml:description> <maml:para>Specifies a value that can be used to group OS or VM images.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublishedDate</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivacyUri</maml:name> <maml:description> <maml:para>Specifies the URI that points to a document that contains the privacy policy related to the OS or VM image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>RecommendedVMSize</maml:name> <maml:description> <maml:para>Specifies the size to use for the virtual machine that is created from the OS or VM image. Values are: "Medium", "Large", and "ExtraLarge", "A5", "A6",, "A7".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="8"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>This is the OS Disk and the Data Disk configuration for the VM Image created using the New-AzureVMImageDiskConfigSet, Set-AzureVMImageOSDiskConfig and Set-AzureVMImageDataDiskConfig cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Language</maml:name> <maml:description> <maml:para>Language for the OS in the VM or OS Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>IconUri</maml:name> <maml:description> <maml:para>Uri to an icon for the OS or VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>SmallIconUri</maml:name> <maml:description> <maml:para>Uri to a small icon for the OS or VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>DontShowInGui</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>ImageName</maml:name> <maml:description> <maml:para>Name of the image to update in the image repository.</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="true (ByPropertyName)" position="1"> <maml:name>Label</maml:name> <maml:description> <maml:para>The new label of the image.</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="true (ByPropertyName)" position="2"> <maml:name>Eula</maml:name> <maml:description> <maml:para>Specifies the End User License Aggreement, recommended value is a URL.</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="true (ByPropertyName)" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the OS image.</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="true (ByPropertyName)" position="4"> <maml:name>ImageFamily</maml:name> <maml:description> <maml:para>Specifies a value that can be used to group OS or VM images.</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>PublishedDate</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue> <dev:type> <maml:name>Nullable`1[DateTime]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>PrivacyUri</maml:name> <maml:description> <maml:para>Specifies the URI that points to a document that contains the privacy policy related to the OS or VM image.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>RecommendedVMSize</maml:name> <maml:description> <maml:para>Specifies the size to use for the virtual machine that is created from the OS or VM image. Values are: "Medium", "Large", and "ExtraLarge", "A5", "A6",, "A7".</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="true (ByValue, ByPropertyName)" position="8"> <maml:name>DiskConfig</maml:name> <maml:description> <maml:para>This is the OS Disk and the Data Disk configuration for the VM Image created using the New-AzureVMImageDiskConfigSet, Set-AzureVMImageOSDiskConfig and Set-AzureVMImageDataDiskConfig cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachineImageDiskConfigSet</command:parameterValue> <dev:type> <maml:name>VirtualMachineImageDiskConfigSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>Language</maml:name> <maml:description> <maml:para>Language for the OS in the VM or OS Image</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="true (ByPropertyName)" position="10"> <maml:name>IconUri</maml:name> <maml:description> <maml:para>Uri to an icon for the OS or VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>SmallIconUri</maml:name> <maml:description> <maml:para>Uri to a small icon for the OS or VM Image</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>DontShowInGui</maml:name> <maml:description> <maml:para> </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="true (ByValue, ByPropertyName)" position="14"> <maml:name>ShowInGui</maml:name> <maml:description> <maml:para>Not Specified</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>OSImageContext</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Update-AzureVMImage -ImageName "Windows-Server-2008-SP2" -Label "DoNotUse"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example updates the image named "Windows-Server-2008-SP2" by changing the image label to "DoNotUse"</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureVMImage | Where-Object {$_.Label -eq "DoNotUse" } | Update-AzureVMImage -Label "Updated"</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------This example gets all the operating system images labeled "DoNotUse" and changes the label to "Updated".</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRegion</command:name> <maml:description> <maml:para> </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb> </command:verb> <command:noun> </command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRegion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Unknown --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\></dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Unknown --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\></dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureServiceExtensionImage</command:name> <maml:description> <maml:para>Get information for the latest available hosted service extension images.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb> </command:verb> <command:noun> </command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get information for the latest available hosted service extension images.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceExtensionImage</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Get-AzureServiceExtensionImage ProviderNameSpace : Microsoft.Windows.Azure.Extensions Type : RDP Version : 1.0 Label : Microsoft Azure Remote Desktop Extension Description : Microsoft Azure Remote Desktop Extension HostingResources : WebOrWorkerRole ThumbprintAlgorithm : sha1 PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PublicConfig"><xs:complexType><xs:sequence><xs:element name="UserName" type="xs:string" minOccurs="1" /><xs:element name="Expiration" type="xs:string" minOccurs="1" /></xs:sequence></xs:complexType></xs:element></xs:schema> PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="PrivateConfig"><xs:complexType><xs:sequence><xs:element name="Password" type="xs:string" /></xs:sequence></xs:complexType></xs:element></xs:schema> OperationDescription : Get-AzureServiceExtensionImage OperationId : ee7f7237-78a6-3819-8529-ede859c51411 OperationStatus : Succeeded</dev:code> <dev:remarks> <maml:para>Description</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>-----------</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unknown</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Remove-AzureVMChefExtension </command:name> <maml:description> <maml:para>This cmdlet deletes the Chef extension applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMChefExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>This cmdlet deletes the Chef extension applied on the VM.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMChefExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Remove-AzureVMChefExtension -VM $vm; </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This cmdlet deletes the Chef extension applied on the VM.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Get-AzureDeploymentEvent </command:name> <maml:description> <maml:para>The Get-AzureDeploymentEvent cmdlet retrieves information regarding Azure-initiated events that impact virtual machines and cloud services, including planned maintenance events, in the provided time window. It returns a list of events that identify the Role Instance or Virtual Machine impacted, the reason for the impact, and the start time of the event.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDeploymentEvent</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>The Get-AzureDeploymentEvent cmdlet retrieves information regarding Azure-initiated events that impact virtual machines and cloud services, including planned maintenance events, in the provided time window. It returns a list of events that identify the Role Instance or Virtual Machine impacted, the reason for the impact, and the start time of the event.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureDeploymentEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Ending time to query deployment events</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Name of the hosted service</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Ending time to query deployment events</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ServiceName</maml:name> <maml:description> <maml:para>Name of the hosted service</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>StartTime</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name> Get-AzureVMChefExtension </command:name> <maml:description> <maml:para>This cmdlet gets the Chef extension (if any) applied on the VM.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMChefExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>This cmdlet gets the Chef extension (if any) applied on the VM.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMChefExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> The cmdlet displays the Chef Extension information on the VM </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVMChefExtension -VM $vm; </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This cmdlet gets the Chef extension (if any) applied on the VM.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name> Set-AzureVMChefExtension </command:name> <maml:description> <maml:para>This cmdlet adds the Chef extension to the VM.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMChefExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>This cmdlet adds the Chef extension to the VM.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMChefExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ValidationPem</maml:name> <maml:description> <maml:para>The Chef validator pem file path</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Validator.pem</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientRb</maml:name> <maml:description> <maml:para>The path to the Chef client.rb.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Client.rb</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>RunList</maml:name> <maml:description> <maml:para>The chef node run list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RunList</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The persistent VM object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Chef Extension version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Latest available Chef Extension version</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ValidationPem</maml:name> <maml:description> <maml:para>The Chef Server Validation Key File Path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Validator.pem</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="true (ByPropertyName)" position="named"> <maml:name>ClientRb</maml:name> <maml:description> <maml:para>The Chef Server Client Config (Client.rb) File Path</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Client.rb</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="true (ByPropertyName)" position="named"> <maml:name>RunList</maml:name> <maml:description> <maml:para>Chef node runlist</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RunList</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="true (ByPropertyName)" position="named"> <maml:name>ChefServerUrl</maml:name> <maml:description> <maml:para>The Chef Server Url</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ChefServerUrl</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" position="named"> <maml:name>DeleteChefConfig</maml:name> <maml:description> <maml:para>DeleteChefConfig Options determines whether Chef configuration files removed when Azure removes the Chef resource extension from the VM. This options is useful during extension update and uninstall process. Default is false</maml:para> </maml:description> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>BootstrapOptions</maml:name> <maml:description> <maml:para>Bootstrap Options in JSON Format</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">BootstrapOptions</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="true (ByPropertyName)" position="named"> <maml:name>ValidationClientName</maml:name> <maml:description> <maml:para>The Chef ValidationClientName, used to determine whether a chef-client may register with a Chef server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">ValidationClientName</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="true (ByPropertyName)" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The Chef Organization name, used to form Validation Client Name</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OrganizationName</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" position="named"> <maml:name>AutoUpdateChefClient</maml:name> <maml:description> <maml:para>Flag to opt for auto chef-client update. Chef-client update is false by default.</maml:para> </maml:description> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" position="named"> <maml:name>Linux</maml:name> <maml:description> <maml:para>Set this parameter for Linux extension</maml:para> </maml:description> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" position="named"> <maml:name>Windows</maml:name> <maml:description> <maml:para>Set this parameter for Windows extension</maml:para> </maml:description> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Set-AzureVMChefExtension -VM $vm -ValidationPem "C:\\myorg-validator.pem" -ClientRb "C:\\client.rb" -RunList "apache" -Windows; </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This cmdlet adds the Chef extension to a windows VM.</maml:para> <maml:para>When the VM comes up, it will be bootstrapped with Chef and have apache running on it.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Set-AzureVMChefExtension -VM $vm -ValidationPem "C:\\myorg-validator.pem" -BootstrapOptions '{"chef_node_name":"your_node_name","chef_server_url":"https://api.opscode.com/organizations/some-org", "validation_client_name":"some-org-validator"}' -RunList "apache" -Windows; </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This cmdlet adds the Chef extension to a windows VM.</maml:para> <maml:para>When the VM comes up, it will be bootstrapped with Chef and have apache running on it, while bootstraping it will refer 'BootstrapOptions' specified in JSON format.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Set-AzureVMChefExtension -VM $vm -ValidationPem "C:\\myorg-validator.pem" -ChefServerUrl "http://ipaddress:port" -ValidationClientName "myorg-validator" -RunList "apache, git" -Windows; </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This cmdlet adds the Chef extension to a windows VM.</maml:para> <maml:para>When the VM comes up, it will be bootstrapped with Chef and have apache and git installed on it.</maml:para> <maml:para>Note that if you dont provide the client.rb, then you will need to provide the chef server url and validation client name</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Set-AzureVMChefExtension -VM $vm -ValidationPem "C:\\myorg-validator.pem" -ChefServerUrl "http://ipaddress:port" -OrganizationName "myorg" -Linux; </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>This cmdlet adds the Chef extension to a Linux VM.</maml:para> <maml:para>When the VM comes up, it will be bootstrapped with Chef.</maml:para> <maml:para>Note that if you dont provide the client.rb, then you will need to provide the chef server url and organization name name</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Get-AzureVMSqlServerExtension </command:name> <maml:description> <maml:para>Gets the settings of the SQL Server extension on a particular VM.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureVMSqlServerExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>This cmdlet gets the settings of the SQL Server extension on a particular VM.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureVMSqlServerExtension</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>VM</maml:name> <maml:description> <maml:para>The virtual machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the Sql Server extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the Sql Server extension.</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="true (ByValue, ByPropertyName)" position="1"> <maml:name>VM</maml:name> <maml:description> <maml:para>The virtual machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName "service" -Name "vmname" | Get-AzureVMSqlServerExtension ExtensionName : SqlIaaSAgent Publisher : Microsoft.SqlServer.Management Version : 1.* State : Enable RoleName : afexttest AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings KeyVaultCredentialSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.KeyVaultCredentialSettings </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Gets the settings of the Sql Server extension on a particular VM using piped input.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVMSqlServerExtension-VM $vm ExtensionName : SqlIaaSAgent Publisher : Microsoft.SqlServer.Management Version : 1.0 State : Enable RoleName : vmname AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings KeyVaultCredentialSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.KeyVaultCredentialSettings </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Gets the settings of the Sql Server extension on a particular VM.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVMSqlServerExtension -VM $vm -Version "1.0" ExtensionName : SqlIaaSAgent Publisher : Microsoft.SqlServer.Management Version : 1.0 State : Enable RoleName : vmname AutoPatchingSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoPatchingSettings AutoBackupSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.AutoBackupSettings KeyVaultCredentialSettings : Microsoft.WindowsAzure.Commands.ServiceManagement.IaaS.Extensions.KeyVaultCredentialSettings </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Gets the settings of the particular version of Sql Server extension on a VM.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> New-AzureVMSqlServerKeyVaultCredentialConfig </command:name> <maml:description> <maml:para>Creates configuration object for SQL Server Azure Key Vault credential</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureVMSqlServerKeyVaultCredentialConfig</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Creates configuration object for SQL Server Azure Key Vault credential</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>New-AzureVMSqlServerKeyVaultCredentialConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Enable is an optional value with a default value of false. If set to true, a SQL Server credential using Azure key vault is created when the configuration is used in Set-AzureVMSqlServerExtension. Otherwise, all SQL Server Azure key vault credential status reporting is disabled. Disabling this feature does not remove previously created SQL Server credential using Azure key vault. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>The name to use when creating the new SQL Server credential. If the operation succeeds, a new SQL Server credential with the given name is created. If a SQL Server credential with similar name already exists, then the operation will fail. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AzureKeyVaultUrl</maml:name> <maml:description> <maml:para>Azure Key Vault absolute URL path to use when creating the SQL Server credential. The Azure key vault must be created before using to create a SQL Server credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ServicePrincipalName</maml:name> <maml:description> <maml:para>Azure key vault client identifier given the principal user access to the Azure key vault set in AzureKeyVaultUrl.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ServicePrincipalSecret</maml:name> <maml:description> <maml:para>Azure key vault principal access secret to the Azure key vault set in AzureKeyVaultUrl.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AzureKeyVaultUrl</maml:name> <maml:description> <maml:para>Azure Key Vault absolute URL path to use when creating the SQL Server credential. The Azure key vault must be created before using to create a SQL Server credential.</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="3"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>The name to use when creating the new SQL Server credential. If the operation succeeds, a new SQL Server credential with the given name is created. If a SQL Server credential with similar name already exists, then the operation will fail. </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="2"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Enable is an optional value with a default value of false. If set to true, a SQL Server credential using Azure key vault is created when the configuration is used in Set-AzureVMSqlServerExtension. Otherwise, all SQL Server Azure key vault credential status reporting is disabled. Disabling this feature does not remove previously created SQL Server credential using Azure key vault. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ServicePrincipalName</maml:name> <maml:description> <maml:para>Azure key vault client identifier given the principal user access to the Azure key vault set in AzureKeyVaultUrl.</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="6"> <maml:name>ServicePrincipalSecret</maml:name> <maml:description> <maml:para>Azure key vault principal access secret to the Azure key vault set in AzureKeyVaultUrl.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>KeyVaultCredentialSettings</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $akvs = New-AzureVMSqlServerKeyVaultCredentialConfig -Enable -CredentialName sqlcredname -AzureKeyVaultUrl "http://myvaultsample.vault.azure.net" -ServicePrincipalName "myvaultsample-principal-client-identifier" -ServicePrincipalSecret $secureSecret Enable : True CredentialName : sqlcredname AzureKeyVaultUrl : http://afSqlKVT.vault.azure.net ServicePrincipalName : dsds-33dd-4d4c-9d2d-42428eeb1fd7 ServicePrincipalSecret : LnT+7aXAdafy1VdSo3z8YnZ5pzGU1h3Y7prrwdlUDVc= </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Creates Azure key vault credential configuration object that can be used to enable and configure KeyVaultCredential using Set-AzureVMSqlServerExtension</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $akvs = New-AzureVMSqlServerKeyVaultCredentialConfig Enable : False CredentialName : AzureKeyVaultUrl : ServicePrincipalName : ServicePrincipalSecret : </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Creates Azure key vault credential configuration object that can be used to disable KeyVaultCredential using Set-AzureVMSqlServerExtension</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name> New-AzureVMSqlServerAutoPatchingConfig </command:name> <maml:description> <maml:para>Creates configuration object for virtual machine automatic patching </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureVMSqlServerAutoPatchingConfig</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Creates configuration object for virtual machine automatic patching</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>New-AzureVMSqlServerAutoPatchingConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Enables or disables automated patching for the virtual machine. Enabling automated patching will put Windows Update into interactive mode. Disabling automated patching does not changes Windows Update settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DayOfWeek</maml:name> <maml:description> <maml:para>Specifies the day of the week when updates should be installed. Can be specified any single day of the week or every day.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowStartingHour</maml:name> <maml:description> <maml:para>Specifies the hour of the day when maintenance window starts. This time defines when updates start installing. Rounded to the hour.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowDuration</maml:name> <maml:description> <maml:para>Specifies the duration of the maintenance window. Automated patching will avoid performing an action that can impact a machine availability outside of that window. Only 30 minutes increments are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PatchCategory</maml:name> <maml:description> <maml:para>Defines if Important updates should be included.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DayOfWeek</maml:name> <maml:description> <maml:para>Specifies the day of the week when updates should be installed. Can be specified any single day of the week or every day.</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>Enable</maml:name> <maml:description> <maml:para>Enables or disables automated patching for the virtual machine. Enabling automated patching will put Windows Update into interactive mode. Disabling automated patching does not changes Windows Update settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowStartingHour</maml:name> <maml:description> <maml:para>Specifies the hour of the day when maintenance window starts. This time defines when updates start installing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindowDuration</maml:name> <maml:description> <maml:para>Specifies the duration of the maintenance window. Automated patching will avoid performing an action that can impact a machine availability outside of that window. Only 30 minutes increments are allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PatchCategory</maml:name> <maml:description> <maml:para>Defines if important updates should be included.</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>Optional</dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AutoPatchingSettings</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> Returns object contains settings for automated patching. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> $aps = New-AzureVMSqlServerAutoPatchingConfig -Enable -DayOfWeek "Thursday" -MaintenanceWindowStartingHour 11 -MaintenanceWindowDuration 120 -PatchCategory "Important" PS C:\> $aps Enable : True DayOfWeek : Thursday MaintenanceWindowStartingHour : 11 MaintenanceWindowDuration : 120 PatchCategory : Important </dev:code> <dev:remarks> <maml:para>This command creates configuration object that can be used to configure automatic patching using Set-AzureVMSqlServerExtension</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureVMSqlServerExtension</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureVMSqlServerExtension</maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name> New-AzureVMSqlServerAutoBackupConfig </command:name> <maml:description> <maml:para>Creates configuration object for SQL Server Automatic Backup </maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureVMSqlServerAutoBackupConfig</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Creates configuration object for SQL Server automatic backup </maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>New-AzureVMSqlServerAutoBackupConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Enables or disables automated backup for the SQL Server Virtual Machine. Enabling automated backup will set a backup schedule for all of your existing and new databases. This will update your Managed Backup settings to follow this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies the storage account to be used to store backups. Default will be storage account associated with the SQL Server VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RetentionPeriod</maml:name> <maml:description> <maml:para>Backup Retention period in days. 1 day minimum, 30 day maximum. Default is 30 days.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>EncryptionEnabled</maml:name> <maml:description> <maml:para>Enable backup encryption. If enabled, the certificate will be automatically generated and stored in the same storage account as the backups, and password protected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to encrypt the certificate that is used to perform SQL Server encrypted backups</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Enables or disables automated backup for the SQL Server Virtual Machine. Enabling automated backup will set a backup schedule for all of your existing and new databases. This will update your Managed Backup settings to follow this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>EncryptionEnabled</maml:name> <maml:description> <maml:para>Enable backup encryption. If enabled, the certificate will be automatically generated and stored in the same storage account as the backups, and password protected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>Password to encrypt the certificate that is used to perform SQL Server encrypted backups</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RetentionPeriod</maml:name> <maml:description> <maml:para>Backup Retention period in days. 1 day minimum, 30 day maximum. Default is 30 days.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageContext</maml:name> <maml:description> <maml:para>Specifies the storage account to be used to store backups. Default will be storage account associated with the SQL Server VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureStorageContext</command:parameterValue> <dev:type> <maml:name>AzureStorageContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $abs = New-AzureVMSqlServerAutoBackupConfig -Enable -RetentionPeriod 10 -StorageUri $storageUrl -StorageKey $storageAccountKeySecure Enable : True EnableEncryption : False RetentionPeriodInDays : 10 </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Creates a auto-backup config object by specifying storage uri and account key.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $abs = New-AzureVMSqlServerAutoBackupConfig -StorageContext $storageContext -Enable -RetentionPeriod 10 Enable : True EnableEncryption : False RetentionPeriodInDays : 10 </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Creates an auto-backup config object by specifying Storage context.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $abs = New-AzureVMSqlServerAutoBackupConfig -StorageContext $storageContext -Enable -RetentionPeriod 10 -EnableEncryption -CertificatePassword $certPasswd Enable : True EnableEncryption : True RetentionPeriodInDays : 10 </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Creates an auto-backup config object by specifying Storage context and enabling encryption option with password.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name> Remove-AzureVMSqlServerExtension </command:name> <maml:description> <maml:para>Remove Azure VM Sql Server extension from a VM object.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureVMSqlServerExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Remove Azure VM Sql Server extension from a VM object.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureVMSqlServerExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The Virtual Machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>The Virtual Machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- v 1.3.0.36 --> <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"> <command:details> <command:name> Set-AzureVMSqlServerExtension </command:name> <maml:description> <maml:para>Configure the Sql Server extension on a VM.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureVMSqlServerExtension</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Configure the Sql Server extension on a VM.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureVMSqlServerExtension</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>VM</maml:name> <maml:description> <maml:para>The Virtual Machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the SQL Server extension that Get-AzureVMSqlServerExtension will get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoBackupSettings</maml:name> <maml:description> <maml:para>Automatic SQL Server backup settings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AutoBackupSettings</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoPatchingSetttings</maml:name> <maml:description> <maml:para>Automatic patching settings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AutoPatchingSetttings</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeyVaultCredentialSettings</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyVaultCredentialSettings</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoBackupSettings</maml:name> <maml:description> <maml:para>Automatic SQL Server backup settings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AutoBackupSettings</command:parameterValue> <dev:type> <maml:name>AutoBackupSettings</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>AutoPatchingSetttings</maml:name> <maml:description> <maml:para>Automatic patching settings</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AutoPatchingSetttings</command:parameterValue> <dev:type> <maml:name>AutoPatchingSetttings</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>KeyVaultCredentialSettings</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyVaultCredentialSettings</command:parameterValue> <dev:type> <maml:name>KeyVaultCredentialSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <maml:description> <maml:para>The specific version of the SQL Server extension that Get-AzureVMSqlServerExtension will get the settings from.</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="true (ByValue, ByPropertyName)" position="1"> <maml:name>VM</maml:name> <maml:description> <maml:para>The Virtual Machine to get the settings from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IPersistentVM</command:parameterValue> <dev:type> <maml:name>IPersistentVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</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 /> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</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 /> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, svc, mgmt, service</maml:para> </maml:alert> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName serviceName -Name vmName | Set-AzureVMSqlServerExtension -AutoPatchingSettings $aps | Update-AzureVM </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Sets auto-patching settings on Azure VM.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName serviceName -Name vmName | Set-AzureVMSqlServerExtension -AutoBackupSettings $abs | Update-AzureVM </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Sets auto-backup settings on Azure VM.</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 3 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName $serviceName -Name $vmName | Set-AzureVMSqlServerExtension -KeyVaultCredentialSettings $akvs | Update-AzureVM Sets SQL Server credential Azure key vault settings </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 4 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName service -Name vmName| Set-AzureVMSqlServerExtension -Disable </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Disables SQL Server VM extension on a given VM</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 5 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureVM -ServiceName service -Name vmName| Set-AzureVMSqlServerExtension -UnInstall </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Uninstalls SQL Server VM extension on a given VM</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |