Networking/Microsoft.WindowsAzure.Commands.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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AzureAccount</command:name> <maml:description> <maml:para>Adds the Azure account to Windows PowerShell</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-AzureAccount cmdlet makes your Azure account and its subscriptions available in Windows PowerShell. It's like logging into your Azure account in Windows PowerShell. To log out of the account, use the Remove-AzureAccount cmdlet.</maml:para> <maml:para>Add-AzureAccount downloads information about your Azure account and saves it in a subscription data file in your roaming user profile. It also gets an access token that allows Windows PowerShell to access your Azure account on your behalf. When the command completes, you can manage your Azure account in Windows PowerShell.</maml:para> <maml:para> There are two different ways to make your Azure account available to Windows PowerShell. You can use the Add-AzureAccount cmdlet, which uses Azure Active Directory (Azure AD) authentication access tokens, or Import-AzurePublishSettingsFile, which uses a management certificate. For guidance on which method to use, see "<maml:navigationLink><maml:linkText>How to: Connect to your subscription</maml:linkText><maml:uri></maml:uri></maml:navigationLink>" (http://azure.microsoft.com/en-us/documentation/articles/install-configure-powershell/#Connect). </maml:para> <maml:para>When you run Add-AzureAccount, it displays an interactive window that prompts you to sign into your Azure account. This sign-in is valid until the access token expires. When it expires, cmdlets that require access to your account prompt you to run Add-AzureAccount again.</maml:para> <maml:para>If you have a Microsoft Organizational account, you can use the -Credential parameter to add the subscriptions associated with your account to Windows PowerShell without an interactive dialog.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>The username and password account credentials used to authenticate with Azure Active Directory. The credentials must be for a Microsoft Organizational account and not another kind of Microsoft account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Environment</maml:name> <maml:description> <maml:para>Specifies an Azure environment for the user account. This parameter is optional. The default is the AzureCloud environment.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. </maml:para> <maml:para>To get the available Azure environments, use the Get-AzureEnvironment cmdlet. To add an environment, use the Add-AzureEnvironment 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="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate location for the subscription data file. This parameter is optional. By default, the subscription data file is saved in your roaming user profile.</maml:para> <maml:para>If you use this parameter to specify an alternate location for the subscription data file, be sure to use the SubscriptionDataFile parameters of cmdlets that access your account. Otherwise, the cmdlets look for your account data in the default location.</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>Credential</maml:name> <maml:description> <maml:para>The username and password account credentials used to authenticate with Azure Active Directory. The credentials must be for a Microsoft Organizational account and not another kind of Microsoft account.</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="false" position="named" aliases=""> <maml:name>Environment</maml:name> <maml:description> <maml:para>Specifies an Azure environment for the user account. This parameter is optional. The default is the AzureCloud environment.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. </maml:para> <maml:para>To get the available Azure environments, use the Get-AzureEnvironment cmdlet. To add an environment, use the Add-AzureEnvironment 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="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate location for the subscription data file. This parameter is optional. By default, the subscription data file is saved in your roaming user profile.</maml:para> <maml:para>If you use this parameter to specify an alternate location for the subscription data file, be sure to use the SubscriptionDataFile parameters of cmdlets that access your account. Otherwise, the cmdlets look for your account data in the default location.</maml:para> </maml:description> <command:parameterValue required="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>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe input to this cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>Add-AzureAccount (and the Azure AD authentication method) takes precedence over Import-AzurePublishSettings (and the management certificate method). If you use Add-AzureAccount even once on your account, the Azure AD authentication method is used and the management certificate is ignored. To remove the Azure AD token and restore the management certificate method, use the Remove-AzureAccount cmdlet. For more information, type: Get-Help Remove-AzureAccount.</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> <maml:alert> <maml:para>The error, "Your credentials have expired. Please use Add-AzureAccount to log in again." indicates that your access token is expired and Windows PowerShell cannot access your Azure account. To restore access to your account, run Add-AzureAccount again.</maml:para> </maml:alert> <maml:alert> <maml:para>The Azure PowerShell account and subscription cmdlets get their data from the subscription data file, not from the live Azure account. If you change your account or subscriptions outside of Windows PowerShell, such as by using the Azure Management Portal, run Add-AzureAccount again to refresh the subscription data file.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Add an account ----------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Add-AzureAccount </dev:code> <dev:remarks> <maml:para>This command adds an Azure account to Windows PowerShell. When you run the command, a windows pops up to request the user name and password of the account. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>---------- Example 2: Use an alternate subscription data file ----------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Add-AzureAccount -SubscriptionDataFile C:\Testing\SDF.xml </dev:code> <dev:remarks> <maml:para>This command uses the SubscriptionDataFile parameter to direct Add-AzureAccount to store the account data in the C:\Testing\SDF.xml file, instead of the default file.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>---------- Example 3: Add a Microsoft Organizational account using -Credential ----------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$credential = Get-Credential PS C:\>Add-AzureAccount -Credential $credential </dev:code> <dev:remarks> <maml:para>This command uses the Credential parameter to provide AAD authentication information on the command line, rather than using the pop-up dialog for AAD authentication.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>---------- Example 4: Add an account in Azure China ----------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Add-AzureAccount -Environment AzureChinaCloud </dev:code> <dev:remarks> <maml:para>This command uses the Environment parameter to add an Azure China account to Windows PowerShell. When you run the command, a windows pops up to request the user name and password of the account.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397618</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAccount</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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureAccount</command:name> <maml:description> <maml:para>Gets Azure accounts that are available to Azure PowerShell.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureAccount cmdlet gets the Azure accounts that are available to Windows PowerShell. To make your accounts available to Windows PowerShell, run the Add-AzureAccount or Import-PublishSettingsFile cmdlets.</maml:para> <maml:para>The Get-AzureEnvironment cmdlet gets environments from your subscription data file, not from Azure. If the subscription data file is outdated, run the Add-AzureAccount or Import-PublishSettingsFile cmdlets to refresh it.This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified account. Type the account name. The Name value is case-sensitive. Wildcards are not permitted. The default is all accounts that are available to Windows PowerShell.</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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) file.</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="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified account. Type the account name. The Name value is case-sensitive. Wildcards are not permitted. The default is all accounts that are available to Windows PowerShell.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe input to this cmdlet</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all accounts</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAccount Name ActiveDirectories ---- ----------------- contosoadmin@outlook.com {{ ActiveDirectoryTenantId = abcde5cd-bcc3-441a-bd86-e6a... contosotest1@outlook.com {{ ActiveDirectoryTenantId = aaeabcde-386c-4466-bf70-794... </dev:code> <dev:remarks> <maml:para>This command gets all accounts associated with the specified user.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get an account by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAccount -Name contosoadmin@outlook.com Name ActiveDirectories ---- ----------------- contosoadmin@outlook.com {{ ActiveDirectoryTenantId = abcde5cd-bcc3-441a-bd86-e6a... </dev:code> <dev:remarks> <maml:para>This command gets the ContosoAdmin account.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397620</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureAccount</command:name> <maml:description> <maml:para>Deletes an Azure account from Windows PowerShell.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureAccount cmdlet deletes an Azure account from your subscription data file and deletes the management certificate or access token that allows Windows PowerShell to access your account on your behalf. This cmdlet does not delete the account from Microsoft Azure, or change the actual account in any way.</maml:para> <maml:para>Using this cmdlet is a lot like logging out of your Azure account. And, if you want to log into the account again, use the Add-AzureAccount or Import-AzurePublishSettingsFile to add the account to Windows PowerShell again.</maml:para> <maml:para>You can also use Remove-AzureAccount cmdlet to change the way the Azure PowerShell cmdlets sign into your Azure account. If your account has both a management certificate from Import-AzurePublishSettingsFile and an access token from Add-AzureAccount, the Azure PowerShell cmdlets use only the access token; they ignore the management certificate. To use the management certificate, run Remove-AzureAccount. When Remove-AzureAccount finds both a management certificate and an access token, it deletes only the access token, instead of deleting the account. The management certificate is still there, so account is still available to Windows PowerShell.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the account to remove. The parameter value is case-sensitive. Wildcard characters are not 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="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureAccount prompts you before deleting the account from Windows PowerShell.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeded and False ($false) if it failed. By default, the cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) file.</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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureAccount prompts you before deleting the account from Windows PowerShell.</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the account to remove. The parameter value is case-sensitive. Wildcard characters are not 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="false" position="4" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeded and False ($false) if it failed. By default, the cmdlet does not return any output.</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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Get-AzureAccount gets account and subscription information from the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) 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="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. Otherwise, it does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete an account</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Remove-AzureAccount -Name admin@contoso.com </dev:code> <dev:remarks> <maml:para>This command deletes the admin@contoso.com from your subscription data file. When the command completes, the account is no longer available to Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397625</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureEnvironment</command:name> <maml:description> <maml:para>Gets Azure environments</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureEnvironment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureEnvironment cmdlet gets the Azure environments that are available to Windows PowerShell.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx). </maml:para> <maml:para>The Get-AzureEnvironment cmdlet gets environments from your subscription data file, not from Azure. If the subscription data file is outdated, run the Add-AzureAccount or Import-PublishSettingsFile cmdlet to refresh it.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureEnvironment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified environment. Type the environment name. The parameter value is case-sensitive. Wildcard characters are not permitted.</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="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the specified environment. Type the environment name. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="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>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>By default, Get-AzureEnvironment returns a custom object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you run Get-AzureEnvironment with the Name parameter, it returns a WindowsAzureEnvironment object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all environments</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureEnvironment EnvironmentName ServiceEndpoint ResourceManagerEndpoint PublishSettingsFileUrl --------------- --------------- ----------------------- ---------------------- AzureCloud https://management.core.wi... https://management.azure.com/ http://go.microsoft.com/fw... AzureChinaCloud https://management.core.ch... https://not-supported-serv... http://go.microsoft.com/fw... </dev:code> <dev:remarks> <maml:para>This command gets all environments that are available to Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get an environment by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureEnvironment -Name AzureCloud Name : AzureCloud PublishSettingsFileUrl : http://go.microsoft.com/fwlink/?LinkID=301775 ServiceEndpoint : https://management.core.windows.net/ ResourceManagerEndpoint : https://management.azure.com/ ManagementPortalUrl : http://go.microsoft.com/fwlink/?LinkId=254433 ActiveDirectoryEndpoint : https://login.windows.net/ ActiveDirectoryCommonTenantId : common StorageEndpointSuffix : core.windows.net StorageBlobEndpointFormat : {0}://{1}.blob.core.windows.net/ StorageQueueEndpointFormat : {0}://{1}.queue.core.windows.net/ StorageTableEndpointFormat : {0}://{1}.table.core.windows.net/ GalleryEndpoint : https://gallery.azure.com/ </dev:code> <dev:remarks> <maml:para>This example gets the AzureCloud environment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all properties of all environments</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureEnvironment | ForEach-Object {Get-AzureEnvironment -Name $_.EnvironmentName} </dev:code> <dev:remarks> <maml:para>This command gets all properties of all environments.</maml:para> <maml:para>The command uses the Get-AzureEnvironment cmdlet to get all Azure environments for this account. Then, it uses the Foreach-Object cmdlet to run a Get-AzureEnvironment command with the Name parameter on each environment. The value of the Name parameter is the EnvironmentName property of each environment.</maml:para> <maml:para>Without parameters, Get-AzureEnvironment gets only selected properties of an environment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397621</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AzureEnvironment</command:name> <maml:description> <maml:para>Creates an Azure environment</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureEnvironment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-AzureEnvironment cmdlet creates a new custom Azure account environment and saves it in your roaming user profile. The cmdlet returns an object that represents the new environment. When the command completes, you can use the environment in Windows PowerShell.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx). </maml:para> <maml:para>Only the Name parameter of this cmdlet is mandatory. If you omit a parameter, its value is null ($null), and the service that uses that endpoint might not function properly. To add or change the value of an environment property, use the Set-AzureEnvironment cmdlet.</maml:para> <maml:para>NOTE: Changing your environment can cause your account to fail. Typically, environments are added only for testing or troubleshooting.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureEnvironment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the environment. This parameter is required. Do not use the names of the default environments, AzureCloud and AzureChinaCloud.</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" aliases=""> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>Specifies the URL of the publish settings files for your account. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</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" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Specifies the URL of the Azure service endpoint. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</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" aliases=""> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>Specifies the URL of the Azure Management Portal in the new environment.</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" aliases=""> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>Specifies the default endpoint of storage services in the new environment.</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" aliases=""> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>Specifies the endpoint for Azure Active Directory authentication in the new environment.</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" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para> Specifies the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </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" aliases=""> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para> Specifies the endpoint for the Azure Resource Manager gallery, which stores resource group gallery templates. </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="6" aliases=""> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>Specifies the endpoint for Azure Active Directory authentication in the new environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="8" aliases=""> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para> Specifies the endpoint for the Azure Resource Manager gallery, which stores resource group gallery templates. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>Specifies the URL of the Azure Management Portal in the new environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the environment. This parameter is required. Do not use the names of the default environments, AzureCloud and AzureChinaCloud.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>Specifies the URL of the publish settings files for your account. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para> Specifies the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Specifies the URL of the Azure service endpoint. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>Specifies the default endpoint of storage services in the new environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Add an Azure environment</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Add-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl https://contoso.com/fwlink/?LinkID=101 -ServiceEndpoint https://contoso.com/fwlink/?LinkID=102 Name : ContosoEnv PublishSettingsFileUrl : https://contoso.com/fwlink/?LinkID=101 ServiceEndpoint : https://contoso.com/fwlink/?LinkID=102 ResourceManagerEndpoint : ManagementPortalUrl : ActiveDirectoryEndpoint : ActiveDirectoryCommonTenantId : StorageEndpointSuffix : StorageBlobEndpointFormat : StorageQueueEndpointFormat : StorageTableEndpointFormat : GalleryEndpoint : </dev:code> <dev:remarks> <maml:para>This command creates the ContosoEnv Azure environment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397619</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureEnvironment</command:name> <maml:description> <maml:para>Changes the properties of an Azure environment</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureEnvironment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureEnvironment cmdlet changes the properties of an Azure environment. It returns an object that represents the environment with its new property values. Use the Name parameter to identify the environment and the other parameters to change property values. You cannot use Set-AzureEnvironment to change the name of an Azure environment.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx). </maml:para> <maml:para>NOTE: Do not change the properties of the AzureCloud or AzureChinaCloud environments. Use this cmdlet to change the values of private environments that you create.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureEnvironment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Identifies the environment that is being changed. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</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" aliases=""> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>Changes the URL for publish settings files in the specified environment. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</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" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Changes the URL of the Azure service endpoint in the specified environment. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</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" aliases=""> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>Changes the URL of the Azure Management Portal to the specified 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="5" aliases=""> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>Changes the default endpoint of storage services in the specified environment.</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" aliases="AdEndpointUrl"> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>Changes the endpoint for Azure Active Directory authentication to the specified 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="True (ByPropertyName)" position="7" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para> Changes the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </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" aliases=""> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para> Changes the endpoint for the Azure Resource Manager gallery to the specified value. The gallery endpoint is the location for resource group gallery templates. </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="6" aliases="AdEndpointUrl"> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>Changes the endpoint for Azure Active Directory authentication to the specified 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="True (ByPropertyName)" position="8" aliases=""> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para> Changes the endpoint for the Azure Resource Manager gallery to the specified value. The gallery endpoint is the location for resource group gallery templates. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>Changes the URL of the Azure Management Portal to the specified 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="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Identifies the environment that is being changed. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>Changes the URL for publish settings files in the specified environment. An Azure publish settings file is an XML file that contains information about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para> Changes the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Changes the URL of the Azure service endpoint in the specified environment. The Azure service endpoint determines whether your application is managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>Changes the default endpoint of storage services in the specified environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Change environment properties</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com" </dev:code> <dev:remarks> <maml:para>This command changes the values of the PublishSettingsFileUrl and StorageEndpoint properties of the ContosoEnv environment.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397629</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureEnvironment</command:name> <maml:description> <maml:para>Deletes an Azure environment from Windows PowerShell</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureEnvironment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureEnvironment cmdlet deletes an Azure environment from your roaming profile so Windows PowerShell can't find it. This cmdlet does not delete the environment from Microsoft Azure, or change the actual environment in any way.</maml:para> <maml:para> An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by 21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see <maml:navigationLink><maml:linkText>Azure Pack</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://www.microsoft.com/en-us/server-cloud/products/windows-azure-pack/default.aspx). </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureEnvironment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the environment to remove. This parameter is required. This parameter value is case-sensitive. Wildcard characters are not permitted.</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" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the environment to remove. This parameter is required. This parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="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>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. Otherwise, it does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete an environment</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Remove-AzureEnvironment -Name ContosoEnv </dev:code> <dev:remarks> <maml:para>This command deletes the ContosoEnv environment from Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete multiple environments</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureEnvironment | Where-Object EnvironmentName -like "Contoso*" | ForEach-Object {Remove-AzureEnvironment -Name $_.EnvironmentName } </dev:code> <dev:remarks> <maml:para>This command deletes environments whose names begin with "Contoso" from Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397626</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzurePublishSettingsFile</command:name> <maml:description> <maml:para>Downloads the publish-settings file for a Microsoft Azure subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzurePublishSettingsFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Get-AzurePublishSettingsFile cmdlet opens your default browser, logs onto your Microsoft Azure account, and automatically downloads a .publishsettings file that contains information and a certificate for your Microsoft Azure subscription. This file is used by the Import-AzureSubscription cmdlet and is an XML file with a ".publishsettings" extension. </maml:para> <maml:para>Security Note: The file downloaded contains an encoded management certificate that serves as the credentials to administer your Microsoft Azure subscriptions and services. Store this file in a secure location or delete after use.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzurePublishSettingsFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>The organization ID to use for federated authentication when displaying the Microsoft Azure Portal</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>Environment</maml:name> <maml:description> <maml:para>The Microsoft Azure environment name to be used. Example AzureCloud</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>Realm</maml:name> <maml:description> <maml:para>The organization ID to use for federated authentication when displaying the Microsoft Azure Portal</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>Environment</maml:name> <maml:description> <maml:para>The Microsoft Azure environment name to be used. Example AzureCloud</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <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, utilities</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-AzurePublishSettingsFile </dev:code> <dev:remarks> <maml:para>This example launches your default browser, connects to your Microsoft Azure account, and then automatically downloads the .publishsettings file for your account. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureSubscription</command:name> <maml:description> <maml:para>Gets Azure subscriptions in the user accounts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureSubscription cmdlet gets the subscriptions in your Azure accounts. You can use this cmdlet to get information about the subscription and to pipe the subscription to other cmdlets.</maml:para> <maml:para>Get-AzureSubscription requires access to your Azure accounts. Before you run Get-AzureSubscription, you must run the Add-AzureAccount cmdlet or the cmdlets that download and install a publish settings file (Get-AzurePublishSettingsFile, Import-AzurePublishSettingsFile.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Gets only the specified subscription. Enter the subscription name. The value is case-sensitive. Wildcard characters are not supported. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts.</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" aliases=""> <maml:name>ExtendedDetails</maml:name> <maml:description> <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Current</maml:name> <maml:description> <maml:para>Gets only the current subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para> <maml:para>You can designate "current" and "default" subscriptions. The "current subscription" is used by default in the current Windows PowerShell session. The "default subscription" is used by default for all Windows PowerShell sessions. The "current subscription" label lets you specify a subscription to be used by default for the current session without changing the "default subscription" for all other sessions.</maml:para> <maml:para>To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ExtendedDetails</maml:name> <maml:description> <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Default</maml:name> <maml:description> <maml:para>Gets only the default subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para> <maml:para>The "default subscription" is the subscription that is used by default for all Windows PowerShell sessions. To use a different subscription as the default only for the current session, set a subscription to "Current". To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ExtendedDetails</maml:name> <maml:description> <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</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" aliases=""> <maml:name>Current</maml:name> <maml:description> <maml:para>Gets only the current subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para> <maml:para>You can designate "current" and "default" subscriptions. The "current subscription" is used by default in the current Windows PowerShell session. The "default subscription" is used by default for all Windows PowerShell sessions. The "current subscription" label lets you specify a subscription to be used by default for the current session without changing the "default subscription" for all other sessions.</maml:para> <maml:para>To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</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" aliases=""> <maml:name>Default</maml:name> <maml:description> <maml:para>Gets only the default subscription. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts. </maml:para> <maml:para>The "default subscription" is the subscription that is used by default for all Windows PowerShell sessions. To use a different subscription as the default only for the current session, set a subscription to "Current". To designate subscriptions as "current" and "default," use the Select-AzureSubscription cmdlet.</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" aliases=""> <maml:name>ExtendedDetails</maml:name> <maml:description> <maml:para>Returns quota properties of the subscription, in addition to the standard properties.</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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Gets a subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Gets only the specified subscription. Enter the subscription name. The value is case-sensitive. Wildcard characters are not supported. By default, Get-AzureSubscription gets all subscriptions in your Azure accounts.</maml:para> </maml:description> <command:parameterValue required="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>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.AzureSubscription</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>By default, Get-AzureSubscription returns a AzureSubscription object.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Common.SubscriptionDataExtended</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the ExtendedDetails parameter, Get-AzureSubscription returns a SubscriptionDataExtended object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all subscriptions</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS>Get-AzureSubscription </dev:code> <dev:remarks> <maml:para>This command gets all subscriptions that are available to Windows PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a subscription by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS>Get-AzureSubscription ???SubscriptionName MyProdSubscription </dev:code> <dev:remarks> <maml:para>This command gets only the "MyProdSubsciption" subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get the default subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS>(Get-AzureSubscription -Default).SubscriptionName ContosoEngineering </dev:code> <dev:remarks> <maml:para>This command gets the name of the default subscription. The command first gets the subscription and then uses the dot method to get the SubscriptionName property of the subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Get the current subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS>Get-AzureSubscription -Current | Format-List -Property SubscriptionName, Certificate </dev:code> <dev:remarks> <maml:para>This command returns a list with the name and certificate of the current subscription. It uses a Get-AzureSubscription command to get the current subscription. Then it pipes the subscription to a Format-List command that displays the selected properties in a list.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Get quota properties</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS>Get-AzureSubscription -SubscriptionDataFile "C:\Temp\MySubscriptions.xml" -ExtendedDetails </dev:code> <dev:remarks> <maml:para>This command gets all properties, included quota properties, of the subscriptions in the C:\Temp\MySubscriptions.xml subscription data file. Use the SubscriptionDataFile parameter if you specified an alternate subscription data file when you ran the Add-AzureAccount or Import-PublishSettingsFile cmdlets.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397623</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-AzurePublishSettingsFile</command:name> <maml:description> <maml:para>Imports a publish-settings file with a certificate to connect to your Microsoft Azure account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>AzurePublishSettingsFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Import-AzurePublishSettingsFile cmdlet imports a .publishsettings file downloaded using the Get-AzurePublishSettingsFile cmdlet. This file contains settings and an encoded certificate that is used to provide management credentials for the Microsoft Azure account. </maml:para> <maml:para>Security Note: The file downloaded contains an encoded management certificate that serves as the credentials to administer Microsoft Azure subscriptions and services. Store this file in a secure location or delete after use.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-AzurePublishSettingsFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>PublishSettingsFile</maml:name> <maml:description> <maml:para>Specifies the full path and filename for the .publishsettings file for the Microsoft Azure 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="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path to a file where the subscription data is stored. This parameter is optional. If it is not provided, the subscription data is imported into a default file in the user's profile.. </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="1" aliases=""> <maml:name>PublishSettingsFile</maml:name> <maml:description> <maml:para>Specifies the full path and filename for the .publishsettings file for the Microsoft Azure 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="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path to a file where the subscription data is stored. This parameter is optional. If it is not provided, the subscription data is imported into a default file in the user's profile.. </maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <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, utilities</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:\> Import-AzurePublishSettingsFile –PublishSettingsFile "C:\Temp\MyAccountName-date-credentials.publishsettings" </dev:code> <dev:remarks> <maml:para>This example imports the "C:\Temp\MyAccountName-date-credentials.publishsettings" file for a Microsoft Azure account, including the encoded certificate used for management of the account. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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:\> Import-AzurePublishSettingsFile –PublishSettingsFile "C:\Temp\MyAccountName-date-credentials.publishsettings" –SubscriptionDataFile c:\Subs\Subscriptions.xml" </dev:code> <dev:remarks> <maml:para>This example imports the "C:\Temp\MyAccountName-date-credentials.publishsettings" file for a Microsoft Azure account, including the encoded certificate used for management of the account. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureSubscription</command:name> <maml:description> <maml:para>Deletes an Azure subscription from Windows PowerShell.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureSubscription cmdlet deletes an Azure subscription from your subscription data file so Windows PowerShell can't find it. This cmdlet does not delete the subscription from Microsoft Azure, or change the actual subscription in any way.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</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" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureSubscription prompts you before deleting the subscription.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Deletes the subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt. By default, Remove-AzureSubscription prompts you before deleting the subscription.</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="4" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the command succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Deletes the subscription from an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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 running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. Otherwise, it does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete a subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> Remove-AzureSubscription -SubscriptionName Test Confirm Are you sure you want to perform this action? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): </dev:code> <dev:remarks> <maml:para>This command deletes the "Test" subscription from the default subscription data file. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete from an alternate subscription data file</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> Remove-AzureSubscription -SubscriptionName Test -SubscriptionDataFile C:\Subs\MySubscriptions.xml -Force </dev:code> <dev:remarks> <maml:para>This command deletes the Test subscription from the MySubscriptions.xml subscription data file. The command uses the Force parameter to suppress the confirmation prompt.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Delete a subscription in a script</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> ...if (Remove-AzureSubscription -SubscriptionName Test -PassThru) {...} </dev:code> <dev:remarks> <maml:para>This command uses the Remove-AzureSubscription command in an If statement. It uses the PassThru parameter, which returns a Boolean value, to determine whether the script block in the If statement is executed.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397627</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-AzureSubscription</command:name> <maml:description> <maml:para>Changes the current and default Azure subscriptions</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Select</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Select-AzureSubscription cmdlet sets and clears the current and default Azure subscriptions.</maml:para> <maml:para>The "current subscription" is the subscription that is used by default in the current Windows PowerShell session. The "default subscription" is used by default in all Windows PowerShell sessions. The "current subscription" label lets you specify a different subscription to be used by default for the current session without changing the "default subscription" for all other sessions.</maml:para> <maml:para>The "default" subscription designation is saved in your subscription data file. The session-specific "current" designation is not saved.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription to change. Enter the subscription name. This parameter value is case-sensitive. Wildcard characters are not permitted.</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" aliases=""> <maml:name>Current</maml:name> <maml:description> <maml:para>Sets the "current" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "current subscription" is the subscription that is used by default in the current Windows PowerShell session.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription to change. Enter the subscription name. This parameter value is case-sensitive. Wildcard characters are not permitted.</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" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</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" aliases=""> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the "default" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "default subscription" is the subscription that is used by default in the all Windows PowerShell sessions, unless a different subscription is set to "current".</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-AzureSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</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" aliases=""> <maml:name>NoCurrent</maml:name> <maml:description> <maml:para>Clears the "current" subscription setting. When no subscription is set to "current," the Azure PowerShell cmdlets use the default subscription.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-AzureSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</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" aliases=""> <maml:name>NoDefault</maml:name> <maml:description> <maml:para>Clears the "default" subscription setting. If there is no "default subscription," the "current subscription" is used by default. When there is no current or default subscription, and you do not identify a subscription, commands that require a subscription fail.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Current</maml:name> <maml:description> <maml:para>Sets the "current" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "current subscription" is the subscription that is used by default in the current Windows PowerShell session.</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" aliases=""> <maml:name>Default</maml:name> <maml:description> <maml:para>Sets the "default" subscription. Use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>The "default subscription" is the subscription that is used by default in the all Windows PowerShell sessions, unless a different subscription is set to "current".</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" aliases=""> <maml:name>NoCurrent</maml:name> <maml:description> <maml:para>Clears the "current" subscription setting. When no subscription is set to "current," the Azure PowerShell cmdlets use the default subscription.</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" aliases=""> <maml:name>NoDefault</maml:name> <maml:description> <maml:para>Clears the "default" subscription setting. If there is no "default subscription," the "current subscription" is used by default. When there is no current or default subscription, and you do not identify a subscription, commands that require a subscription fail.</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" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) when the operation succeeds and False ($false) when it fails. By default, this cmdlet does not return any output.</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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies an alternate subscription data file. Use this parameter if you used the SubscriptionDataFile parameter of Add-AzureAccount or Import-PublishSettingsFile to specify an alternate location for the subscription data file. By default, your subscription data file is saved in your roaming user profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription to change. Enter the subscription name. This parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> </maml:description> <command:parameterValue required="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>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>If you use the PassThru parameter, this cmdlet returns a Boolean value. By default, it does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Set the current subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> Select-AzureSubscription -SubscriptionName ContosoEngineering -Current </dev:code> <dev:remarks> <maml:para>This command makes "ContosoEngineering" the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Set the default description</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> Select-AzureSubscription -SubscriptionName ContosoFinance -SubscriptionDataFile "C:\subs\MySubscriptions.xml" </dev:code> <dev:remarks> <maml:para>This command changes the default subscription to "ContosoFinance." It saves the setting in the Subscriptions.xml subscription data file.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397628</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureSubscription</command:name> <maml:description> <maml:para>Creates or changes an Azure subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureSubscription cmdlet establishes and changes the properties of an Azure subscription. You can use this cmdlet to create a new subscription or change the properties of an existing subscription.</maml:para> <maml:para>To create a new subscription, select a unique name for the value of the SubscriptionName parameter. To change an existing subscription, use the SubscriptionName parameter to identify the subscription.</maml:para> <maml:para>This cmdlet changes the data in the subscription data file that you create when you use the Add-AzureAccount or Import-AzurePublishSettingsFile cmdlet to add an Azure account to Windows PowerShell.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. If an Azure subscription with this name does not exist, this parameter creates a new subscription with the specified name. If the subscription exists, this parameter identifies the subscription and uses the other property values to change it.</maml:para> <maml:para>To get the names of existing Azure subscriptions, use the Get-AzureSubscription 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" aliases=""> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies a management certificate for the subscription. Management certificates are X.509 certificates that are saved as .cer files and uploaded to the Azure Management Portal. The certificate, including its private key, must be installed on the local computer, either in the current user's personal certificate store, or the local machine???s personal certificate store. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">X509Certificate2</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>CurrentStorageAccountName</maml:name> <maml:description> <maml:para>Designates the specified storage account as the "current" storage account for the subscription. Enter the storage account name. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> <maml:para>This parameter does not create a storage account; it just associates the storage account with the subscription. To create a storage account, use the New-AzureStorageAccount 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="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the endpoint for Azure Resource Manager data to the specified value.</maml:para> <maml:para> For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </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" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the custom service endpoint for the management service to the specified value.</maml:para> <maml:para>The service endpoint is the Azure management API endpoint in the Azure environment. You can create custom service endpoints and set a different service endpoint for each 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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Set-AzureSubscription gets and changes data in the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) location for this file.</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" aliases=""> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Specifies the ID of the subscription. To get the subscription ID of an existing Azure subscription, use the Get-AzureSubscription cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. If an Azure subscription with this name does not exist, this parameter creates a new subscription with the specified name. If the subscription exists, this parameter identifies the subscription and uses the other property values to change it.</maml:para> <maml:para>To get the names of existing Azure subscriptions, use the Get-AzureSubscription 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="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Set-AzureSubscription gets and changes data in the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) location for this file.</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" aliases=""> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies a management certificate for the subscription. Management certificates are X.509 certificates that are saved as .cer files and uploaded to the Azure Management Portal. The certificate, including its private key, must be installed on the local computer, either in the current user's personal certificate store, or the local machine???s personal certificate store. </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="false" position="named" aliases=""> <maml:name>CurrentStorageAccountName</maml:name> <maml:description> <maml:para>Designates the specified storage account as the "current" storage account for the subscription. Enter the storage account name. The parameter value is case-sensitive. Wildcard characters are not permitted.</maml:para> <maml:para>This parameter does not create a storage account; it just associates the storage account with the subscription. To create a storage account, use the New-AzureStorageAccount 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="false" position="named" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns True ($true) if the operation succeeds and False ($false) if it fails. By default, this cmdlet does not return any output.</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" aliases=""> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the endpoint for Azure Resource Manager data to the specified value.</maml:para> <maml:para> For more information about Azure Resource Manager, see <maml:navigationLink><maml:linkText>Azure Resource Manager Cmdlets</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394765) and <maml:navigationLink><maml:linkText>Using Windows PowerShell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://go.microsoft.com/fwlink/?LinkID=394767). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>Sets or changes the custom service endpoint for the management service to the specified value.</maml:para> <maml:para>The service endpoint is the Azure management API endpoint in the Azure environment. You can create custom service endpoints and set a different service endpoint for each 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" aliases=""> <maml:name>SubscriptionDataFile</maml:name> <maml:description> <maml:para>Specifies the path and filename of an alternate subscription data file. This parameter is optional. By default, Set-AzureSubscription gets and changes data in the default subscription data file in your roaming user profile. Use this parameter if you used the SubscriptionDataFile parameter in Add-AzureAccount or Import-AzurePublishSettingsFile to specify an alternate (non-default) location for this 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="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Specifies the ID of the subscription. To get the subscription ID of an existing Azure subscription, use the Get-AzureSubscription 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 (ByPropertyName)" position="1" aliases=""> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the subscription name. If an Azure subscription with this name does not exist, this parameter creates a new subscription with the specified name. If the subscription exists, this parameter identifies the subscription and uses the other property values to change it.</maml:para> <maml:para>To get the names of existing Azure subscriptions, use the Get-AzureSubscription 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None or System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the PassThru parameter, this cmdlet returns a Boolean value. By default, this cmdlet does not return any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a new subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$thumbprint = <Certificate Thumbprint> PS C:\>$myCert = Get-Item cert:\\CurrentUser\My\$thumbprint PS C:\>Set-AzureSubscription -SubscriptionName ContosotTest -Certificate $myCert -SubscriptionID 12345 </dev:code> <dev:remarks> <maml:para>These commands create the ContosoTest subscription in the default subscription data file. The commands add a management certificate and subscription ID for the new subscription.</maml:para> <maml:para>When you run the Set-AzureSubscription command, the cmdlet looks for a subscription with the name "ContosoTest". If it doesn't find one, it creates a new subscription with the specified values.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Change an existing subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> $thumbprint = <Thumbprint-2> C:\PS> $differentCert = Get-Item cert:\\CurrentUser\My\$thumbprint C:\PS> Set-AzureSubscription ???SubscriptionName ContosoEngineering -Certificate $differentCert </dev:code> <dev:remarks> <maml:para>These commands are very similar to the commands in Example 1. However, because the SubscriptionName parameter now identifies an existing subscription, Set-AzureSubscription uses the remaining parameters to change the values of the existing subscription rather than creating a new subscription</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Change the service endpoint</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> Set-AzureSubscription ???SubscriptionName ContosoEngineering -ServiceEndpoint "https://management.core.contoso.com" </dev:code> <dev:remarks> <maml:para>This command adds or changes a custom service endpoint for the ContosoEngineering subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Clear property values</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> Set-AzureSubscription ???SubscriptionName ContosoEngineering ???Certificate $null -ResourceManagerEndpoint $null </dev:code> <dev:remarks> <maml:para>This command sets the values of the Certificate and ResourceManagerEndpoint properties to null ($null). This clears the values of those properties without changing other settings.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Use an alternate subscription data file</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> C:\PS> Set-AzureSubscription -SubscriptionName ContosoFinance -SubscriptionDataFile = C:\Azure\SubscriptionData.xml - CurrentStorageAccount ContosoStorage01 </dev:code> <dev:remarks> <maml:para>This command changes the current storage account of the ContosoFinance subscription to ContosoStorage01. The command uses the SubscriptionDataFile parameter to change the data in the C:\Azure\SubscriptionData.xml subscription data file. By default, Set-AzureSubscription uses the default subscription data file in your roaming user profile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397630</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureSubscription</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </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 Help Cmdlet Editor--> <command:details> <command:name>Add-AzureCacheWorkerRole</command:name> <maml:description> <maml:para>Add a dedicated cache worker role to the current service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureCacheWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add a dedicated cache worker role to the current service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureCacheWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the cache worker 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="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of worker role instances to devote to the cache worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the cache worker 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="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of worker role instances to devote to the cache worker role</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>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Basic -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureCacheWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a cache role to the current 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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-AzureMemcacheRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWebRole</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 Help Cmdlet Editor--> <command:details> <command:name>Add-AzureNodeWebRole</command:name> <maml:description> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via IIS</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureNodeWebRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via IIS</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureNodeWebRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the node.js application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in 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="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the node.js application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in 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>WebRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</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</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureNodeWebRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure web role with the default configuration (Name = "Webole1", Instances = 1)</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> -------------- Single Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureNodeWebRole -Name MyWebRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single web role named "MyWebRole" to the current application</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> -------------- Multiple Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureNodeWebRole MyWebRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application, with a role instance count of 2</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</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 Help Cmdlet Editor--> <command:details> <command:name>Add-AzureNodeWorkerRole</command:name> <maml:description> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via node.exe</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureNodeWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a Node.js application which will be hosted in the cloud via node.exe</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureNodeWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the node.js service hosted in the worker 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="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the node.js service hosted in the worker 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>WorkerRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</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</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureNodeWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure Worker role with the default configuration (Name = "WorkerRole1", Instances = 1)</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> -------------- Single Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureNodeWorkerRole MyWorkerRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single worker role named "MyWorkerRole" to the current application</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> -------------- Multiple Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureNodeWorkerRole MyWorkerRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with a role instance count of 2</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</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 Help Cmdlet Editor--> <command:details> <command:name>Add-AzurePHPWebRole</command:name> <maml:description> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via IIS</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzurePHPWebRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via IIS</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzurePHPWebRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the PHP application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in 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="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the PHP application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in 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>WebRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</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>php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzurePHPWebRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure web role with the default configuration (Name = "Webole1", Instances = 1)</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> -------------- Single Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzurePHPWebRole -Name MyWebRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single web role named "MyWebRole" to the current application</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> -------------- Multiple Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzurePHPWebRole MyWebRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application, with a role instance count of 2</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWorkerRole</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 Help Cmdlet Editor--> <command:details> <command:name>Add-AzurePHPWorkerRole</command:name> <maml:description> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via php.exe</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzurePHPWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a PHP application which will be hosted in the cloud via php.exe</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzurePHPWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the PHP service hosted in the worker 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="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the folder name that will contain the scaffolding for the PHP service hosted in the worker 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>WorkerRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</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>php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzurePHPWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure Worker role with the default configuration (Name = "WorkerRole1", Instances = 1)</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> -------------- Single Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzurePHPWorkerRole MyWorkerRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single worker role named "MyWorkerRole" to the current application</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> -------------- Multiple Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzurePHPWorkerRole MyWorkerRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with a role instance count of 2</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWebRole</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 Help Cmdlet Editor--> <command:details> <command:name>Disable-AzureServiceProjectRemoteDesktop</command:name> <maml:description> <maml:para>Disables remote desktop access to a hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>AzureServiceProjectRemoteDesktop</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Disables remote desktop access to a hosted service. You must publish the service using the Publish-AzureServiceProject cmdlet after disabling remote desktop access for the change to take effect.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureServiceProjectRemoteDesktop</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>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-AzureServiceProjectRemoteDesktop</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServicProjecte</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 Help Cmdlet Editor--> <command:details> <command:name>Enable-AzureMemcacheRole</command:name> <maml:description> <maml:para>Enable memcached for the specified web role, configured to communicate with the specified dedicated cache role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureMemcacheRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Enable memcached for the specified web role, configured to communicate with the specified dedicated cache role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureMemcacheRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web role that will use the cache</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>CacheWorkerRoleName</maml:name> <maml:description> <maml:para>The name of the dedicated cache worker role, created with Add-AzureCacheWorkerRole</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>CacheRuntimeVersion</maml:name> <maml:description> <maml:para>The cache runtime 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="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web role that will use the cache</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>CacheWorkerRoleName</maml:name> <maml:description> <maml:para>The name of the dedicated cache worker role, created with Add-AzureCacheWorkerRole</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>CacheRuntimeVersion</maml:name> <maml:description> <maml:para>The cache runtime 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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Enable Caching in web role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Enable-AzureMemcacheRole WebRole1 WorkerRole1</dev:code> <dev:remarks> <maml:para>Enables memcached in web role WebRole1, using dedicated caching role WorkerRole1</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> -------------- Enable Caching in worker role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Enable-AzureMemcacheRole WorkerRole1 CacheWorkerRole</dev:code> <dev:remarks> <maml:para>Enables memcached in worker role WorkerRole1, using dedicated caching role CacheWorkerRole</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> -------------- Enable Caching in web role with runtime version specified -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Enable-AzureMemcacheRole WebRole1 WorkerRole1 1.8.0</dev:code> <dev:remarks> <maml:para>Enables memcached with runtime version 1.8.0 in web role WebRole1, using dedicated caching role WorkerRole1</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureCacheWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzurePHPWebRole</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 Help Cmdlet Editor--> <command:details> <command:name>Enable-AzureServiceProjectRemoteDesktop</command:name> <maml:description> <maml:para>Enables remote desktop access to a hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureServiceProjectRemoteDesktop</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Enables remote desktop access to a hosted service. You must publish the service using the Publish-AzureServiceProject cmdlet after enabling remote desktop access for the change to take effect.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureServiceProjectRemoteDesktop</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username credential you will use when connecting to the azure role instance via RDP. The cmdlet will prompt you for a password.</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>Password</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>The username credential you will use when connecting to the azure role instance via RDP. The cmdlet will prompt you for a 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para> </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> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-AzureServiceProjectRemoteDesktop</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureServiceProjectRoleRuntime</command:name> <maml:description> <maml:para>Get the runtimes available to install in a role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureServiceProjectRoleRuntime</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets the runtimes available to install in a role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureServiceProjectRoleRuntime</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Runtime</maml:name> <maml:description> <maml:para> The name of the runtime. If a runtime specified, only the specific versions of that runtime available to install in your role in Azure 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="1"> <maml:name>Runtime</maml:name> <maml:description> <maml:para> The name of the runtime. If a runtime specified, only the specific versions of that runtime available to install in your role in Azure 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>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</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 Help Cmdlet Editor--> <command:details> <command:name>New-AzureServiceProject</command:name> <maml:description> <maml:para>Creates scaffolding for a new service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureServiceProject</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates the necessary files and configuration for a new Microsoft Azure service in the current directory</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureServiceProject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the service - determines the leftmost portion of the hostname for your service (i.e. <Name>.cloudapp.net), and the directory that will contain your service. Must contain only letters, digits, and the dash character (-).</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>ServiceName</maml:name> <maml:description> <maml:para>The name of the service - determines the leftmost portion of the hostname for your service (i.e. <Name>.cloudapp.net), and the directory that will contain your service. Must contain only letters, digits, and the dash character (-).</maml:para> </maml:description> <command:parameterValue required="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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureServiceProject "MyService1"</dev:code> <dev:remarks> <maml:para>Create scaffolding for a new Microsoft Azure service named "MyService1" in the current directory.</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</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 Help Cmdlet Editor--> <command:details> <command:name>Publish-AzureServiceProject</command:name> <maml:description> <maml:para>Publish the current service to the cloud</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>AzureServiceProject</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Publish the current service to the cloud. Publishing configuration (Subscription, StorageAccountName, Location, Slot) can be specified on the command line, or in local settings via the Set-AzureServiceProject commands.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-AzureServiceProject</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name to be used for the service when publishing to the cloud. The name determines the subdomain label in the cloudapp.net subdomain that will be used to address the service when hosted in Azure (that is, <Name>.cloudapp.net). Any name specified while publishing the service will override the name given when creating the service (see the New-AzureServiceProject commandlet).</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>Package</maml:name> <maml:description> <maml:para>The package file to deploy. Possible value are either a local .cspkg file or a blob uri containing the package. When you use this option, you don't need to specify 'ServiceName' parameter.</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>Configuration</maml:name> <maml:description> <maml:para>The service configuration file. This value is used together with the 'Package' parameter.</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>StorageAccountName</maml:name> <maml:description> <maml:para>The Microsoft Azure storage account name to be used while publishing the service to the cloud. This value is not used until the service is published to the cloud. If no storage account name is provided, the storage account specified by the last call to Set-AzureServiceProject will be used. If no storage account was ever specified, a storage account matching the name of the service will be used. If no such storage account exists, the commandlet will attempt to create a new one - this may fail if a storage account matching the service name exists in another 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>Location</maml:name> <maml:description> <maml:para>The region in which the application will be hosted. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US. If no Location is specified, the location specified in the last call to Set-AzureServiceProject will be used. If no Location was ever specified, the Location will be randomly chosen from 'North Central US' and 'South Central US' locations.</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>Slot</maml:name> <maml:description> <maml:para>The deployment slot to be used for this service. Possible values are 'Staging' and 'Production'. If no slot is specified, the slot provided in the last call to Set-AzureDeploymentSlot will be used. If no slot was ever specified, the 'Production' slot will be 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>Launch</maml:name> <maml:description> <maml:para>If specified, launch a browser window to view the application after it is deployed to Azure</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AffinityGroup</maml:name> <maml:description> <maml:para>The affinity group 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>DeploymentName</maml:name> <maml:description> <maml:para>The deployment 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="false" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name to be used for the service when publishing to the cloud. The name determines the subdomain label in the cloudapp.net subdomain that will be used to address the service when hosted in Azure (that is, <Name>.cloudapp.net). Any name specified while publishing the service will override the name given when creating the service (see the New-AzureServiceProject commandlet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Package</maml:name> <maml:description> <maml:para>The package file to deploy. Possible value are either a local .cspkg file or a blob uri containing the package. When you use this option, you don't need to specify 'ServiceName' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Configuration</maml:name> <maml:description> <maml:para>The service configuration file. This value is used together with the 'Package' parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>StorageAccountName</maml:name> <maml:description> <maml:para>The Microsoft Azure storage account name to be used while publishing the service to the cloud. This value is not used until the service is published to the cloud. If no storage account name is provided, the storage account specified by the last call to Set-AzureServiceProject will be used. If no storage account was ever specified, a storage account matching the name of the service will be used. If no such storage account exists, the commandlet will attempt to create a new one - this may fail if a storage account matching the service name exists in another 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>Value taken from the current service settings or the current publish profile</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>The region in which the application will be hosted. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US. If no Location is specified, the location specified in the last call to Set-AzureServiceProject will be used. If no Location was ever specified, the Location will be randomly chosen from 'North Central US' and 'South Central US' locations.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>value from current service settings</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment slot to be used for this service. Possible values are 'Staging' and 'Production'. If no slot is specified, the slot provided in the last call to Set-AzureDeploymentSlot will be used. If no slot was ever specified, the 'Production' slot will be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Value from current service settings</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para>If specified, launch a browser window to view the application after it is deployed to Azure</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Off</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>The affinity group 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>DeploymentName</maml:name> <maml:description> <maml:para>The deployment name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Publish-AzureServiceProject</dev:code> <dev:remarks> <maml:para>Publishes the current service, using the current service settings and the current Azure publish profile</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</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 Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureService</command:name> <maml:description> <maml:para>Removes the current hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureService</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stops and removes the current hosted service, or the service matching the specified service and subscription name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the service to be removed. If the command is run from a service directory and no name is specified, uses the current 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="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription name that was used to host the service. If no subscription is specified, uses the subscription specified in the last call to Set-AzureDeploymentSubscription. If no subscription was ever specified, uses the first subscription in the current Azure publish profile.</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>Remove service without confirmation prompts</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the service to be removed. If the command is run from a service directory and no name is specified, uses the current 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="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription name that was used to host the service. If no subscription is specified, uses the subscription specified in the last call to Set-AzureDeploymentSubscription. If no subscription was ever specified, uses the first subscription in the current Azure publish profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Force</maml:name> <maml:description> <maml:para>Remove service without confirmation prompts</maml:para> </maml:description> <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>DeleteAll</maml:name> <maml:description> <maml:para>Specify to remove the service and the underlying disk blob(s).</maml:para> </maml:description> <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>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureService</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 Help Cmdlet Editor--> <command:details> <command:name>Set-AzureServiceProject</command:name> <maml:description> <maml:para>Sets default location, subscription, slot, and storage account for the current service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceProject</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Sets the deployment location, slot, storage account, and subscription for the current service. These values are used whenever the service is published to the cloud.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceProject</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>The region in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US.</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>Slot</maml:name> <maml:description> <maml:para>The slot (production or staging) in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Production, 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="named"> <maml:name>Storage</maml:name> <maml:description> <maml:para>The storage account to be used when uploading the service package to the cloud. If the storage account doesn't exist, it will be created when the service is published to the 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="false" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription that will host the service in the cloud. This value is used whenever the service is published to the cloud. You will need to register credentials for this subscription by using the Import-AzurePublishSettingsFile commandlet.</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>Location</maml:name> <maml:description> <maml:para>The region in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Anywhere Asia, Anywhere Europe, Anywhere US, East Asia, East US, North Central US, North Europe, South Central US, Southeast Asia, West Europe, West US.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Slot</maml:name> <maml:description> <maml:para>The slot (production or staging) in which the service will be hosted. This value is used whenever the service is published to the cloud. Possible values are: Production, 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="named"> <maml:name>Storage</maml:name> <maml:description> <maml:para>The storage account to be used when uploading the service package to the cloud. If the storage account doesn't exist, it will be created when the service is published to the 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="false" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription that will host the service in the cloud. This value is used whenever the service is published to the cloud. You will need to register credentials for this subscription by using the Import-AzurePublishSettingsFile commandlet.</maml:para> </maml:description> <command:parameterValue required="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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Basic Settings -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureServiceProject -Location "North Central US" -Slot Production -Storage myStorageAccount -Subscription myAzureSubscription</dev:code> <dev:remarks> <maml:para> Sets the deployment location for the service to the North Central US region. Sets the deloyment slot to Production. Sets the storage account ahat will be used to stage the service definition to 'myStorageAccount'. Sets the subscription that will host the service to 'mySubscription'. Whenever the service is published to the cloud, it will be hosted in a data center in the North Central US region, it will update the deployment slot, and it will use the specified subscription and storage account. </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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-AzurePublishSettingsFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProjectRole</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 Help Cmdlet Editor--> <command:details> <command:name>Set-AzureServiceProjectRole</command:name> <maml:description> <maml:para>Set the number of instances, vm size or the runtime version of a role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureServiceProjectRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Sets the number of role instances for the specified role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureServiceProjectRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</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>Instances</maml:name> <maml:description> <maml:para>The number of role instances for the specified web or worker role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceProjectRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</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>Runtime</maml:name> <maml:description> <maml:para>The runtime to add to the specified role</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 runtime version to add to the specified role</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureServiceProjectRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</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>VMSize</maml:name> <maml:description> <maml:para>The vm size of the role</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="1"> <maml:name>RoleName</maml:name> <maml:description> <maml:para>The name of the web or worker role that is changing</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Instances</maml:name> <maml:description> <maml:para>The number of role instances for the specified web or worker role</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="2"> <maml:name>VMSize</maml:name> <maml:description> <maml:para>The vm size of 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="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Runtime</maml:name> <maml:description> <maml:para>The runtime to add to 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="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>The runtime version to add to 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: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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureServiceProjectRole "MyWebRole" 2</dev:code> <dev:remarks> <maml:para>Sets the number of instances for the web role named 'MyWebRole1' to 2</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> -------------- Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureServiceProjectRole "MyWorkerRole1" 2</dev:code> <dev:remarks> <maml:para>Sets the role instance count for the worker role named "WorkerRole1" to 2</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> -------------- Add Node Runtime -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureServiceProjectRole MyRole1 node 0.6.20</dev:code> <dev:remarks> <maml:para>Sets the node.exe runtime version for role "MyRole1" to 0.6.20.</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> -------------- Change Web Role VM Size to ExtraLarge-------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureServiceProjectRole "MyWebRole" -VMSize ExtraLarge</dev:code> <dev:remarks> <maml:para>Sets VMSize for the web role named 'MyWebRole1' to ExtraLarge</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureNodeWebRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureNodeWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureServiceProjectRoleRuntime</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>Start-AzureEmulator</command:name> <maml:description> <maml:para>Starts both the compute and storage emulators and hosts the current service in the compute emulator</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureEmulator</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Starts both the compute and storage emulators and executes the service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureEmulator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para>Open a new browser window on the service after hosting it in the emulator</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>Mode</maml:name> <maml:description> <maml:para>Emulator mode. Valid values are 'Full' and 'Express'. Default value is 'Express'</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>Launch</maml:name> <maml:description> <maml:para>Open a new browser window on the service after hosting it in the emulator</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>Mode</maml:name> <maml:description> <maml:para>Emulator mode. Valid values are 'Full' and 'Express'. Default value is 'Express'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Express</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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Launch --------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\> Start-AzureEmulator -L</dev:code> <dev:remarks> <maml:para>Executes the service in the Azure emulator and launches a new browser window on the emulated 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>New-AzureServiceProject</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureEmulator</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 Help Cmdlet Editor--> <command:details> <command:name>Start-AzureService</command:name> <maml:description> <maml:para>Starts the specified hosted service in Azure</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureService</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Starts the specified hosted service in the cloud, if the service is in the stopped state. Note that the Publish-AzureServiceProject command will attempt to automatically start the service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to start. If no name is specified, starts the current 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="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment slot (Staging, Production) to start the service in</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>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when starting 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="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to start. If no name is specified, starts the current 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="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The deployment slot (Staging, Production) to start the service 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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when starting 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>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Publish-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureService</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 Help Cmdlet Editor--> <command:details> <command:name>Stop-AzureEmulator</command:name> <maml:description> <maml:para>Stops the compute emulator</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureEmulator</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stops the Microsoft Azure compute emulator. Any services currently executing in the emulator will be removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureEmulator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Launch</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <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>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Start-AzureEmulator</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 Help Cmdlet Editor--> <command:details> <command:name>Stop-AzureService</command:name> <maml:description> <maml:para>Stops the current hosted service</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureService</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stops the current hosted service in the specified slot in Microsoft Azure. If no slot is specified, stops the service in the Production slot</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to stop. If no name is specified, stops the current 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="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot where the service is hosted. If no slot is specified, 'Production' 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="true (ByPropertyName)" position="3"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when stopping 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="1"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>The name of the hosted service to stop. If no name is specified, stops the current 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="true (ByPropertyName)" position="2"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot where the service is hosted. If no slot is specified, 'Production' 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="true (ByPropertyName)" position="3"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to use when stopping 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>node-dev, php-dev</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-AzureService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureService</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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-AzureName</command:name> <maml:description> <maml:para>Tests whether a Microsoft Azure cloud service name, storage service name or service bus namespace name exists or not.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>AzureName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>If the name exists, the cmdlet returns $True. If the name does not exist, it returns $False.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies to test for an existing cloud service.</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="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the cloud service to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies to test for an existing storage service.</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="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the storage account to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ServiceBusNamespace</maml:name> <maml:description> <maml:para>Specifies to test for an existing service bus namespace.</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="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the service bus namespace to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-AzureName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Website</maml:name> <maml:description> <maml:para>Specifies to test for an existing website.</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="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the service bus namespace to test.</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="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the service or storage account to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies to test for an existing service 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:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Storage</maml:name> <maml:description> <maml:para>Specifies to test for an existing 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:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>ServiceBusNamespace</maml:name> <maml:description> <maml:para>Specifies to test for an existing service bus namespace.</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" aliases=""> <maml:name>Website</maml:name> <maml:description> <maml:para>Specifies to test for an existing website.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <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, utilities</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> C:\PS>Test-AzureName –Service "MyNameService1" </dev:code> <dev:remarks> <maml:para>This command tests to see if the "MyNameService1" is an existing Microsoft Azure cloud service name. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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> C:\PS>Test-AzureName –Storage "mystorename1" </dev:code> <dev:remarks> <maml:para>This command tests to see if the "mystorename1" is an existing Microsoft Azure storage service name. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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> C:\PS>Test-AzureName –ServiceBusNamespace "mynamespace" </dev:code> <dev:remarks> <maml:para>This command tests to see if the "mynamespace" is an existing Microsoft Azure service bus namespace name. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-AzureServiceProjectPackage</command:name> <maml:description> <maml:para>Packages the service project into Microsoft Azure cloud package (*.cspkg).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>AzureServiceProjectPackage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Packages the service project into Microsoft Azure cloud package (*.cspkg).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AzureServiceProjectPackage</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <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, utilities</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> C:\PS\MyAzureServiceProject>Save-AzureServiceProjectPackage </dev:code> <dev:remarks> <maml:para>This command Creates *.cspgk for MyAzureServiceProject service project.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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 Help Cmdlet Editor--> <command:details> <command:name>Add-AzureWebRole</command:name> <maml:description> <maml:para>Creates scaffolding for a custom web role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureWebRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a custom web role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureWebRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in 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="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</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>TemplateFolder</maml:name> <maml:description> <maml:para>The web role scaffolding template folder to use</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the web role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the web role, default is WebRole# Where # is the number of web roles in 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>WebRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this web role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TemplateFolder</maml:name> <maml:description> <maml:para>The web role scaffolding template folder 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>WebRole1</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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWebRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure web role with the default configuration (Name = "Webole1", Instances = 1)</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> -------------- Single Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWebRole -Name MyWebRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single web role named "MyWebRole" to the current application</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> -------------- Multiple Instance Web Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWebRole MyWebRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application, with a role instance count of 2</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> -------------- Create web role with custom scaffolding -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWebRole MyWebRole -TemplateFolder .\MyWebTemplateFolder</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new web role named "MyWebRole" to the current application with MyWebTemplateFolder as scaffolding template</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWorkerRole</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 Help Cmdlet Editor--> <command:details> <command:name>Add-AzureWorkerRole</command:name> <maml:description> <maml:para>Creates scaffolding for a custom worker role</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureWorkerRole</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates scaffolding for a custom worker role</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureWorkerRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the worker role, default is WorkerRole# Where # is the number of Worker roles in 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="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</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>TemplateFolder</maml:name> <maml:description> <maml:para>The scaffolding template folder used to create the worker role</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the worker role, determines the name of the directory containing the scaffolding for the custom application that will be hosted in the worker role, default is WorkerRole# Where # is the number of Worker roles in 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>WorkerRole1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Instances</maml:name> <maml:description> <maml:para>The number of role instances for this worker role, default is 1</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TemplateFolder</maml:name> <maml:description> <maml:para>The scaffolding template folder used to create the worker 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>WorkerRole1</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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Default -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWorkerRole</dev:code> <dev:remarks> <maml:para>Adds a Microsoft Azure worker role with the default configuration (Name = "Workerole1", Instances = 1)</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> -------------- Single Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWorkerRole -Name MyWorkerRole</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a single worker role named "MyWorkerRole" to the current application</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> -------------- Multiple Instance Worker Role -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWorkerRole MyWorkerRole -I 2</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with a role instance count of 2</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> -------------- Create worker role with custom scaffolding -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-AzureWorkerRole MyWorkerRole -TemplateFoldr .\MyWorkerRoleTemplate</dev:code> <dev:remarks> <maml:para>Adds scaffolding for a new worker role named "MyWorkerRole" to the current application, with custom scaffolding .\MyWorkerRoleTemplate</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWorkerRole</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 Help Cmdlet Editor--> <command:details> <command:name>New-AzureRoleTemplate</command:name> <maml:description> <maml:para>Creates azure web and worker role template</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--New copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRoleTemplate</command:noun> <!--New Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates azure web and worker role template</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRoleTemplate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Web</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create web role template folder</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Worker</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create worker role template folder</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Output</maml:name> <maml:description> <maml:para>The output path of generated template</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="1"> <maml:name>Web</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create web role template folder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Worker</maml:name> <maml:description> <maml:para>Indicates that cmdlet should create web role template folder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Output</maml:name> <maml:description> <maml:para>The output path of generated template</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>.\[Web][Worker]RoleTemplate</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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Add web role template -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureRoleTemplate -Web</dev:code> <dev:remarks> <maml:para>Create new azure web role template in folder called WebRoleTemplate in the current directory</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> -------------- Add worker role template -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureRoleTemplate -Worker</dev:code> <dev:remarks> <maml:para>Create new azure worker role template in folder called WorkerRoleTemplate in the current directory</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> -------------- Add Web role template in output folder-------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureRoleTemplate -Web -Output C:\MyWebRoleTemplate</dev:code> <dev:remarks> <maml:para>Create new azure web role template in in MyWebRoleTemplate</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureServiceProject</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWorkerRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureWebRole</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureSBLocation</command:name> <maml:description> <maml:para>Get the Microsoft Azure regions that may be used to create new Microsoft Azure ServiceBus namespaces</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSBLocation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get the Microsoft Azure regions that may be used to create new Microsoft Azure ServiceBus namespaces</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSBLocation</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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBNamespace</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureSBNamespace</command:name> <maml:description> <maml:para>Get information about existing Microsoft Azure ServiceBus namespaces</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSBNamespace</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>List current Microsoft Azure Namespaces or get details about a particular Microsoft Azure ServiceBus namespace</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSBNamespace</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the ServiceBus 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the ServiceBus 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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- List namespaces -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSBNamespace</dev:code> <dev:remarks> <maml:para>List all current Microsoft Azure ServiceBus namespaces</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> -------------- Get ServiceBus namespace detail -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSBNamespace myNamespace</dev:code> <dev:remarks> <maml:para>Get details information about the Microsoft Azure ServiceBus namespace 'myNamespace'</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBNamespace</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 Help Cmdlet Editor--> <command:details> <command:name>New-AzureSBNamespace</command:name> <maml:description> <maml:para>Create a new Microsoft Azure ServiceBus namespace</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSBNamespace</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create a new Microsoft Azure ServiceBus namespace</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSBNamespace</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the namespace 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="true (ByPropertyName)" position="2"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to create the namespace in</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>CreateACSNamespace</maml:name> <maml:description> <maml:para>Create assosciated ACS namespace as well</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>NamespaceType</maml:name> <maml:description> <maml:para>Choose if the Namespace will be used for Messaging or Notification Hubs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NamespaceType</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>The name of the namespace 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="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location to create the namespace 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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CreateACSNamespace</maml:name> <maml:description> <maml:para>Create assosciated ACS namespace as well</maml:para> </maml:description> <command:parameterValue required="false" 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="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>NamespaceType</maml:name> <maml:description> <maml:para>Choose if the Namespace will be used for Messaging or Notification Hubs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NamespaceType</command:parameterValue> <dev:type> <maml:name>NamespaceType</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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureSBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</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 Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureSBNamespace</command:name> <maml:description> <maml:para>Delete a WindowsAzure ServiceBus namespace and all associated objects</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSBNamespace</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Delete a WindowsAzure ServiceBus namespace and all associated objects</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSBNamespace</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Microsoft Azure ServiceBus namespace to remove</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>The name of the Microsoft Azure ServiceBus namespace 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: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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureSBLocation</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Azure-SBNamespace</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBNamespace</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 Help Cmdlet Editor--> <command:details> <command:name>New-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Creates new Service Bus authorization rule</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates new Service Bus authorization rule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSBAuthorizationRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</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>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary 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="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</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>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Creates new authorization rule with generated primary key -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Send")</dev:code> <dev:remarks> <maml:para>Creates new authorization rule on namespace level with Send permission</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Creates new authorization rule providing primary key -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Manage", "Listen", "Send") -EntityName MyEntity -EntityType Queue -PrimaryKey P+lL/Mnd2Z9sj5hwMrRyAxQDdX8RHfbdqU2eIAqs1rc=</dev:code> <dev:remarks> <maml:para>Creates new authorization rule on MyEntity Queue level with all permissions</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-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBAuthorizationRule</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 Help Cmdlet Editor--> <command:details> <command:name>Set-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Updates existing Service Bus authorization rule</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Updates existing Service Bus authorization rule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSBAuthorizationRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</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>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary 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="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions (Send, Manage, Listen)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature primary key. Will be generated if not provided</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>SecondaryKey</maml:name> <maml:description> <maml:para>The Shared Access Signature secondary key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Renew primary key for authorization rule at namespace level -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Send")</dev:code> <dev:remarks> <maml:para>The primary key is renewed</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Update authorization rule permission -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -Permission $("Listen", "Send") -EntityName MyEntity -EntityType Queue</dev:code> <dev:remarks> <maml:para>Updates the permissions</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-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureSBAuthorizationRule</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 Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Removes existing Service Bus authorization rule</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Removes existing Service Bus authorization rule</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSBAuthorizationRule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Remove authorization rule at namespace level -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace</dev:code> <dev:remarks> <maml:para>Removes authorization rule MyRule from MyNamespace</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Remove authorization rule for a Queue -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace -EntityName MyEntity -EntityType Queue</dev:code> <dev:remarks> <maml:para>Removes authorization rule called MyRule for a MyEntity Queue on MyNamespace</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-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSBAuthorizationRule</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureSBAuthorizationRule</command:name> <maml:description> <maml:para>Gets Service bus authorization rules</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSBAuthorizationRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets Service bus authorization rules</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSBAuthorizationRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the search will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to search for rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions to filter (Send, Manage, Listen). This uses exact match</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureSBAuthorizationRule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the search will be on the namespace level</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>Permission</maml:name> <maml:description> <maml:para>The authorization permissions to filter (Send, Manage, Listen). This uses exact match</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The unique authorization rule 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="Named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>The namespace name to apply the authorization rule. If no EntityName provided the rule will be on the namespace level</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>EntityName</maml:name> <maml:description> <maml:para>The entity name to apply rule at.</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>EntityType</maml:name> <maml:description> <maml:para>The entity type (Queue, Topic, Relay, NotificationHub).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ServiceBusEntityType</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The authorization permissions to filter (Send, Manage, Listen). This uses exact match</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights[]</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get authorization rule at namespace level -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Namespace MyNamespace</dev:code> <dev:remarks> <maml:para>Gets all available authorization rules at MyNamespace</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get authorization rule for a Queue -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Namespace MyNamespace -EntityName MyEntity -EntityType Queue</dev:code> <dev:remarks> <maml:para>Gets all available authorization rules a MyEntity Queue on MyNamespace</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get authorization rule by name -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Name MyRule -Namespace MyNamespace</dev:code> <dev:remarks> <maml:para>Gets an authorization rule called MyRule on MyNamespace level</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Get authorization rule by permisssion -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSBAuthorizationRule -Namespace MyNamespace -Permission $("Send")</dev:code> <dev:remarks> <maml:para>Gets all authorization rules that have send permission on namespace level</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>Remove-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureSBAuthorizationRule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureSBAuthorizationRule</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureStoreAddOn</command:name> <maml:description> <maml:para>Gets all the available Microsoft Azure Store Add-Ons for purchasing or the existing add-on instances on the current subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureStoreAddOn</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets all the available Microsoft Azure Store Add-Ons for purchasing or the existing add-on instances on the current subscription</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureStoreAddOn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ListAvailable</maml:name> <maml:description> <maml:para>If specified, the cmdlet will get available Microsoft Azure Store Add-Ons for purchasing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Country</maml:name> <maml:description> <maml:para>If specified, only return the Microsoft Azure Store add-on instances available in that Country. Default is "US"</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>Name</maml:name> <maml:description> <maml:para>If specified, returns the add-on instance that matches this 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>ListAvailable</maml:name> <maml:description> <maml:para>If specified, the cmdlet will return all the available Microsoft Azure Store Add-Ons for purchasing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Country</maml:name> <maml:description> <maml:para>If specified, only return the Azure Store add-on instances available in that Country. Default is "US"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Name</maml:name> <maml:description> <maml:para>If specified, returns the add-on instance that matches this 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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get available Microsoft Azure Store Add-Ons for purchasing -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureStoreAddOn -ListAvailable</dev:code> <dev:remarks> <maml:para>Get all the available Microsoft Azure Store Add-Ons for purchasing in US</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> -------------- Get available Microsoft Azure Store Add-Ons in CH -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureStoreAddOn -ListAvailable -Country CH</dev:code> <dev:remarks> <maml:para>Get all the available Microsoft Azure Store Add-Ons for purchasing in CH</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> -------------- Get all purchased add-on instances on current subscription -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureStoreAddOn</dev:code> <dev:remarks> <maml:para>Get all the purchased add-on instances on the current subscription</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> -------------- Get MyAddOn from the purcahsed add-on instance in current subscription -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureStoreAddOn -Name MyAddOn</dev:code> <dev:remarks> <maml:para>Get MyAddOn from the current subscription</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> </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 Help Cmdlet Editor--> <command:details> <command:name>New-AzureStoreAddOn</command:name> <maml:description> <maml:para>Purchases a new add-on instance from Microsoft Azure Store</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureStoreAddOn</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Purchases a new add-on instance from Microsoft Azure Store</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureStoreAddOn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the add-on instance</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>Addon</maml:name> <maml:description> <maml:para>The addon id</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>Plan</maml:name> <maml:description> <maml:para>The plan id</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>Location</maml:name> <maml:description> <maml:para>The add-on instance location</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>PromotionCode</maml:name> <maml:description> <maml:para>The promotion code</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>The name of the add-on instance</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>Addon</maml:name> <maml:description> <maml:para>The addon id</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>Plan</maml:name> <maml:description> <maml:para>The plan id</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>Location</maml:name> <maml:description> <maml:para>The add-on instance location</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>PromotionCode</maml:name> <maml:description> <maml:para>The promotion code</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Purchase an add-on instance -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureStoreAddOn MyAddOn AddonId PlanId "West US"</dev:code> <dev:remarks> <maml:para>Purchases AddOnId and call it MyAddOn with plan PlanId in West US location</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> -------------- Purchase an add-on instance with promotion code-------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureStoreAddOn MyAddOn AddonId PlanId "West US" MyPromoCode</dev:code> <dev:remarks> <maml:para>Purchases AddOnId and call it MyAddOn with plan PlanId and promotion code MyPromoCode in West US location</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> </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 Help Cmdlet Editor--> <command:details> <command:name>Set-AzureStoreAddOn</command:name> <maml:description> <maml:para>Updates an existing add-on instance from current subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureStoreAddOn</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Updates an existing add-on instance from current subscription</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureStoreAddOn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the add-on instance</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>Plan</maml:name> <maml:description> <maml:para>The plan id</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>PromotionCode</maml:name> <maml:description> <maml:para>The promotion code</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>PassThru</maml:name> <maml:description> <maml:para>If specified, the cmdlet return true is succeed and false in failure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</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>The name of the add-on instance</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>Plan</maml:name> <maml:description> <maml:para>The plan id</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>PromotionCode</maml:name> <maml:description> <maml:para>The promotion code</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>PassThru</maml:name> <maml:description> <maml:para>If specified, the cmdlet return true is succeed and false in failure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Update MyAddOn add-on instance -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureStoreAddOn MyAddOn NewPlanId </dev:code> <dev:remarks> <maml:para>Updated MyAddOn with plan NewPlanId</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> -------------- Update an add-on instance with promotion code-------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureStoreAddOn MyAddOn NewPlanId MyPromoCode</dev:code> <dev:remarks> <maml:para>Updates MyAddOn with plan NewPlanId and promotion code MyPromoCode</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> </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 Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureStoreAddOn</command:name> <maml:description> <maml:para>Removes an existing add-on instance</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureStoreAddOn</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Removes an existing add-on instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureStoreAddOn</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the add-on instance</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>The name of the add-on instance</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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:alertRemove> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertRemove> <command:examples> <command:example> <maml:title> -------------- Remove MyAddOn add-on instance -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureStoreAddOn MyAddOn</dev:code> <dev:remarks> <maml:para>Removes MyAddOn add-on instance from current subscription</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> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureWebsite</command:name> <maml:description> <maml:para>Gets Azure websites in the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebsite</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureWebsite cmdlet gets information about Azure websites in the current subscription. </maml:para> <maml:para>By default, Get-AzureWebsite gets all Azure websites in the current subscription and returns an object that provides basic information about the sites. When you use the Name parameter, Get-AzureWebsite returns an object with extensive information, including configuration details.</maml:para> <maml:para> The current subscription is the subscription that is designated as "current." To find the current subscription, use the Current parameter of the <maml:navigationLink><maml:linkText>Get-AzureSubscription</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. To change the current subscription, use the <maml:navigationLink><maml:linkText>Select-AzureSubscription</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets detailed configuration information about the specified website. Enter the name of one website in the subscription. By default, Get-AzureWebsite gets all websites in the current subscription. The Name value does not support wildcard characters.</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" aliases=""> <maml:name>Slot</maml:name> <maml:description> <maml:para> Gets the specified deployment slot of the website. Enter the slot name, such as "Staging" or "Production". For more information about deployment slots, see <maml:navigationLink><maml:linkText>Staged Deployment on Microsoft Azure Web Sites</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. To add a deployment slot to an existing Azure website, use the Set-AzureWebsite cmdlet. </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="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets detailed configuration information about the specified website. Enter the name of one website in the subscription. By default, Get-AzureWebsite gets all websites in the current subscription. The Name value does not support wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>Slot</maml:name> <maml:description> <maml:para> Gets the specified deployment slot of the website. Enter the slot name, such as "Staging" or "Production". For more information about deployment slots, see <maml:navigationLink><maml:linkText>Staged Deployment on Microsoft Azure Web Sites</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. To add a deployment slot to an existing Azure website, use the Set-AzureWebsite 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.Site</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>By default, Get-AzureWebsite returns an array of Site objects.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.SiteWithConfig</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>When you use the Name parameter, Get-AzureWebsite returns a SiteWithConfig object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all websites in the subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureWebsite </dev:code> <dev:remarks> <maml:para>This command gets all Azure websites in the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a website by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureWebsite -Name ContosoWeb </dev:code> <dev:remarks> <maml:para>This command gets detailed information about the ContosoWeb Azure website, including configuration information. When you use the Name parameter, Get-AzureWebsite returns a SiteWithConfig object with extended information about the website.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get detailed information about all websites</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureWebsite | ForEach-Object {Get-AzureWebsite -Name $_.Name} </dev:code> <dev:remarks> <maml:para>This command gets detailed information about all websites in the subscription. It uses a Get-AzureWebsite command to get all websites and then uses the ForEach-Object cmdlet to get each website by name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Get information about a deployment slot</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureWebsite -Name ContosoWeb -Slot Staging </dev:code> <dev:remarks> <maml:para>This command gets the Staging deployment slot of the ContosoWeb website. Deployment slots let you test different versions of your Azure website without releasing them to the public.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Get website instances</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>(Get-AzureWebsite -Name ContosoWeb).Instances InstanceId ---------- 2d8e712fb8f85d061c30fd793a534e6700a175f9a9ab12ca55cb3b0edfcc10ee 5834916b8cef49249b18187708223a33fbbc4352d33b48369f3166644bdd3445 PS C:\>(Get-AzureWebsite -Name ContosoWeb).Instances.Count 2 </dev:code> <dev:remarks> <maml:para>The commands in this example use the Instances property of an Azure website to get information about currently running website instances. </maml:para> <maml:para>The first command gets the instance IDs of all currently running instances of a website. The second command gets the number of running instances of the website. (You can use the Count property on any array.)</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureWebsiteMetric</command:name> <maml:description> <maml:para>Gets metrics for Azure website in the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebsiteMetricMetric</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureWebsiteMetric cmdlet gets information about metrics on Azure web hosting plans in subscription. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebsiteMetricMetric</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter the name of one web site in the subscription. The Name value does not support wildcard characters.</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" aliases=""> <maml:name>MetricNames</maml:name> <maml:description> <maml:para>List of metrics to return. If empty returns all</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" aliases=""> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start time from which to returns metrics.</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" aliases=""> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End time from which to returns metrics.</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" aliases=""> <maml:name>TimeGrain</maml:name> <maml:description> <maml:para>Time grain at which to return metrics. Supported values are Minute(PT1M), Hour(PT1H) - default, Day(P1D).</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" aliases=""> <maml:name>InstanceDetails</maml:name> <maml:description> <maml:para>Include details per instance level. If the web hosting plan runs on two or more machines returns details metrics for each machine.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases=""> <maml:name>SlotView</maml:name> <maml:description> <maml:para>Represent the metrics for the hostnames that receive the traffic at the current slot. If swap occured in the middle of the period mereics will be merged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.MetricResponse</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>By default, Get-AzureWebsiteMetric returns an array of MetricResponse objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Gets metrics for last 3 hours on per instance level for a site</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$metrics = Get-AzureWebsiteMetric -Name webSiteName -StartDate (get-date).AddHours(-3) -MetricNames "Requests" -InstanceDetails -SlotView -TimeGrain "PT1M" $metrics[1].Data Name : Requests Unit : Count StartTime : 8/11/2014 7:05:00 AM EndTime : 8/11/2014 5:06:01 PM TimeGrain : PT1M PrimaryAggregationType : Instance Values : {Time:8/11/2014 7:05:00 AM, Total:4, Min:, Max:, Time:8/11/2014 7:06:00 AM, Total:3, Min:, Max:, Time:8/11/2014 7:07:00 AM, Total:3, Min:, Max:, Time:8/11/2014 7:08:00 AM, Total:12, Min:, Max:...} $metrics[1].Data.Values | ft TimeCreated Total Minimum Maximum Count InstanceName ----------- ----- ------- ------- ----- ------------ 8/11/2014 7:05:00 AM 4 1 RD00155DC24599 8/11/2014 7:06:00 AM 3 1 RD00155DC24599 8/11/2014 7:07:00 AM 3 1 RD00155DC24599 8/11/2014 7:08:00 AM 12 1 RD00155DC24599 8/11/2014 7:09:00 AM 37 1 RD00155DC24599 8/11/2014 7:10:00 AM 9 1 RD00155DC24599 </dev:code> <dev:remarks> <maml:para>This command gets metrics for last 3 hours on per instance level for a site.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureWebHostingPlan</command:name> <maml:description> <maml:para>Gets Azure web hosting plan in the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebHostingPlan</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureWebHostingPlan cmdlet gets information about Azure web hosting plans in subscription. </maml:para> <maml:para>By default, Get-AzureWebHostingPlan gets all Azure hosting plans in the current subscription and returns an object that provides basic information about the plans. When you use the WebSpace and Name parameters, Get-AzureWebHostingPlan returns a specific object.</maml:para> <maml:para> The current subscription is the subscription that is designated as "current." To find the current subscription, use the Current parameter of the <maml:navigationLink><maml:linkText>Get-AzureSubscription</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. To change the current subscription, use the <maml:navigationLink><maml:linkText>Select-AzureSubscription</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. </maml:para> <maml:para>This topic describes the cmdlet in the 0.8.2 version of the Microsoft Azure PowerShell module. To find the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebHostingPlan</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>WebSpaceName</maml:name> <maml:description> <maml:para>Enter the name of one webspaces in the subscription. By default, Get-AzureWebHostingPlan gets all plans in the current subscription. The WebSpaceName value does not support wildcard characters.</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter the name of one plan in the subscription. By default, Get-AzureWebHostingPlan gets all websites in the specified web space. The Name value does not support wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.WebHostingPlan</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>By default, Get-AzureWebHostingPlan returns an array of WebHostingPlan objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all web hosting plans in the subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureWebHostingPlan Name : Default1 SKU : Basic WorkerSize : Small NumberOfWorkers : 1 CurrentWorkerSize : Small CurrentNumberOfWorkers : 1 Status : Ready WebSpace : eastuswebspace Name : Default0 SKU : Free WorkerSize : Small NumberOfWorkers : 0 CurrentWorkerSize : Small CurrentNumberOfWorkers : 0 Status : Ready </dev:code> <dev:remarks> <maml:para>This command gets all Azure web hosting plans in the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a specific web hosting plans in the subscription</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureWebHostingPlan westeuropewebspace Default0 Name : Default0 SKU : Free WorkerSize : Small NumberOfWorkers : 0 CurrentWorkerSize : Small CurrentNumberOfWorkers : 0 Status : Ready WebSpace : westeuropewebspace </dev:code> <dev:remarks> <maml:para>This command gets single Azure web hosting plans in the current subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureWebHostingPlanMetric</command:name> <maml:description> <maml:para>Gets metrics for web hsoting plan.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebHostingPlanMetricMetric</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureWebHostingPlanMetric cmdlet gets information about metrics on Azure web hosting plans in subscription. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebHostingPlanMetricMetric</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>WebSpaceName</maml:name> <maml:description> <maml:para>Enter the name of one webspaces in the subscription. By default, Get-AzureWebHostingPlanMetric gets all plans in the current subscription. The WebSpaceName value does not support wildcard characters.</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter the name of one plan in the subscription. By default, Get-AzureWebHostingPlanMetric gets all websites in the current subscription. The Name value does not support wildcard characters.</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" aliases=""> <maml:name>MetricNames</maml:name> <maml:description> <maml:para>List of metrics to return. If empty returns all</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" aliases=""> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start time from which to returns metrics.</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" aliases=""> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End time from which to returns metrics.</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" aliases=""> <maml:name>TimeGrain</maml:name> <maml:description> <maml:para>Time grain at which to return metrics. Supported values are Minute(PT1M), Hour(PT1H) - default, Day(P1D).</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" aliases=""> <maml:name>InstanceDetails</maml:name> <maml:description> <maml:para>Include details per instance level. If the web hosting plan runs on two or more machines returns details metrics for each machine.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe input to this cmdlet by property name, but not by value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.MetricResponse</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>By default, Get-AzureWebHostingPlanMetric returns an array of MetricResponse objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get metrics for last 3 hours at hourly level.</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$metrics = Get-AzureWebHostingPlanMetric eastuswebspace default1 -StartDate (get-date).AddHours(-3) -InstanceDetails $metrics[1].Data Name : CpuPercentage Unit : Percent StartTime : 8/11/2014 7:00:00 AM EndTime : 8/11/2014 5:00:23 PM TimeGrain : PT1H PrimaryAggregationType : Instance Values : {Time:8/11/2014 7:00:00 AM, Total:2, Min:9, Max:0, Time:8/11/2014 8:00:00 AM, Total:2, Min:9, Max:0, Time:8/11/2014 9:00:00 AM, Total:2, Min:9, Max:0, Time:8/11/2014 10:00:00 AM, Total:2, Min:8, Max:0...} $metrics[1].Data.Values | ft TimeCreated Total Minimum Maximum Count InstanceName ----------- ----- ------- ------- ----- ------------ 8/11/2014 7:00:00 AM 2 9 0 1 RD00155DC24599 8/11/2014 8:00:00 AM 2 9 0 1 RD00155DC24599 8/11/2014 9:00:00 AM 2 9 0 1 RD00155DC24599 8/11/2014 10:00:00 AM 2 8 0 1 RD00155DC24599 8/11/2014 11:00:00 AM 2 9 0 1 RD00155DC24599 8/11/2014 12:00:00 PM 2 6 0 1 RD00155DC24599 8/11/2014 1:00:00 PM 2 15 0 1 RD00155DC24599 8/11/2014 2:00:00 PM 3 21 0 1 RD00155DC24599 8/11/2014 3:00:00 PM 2 13 0 1 RD00155DC24599 8/11/2014 4:00:00 PM 2 14 0 1 RD00155DC24599 </dev:code> <dev:remarks> <maml:para>This command gets metrics for last 3 hours on per instance level.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureWebsiteDeployment</command:name> <maml:description> <maml:para>List the deployments for an Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebsiteDeployment</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>List the deployments for an Azure website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebsiteDeployment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>CommitId</maml:name> <maml:description> <maml:para>The unique identifier 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="3"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The largest number of results to return</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>Details</maml:name> <maml:description> <maml:para>Show detailed information about the deployment(s)</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website to get deployment information about</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="2"> <maml:name>CommitId</maml:name> <maml:description> <maml:para>The unique identifier 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="3"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The largest number of results to return</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="named"> <maml:name>Details</maml:name> <maml:description> <maml:para>Show detailed information about the deployment(s)</maml:para> </maml:description> <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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website to get deployment 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- List Deployments -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteDeployment -Name mySite</dev:code> <dev:remarks> <maml:para>List all deployments for the Azure website named 'mySite'</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> -------------- Get Deployment Detail -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteDeployment -Name mySite -CommitId f87654321 -Details</dev:code> <dev:remarks> <maml:para>Get details information about deployment 'f87654321' for Azure website 'mySite'</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Restore-AzureWebsiteDeployment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-AzureWebsiteLog</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureWebsiteLocation</command:name> <maml:description> <maml:para>Get the website locations available to the current subscription</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebsiteLocation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get the website locations available to the current subscription</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebsiteLocation</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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get Locations -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteLocations</dev:code> <dev:remarks> <maml:para>List all available locations for the current subscription</maml:para> <maml:para> </maml:para> <maml:para> </maml:para> <maml:para> North Central US South Central US East US West US </maml:para> <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>New-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>New-AzureWebsite</command:name> <maml:description> <maml:para>Create an Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create an Azure website and prepare for website deployment via Git</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Location</maml:name> <maml:description> <maml:para>The data center where the website should be deployed</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>Hostname</maml:name> <maml:description> <maml:para>An alternative hostname for the new azure website.</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>PublishingUsername</maml:name> <maml:description> <maml:para>The username you have specified in the Microsoft Azure Portal for Git 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>Git</maml:name> <maml:description> <maml:para>Set up a local git repository and link it to the website. If specified, this will set up a git repository in the local directory and add a remote named 'azure' that links to the website in Microsoft Azure.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GitHub</maml:name> <maml:description> <maml:para>If enabled, link this website with an existing Github repository. Commits to the Giuthub repository will be pushed to the website in Microsoft Azure.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GithubCredentials</maml:name> <maml:description> <maml:para>The username and password credentials used to connect to Github</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="named"> <maml:name>GithubRepository</maml:name> <maml:description> <maml:para>The full name of the Github repository to link to this website. For example, myaccount/myrepo</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>The name of the website</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>The slot 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="2"> <maml:name>Location</maml:name> <maml:description> <maml:para>The data center where the website should 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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>An alternative hostname for the new azure website.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>PublishingUsername</maml:name> <maml:description> <maml:para>The username you have specified in the Microsoft Azure Portal for Git 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>Git</maml:name> <maml:description> <maml:para>Set up a local git repository and link it to the website. If specified, this will set up a git repository in the local directory and add a remote named 'azure' that links to the website in Microsoft Azure.</maml:para> </maml:description> <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>GitHub</maml:name> <maml:description> <maml:para>If enabled, link this website with an existing Github repository. Commits to the Giuthub repository will be pushed to the website in Microsoft Azure.</maml:para> </maml:description> <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>GithubCredentials</maml:name> <maml:description> <maml:para>The username and password credentials used to connect to Github</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="named"> <maml:name>GithubRepository</maml:name> <maml:description> <maml:para>The full name of the Github repository to link to this website. For example, myaccount/myrepo</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>The name of the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Create New Website With Git -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureWebsite mySite -Git</dev:code> <dev:remarks> <maml:para>Create a new azure website and a local git repository to use for deploying files to the new website</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> -------------- Create website with Github integration -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureWebsite mysite -Github -GithubRepository myaccount/myrepo</dev:code> <dev:remarks> <maml:para>Create a new website linked to the Github repository myaccount/myrepo. Commits to the Github repository will be pushed to the website in Microsoft Azure</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> <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 Help Cmdlet Editor--> <command:details> <command:name>Remove-AzureWebsite</command:name> <maml:description> <maml:para>Remove the specified azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Remove the specified azure website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified, bypass confirmation prompts and delete the specified website</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website to delete</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The website slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified, bypass confirmation prompts and delete the specified website</maml:para> </maml:description> <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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The website slot 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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Remove Current Website -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureWebsite</dev:code> <dev:remarks> <maml:para>Remove the azure website associated with the current directory</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> -------------- Remove Website Silently -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureWebsite -Name mySite -Force</dev:code> <dev:remarks> <maml:para>Delete the Azure website named 'mySite' without prompting for confirmation</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> -------------- Remove Website Slot -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureWebsite -Name MyWebsite -Slot staging</dev:code> <dev:remarks> <maml:para>Remove the azure website slot with name staging for website MyWebsite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Switch-AzureWebsiteSlot</command:name> <maml:description> <maml:para>Swaps the production slot for a website with another slot. This works on websites with two slots only</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Switch</command:verb> <command:noun>AzureWebsiteSlot</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Swaps the production slot for a website with another slot. This works on websites with two slots only</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Switch-AzureWebsiteSlot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website</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"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not confirm the swap operation.</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not confirm the swap operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Switch Website Slot -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Switch-AzureWebsiteSlot -Name MyWebsite</dev:code> <dev:remarks> <maml:para>Switch the azure website MyWebsite backup slot with production slot</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Update-AzureWebsiteRepository</command:name> <maml:description> <maml:para> Update the remote repositories of a local git repository for all the slots</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Update</command:verb> <command:noun>AzureWebsiteRepository</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para> Update the remote repositories of a local git repository for all the slots</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-AzureWebsiteRepository</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website</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)"> <maml:name>PublishingUsername</maml:name> <maml:description> <maml:para>The username you have specified in the Microsoft Azure Portal for Git deployment</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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)"> <maml:name>PublishingUsername</maml:name> <maml:description> <maml:para>The username you have specified in the Microsoft Azure Portal for Git deployment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Update Website Remote Repositories -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-AzureWebsiteRepository -Name MyWebsite</dev:code> <dev:remarks> <maml:para>Updates the remote repositories of a local git repository for all the slots for website MyWebsite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Restart-AzureWebsite</command:name> <maml:description> <maml:para>Stop and then restart the specified Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stop and then restart the specified Azure website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restart-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website to restart</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website 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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Restore-AzureWebsiteDeployment</command:name> <maml:description> <maml:para>Redeploy a previous deployment for an Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>AzureWebsiteDeployment</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Redeploy a previous deployment for an Azure website. This replaces the current deployment with the selected deployment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-AzureWebsiteDeployment</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>CommitId</maml:name> <maml:description> <maml:para>The identifier of the deployment to redeploy</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>Skip any confirmation prompts</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website to redeploy</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>WhatIf</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>Confirm</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="2"> <maml:name>CommitId</maml:name> <maml:description> <maml:para>The identifier of the deployment to redeploy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Force</maml:name> <maml:description> <maml:para>Skip any confirmation prompts</maml:para> </maml:description> <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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website to redeploy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Redeploy -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Restore-AzureWebsiteDeployment mySite -CommitId f876543210</dev:code> <dev:remarks> <maml:para>Redeploy the deployment with id "f876543210" for the website named "mySite"</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureWebsiteDeployment</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 Help Cmdlet Editor--> <command:details> <command:name>Save-AzureWebsiteLog</command:name> <maml:description> <maml:para>Download logs for the specified website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Save</command:verb> <command:noun>AzureWebsiteLog</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Download logs for the specified website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AzureWebsiteLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Output</maml:name> <maml:description> <maml:para>The path to the log download file</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>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="2"> <maml:name>Output</maml:name> <maml:description> <maml:para>The path to the log download 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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get Logs -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Save-AzureWebsiteLogs -Name mySite -Output .\logs.zip</dev:code> <dev:remarks> <maml:para>Download runtime and deployment logs for webaite 'mySite' to the file 'logs.zip' in the current directory</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureWebsiteDeployment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restore-AzureWebsiteDeployment</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 Help Cmdlet Editor--> <command:details> <command:name>Set-AzureWebsite</command:name> <maml:description> <maml:para>Configure a Microsoft Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Configure a Microsoft Azure website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NumberOfWorkers</maml:name> <maml:description> <maml:para>The number of worker processes executing the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DefaultDocuments</maml:name> <maml:description> <maml:para>The documents that are automatically displayed when browsing the website</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="named"> <maml:name>NetFrameworkVersion</maml:name> <maml:description> <maml:para>The version of the .Net Framework required by the website</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>PhpVersion</maml:name> <maml:description> <maml:para>The PHP version required by the website</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>RequestTracingEnabled</maml:name> <maml:description> <maml:para>Determines whether request tracing is enabled for the website</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>HttpLoggingEnabled</maml:name> <maml:description> <maml:para>Determines whether http logging is enabled for the website</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DetailedErrorLoggingEnabled</maml:name> <maml:description> <maml:para>Determines whether detailed iis errors are logged for the website</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>HostNames</maml:name> <maml:description> <maml:para>The fully qualified hostnames that can be used to access the website</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="named"> <maml:name>AppSettings</maml:name> <maml:description> <maml:para>The environment variables that will be used by the website</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>Metadata</maml:name> <maml:description> <maml:para>The Metadata for the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValuePair</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ConnectionStrings</maml:name> <maml:description> <maml:para>The connection strings used by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnStringPropertyBag</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>HandlerMappings</maml:name> <maml:description> <maml:para>The Handler Mappings used by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HandlerMapping[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>SiteWithConfig</maml:name> <maml:description> <maml:para>The configuration used by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SiteWithConfig</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>The name of the website</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="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>When specified, a boolean value is returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ManagedPipelineMode</maml:name> <maml:description> <maml:para>The managed pipeline mode</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>WebSocketsEnabled</maml:name> <maml:description> <maml:para>Flag to enable/disable websockets</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>The slot 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="named"> <maml:name>RoutingRules</maml:name> <maml:description> <maml:para>Routing rules used for testing in production</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.RampUpRule</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Use32BitWorkerProcess</maml:name> <maml:description> <maml:para>Indicates if 32-bit mode is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</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>NumberOfWorkers</maml:name> <maml:description> <maml:para>The number of worker processes executing the website</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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DefaultDocuments</maml:name> <maml:description> <maml:para>The documents that are automatically displayed when browsing the website</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="named"> <maml:name>NetFrameworkVersion</maml:name> <maml:description> <maml:para>The version of the .Net Framework required by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>PhpVersion</maml:name> <maml:description> <maml:para>The PHP version required by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>RequestTracingEnabled</maml:name> <maml:description> <maml:para>Determines whether request tracing is enabled for the website</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByPropertyName)" position="named"> <maml:name>HttpLoggingEnabled</maml:name> <maml:description> <maml:para>Determines whether http logging is enabled for the website</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByPropertyName)" position="named"> <maml:name>DetailedErrorLoggingEnabled</maml:name> <maml:description> <maml:para>Determines whether detailed iis errors are logged for the website</maml:para> </maml:description> <command:parameterValue required="false" 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="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>HostNames</maml:name> <maml:description> <maml:para>The fully qualified hostnames that can be used to access the website</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="named"> <maml:name>AppSettings</maml:name> <maml:description> <maml:para>The environment variables that will be used by the website</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>Metadata</maml:name> <maml:description> <maml:para>The Metadata for the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">NameValuePair</command:parameterValue> <dev:type> <maml:name>NameValuePair</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>ConnectionStrings</maml:name> <maml:description> <maml:para>The connection strings used by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnStringPropertyBag</command:parameterValue> <dev:type> <maml:name>ConnStringPropertyBag</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>HandlerMappings</maml:name> <maml:description> <maml:para>The Handler Mappings used by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HandlerMapping[]</command:parameterValue> <dev:type> <maml:name>HandlerMapping[]</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>SiteWithConfig</maml:name> <maml:description> <maml:para>The configuration used by the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SiteWithConfig</command:parameterValue> <dev:type> <maml:name>SiteWithConfig</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>PassThru</maml:name> <maml:description> <maml:para>When specified, a boolean value is returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Switch</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>The name of the website</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>ManagedPipelineMode</maml:name> <maml:description> <maml:para>The managed pipeline mode</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>WebSocketsEnabled</maml:name> <maml:description> <maml:para>Flag to enable/disable websockets</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>The slot 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="named"> <maml:name>RoutingRules</maml:name> <maml:description> <maml:para>Routing rules used for testing in production</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.RampUpRule</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Use32BitWorkerProcess</maml:name> <maml:description> <maml:para>Indicates if 32-bit mode is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Enable HTTP Logging -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureWebsite -HttpLoggingEnabled 1</dev:code> <dev:remarks> <maml:para>Enable http logging</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> -------------- Set storage credentials -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code> $settings = New-Object Hashtable $settings["AZURE_STORAGE_ACCOUNT"] = myaccountname $settings["AZURE_STORAGE_ACCESS_KEY"] = myaccesskey Set-AzureWebsite -AppSettings $settings myWebsite </dev:code> <dev:remarks> <maml:para>Sets up environment variables for AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY in the website myWebsite</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> -------------- Enable Drive Logging -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code> Set-AzureWebsite -AzureDriveTraceEnabled $true </dev:code> <dev:remarks> <maml:para>Enable drive logging for the specified website</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Set routing rules for testing in production -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $rule = New-Object Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebEntities.RampUpRule $rule.ActionHostName = "mysite-staging.azurewebsites.net" $rule.ReroutePercentage = 10; $rule.Name = "rule1" Set-AzureWebsite mysite -RoutingRules $rule </dev:code> <dev:remarks> <maml:para>Sets up a routing for 10 percent of the traffic to staging slot.</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Show-AzurePortal</command:name> <maml:description> <maml:para>Show the Azure management portal</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Show</command:verb> <command:noun>AzurePortal</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Show the Azure management portal</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-AzurePortal</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website to show in the portal</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>Realm</maml:name> <maml:description> <maml:para>The organization ID to use for federated authentication when displaying the Microsoft Azure Portal</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>Environment</maml:name> <maml:description> <maml:para>The Microsoft Azure environment name to use</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website to show in the portal</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Realm</maml:name> <maml:description> <maml:para>The organization ID to use for federated authentication when displaying the Microsoft Azure Portal</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Environment</maml:name> <maml:description> <maml:para>The Microsoft Azure environment name to use</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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>websites, website</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Show Site -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Show-AzurePortal -Name mySite</dev:code> <dev:remarks> <maml:para>Open a browser on the Microsoft Azure portal, showing information about website 'mySite'</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Show-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Show-AzureWebsite</command:name> <maml:description> <maml:para>Open a browser on the website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Show</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Open a browser on the website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site to open in the browser</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the site to open in the browser</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Show-AzurePortal</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 Help Cmdlet Editor--> <command:details> <command:name>Start-AzureWebsite</command:name> <maml:description> <maml:para>Start the specified Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Start the specified Azure website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website to start</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the website 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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Stop-AzureWebsite</command:name> <maml:description> <maml:para>Stop the specified Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stop the specified Azure website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website to stop</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website to stop</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Restart-AzureWebsite</command:name> <maml:description> <maml:para>Stop and then restart the specified Azure website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>AzureWebsite</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Stop and then restart the specified Azure website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restart-AzureWebsite</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website to restart</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website 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="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureWebsiteLog</command:name> <maml:description> <maml:para>Gets log for the specified website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebsiteLog</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets log for the specified website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebsiteLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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>Path</maml:name> <maml:description> <maml:para>The path from which the log will be retrieved. By default it is Root which means include all the paths.</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>Message</maml:name> <maml:description> <maml:para>A string which will be used to filter the log message. Only logs which contains this string will be 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 (ByPropertyName)" position="4"> <maml:name>Tail</maml:name> <maml:description> <maml:para>Log streaming switch parameter</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ListPath</maml:name> <maml:description> <maml:para>List log paths switch parameter</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</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>The slot 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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>Path</maml:name> <maml:description> <maml:para>The path from which the log will be retrieved. By default it is Root which means include all the paths.</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>Message</maml:name> <maml:description> <maml:para>A string which will be used to filter the log message. Only logs which contains this string will be 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 (ByPropertyName)" position="4"> <maml:name>Tail</maml:name> <maml:description> <maml:para>Log streaming switch parameter</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ListPath</maml:name> <maml:description> <maml:para>List log paths switch parameter</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</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>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Start log streaming -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteLog -Tail</dev:code> <dev:remarks> <maml:para>Starts log streaming for all application logs</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> -------------- Start log streaming for http-------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteLog -Tail -Path http</dev:code> <dev:remarks> <maml:para>Starts log streaming for http logs</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> -------------- Start log streaming for Errors -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteLog -Tail -Message Error</dev:code> <dev:remarks> <maml:para>Starts log streaming and show error logs only</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> -------------- List available log paths -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteLog -Name MyWebsite -ListPath</dev:code> <dev:remarks> <maml:para>Lists all available log paths in the website</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</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 Help Cmdlet Editor--> <command:details> <command:name>Enable-AzureWebsiteApplicationDiagnostic</command:name> <maml:description> <maml:para>Enables the website's application diagnostics</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureWebsiteApplicationDiagnostic</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Enables the website's application diagnostics on file system or on Microsoft Azure Storage</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureWebsiteApplicationDiagnostic</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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>File</maml:name> <maml:description> <maml:para>Indicates using file system to store the log files</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Storage</maml:name> <maml:description> <maml:para>Indicates using Microsoft Azure Storage to store the log files</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>StorageAccountName</maml:name> <maml:description> <maml:para>The storage account to use for storing the logs. If not specified, the CurrentStorageAccountName will be 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="true (ByPropertyName)" position="3"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>The log level to 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>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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>File</maml:name> <maml:description> <maml:para>Indicates using file system to store the log files</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Storage</maml:name> <maml:description> <maml:para>Indicates using Microsoft Azure Storage to store the log files</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>StorageAccountName</maml:name> <maml:description> <maml:para>The storage account to use for storing the logs. If not specified, the CurrentStorageAccountName will be 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="true (ByPropertyName)" position="3"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>The log level to 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>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Enable diagnostics using file system -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Enable-AzureWebsiteApplicationDiagnostic -Name MyWebsite -File -LogLevel Verbose</dev:code> <dev:remarks> <maml:para>Enables application logging on file system with verbose level</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> -------------- Enable logging using Microsoft Azure Storage -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Enable-AzureWebsiteApplicationDiagnostic -Name MyWebsite -Storage -LogLevel Information -StorageAccountName myaccount</dev:code> <dev:remarks> <maml:para>Enables application logging using storage account myaccount with logging level set to information</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureWebsiteApplicationDiagnostic</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 Help Cmdlet Editor--> <command:details> <command:name>Disable-AzureWebsiteApplicationDiagnostic</command:name> <maml:description> <maml:para>Disables the website's application diagnostics</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>AzureWebsiteApplicationDiagnostic</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Disables the website's application diagnostics on file system or on Microsoft Azure Storage</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureWebsiteApplicationDiagnostic</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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>File</maml:name> <maml:description> <maml:para>Indicates using file system to store the log files</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Storage</maml:name> <maml:description> <maml:para>Indicates using Microsoft Azure Storage to store the log files</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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>File</maml:name> <maml:description> <maml:para>Indicates using file system to store the log files</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Storage</maml:name> <maml:description> <maml:para>Indicates using Microsoft Azure Storage to store the log files</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>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Disable diagnostics using file system -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Disable-AzureWebsiteApplicationDiagnostic -Name MyWebsite -File</dev:code> <dev:remarks> <maml:para>Disables application logging on file system</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> -------------- Disable logging using Microsoft Azure Storage -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Disable-AzureWebsiteApplicationDiagnostic -Name MyWebsite -Storage</dev:code> <dev:remarks> <maml:para>Disables application logging using storage</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureWebsiteApplicationDiagnostic</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 Help Cmdlet Editor--> <command:details> <command:name>Enable-AzureWebsiteDebug</command:name> <maml:description> <maml:para>Enables the website's debug</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureWebsiteDebug</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Enables the website's debug feature in Visual Studio</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureWebsiteDebug</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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 Visual Studio 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>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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 Visual Studio 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>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Enable debugging of Visual Studio 2013 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Enable-AzureWebsiteDebug -Name MyWebsite -Version VS2013</dev:code> <dev:remarks> <maml:para>Enables debugging on VS 2013</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureWebsiteDebug</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 Help Cmdlet Editor--> <command:details> <command:name>Disable-AzureWebsiteDebug</command:name> <maml:description> <maml:para>Disables the website's debugging</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>AzureWebsiteDebug</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Disables the website's debugging in Visual Studio</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureWebsiteDebug</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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>PassThru</maml:name> <maml:description> <maml:para>Flag to return true if succeeded</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Disable website debugging -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Disable-AzureWebsiteDebug -Name MyWebsite</dev:code> <dev:remarks> <maml:para>Disables website debugging on website MyWebsite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureWebsiteDebug</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 Help Cmdlet Editor--> <command:details> <command:name>Get-AzureWebsiteJob</command:name> <maml:description> <maml:para>Gets the web jobs associated with a website</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebsiteJob</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Gets the web jobs associated with a website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebsiteJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get specific web job info -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteJob -Name MyWebsite -JobName MyWebJob</dev:code> <dev:remarks> <maml:para>Gets a web job called MyWebJob from MyWebsite production slot</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> -------------- Get all web jobs for a website -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteJob -Name MyWebsite</dev:code> <dev:remarks> <maml:para>Gets all web jobs associated with MyWebsite production slot</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> -------------- Get all triggered web jobs -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteJob -Name MyWebsite -Slot staging -Type Triggered</dev:code> <dev:remarks> <maml:para>Gets all triggered web jobs from staging slot of MyWebsite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsiteJob</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-AzureWebsiteJob</command:name> <maml:description> <maml:para>Creates new web job for a website</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureWebsiteJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new web job for a website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureWebsiteJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</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)"> <maml:name>JobFile</maml:name> <maml:description> <maml:para>The web job file</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</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)"> <maml:name>JobFile</maml:name> <maml:description> <maml:para>The web job file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Create new web job for a website -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureWebsiteJob -Name MyWebsite -JobName MyWebJob -JobType Continuous -JobFile job.bat</dev:code> <dev:remarks> <maml:para>Creates a continuous job to call job.bat on website MyWebsite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsiteJob</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-AzureWebsiteJob</command:name> <maml:description> <maml:para>Removes an existing web job for a website</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureWebsiteJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes an existing web job for a website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureWebsiteJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Remove an existing web job for a website -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureWebsiteJob -Name MyWebsite -JobName MyWebJob -JobType Continuous</dev:code> <dev:remarks> <maml:para>Removes a web job called MyWebJob for MyWebSite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsiteJob</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>Stop-AzureWebsiteJob</command:name> <maml:description> <maml:para>Stops a web job for a website</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureWebsiteJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Stops a web job for a website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureWebsiteJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns a boolean value indicating that the job stopped successfully. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="true" 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns a boolean value indicating that the job stopped successfully. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Stop a web job for a website -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Stop-AzureWebsiteJob -Name MyWebsite -JobName MyWebJob -JobType Continuous</dev:code> <dev:remarks> <maml:para>Stops a web job called MyWebJob for MyWebSite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsiteJob</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>Start-AzureWebsiteJob</command:name> <maml:description> <maml:para>Starts a web job for a website</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureWebsiteJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Starts a web job for a website</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureWebsiteJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns a boolean value indicating that the job started successfully. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="true" 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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)"> <maml:name>JobType</maml:name> <maml:description> <maml:para>The web job type. Can be 'triggered' or 'continuous'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns a boolean value indicating that the job started successfully. By default, this cmdlet does not return any output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Start a web job for a website -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-AzureWebsiteJob -Name MyWebsite -JobName MyWebJob -JobType Continuous</dev:code> <dev:remarks> <maml:para>Starts a web job called MyWebJob for MyWebSite</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsiteJob</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-AzureWebsiteJobHistory</command:name> <maml:description> <maml:para>Gets a web job history</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureWebsiteJobHistory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets a web job history</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureWebsiteJobHistory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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="named"> <maml:name>RunId</maml:name> <maml:description> <maml:para>The id of the run history you want to see</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" position="named"> <maml:name>Latest</maml:name> <maml:description> <maml:para>If specified, return the latest run history.</maml:para> </maml:description> <command:parameterValue required="true" 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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Azure website</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)"> <maml:name>Slot</maml:name> <maml:description> <maml:para>The slot name of the Azure website</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)"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The web job 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="named"> <maml:name>RunId</maml:name> <maml:description> <maml:para>The id of the run history you want to see</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" position="named"> <maml:name>Latest</maml:name> <maml:description> <maml:para>If specified, return the latest run history.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> </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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get complete history for a web job -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteJobHistory -Name MyWebsite -JobName MyWebJob</dev:code> <dev:remarks> <maml:para>Gets complete history for MyWebJob</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> -------------- Get latest run for a web job -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteJobHistory -Name MyWebsite -JobName MyWebJob -Latest</dev:code> <dev:remarks> <maml:para>Gets latest run info for MyWebJob</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> -------------- Get specific run for a web job -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureWebsiteJobHistory -Name MyWebsite -JobName MyWebJob -RunId 10</dev:code> <dev:remarks> <maml:para>Gets all info about run with id 10 for MyWebJob</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> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureWebsiteJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsiteJob</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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureMediaServicesAccount</command:name> <maml:description> <maml:para>Gets an Azure Media Services account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureMediaServicesAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets an Azure Media Services account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureMediaServicesAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The media service account name.</maml:para> </maml:description> <command:parameterValue required="false" 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>The media service account name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1 --------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-AzureMediaServicesAccount</dev:code> <dev:remarks> <maml:para>This example lists all available Media Services accounts.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- Example 2 --------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-AzureMediaServicesAccount -Name myaccount</dev:code> <dev:remarks> <maml:para>This example displays properties of a Media Services account.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureMediaServicesAccount</command:name> <maml:description> <maml:para>Creates new Azure Media Services account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureMediaServicesAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new Azure Media Services account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureMediaServicesAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The media service account 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>Location</maml:name> <maml:description> <maml:para>The media service location.</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>StorageAccountName</maml:name> <maml:description> <maml:para>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>Name</maml:name> <maml:description> <maml:para>The media service account 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>Location</maml:name> <maml:description> <maml:para>The media service location.</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>StorageAccountName</maml:name> <maml:description> <maml:para>Storage account name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1 --------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> New-AzureMediaServicesAccount -Name myaccount -Location "West US" -StorageAccountName mystorageaccount</dev:code> <dev:remarks> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureMediaServicesKey</command:name> <maml:description> <maml:para>Resets an Azure Media Services key.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureMediaServicesKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Resets an Azure Media Services key.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureMediaServicesKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The media services account 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>KeyType</maml:name> <maml:description> <maml:para>The media services key type <Primary|Secondary>.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyType</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>Do not confirm regeneration of the key.</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>Name</maml:name> <maml:description> <maml:para>The media services account 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>KeyType</maml:name> <maml:description> <maml:para>The media services key type <Primary|Secondary>.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyType</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>Do not confirm regeneration of the key.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1 --------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> New-AzureMediaServicesKey -Name myaccount -KeyType Primary</dev:code> <dev:remarks> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureMediaServicesAccount</command:name> <maml:description> <maml:para>Removes an Azure Media Services account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureMediaServicesAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes an Azure Media Services account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureMediaServicesAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The media services account 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>Do not confirm deletion of 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>Name</maml:name> <maml:description> <maml:para>The media services account 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>Do not confirm deletion of account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name /> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1 --------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Remove-AzureMediaServicesAccount -Name myaccount</dev:code> <dev:remarks> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <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> Publish-AzureWebsiteProject </command:name> <maml:description> <maml:para>Publish a Visual Studio web project to a Microsoft Azure web site using WebDeploy.</maml:para> </maml:description> <maml:copyright> <maml:para> </maml:para> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>AzureWebsiteProject</command:noun> <dev:version> </dev:version> </command:details> <maml:description> <maml:para>Publish a Visual Studio web project to a Microsoft Azure web site using WebDeploy. It can either take a WebDeploy package and publish directly, or take a Visual Studio web project, build the project and publish. It can also replace the connection strings in the Web.config during publish.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Publish-AzureWebsiteProject</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The web site 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>Package</maml:name> <maml:description> <maml:para>The WebDeploy package folder for zip file of the Visual Studio web application project to be published.</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>ConnectionString</maml:name> <maml:description> <maml:para>The connection strings to use for the deployment.</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>Slot</maml:name> <maml:description> <maml:para>The web site slot name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-AzureWebsiteProject</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The web site 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>ProjectFile</maml:name> <maml:description> <maml:para>The Visual Studio web application project to be published.</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>Configuration</maml:name> <maml:description> <maml:para>The configuration used to build the Visual Studio web application 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="true (ByPropertyName)" position="4"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>The connection strings to use for the deployment.</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>Slot</maml:name> <maml:description> <maml:para>The web site slot name.</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="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The web site 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>Slot</maml:name> <maml:description> <maml:para>The web site slot 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>ProjectFile</maml:name> <maml:description> <maml:para>The Visual Studio web application project to be published.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>Configuration</maml:name> <maml:description> <maml:para>The configuration used to build the Visual Studio web application 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>Release</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Package</maml:name> <maml:description> <maml:para>The WebDeploy package folder for zip file of the Visual Studio web application project to be published.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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>ConnectionString</maml:name> <maml:description> <maml:para>The connection strings to use for the deployment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <!-- 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, utilities</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-AzureWebsiteProject -Name site1 -ProjectFile .\WebApplication1.csproj -Configuration Debug </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Build a Visual Studio web project with "Debug" configuration (meaning use Web.Debug.config) and publish to a Microsoft Azure Web Site using WebDeploy.</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-AzureWebsiteProject -Name site1 -Package .\WebApplication1.zip </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Publish a WebDeploy Pacakge .zip file to a Microsoft Azure Web Site using WebDeploy.</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-AzureWebsiteProject -Name site1 -Package .\WebApplication1 </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Publish a WebDeploy Pacakge folder to a Microsoft Azure Web Site using WebDeploy.</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-AzureWebsiteProject -Name site1 -ProjectFile .\WebApplication1.csproj -ConnectionString @{ DefaultConnection = "my connection string" } </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Build a Visual Studio web project, overwrite the "DefaultConnection" connection string in Web.config and publish to a Microsoft Azure Web Site using WebDeploy.</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-AzureWebsiteProject -Name site1 -ProjectFile .\WebApplication1.csproj -DefaultConnection "my connection string" </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Build a Visual Studio web project, overwrite the "DefaultConnection" connection string in Web.config and publish to a Microsoft Azure Web Site using WebDeploy. Notice that -DefaultConnection is a dynamic parameter which gets added by parsing Web.config.</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>New-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureWebsite</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureWebsite</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-AzureSchedulerLocation</command:name> <maml:description> <maml:para>Get available scheduler locations</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSchedulerLocation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get available scheduler locations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSchedulerLocation</maml:name> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Get Azure Scheduler Location -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerLocation</dev:code> <dev:remarks> <maml:para>Get available scheduler locations</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> </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-AzureSchedulerJobCollection</command:name> <maml:description> <maml:para>Get a list of scheduler job collections or a particular scheduler job collection</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSchedulerJobCollection</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get a list of scheduler job collections or a particular scheduler job collection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSchedulerJobCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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="2"> <maml:name>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJobCollection</dev:code> <dev:remarks> <maml:para>Get all scheduler job collections across all locations in the current subscription</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> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJobCollection -Location "North Central US"</dev:code> <dev:remarks> <maml:para>Get all scheduler job collections under location North Central US</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> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJobCollection -Location "North Central US" -JobCollectionName jobCollection1</dev:code> <dev:remarks> <maml:para>Get details of jobCollection1</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> </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-AzureSchedulerJob</command:name> <maml:description> <maml:para>Get a list of scheduler jobs or a particular scheduler job under a job collection and location</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSchedulerJob</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get a list of scheduler jobs or a particular scheduler job under a job collection and location</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSchedulerJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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>Job Name</maml:name> <maml:description> <maml:para>The name of scheduler job.</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>Job State</maml:name> <maml:description> <maml:para>The scheduler job state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJob -Location "North Central US" -JobCollectionName jobCollection1</dev:code> <dev:remarks> <maml:para>Get scheduler jobs under jobCollection1</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> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1</dev:code> <dev:remarks> <maml:para>Get details of job1 under jobCollection1</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> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJobCollection -Location "North Central US" -JobCollectionName jobCollection1 -JobState Disabled</dev:code> <dev:remarks> <maml:para>Get all disabled scheduler jobs under jobCollection1</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> </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-AzureSchedulerJobHistory</command:name> <maml:description> <maml:para>Get history for a scheduler job</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureSchedulerJobHistory</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Get history for a scheduler job</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureSchedulerJobHistory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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>Job Name</maml:name> <maml:description> <maml:para>The name of scheduler job.</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>Job Status</maml:name> <maml:description> <maml:para>The scheduler job status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJobHistory -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1</dev:code> <dev:remarks> <maml:para>Get history of job1</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> C:\PS> </maml:introduction> <dev:code>Get-AzureSchedulerJobHistory -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -JobStatus Failed</dev:code> <dev:remarks> <maml:para>Get history of job1 with Failed status</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> </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-AzureSchedulerJobCollection</command:name> <maml:description> <maml:para>Deletes a scheduler job collection and the job(s) under it</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSchedulerJobCollection</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Deletes a scheduler job collection and the job(s) under it</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSchedulerJobCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureSchedulerJobCollection -Location "North Central US" -JobCollectionName jobCollection1</dev:code> <dev:remarks> <maml:para>Deletes jobCollection1 and the job(s) under 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 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureSchedulerJobCollection -JobCollectionName jobCollection1</dev:code> <dev:remarks> <maml:para>Deletes jobCollection1 and the job(s) under 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:examples> </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-AzureSchedulerJob</command:name> <maml:description> <maml:para>Deletes a scheduler job</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureSchedulerJob</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Deletes a scheduler job</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureSchedulerJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection containing the scheduler job to 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="2"> <maml:name>Job Name</maml:name> <maml:description> <maml:para>The name of scheduler job to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-AzureSchedulerJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1</dev:code> <dev:remarks> <maml:para>Deletes job1</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> </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-AzureSchedulerStorageQueueJob</command:name> <maml:description> <maml:para>Create a scheduler job with a storage action</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSchedulerStorageQueueJob</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create a scheduler job with a storage action</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSchedulerStorageQueueJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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)"> <maml:name>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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)"> <maml:name>Job Name</maml:name> <maml:description> <maml:para>The name of scheduler job.</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)"> <maml:name>StorageQueueAccount</maml:name> <maml:description> <maml:para>The Storage account 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)"> <maml:name>StorageQueueName</maml:name> <maml:description> <maml:para>The Storage Queue 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)"> <maml:name>SASToken</maml:name> <maml:description> <maml:para>The SAS token for storage queue.</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)"> <maml:name>StorageQueueMessage</maml:name> <maml:description> <maml:para>The queue message for storage job.</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)"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The Start time.</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)"> <maml:name>Interval</maml:name> <maml:description> <maml:para>Interval of the recurrence at the given frequency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>The frequency of recurrence.</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)"> <maml:name>ExecutionCount</maml:name> <maml:description> <maml:para>Count of occurrences that will execute. Optional. Default will recur infinitely.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The End time.</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)"> <maml:name>JobState</maml:name> <maml:description> <maml:para>The scheduler job state.</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)"> <maml:name>Headers</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionMethod</maml:name> <maml:description> <maml:para>The Method for Http and Https Action types (GET, PUT, POST, HEAD or DELETE).</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)"> <maml:name>ErrorActionURI</maml:name> <maml:description> <maml:para>The Uri for error job action.</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)"> <maml:name>ErrorActionRequestBody</maml:name> <maml:description> <maml:para>The Body for PUT and POST job actions.</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)"> <maml:name>ErrorActionHeaders</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionStorageAccount</maml:name> <maml:description> <maml:para>The Storage account 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)"> <maml:name>ErrorActionStorageQueue</maml:name> <maml:description> <maml:para>The Storage queue 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)"> <maml:name>ErrorActionSASToken</maml:name> <maml:description> <maml:para>The Sas token for storage queue.</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)"> <maml:name>ErrorActionQueueMessageBody</maml:name> <maml:description> <maml:para>The body for storage job acitons.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -StorageQueueAccount myStorageAccount -StorageQueueName myStorageQueue -SASToken "mySASToken"</dev:code> <dev:remarks> <maml:para>Create a new scheduler storage job under jobCollection1 with the provided storage credentials (storage account, queue name, sas token). The job's schedule will be default - runs once immediately</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> C:\PS> </maml:introduction> <dev:code>New-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -StorageQueueAccount myStorageAccount -StorageQueueName myStorageQueue -SASToken "mySASToken" -ExecutionCount 20 -Frequency Hour -Interval 2</dev:code> <dev:remarks> <maml:para>Create a new scheduler storage job under jobCollection1 with the provided storage credentials (storage account, queue name, sas token). The job will execute 20 times in total, twice every hour</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> </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-AzureSchedulerHttpJob</command:name> <maml:description> <maml:para>Create a scheduler job with an Http action</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSchedulerHttpJob</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create a scheduler job with an Http action</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSchedulerHttpJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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)"> <maml:name>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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)"> <maml:name>Job Name</maml:name> <maml:description> <maml:para>The name of scheduler job.</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)"> <maml:name>Method</maml:name> <maml:description> <maml:para>The Method for Http and Https Action types (GET, PUT, POST, HEAD or DELETE).</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)"> <maml:name>URI</maml:name> <maml:description> <maml:para>The Uri for job action.</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)"> <maml:name>RequestBody</maml:name> <maml:description> <maml:para>The Body for PUT and POST job actions.</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)"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The Start time.</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)"> <maml:name>Interval</maml:name> <maml:description> <maml:para>Interval of the recurrence at the given frequency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>The frequency of recurrence.</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)"> <maml:name>ExecutionCount</maml:name> <maml:description> <maml:para>Count of occurrences that will execute. Optional. Default will recur infinitely.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The End time.</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)"> <maml:name>JobState</maml:name> <maml:description> <maml:para>The scheduler job state.</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)"> <maml:name>Headers</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionMethod</maml:name> <maml:description> <maml:para>The Method for Http and Https Action types (GET, PUT, POST, HEAD or DELETE).</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)"> <maml:name>ErrorActionURI</maml:name> <maml:description> <maml:para>The Uri for error job action.</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)"> <maml:name>ErrorActionRequestBody</maml:name> <maml:description> <maml:para>The Body for PUT and POST job actions.</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)"> <maml:name>ErrorActionHeaders</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionStorageAccount</maml:name> <maml:description> <maml:para>The Storage account 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)"> <maml:name>ErrorActionStorageQueue</maml:name> <maml:description> <maml:para>The Storage queue 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)"> <maml:name>ErrorActionSASToken</maml:name> <maml:description> <maml:para>The Sas token for storage queue.</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)"> <maml:name>ErrorActionQueueMessageBody</maml:name> <maml:description> <maml:para>The body for storage job acitons.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureSchedulerHttpJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -Method GET -URI http://www.bing.com</dev:code> <dev:remarks> <maml:para>Create a new scheduler http job under jobCollection1. The method is GET and Uri is http://www.bing.com. The job's schedule will be default - runs once immediately</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> C:\PS> </maml:introduction> <dev:code>New-AzureSchedulerHttpJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -Method GET -URI http://www.bing.com -ExecutionCount 20</dev:code> <dev:remarks> <maml:para>Create a new scheduler http job under jobCollection1. The method is GET and Uri is http://www.bing.com. The job will execute 20 times with default schedule</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> </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-AzureSchedulerJobCollection</command:name> <maml:description> <maml:para>Create a scheduler job collection</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureSchedulerJobCollection</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create a scheduler job collection with the specified plan, max job count and max recurrence. If no plan is specified, Standard job collection will be created</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureSchedulerJobCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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)"> <maml:name>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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)"> <maml:name>Plan</maml:name> <maml:description> <maml:para>The scheduler job collection plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false"> <maml:name>MaxJobCount</maml:name> <maml:description> <maml:para>The maximum number of jobs that can be created in the scheduler job collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>The maximum frequency that can be specified on any job in this scheduler job collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false"> <maml:name>Interval</maml:name> <maml:description> <maml:para>The interval of recurrence at given frequency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-AzureSchedulerJobCollection -Location "North Central US" -JobCollectionName jobCollection1 -Plan Standard</dev:code> <dev:remarks> <maml:para>Create a new Standard scheduler job collection jobCollection1 with default job count and max recurrence values for a Standard scheduler job collection</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> C:\PS> </maml:introduction> <dev:code>New-AzureSchedulerJobCollection -Location "North Central US" -JobCollectionName jobCollection1 -Plan Standard -MaxJobCount 30 -Frequency Hour -Interval 12</dev:code> <dev:remarks> <maml:para>Create a new Standard scheduler job collection jobCollection1 with max job count set to 30, and max recurrence set to 12 per hour</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> </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-AzureSchedulerJobCollection</command:name> <maml:description> <maml:para>Update a scheduler job collection</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSchedulerJobCollection</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Update a scheduler job collection with specified parameters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSchedulerJobCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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)"> <maml:name>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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)"> <maml:name>Plan</maml:name> <maml:description> <maml:para>The scheduler job collection plan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false"> <maml:name>MaxJobCount</maml:name> <maml:description> <maml:para>The maximum number of jobs that can be created in the scheduler job collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>The maximum frequency that can be specified on any job in this scheduler job collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false"> <maml:name>Interval</maml:name> <maml:description> <maml:para>The interval of recurrence at given frequency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureSchedulerJobCollection -Location "North Central US" -JobCollectionName jobCollection1 -MaxJobCount 30</dev:code> <dev:remarks> <maml:para>Sets the max job count to 30 on existing scheduler job collection, jobcollection1</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> </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-AzureSchedulerHttpJob</command:name> <maml:description> <maml:para>Update a scheduler job with an Http action</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSchedulerHttpJob</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Update a scheduler job with an Http action</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSchedulerHttpJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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)"> <maml:name>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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)"> <maml:name>Job Name</maml:name> <maml:description> <maml:para>The name of scheduler job.</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)"> <maml:name>Method</maml:name> <maml:description> <maml:para>The Method for Http and Https Action types (GET, PUT, POST, HEAD or DELETE).</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)"> <maml:name>URI</maml:name> <maml:description> <maml:para>The Uri for job action.</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)"> <maml:name>RequestBody</maml:name> <maml:description> <maml:para>The Body for PUT and POST job actions.</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)"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The Start time.</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)"> <maml:name>Interval</maml:name> <maml:description> <maml:para>Interval of the recurrence at the given frequency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>The frequency of recurrence.</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)"> <maml:name>ExecutionCount</maml:name> <maml:description> <maml:para>Count of occurrences that will execute. Optional. Default will recur infinitely.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The End time.</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)"> <maml:name>JobState</maml:name> <maml:description> <maml:para>The scheduler job state.</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)"> <maml:name>Headers</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionMethod</maml:name> <maml:description> <maml:para>The Method for Http and Https Action types (GET, PUT, POST, HEAD or DELETE).</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)"> <maml:name>ErrorActionURI</maml:name> <maml:description> <maml:para>The Uri for error job action.</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)"> <maml:name>ErrorActionRequestBody</maml:name> <maml:description> <maml:para>The Body for PUT and POST job actions.</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)"> <maml:name>ErrorActionHeaders</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionStorageAccount</maml:name> <maml:description> <maml:para>The Storage account 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)"> <maml:name>ErrorActionStorageQueue</maml:name> <maml:description> <maml:para>The Storage queue 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)"> <maml:name>ErrorActionSASToken</maml:name> <maml:description> <maml:para>The Sas token for storage queue.</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)"> <maml:name>ErrorActionQueueMessageBody</maml:name> <maml:description> <maml:para>The body for storage job actions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureSchedulerHttpJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -JobState Disabled</dev:code> <dev:remarks> <maml:para>Set job1 state to disabled</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> C:\PS> </maml:introduction> <dev:code>Set-AzureSchedulerHttpJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -URI http://www.bing.com</dev:code> <dev:remarks> <maml:para>Update job1 Uri to http://www.bing.com</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> </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-AzureSchedulerStorageQueueJob</command:name> <maml:description> <maml:para>Update a scheduler job with a storage action</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureSchedulerStorageQueueJob</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Update a scheduler job with a storage action</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureSchedulerStorageQueueJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Location</maml:name> <maml:description> <maml:para>The location 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)"> <maml:name>Job Collection Name</maml:name> <maml:description> <maml:para>The name of scheduler job collection.</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)"> <maml:name>Job Name</maml:name> <maml:description> <maml:para>The name of scheduler job.</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)"> <maml:name>StorageQueueAccount</maml:name> <maml:description> <maml:para>The Storage account 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)"> <maml:name>StorageQueueName</maml:name> <maml:description> <maml:para>The Storage Queue 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)"> <maml:name>SASToken</maml:name> <maml:description> <maml:para>The SAS token for storage queue.</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)"> <maml:name>StorageQueueMessage</maml:name> <maml:description> <maml:para>The queue message for storage job.</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)"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The Start time.</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)"> <maml:name>Interval</maml:name> <maml:description> <maml:para>Interval of the recurrence at the given frequency.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>The frequency of recurrence.</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)"> <maml:name>ExecutionCount</maml:name> <maml:description> <maml:para>Count of occurrences that will execute. Optional. Default will recur infinitely.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">integer</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The End time.</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)"> <maml:name>JobState</maml:name> <maml:description> <maml:para>The scheduler job state.</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)"> <maml:name>Headers</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionMethod</maml:name> <maml:description> <maml:para>The Method for Http and Https Action types (GET, PUT, POST, HEAD or DELETE).</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)"> <maml:name>ErrorActionURI</maml:name> <maml:description> <maml:para>The Uri for error job action.</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)"> <maml:name>ErrorActionRequestBody</maml:name> <maml:description> <maml:para>The Body for PUT and POST job actions.</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)"> <maml:name>ErrorActionHeaders</maml:name> <maml:description> <maml:para>The header collection.</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)"> <maml:name>ErrorActionStorageAccount</maml:name> <maml:description> <maml:para>The Storage account 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)"> <maml:name>ErrorActionStorageQueue</maml:name> <maml:description> <maml:para>The Storage queue 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)"> <maml:name>ErrorActionSASToken</maml:name> <maml:description> <maml:para>The Sas token for storage queue.</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)"> <maml:name>ErrorActionQueueMessageBody</maml:name> <maml:description> <maml:para>The body for storage job actions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <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, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -StorageQueueMessage "Updated message"</dev:code> <dev:remarks> <maml:para>Update queue message for storage job job1</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> C:\PS> </maml:introduction> <dev:code>Set-AzureSchedulerStorageQueueJob -Location "North Central US" -JobCollectionName jobCollection1 -JobName job1 -JobState Enabled</dev:code> <dev:remarks> <maml:para>Enable job1</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> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackVM</command:name> <maml:description> <maml:para>Gets virtual machine objects. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackVM cmdlet gets virtual machine objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackVM</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a virtual machine. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVM</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a virtual machine. </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="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a virtual machine. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a virtual machine by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVM -Name "ContosoV126" </dev:code> <dev:remarks> <maml:para>This command gets the virtual machine named ContosoV126. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a virtual machine by using an ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVM -Id 66242D17-189F-480D-87CF-8E1D749998C8 </dev:code> <dev:remarks> <maml:para>This command gets the virtual machine that has the specified ID. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all virtual machines</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVM </dev:code> <dev:remarks> <maml:para> This command gets all virtual machines. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WAPackVMOSDisk</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackVMOSDisk</command:name> <maml:description> <maml:para>Gets operating system disk objects for virtual machines. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackVMOSDisk</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackVMOSDisk cmdlet gets operating system disk objects for virtual machines. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackVMOSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of an operating system disk. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVMOSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of an operating system disk. </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="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of an operating system disk. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of an 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get an operating system disk by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMOSDisk -Name "ContosoOSDisk" </dev:code> <dev:remarks> <maml:para>This command gets an operating system disk named ContosoOSDisk. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get an operating system disk by using an ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMOSDisk -Id 66242D17-189F-480D-87CF-8E1D749998C8 </dev:code> <dev:remarks> <maml:para>This command gets the operating system disk that has the specified ID. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all operating system disks</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMOSDisk </dev:code> <dev:remarks> <maml:para>This command gets all operating system disks. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackVMSizeProfile</command:name> <maml:description> <maml:para>Gets size profile objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackVMSizeProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackVMSizeProfile cmdlet gets size profile objects for virtual machines. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackVMSizeProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a size profile. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVMSizeProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a size profile.</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="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a size profile. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a size profile.</maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a size profile by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMSizeProfile -Name "ContosoSizeProfile07" </dev:code> <dev:remarks> <maml:para>This command gets the size profile named ContosoSizeProfile07. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a size profile by using an ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMSizeProfile -ID 66242D17-189F-480D-87CF-8E1D749998C8 </dev:code> <dev:remarks> <maml:para>This command gets the size profile that has the specified ID. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all size profiles</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMSizeProfile </dev:code> <dev:remarks> <maml:para>This command gets all the size profiles. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackCloudVMRoleSizeProfile</command:name> <maml:description> <maml:para>Gets Cloud VM Role Size profile objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackCloudVMRoleSizeProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackCloudVMRoleSizeProfile cmdlet gets Cloud VM Role size profile objects for virtual machines. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackCloudVMRoleSizeProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a Cloud VM Role size profile.</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="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a Cloud VM Role size profile.</maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a Cloud VM Role size profile by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackCloudVMRoleSizeProfile -Name "Small" </dev:code> <dev:remarks> <maml:para>This command gets the size profile named Small. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all Cloud VM Role size profiles</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackCloudVMRoleSizeProfile </dev:code> <dev:remarks> <maml:para>This command gets all the size profiles. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackVMTemplate</command:name> <maml:description> <maml:para>Gets virtual machine templates.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackVMTemplate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackVMTemplate cmdlet gets virtual machine templates. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackVMTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a template. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVMTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a template. </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="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a template. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a template. </maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a virtual machine template by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMTemplate -Name "ContosoTemplate04" </dev:code> <dev:remarks> <maml:para>This command gets the virtual machine template named ContosoTemplate04. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a virtual machine template by using an ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMTemplate -Id 66242D17-189F-480D-87CF-8E1D749998C8 </dev:code> <dev:remarks> <maml:para>This command gets the virtual machine template that has the specified ID. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all virtual machine templates</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMTemplate </dev:code> <dev:remarks> <maml:para>This command gets all the virtual machine templates. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackVNet</command:name> <maml:description> <maml:para>Gets virtual networks.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackVNet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackVNet cmdlet gets virtual networks. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackVNet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a virtual network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVNet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a virtual network. </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="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a virtual network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all virtual networks</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVNet </dev:code> <dev:remarks> <maml:para>This command gets all virtual networks.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a virtual network by using an ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVNet -ID 66242D17-189F-480D-87CF-8E1D749998C8 </dev:code> <dev:remarks> <maml:para>This command gets the virtual network that has the specified ID. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get a virtual network by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-WAPackVNet -Name "ContosoVNet08" </dev:code> <dev:remarks> <maml:para>This command gets the virtual network named ContosoVNet08. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-WAPackQuickVM</command:name> <maml:description> <maml:para>Creates a virtual machine based on a template.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>WAPackQuickVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-WAPackQuickVM cmdlet creates a virtual machine based on a template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WAPackQuickVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for 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="named" aliases=""> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies a template. The cmdlet creates a virtual machine based on the template that you specify. To obtain a template object, use the Get-WAPackVMTemplate cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>VMCredential</maml:name> <maml:description> <maml:para>Specifies the credential for the local Administrator account. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for 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="named" aliases=""> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies a template. The cmdlet creates a virtual machine based on the template that you specify. To obtain a template object, use the Get-WAPackVMTemplate cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMTemplate</command:parameterValue> <dev:type> <maml:name>VMTemplate</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" aliases=""> <maml:name>VMCredential</maml:name> <maml:description> <maml:para>Specifies the credential for the local Administrator account. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a virtual machine based on a template</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Credentials = Get-Credential PS C:\> $TemplateId = Get-WAPackVMTemplate -Id 66242D17-189F-480D-87CF-8E1D749998C8 PS C:\> New-WAPackQuickVM -Name "VirtualMachine023" -Template $TemplateId -VMCredential $Credentials </dev:code> <dev:remarks> <maml:para>The first command creates a PSCredential object, and then stores it in the $Credentials variable. The cmdlet prompts you for an account and password. For more information, type Get-Help Get-Credential.</maml:para> <maml:para>The second command gets a template by using the Get-WAPackVMTemplate cmdlet. The command specifies the ID of a template. The command stores the template object in the $TemplateID variable. </maml:para> <maml:para>The final command creates a virtual machine named VirtualMachine023. The command bases the virtual machine on the template stored in $TemplateId.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WAPackVMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-WAPackVM</command:name> <maml:description> <maml:para>Creates a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-WAPackVM cmdlet creates a virtual machine. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WAPackVM</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ProductKey</maml:name> <maml:description> <maml:para>Specifies a product key. The product key is a 25 digit number that identifies the product license. Use a product key for an operating system that you plan to install on a virtual machine or host.</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" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a virtual network. The cmdlet connects the virtual machine to the virtual network that you specify. To obtain a virtual network, use the Get-WAPackVNet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMNetwork</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for 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="named" aliases=""> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies a template. The cmdlet creates a virtual machine based on the template that you specify. To obtain a template object, use the Get-WAPackVMTemplate cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VMCredential</maml:name> <maml:description> <maml:para>Specifies the credential for the local Administrator account. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.</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="named" aliases=""> <maml:name>Windows</maml:name> <maml:description> <maml:para>Indicates that the cmdlet creates a virtual machine to run the Windows operating system. </maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WAPackVM</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>AdministratorSSHKey</maml:name> <maml:description> <maml:para>Specifies the Secure Shell (SSH) key for the Administrator 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" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a virtual network. The cmdlet connects the virtual machine to the virtual network that you specify. To obtain a virtual network, use the Get-WAPackVNet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMNetwork</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Linux</maml:name> <maml:description> <maml:para>Indicates that the cmdlet creates a virtual machine to run the Linux operating system.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for 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="named" aliases=""> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies a template. The cmdlet creates a virtual machine based on the template that you specify. To obtain a template object, use the Get-WAPackVMTemplate cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMTemplate</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VMCredential</maml:name> <maml:description> <maml:para>Specifies the credential for the local Administrator account. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WAPackVM</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a virtual network. The cmdlet connects the virtual machine to the virtual network that you specify. To obtain a virtual network, use the Get-WAPackVNet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMNetwork</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for 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="named" aliases=""> <maml:name>OSDisk</maml:name> <maml:description> <maml:para>Specifies an operating system disk as a VirtualHardDisk object. To obtain an operating system disk, use the Get-WAPackVMOSDisk cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualHardDisk</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>VMSizeProfile</maml:name> <maml:description> <maml:para>Specifies a size profile for a virtual machine as a HardwareProfile object. To obtain a size profile, use the Get-WAPackVMSizeProfile cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HardwareProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>AdministratorSSHKey</maml:name> <maml:description> <maml:para>Specifies the Secure Shell (SSH) key for the Administrator 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="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Linux</maml:name> <maml:description> <maml:para>Indicates that the cmdlet creates a virtual machine to run the Linux operating system.</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="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for 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="named" aliases=""> <maml:name>OSDisk</maml:name> <maml:description> <maml:para>Specifies an operating system disk as a VirtualHardDisk object. To obtain an operating system disk, use the Get-WAPackVMOSDisk cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualHardDisk</command:parameterValue> <dev:type> <maml:name>VirtualHardDisk</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" aliases=""> <maml:name>ProductKey</maml:name> <maml:description> <maml:para>Specifies a product key. The product key is a 25 digit number that identifies the product license. Use a product key for an operating system that you plan to install on a virtual machine or host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies a template. The cmdlet creates a virtual machine based on the template that you specify. To obtain a template object, use the Get-WAPackVMTemplate cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMTemplate</command:parameterValue> <dev:type> <maml:name>VMTemplate</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>VMCredential</maml:name> <maml:description> <maml:para>Specifies the credential for the local Administrator account. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.</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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>VMSizeProfile</maml:name> <maml:description> <maml:para>Specifies a size profile for a virtual machine as a HardwareProfile object. To obtain a size profile, use the Get-WAPackVMSizeProfile cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HardwareProfile</command:parameterValue> <dev:type> <maml:name>HardwareProfile</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" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a virtual network. The cmdlet connects the virtual machine to the virtual network that you specify. To obtain a virtual network, use the Get-WAPackVNet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMNetwork</command:parameterValue> <dev:type> <maml:name>VMNetwork</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" aliases=""> <maml:name>Windows</maml:name> <maml:description> <maml:para>Indicates that the cmdlet creates a virtual machine to run the Windows operating system. </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a virtual machine for the Windows operating system by using a template</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Credentials = Get-Credential PS C:\> $Template = Get-WAPackVMTemplate -Name "ContosoTemplate04" PS C:\> New-WAPackVM -Name "ContosoV023" -Template $Template -VMCredential $Credentials -Windows </dev:code> <dev:remarks> <maml:para>The first command creates a PSCredential object, and then stores it in the $Credentials variable. The cmdlet prompts you for an account and password. For more information, type Get-Help Get-Credential.</maml:para> <maml:para>The second command gets the virtual machine template named ContosoTemplate04 by using the Get-WAPackVMTemplate cmdlet, and then stores it in the $Template variable.</maml:para> <maml:para>The final command creates a virtual machine named ContosoV023, based on the template stored in the $Template variable. The command specifies the Windows parameter, and, therefore, the virtual machine must run a version of the Windows operating system. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Create a virtual machine for the Linux operating system by using a template </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Credentials = Get-Credential PS C:\> $Template = Get-WAPackVMTemplate -Name "ContosoTemplate19" PS C:\> New-WAPackVM -Linux -Name "ContosoV028" -Template $Template -VMCredential $Credentials </dev:code> <dev:remarks> <maml:para>The first command creates a PSCredential object, and then stores it in the $Credentials variable. </maml:para> <maml:para>The second command gets the virtual machine template named ContosoTemplate19 by using the Get-WAPackVMTemplate cmdlet, and then stores it in the $Template variable.</maml:para> <maml:para>The final command creates a virtual machine named ContosoV028, based on the template stored in the $Template variable. The command specifies the Linux parameter, and, therefore, the virtual machine must run a version of the Linux operating system.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Create a virtual machine from an operating system disk and size profile</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$OSDisk = Get-WAPackVMOSDisk -Name "ContosoDiskOS" PS C:\> $SizeProfile = Get-WAPackVMSizeProfile -Name "MediumSizeVM" PS C:\> New-WAPackVM -Name "ContosoV073" -OSDisk $OSDisk -VMSizeProfile $SizeProfile </dev:code> <dev:remarks> <maml:para>The first command gets an operating system disk named ContosoDiskOS by using the Get-WAPackVMOSDisk cmdlet, and then stores it in the $OSDisk variable.</maml:para> <maml:para>The second command gets the size profile named MediumSizeVM by using the Get-WAPackVMSizeProfile cmdlet, and then stores it in the $SizeProfile variable.</maml:para> <maml:para>The final command creates a virtual machine named ContosoV073 from the operating system disk stored in $OSDisk and the size profile stored in $SizeProfile. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WAPackVMSizeProfile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WAPackVMTemplate</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WAPackVMOSDisk</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WAPackVNet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-WAPackVM</command:name> <maml:description> <maml:para>Removes virtual machine objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-WAPackVM cmdlet removes virtual machine objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-WAPackVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</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 running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a virtual machine</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126" PS C:\> Remove-WAPackVM -VM $VirtualMachine </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command removes the virtual machine stored in $VirtualMachine. The command prompts you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove a virtual machine without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126" PS C:\> Remove-WAPackVM -VM $VirtualMachine -Force </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command removes the virtual machine stored in $VirtualMachine. This command includes the Force parameter. The command does not prompt you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restart-WAPackVM</command:name> <maml:description> <maml:para>Restarts virtual machines.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Restart-WAPackVM cmdlet restarts virtual machines. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restart-WAPackVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Restart a virtual machine</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126"PS C:\> Restart-WAPackVM -VM $VirtualMachine </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command restarts the virtual machine stored in $VirtualMachine. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-WAPackVM</command:name> <maml:description> <maml:para>Resumes paused virtual machines.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Resume-WAPackVM cmdlet resumes paused virtual machines. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-WAPackVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Resume a virtual machine</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126"PS C:\> Resume-WAPackVM -VM $VirtualMachine </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command resumes the virtual machine stored in $VirtualMachine. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-WAPackVM</command:name> <maml:description> <maml:para>Changes the size properties of a virtual machine. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-WAPackVM cmdlet changes the size properties of a virtual machine. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-WAPackVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>VMSizeProfile</maml:name> <maml:description> <maml:para>Specifies a size profile for a virtual machine as a HardwareProfile object. To obtain a size profile, use the Get-WAPackVMSizeProfile cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HardwareProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>VMSizeProfile</maml:name> <maml:description> <maml:para>Specifies a size profile for a virtual machine as a HardwareProfile object. To obtain a size profile, use the Get-WAPackVMSizeProfile cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HardwareProfile</command:parameterValue> <dev:type> <maml:name>HardwareProfile</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Specify the size for a virtual machine</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126"PS C:\> $SizeProfile = Get-WAPackVMSizeProfile -Name "MediumSizeVM"PS C:\> Set-WAPackVM -VM $VirtualMachine -VMSizeProfile $SizeProfile </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command gets the size profile named MediumSizeVM by using the Get-WAPackVMSizeProfile cmdlet, and then stores that object in the $SizeProfile variable.</maml:para> <maml:para>The final command assigns the size profile stored in $SizeProfile to the virtual machine stored in $VirtualMachine. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-WAPackVMSizeProfile</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-WAPackVM</command:name> <maml:description> <maml:para>Starts a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-WAPackVM cmdlet starts a virtual machine. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-WAPackVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Start a virtual machine</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126"PS C:\> Start-WAPackVM -VM $VirtualMachine </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command starts the virtual machine stored in $VirtualMachine. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-WAPackVM</command:name> <maml:description> <maml:para>Stops a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-WAPackVM cmdlet stops a virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-WAPackVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Shutdown</maml:name> <maml:description> <maml:para>Indicates that the cmdlet shuts down the operating system of the virtual machine.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</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" aliases=""> <maml:name>Shutdown</maml:name> <maml:description> <maml:para>Indicates that the cmdlet shuts down the operating system of the 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="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Stop a virtual machine</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126"PS C:\> Stop-WAPackVM -VM $VirtualMachine </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command stops the virtual machine stored in $VirtualMachine. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-WAPackVM</command:name> <maml:description> <maml:para>Suspends a virtual machine.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>WAPackVM</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Suspend-WAPackVM cmdlet suspends a virtual machine. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-WAPackVM</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies a virtual machine. To obtain a virtual machine, use the Get-WAPackVM cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VirtualMachine</command:parameterValue> <dev:type> <maml:name>VirtualMachine</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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Suspend a virtual machine</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VirtualMachine = Get-WAPackVM -Name "ContosoV126"PS C:\> Suspend-WAPackVM -VM $VirtualMachine </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine named ContosoV126 by using the Get-WAPackVM cmdlet, and then stores that object in the $VirtualMachine variable.</maml:para> <maml:para>The second command suspends the virtual machine stored in $VirtualMachine.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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:navigationLink> <maml:linkText>Get-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-WAPackVM</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackLogicalNetwork</command:name> <maml:description> <maml:para>Gets logical network objects. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackLogicalNetwork</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackLogicalNetwork cmdlet gets logical network objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackLogicalNetwork</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a logical network. </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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a logical networks. </maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a logical network by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackLogicalNetwork -Name "ContosoLogicalNetwork01" </dev:code> <dev:remarks> <maml:para>This command gets a logical network named ContosoLogicalNetwork01. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all logical networks</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackLogicalNetwork </dev:code> <dev:remarks> <maml:para>This command gets all logical networks. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-WAPackVNet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackStaticIPAddressPool</command:name> <maml:description> <maml:para>Gets static ip address pool objects. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackStaticIPAddressPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackStaticIPAddressPool cmdlet gets static ip address pool objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackStaticIPAddressPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>VMSubnet</maml:name> <maml:description> <maml:para>Specifies the VMSubnet object associated to the static ip address pool. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMSubnet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackStaticIPAddressPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a static ip address pool. </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)" position="0" aliases=""> <maml:name>VMSubnet</maml:name> <maml:description> <maml:para>Specifies the VMSubnet object associated to the static ip address pool. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMSubnet</command:parameterValue> <dev:type> <maml:name>VMSubnet</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a static ip address pool. </maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a static ip address pool from a given VMSubnet</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Subnet = Get-WAPackVMSubet –Name “ContosoVMSubnet01”PS C:\>Get-WAPackStaticIPAddressPool –VMSubnet $Subnet -Name "ContosoStaticIPAddressPool01" </dev:code> <dev:remarks> <maml:para>This command gets the static ip address pool named “ContosoStaticIPAddressPool01” from a given VMSubnet. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all static ip address pool from a given VMSubnet</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Subnet = Get-WAPackVMSubet –Name “ContosoVMSubnet01”PS C:\>Get-WAPackStaticIPAddressPool –VMSubnet $Subnet </dev:code> <dev:remarks> <maml:para>This command gets all the static ip pool from a given VMSubet. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-WAPackStaticIPAddressPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackStaticIPAddressPool</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackVMSubnet</command:name> <maml:description> <maml:para>Gets virtual machine subnet objects. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackVMSubnet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackVMSubnet cmdlet gets virtual machine subnet objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackVMSubnet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies the VNet associated with a virtual machine subnet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VNet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVMSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a virtual machine subnet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVMSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a virtual machine subnet. </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)" position="0" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies the VNet associated with a virtual machine subnet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VNet</command:parameterValue> <dev:type> <maml:name>VNet</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" aliases=""> <maml:name>ID</maml:name> <maml:description> <maml:para>Specifies the unique ID of a virtual machine subnet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a virtual machine subnet. </maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a virtual machine subnet by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VNet = Get-WAPackVNet -Name “ContosoVNet01”PS C:\>Get-WAPackVMTemplate –VNet $VNet -Name "ContosoSubnet01" </dev:code> <dev:remarks> <maml:para>This command gets the virtual machine subnet named “ContosoSubnet01”. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a virtual machine subnet by using an ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VNet = Get- WAPackVNet -Name “ContosoVNet01”PS C:\>Get-WAPackVMSubnet –VNet $VNet -Id 66242D17-189F-480D-87CF-8E1D749998C8 </dev:code> <dev:remarks> <maml:para>This command gets the virtual machine subnet that has the specified ID. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all virtual machine subnets from a given virtualized network</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VNet = Get-WAPackVNet -Name “ContosoVNet01”PS C:\>Get-WAPackVMSubnet –VNet $VNet </dev:code> <dev:remarks> <maml:para> This command gets all the virtual machine subnets from a given virtualized network. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-WAPackVMSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVMSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackCloudService</command:name> <maml:description> <maml:para>Gets cloud service objects. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackCloudService</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackCloudService cmdlet gets cloud service objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackCloudService</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a 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="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a 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> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a cloud services by using a name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackCloudService -Name "ContosoCloudService01" </dev:code> <dev:remarks> <maml:para>This command gets the cloud service named “ContosoCloudService01”. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all cloud services</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackCloudService </dev:code> <dev:remarks> <maml:para>This command gets all cloud services. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-WAPackCloudService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackCloudService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-WAPackVMRole</command:name> <maml:description> <maml:para>Gets virtual machine role objects. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WAPackVMRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-WAPackVMRole cmdlet gets virtual machine role objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-WAPackVMRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a virtual machine role. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-WAPackVMRole</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>CloudServiceName</maml:name> <maml:description> <maml:para>Specifies the cloud service name of virtual machine role. </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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a virtual machine 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="1" aliases=""> <maml:name>CloudServiceName</maml:name> <maml:description> <maml:para>Specifies the cloud service name of virtual machine 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a virtual machine role (created through the portal)</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMRole –Name “ContosoVMRole01” </dev:code> <dev:remarks> <maml:para>This command gets a virtual machine role which has been created through the portal named “ContosoVMRole01”. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a virtual machine role by using a name and a cloud service name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMRole –CloudServiceName “ContosoCloudService01” -Name "ContosoVMRole02" </dev:code> <dev:remarks> <maml:para>This command gets a virtual machine role named ContosoVMRole02 which stand on a cloud service named ContosoCloudService01. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all virtual machine role </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-WAPackVMRole </dev:code> <dev:remarks> <maml:para> This command gets all existing virtual machine role. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-WAPackStaticIPAddressPool</command:name> <maml:description> <maml:para>Creates a static ip address pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>WAPackStaticIPAddressPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-WAPackStaticIPAddressPool cmdlet creates a static ip address pool. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WAPackStaticIPAddressPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>VMSubnet</maml:name> <maml:description> <maml:para>Specifies a VMSubnet associated with the static ip address pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMSubnet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the static ip address pool.</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" aliases=""> <maml:name>IPAddressRangeStart</maml:name> <maml:description> <maml:para>Specifies a ip address range start for the static ip address pool.</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" aliases=""> <maml:name>IPAddressRangeEnd</maml:name> <maml:description> <maml:para>Specifies a ip address range end for the static ip address pool.</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)" position="named" aliases=""> <maml:name>VMSubnet</maml:name> <maml:description> <maml:para>Specifies a VMSubnet associated with the static ip address pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMSubnet</command:parameterValue> <dev:type> <maml:name>VMSubnet</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the static ip address pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>IPAddressRangeStart</maml:name> <maml:description> <maml:para>Specifies a ip address range start for the static ip address pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>IPAddressRangeEnd</maml:name> <maml:description> <maml:para>Specifies a ip address range end for the static ip address pool.</maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a static ip address pool</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VNet = Get-WAPackVNet -Name "ContosoVNet01" PS C:\>$VMSubnet = Get-WAPackVMSubnet –VNet $VNet -Name "ContosoVMSubnet01" PS C:\>New-WAPackStaticIpAddressPool –VMSubnet $VMSubnet -Name "ContosoStaticIpAddressPool01" -IPAddressRangeStart “192.168.1.0” –IPAddressRangeEnd “192.168.1.10” </dev:code> <dev:remarks> <maml:para>The first command first retrieves the virtual machine network to which we want to add the static ip address pool. This virtual machine network is named “ContosoVNet01”.</maml:para> <maml:para>The second command uses the previously retrieved virtual machine network to get the virtual machine subnet named “ContosoVMSubnet01” to which we want to add the static ip address pool. </maml:para> <maml:para>The third and last command creates a new static ip address pool with a name “ContosoStaticIpAddressPool01” and a range start “192.168.1.0” and a range end “192.168.1.10”.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackStaticIPAddressPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackStaticIPAddressPool</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-WAPackVMSubnet</command:name> <maml:description> <maml:para>Creates a virtual machine subnet.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>WAPackVMSubnet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-WAPackVMSubnet cmdlet creates a virtual machine subnet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WAPackVMSubnet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a VNet associated with the virtual machine subnet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VNet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the virtual machine subnet.</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" aliases=""> <maml:name>Subnet</maml:name> <maml:description> <maml:para>Specifies a subnet for the virtual machine subnet.</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)" position="named" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a VNet associated with the virtual machine subnet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VNet</command:parameterValue> <dev:type> <maml:name>VNet</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the virtual machine subnet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>Subnet</maml:name> <maml:description> <maml:para>Specifies a subnet for the virtual machine subnet.</maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a virtual machine subnet</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VNet = Get-WAPackVNet -Name "ContosoVNet01" PS C:\>New-WAPackVMSubnet –VNet $VNet -Name "ContosoVMSubnet01" –Subnet “192.168.1.0/24” </dev:code> <dev:remarks> <maml:para>The first command first retrieves the virtual machine network to which we want to add a new virtual machine subnet. This virtual machine network is named “ContosoVNet01”.</maml:para> <maml:para>The second and last command creates a virtual machine subnet using the previously retrieve virtual machine network, a name “ContosoVMSubnet01” and a subnet “192.168.1.0/24”.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVMSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVMSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-WAPackVNet</command:name> <maml:description> <maml:para>Creates a virtualized network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>WAPackVNet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-WAPackVNet cmdlet creates a virtualized network. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WAPackVNet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>LogicalNetwork</maml:name> <maml:description> <maml:para>Specifies a LogicalNetwork associated with the virtualized network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogicalNetwork</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the virtualized 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="True (ByPropertyName)" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the virtualized network.</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)" position="named" aliases=""> <maml:name>LogicalNetwork</maml:name> <maml:description> <maml:para>Specifies a LogicalNetwork associated with the virtualized network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogicalNetwork</command:parameterValue> <dev:type> <maml:name>LogicalNetwork</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the virtualized 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="True (ByPropertyName)" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the virtualized 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a virtualized network</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$LogicalNetwork = Get-WAPackLogicalNetwork -Name "ContosoLogicalNetwork01" PS C:\>New-WAPackVNet –LogicalNetwork $LogicalNetwork -Name "ContosoVNett01" –Description “A description” </dev:code> <dev:remarks> <maml:para>The first command first retrieves the logical network to which we want to add a new virtualized network. This logical network is named “ContosoLogicalNetwork01”.</maml:para> <maml:para>The second and last command creates a virtualized network using the previously retrieve logical network, a name “ContosoVNett01” and a description “A description”.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVNet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVNet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-WAPackCloudService</command:name> <maml:description> <maml:para>Creates a cloud service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>WAPackCloudService</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-WAPackCloudService cmdlet creates a cloud service. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WAPackCloudService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the cloudservice.</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" aliases=""> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for 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="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for 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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a ip address range start for the static ip address pool.</maml:para> </maml:description> <command:parameterValue required="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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a cloud service</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>New-WAPackCloudService -Name "ContosoCloudService01" -Label “A label” </dev:code> <dev:remarks> <maml:para>The command creates a cloud service named “ContosoCloudService01” with a label. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackCloudService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackCloudService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-WAPackVMRole</command:name> <maml:description> <maml:para>Creates a virtual machine role.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>WAPackVMRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-WAPackVMRole cmdlet creates a virtual machine role. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WAPackVMRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>ResourceDefinition</maml:name> <maml:description> <maml:para>Specifies a resource definition for the virtual machine role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceDefinition</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the virtual machine role.</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" aliases=""> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the virtual machine 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="named" aliases=""> <maml:name>CloudService</maml:name> <maml:description> <maml:para>Specifies a cloud service for the virtual machine role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CloudService</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>ResourceDefinition</maml:name> <maml:description> <maml:para>Specifies a resource definition for the virtual machine role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceDefinition</command:parameterValue> <dev:type> <maml:name>ResourceDefinition</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" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the virtual machine 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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Label</maml:name> <maml:description> <maml:para>Specifies a label for the virtual machine 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="named" aliases=""> <maml:name>CloudService</maml:name> <maml:description> <maml:para>Specifies a cloud service for the virtual machine role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CloudService</command:parameterValue> <dev:type> <maml:name>CloudService</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a virtual machine role (emulating WAP behavior)</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>New-WAPackVMRole –Name “ContosoVMRole01” -Label "ContosoVMRoleLabel01" –ResourceDefinition $resdef </dev:code> <dev:remarks> <maml:para>Since we do not specify any cloud service (emulating WAP behavior), the command will create a cloud service for us which will have the same name as the virtual machine role. In this case, the following command will create a virtual machine role with the name “ContosoVMRole01”, label “ContosoVMRoleLabel01”. Note that the resource definition being used here has to be manually created though PowerShell.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-WAPackStaticIPAddressPool</command:name> <maml:description> <maml:para>Removes static ip address pool objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WAPackStaticIPAddressPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-WAPackStaticIPAddressPool cmdlet removes static ip address pool objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-WAPackStaticIPAddressPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>StaticIPAddressPool</maml:name> <maml:description> <maml:para>Specifies a StaticIPAddressPool. To obtain a static ip address pool, use the Get-WAPackStaticIPAddressPool cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StaticIPAddressPool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>StaticIPAddressPool</maml:name> <maml:description> <maml:para>Specifies a static ip address pool. To obtain a static ip address pool, use the Get-WAPackStaticIPAddressPool cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StaticIPAddressPool</command:parameterValue> <dev:type> <maml:name>StaticIPAddressPool</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 running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a static ip address pool</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$StaticIPAddressPool = Get-WAPackStaticIPAddressPool -Name “ContosoStaticIPAddressPool01” PS C:\>Remove-WAPackStaticIPAddressPool -StaticIPAddressPool $StaticIPAddressPool </dev:code> <dev:remarks> <maml:para>The first command gets the static ip address pool named ContosoStaticIPAddressPool01 by using the Get-WAPackStaticIPAddressPool cmdlet, and then stores that object in the $StaticIPAddressPool variable.</maml:para> <maml:para>The second command removes the static ip address pool stored in $StaticIPAddressPool. The command prompts you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove a static ip address pool without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$StaticIPAddressPool = Get-WAPackStaticIPAddressPool -Name "ContosoStaticIPAddressPool02" PS C:\>Remove-WAPackStaticIPAddressPool -StaticIPAddressPool $StaticIPAddressPool -Force </dev:code> <dev:remarks> <maml:para>The first command gets the static ip address pool named ContosoStaticIPAddressPool02 by using the Get- WAPackStaticIPAddressPool cmdlet, and then stores that object in the $ StaticIPAddressPool variable.</maml:para> <maml:para>The second command removes the static ip address pool stored in $StaticIPAddressPool. This command includes the Force parameter. The command does not prompt you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackStaticIPAddressPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackStaticIPAddressPool</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-WAPackVMSubnet</command:name> <maml:description> <maml:para>Removes virtual machine subnet objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WAPackVMSubnet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-WAPackVMSubnet cmdlet removes virtual machine subnet objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-WAPackVMSubnet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VMSubnet</maml:name> <maml:description> <maml:para>Specifies a virtual machine subnet. To obtain a virtual machine subnet, use the Get-WAPackVMSubnet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMSubnet</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VMSubnet</maml:name> <maml:description> <maml:para>Specifies a virtual machine subnet. To obtain a virtual machine subnet, use the Get-WAPackVMSubnet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMSubnet</command:parameterValue> <dev:type> <maml:name>VMSubnet</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 running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a virtual machine subnet</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VMSubnet = Get-WAPackVMSubnet -Name “ContosoVMSubnet01” PS C:\>Remove-WAPackVMSubnet -VMSubnet $VMSubnet </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine subnet named ContosoVMSubnet01 by using the Get-WAPackVMSubnet cmdlet, and then stores that object in the $VMSubnet variable.</maml:para> <maml:para>The second command removes the virtual machine subnet stored in $VMSubnet. The command prompts you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove a virtual machine without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VMSubnet = Get-WAPackVMSubnet -Name "ContosoVMSubnet02" PS C:\>Remove-WAPackVMSubnet -VMSubnet $VMSubnet -Force </dev:code> <dev:remarks> <maml:para>The first command gets the cloud service named ContosoVMSubnet02 by using the Get- WAPackVMSubnet cmdlet, and then stores that object in the $VMSubnet variable.</maml:para> <maml:para>The second command removes the virtual machine subnet stored in $VMSubnet. This command includes the Force parameter. The command does not prompt you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVMSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVMSubnet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-WAPackVNet</command:name> <maml:description> <maml:para>Removes virtualized network.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WAPackVNet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-WAPackVNet cmdlet removes virtualized network objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-WAPackVNet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a virtualized network. To obtain a virtualized network, use the Get-WAPackVNet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VNet</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VNet</maml:name> <maml:description> <maml:para>Specifies a virtualized network. To obtain a virtualized network, use the Get-WAPackVNet cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VNet</command:parameterValue> <dev:type> <maml:name>VNet</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 running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a virtualized network</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VNet = Get-WAPackVNet -Name “ContosoVNet01” PS C:\>Remove-WAPackVM -VNet $VNet </dev:code> <dev:remarks> <maml:para>The first command gets the virtualized network named ContosoVNet01 by using the Get-WAPackVNet cmdlet, and then stores that object in the $VNet variable.</maml:para> <maml:para>The second command removes the virtualized network stored in $VNet. The command prompts you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove a virtualized network without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VNet = Get-WAPackVNet -Name "ContosoVNet02" PS C:\>Remove-WAPackVNet -VNet $VNet -Force </dev:code> <dev:remarks> <maml:para>The first command gets the cloud service named ContosoVNet02 by using the Get-WAPackVNet cmdlet, and then stores that object in the $VNet variable.</maml:para> <maml:para>The second command removes the virtualized network stored in $VNet. This command includes the Force parameter. The command does not prompt you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVNet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVNet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-WAPackCloudService</command:name> <maml:description> <maml:para>Removes cloud service objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WAPackCloudService</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-WAPackCloudService cmdlet removes cloud service objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-WAPackCloudService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>CloudService</maml:name> <maml:description> <maml:para>Specifies a cloud service. To obtain a cloud service, use the Get-WAPackCloudService cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CloudService</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>CloudService</maml:name> <maml:description> <maml:para>Specifies a cloud service. To obtain a cloud service, use the Get-WAPackCloudService cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CloudService</command:parameterValue> <dev:type> <maml:name>CloudService</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 running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a cloud service</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$CloudService = Get-WAPackCloudService -Name “ContosoCloudService01” PS C:\>Remove-WAPackVM -VM $CloudService </dev:code> <dev:remarks> <maml:para>The first command gets the cloud service named ContosoCloudService01 by using the Get-WAPackCloudService cmdlet, and then stores that object in the $CloudService variable.</maml:para> <maml:para>The second command removes the cloudservice stored in $CloudService. The command prompts you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove a cloud service without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$CloudService = Get-WAPackCloudService -Name "ContosoCloudService02" PS C:\>Remove-WAPackCloudService -VM $CloudService -Force </dev:code> <dev:remarks> <maml:para>The first command gets the cloud service named ContosoCloudService02 by using the Get-WAPackCloudService cmdlet, and then stores that object in the $CloudService variable.</maml:para> <maml:para>The second command removes the cloud service stored in $CloudService. This command includes the Force parameter. The command does not prompt you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackCloudService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackCloudService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-WAPackVMRole</command:name> <maml:description> <maml:para>Removes virtual machine role objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WAPackVMRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-WAPackVMRole cmdlet removes virtual machine role objects. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-WAPackVMRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VMRole</maml:name> <maml:description> <maml:para>Specifies a virtual machine role. To obtain a virtual machine role, use the Get-WAPackVMRole cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMRole</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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 running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that the cmdlet removes a virtual machine without prompting you for confirmation. </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="2" aliases=""> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that the cmdlet returns a Boolean value. If the operation succeeds, the cmdlet returns a value of $True. Otherwise, it returns a value of $False. By default, this cmdlet does not generate any output.</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)" position="1" aliases=""> <maml:name>VMRole</maml:name> <maml:description> <maml:para>Specifies a virtual machine role. To obtain a virtual machine role, use the Get-WAPackVMRole cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMRole</command:parameterValue> <dev:type> <maml:name>VMRole</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 running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a virtual machine role (which was created using the WAP portal)</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VMRole = Get-WAPackVMRole -Name “ContosoVMRole01” PS C:\>Remove-WAPackVMRole -VMRole $VMRole </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine role named ContosoVMRole01 by using the Get-WAPackVMRole cmdlet, and then stores that object in the $VMRole variable.</maml:para> <maml:para>The second command removes the virtual machine role stored in $VMRole. The command prompts you for confirmation.</maml:para> <maml:para>Assuming this virtual machine role was created using the WAP portal, there’s no need to specify the cloud service name.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove a virtual machine role which was created after manually creating a cloud service</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VMRole = Get-WAPackVMRole -Name “ContosoVMRole02” PS C:\>Remove-WAPackVMRole -VMRole $VMRole –CloudServiceName “ContosoCloudService02” </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine role named "ContosoVMRole02" by using the Get-WAPackVMRole cmdlet, and then stores that object in the $VMRole variable.</maml:para> <maml:para>The second command removes the virtual machine role stored in $VMRole. The command prompts you for confirmation.</maml:para> <maml:para>Assuming this virtual machine role was not created using the portal, the user needs to specify the cloud service name. In this case named "ContosoCloudService02".</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Remove a virtual machine role without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VMRole = Get-WAPackVMRole -Name "ContosoVMRole03" PS C:\>Remove-WAPackVMRole -VMRole $VMRole -Force </dev:code> <dev:remarks> <maml:para>The first command gets the cloud service named ContosoVMRole03 by using the Get-WAPackVMRole cmdlet, and then stores that object in the $VMRole variable.</maml:para> <maml:para>The second command removes the virtual machine role stored in $VMRole. This command includes the Force parameter. The command does not prompt you for confirmation.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-WAPackVMRole</command:name> <maml:description> <maml:para>Changes the instance count property of a virtual machine role. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>WAPackVMRole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-WAPackVMRole cmdlet changes the instance count property of a virtual machine role. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-WAPackVMRole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>VMRole</maml:name> <maml:description> <maml:para>Specifies a virtual machine role. To obtain a virtual machine role, use the Get-WAPackVMRole cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMRole</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>InstanceCount</maml:name> <maml:description> <maml:para>Specifies the instance count for a virtual machinerole.</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 (ByValue)" position="1" aliases=""> <maml:name>VMRole</maml:name> <maml:description> <maml:para>Specifies a virtual machine role. To obtain a virtual machine role, use the Get-WAPackVMRole cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMRole</command:parameterValue> <dev:type> <maml:name>VMRole</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>InstanceCount</maml:name> <maml:description> <maml:para>Specifies the instance count for a virtual machine role.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>InstanceCount</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Specify the instance count for a virtual machine role</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$VMRole = Get-WAPackVMRole -Name "ContosoVMRole01" PS C:\>Set-WAPackVMRole -VMRole $VMRole -InstanceCount 3 </dev:code> <dev:remarks> <maml:para>The first command gets the virtual machine role named ContosoVMRole01 by using the Get-WAPackVMRole cmdlet, and then stores that object in the $VMRole variable.</maml:para> <maml:para>The second and final command sets the new instance count of the virtual machine role stored in $VMRole to 3. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-WAPackVMRole</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-AzureHDInsightHiveJob</command:name> <maml:description> <maml:para>Submits Hive queries to the HDInsight cluster, shows progress of the query execution, and retrieves query results in one operation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>AzureHDInsightHiveJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Submits Hive queries to the HDInsight cluster, shows progress of the query execution, and retrieves query results in one operation. The Use-AzureHDInsightCluster cmdlet needs to be used before calling Invoke-Hive to specify which HDInsight cluster the query will be submitted to.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-AzureHDInsightHiveJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="QueryText"> <maml:name>Query</maml:name> <maml:description> <maml:para>The Hive query to be executed.</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" aliases=""> <maml:name>Arguments</maml:name> <maml:description> <maml:para>Arguments of the Hadoop job. The arguments will be passed as command line arguments to each task.</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" aliases="Params"> <maml:name>Defines</maml:name> <maml:description> <maml:para>Hadoop configuration values to be set during the job execution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="QueryFile"> <maml:name>File</maml:name> <maml:description> <maml:para>The wasb path to a file in Azure Blob Storage that contains the query to be executed. Use this File parameter in place of a query parameter.</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" aliases=""> <maml:name>Files</maml:name> <maml:description> <maml:para>A collection of files required for the Hive job to execute.</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" aliases="Name"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The name of the Hive job being defined. If the name is not specified, it is "Hive: <first 100 characters of Query>" by default.</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" aliases=""> <maml:name>StatusFolder</maml:name> <maml:description> <maml:para>Location of the status folder where the standard and error outputs of the job will be stored, including its exit code and task logs.</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="false" position="named" aliases=""> <maml:name>Arguments</maml:name> <maml:description> <maml:para>Arguments of the Hadoop job. The arguments will be passed as command line arguments to each task.</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" aliases="Params"> <maml:name>Defines</maml:name> <maml:description> <maml:para>Hadoop configuration values to be set during the job execution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="QueryFile"> <maml:name>File</maml:name> <maml:description> <maml:para>The wasb path to a file in Azure Blob Storage that contains the query to be executed. Use this File parameter in place of a query parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>Files</maml:name> <maml:description> <maml:para>A collection of files required for the Hive job to execute.</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" aliases="Name"> <maml:name>JobName</maml:name> <maml:description> <maml:para>The name of the Hive job being defined. If the name is not specified, it is "Hive: <first 100 characters of Query>" by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases="QueryText"> <maml:name>Query</maml:name> <maml:description> <maml:para>The Hive query to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>StatusFolder</maml:name> <maml:description> <maml:para>Location of the status folder where the standard and error outputs of the job will be stored, including its exit code and task 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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Submit a Hive query</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Use-AzureHDInsightCluster yourcluster -Subscription (Get-AzureSubscription -Current).SubscriptionId Invoke-Hive "select * from hivesampletable limit 10" </dev:code> <dev:remarks> <maml:para>Submit a Hive queries to the HDInsight cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureHDInsightSqoopJobDefinition</command:name> <maml:description> <maml:para>Defines a new Sqoop job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureHDInsightSqoopJobDefinition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Defines a Sqoop job to be run on an HDInsight cluster.</maml:para> <maml:para>This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureHDInsightSqoopJobDefinition</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Command</maml:name> <maml:description> <maml:para> </maml:para> <maml:para>Specifies a Sqoop command and its arguments.</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" aliases="QueryFile"> <maml:name>File</maml:name> <maml:description> <maml:para>The path to a script file that contains the commands to be executed. The script file must be located on wasb.</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" aliases=""> <maml:name>Files</maml:name> <maml:description> <maml:para>The collection of files required for the execution of the job. Use wasb file references here.</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" aliases=""> <maml:name>StatusFolder</maml:name> <maml:description> <maml:para>Location of the status folder where the standard and error outputs of the Sqoop job will be stored, including its exit code and task logs.</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" aliases=""> <maml:name>Command</maml:name> <maml:description> <maml:para> </maml:para> <maml:para>Specifies a Sqoop command and its arguments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases="QueryFile"> <maml:name>File</maml:name> <maml:description> <maml:para>The path to a script file that contains the commands to be executed. The script file must be located on wasb.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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" aliases=""> <maml:name>Files</maml:name> <maml:description> <maml:para>The collection of files required for the execution of the job. Use wasb file references here.</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" aliases=""> <maml:name>StatusFolder</maml:name> <maml:description> <maml:para>Location of the status folder where the standard and error outputs of the Sqoop job will be stored, including its exit code and task 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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>Sqoop is a tool designed to transfer data between Hadoop clusters and relational databases. You can use Sqoop to import data from a SQL database into an Hadoop Distributed File System (HDFS), transform the data with Hadoop MapReduce, and then export the data from the HDFS back into the SQL database.</maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Import data</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$sqoopJobDef = New-AzureHDInsightSqoopJobDefinition -Command "import --connect jdbc:sqlserver://<SQLDatabaseServerName>.database.windows.net:1433;username=<SQLDatabasUsername>@<SQLDatabaseServerName>; password=<SQLDatabasePassword>; database=<SQLDatabaseDatabaseName> --table <TableName> --target-dir wasb://<ContainerName>@<WindowsAzureStorageAccountName>.blob.core.windows.net/<Path>" </dev:code> <dev:remarks> <maml:para>Define a Sqoop job that that imports??all the rows of a table from a Windows Azure SQL Database to an HDInsight cluster.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureAutomationAccount</command:name> <maml:description> <maml:para>Gets Azure Automation accounts.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAutomationAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureAutomationAccount cmdlet gets the Microsoft Azure Automation accounts for your subscription. An Automation account is a container for Automation resources that is isolated from the resources of other Automation accounts. Automation resources include runbooks, jobs, and assets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAutomationAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies an Azure location associated with Automation accounts.</maml:para> </maml:description> <command:parameterValue required="false" 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="2" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies an Azure location associated with Automation accounts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get an Automation account</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAutomationAccount -Name "Contoso17" </dev:code> <dev:remarks> <maml:para>This command gets the Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397902</maml:uri> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureAutomationJob</command:name> <maml:description> <maml:para>Gets one or more Azure Automation runbook jobs.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAutomationJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureAutomationJob cmdlet gets one or more runbook jobs in Microsoft Azure Automation. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAutomationJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end time for a job as a DateTime object. This cmdlet gets jobs that have an end time at or before the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start time of a job as a DateTime object. This cmdlet gets jobs that have a start time at or after the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end time for a job as a DateTime object. This cmdlet gets jobs that have an end time at or before the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start time of a job as a DateTime object. This cmdlet gets jobs that have a start time at or after the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RunbookId</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end time for a job as a DateTime object. This cmdlet gets jobs that have an end time at or before the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start time of a job as a DateTime object. This cmdlet gets jobs that have a start time at or after the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RunbookName</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the end time for a job as a DateTime object. This cmdlet gets jobs that have an end time at or before the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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="named" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RunbookId</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RunbookName</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </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="false" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start time of a job as a DateTime object. This cmdlet gets jobs that have a start time at or after the value that this parameter specifies. To obtain a DateTime object, use the Get-Date cmdlet. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a runbook job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b647 </dev:code> <dev:remarks> <maml:para>This command gets the job that has the specified GUID.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397903</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureAutomationJobOutput</command:name> <maml:description> <maml:para>Gets the output of an Azure Automation job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAutomationJobOutput</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureAutomationJobOutput cmdlet gets the output of a Microsoft Azure Automation job. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAutomationJobOutput</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies a start time as a DateTime object. The cmdlet retrieves output created after this time. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="OutputType"> <maml:name>Stream</maml:name> <maml:description> <maml:para> Specifies the type of output. Valid values are: -- Any -- Debug -- Error -- Output -- Progress -- Verbose -- Warning </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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies a start time as a DateTime object. The cmdlet retrieves output created after this time. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="OutputType"> <maml:name>Stream</maml:name> <maml:description> <maml:para> Specifies the type of output. Valid values are: -- Any -- Debug -- Error -- Output -- Progress -- Verbose -- Warning </maml:para> </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get the output of an Azure Automation job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAutomationJobOutput -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 -Stream "Any" </dev:code> <dev:remarks> <maml:para>This command gets all of the output of the job that has the specified ID.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397904</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureAutomationRunbook</command:name> <maml:description> <maml:para>Gets a runbook.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAutomationRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureAutomationRunbook cmdlet gets one or more Microsoft Azure Automation runbooks. By default, all runbooks are returned. To get a specific runbook, specify its name or ID. To get all runbooks linked to a specific schedule, specify the schedule name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. </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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. </maml:para> </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all runbooks</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAutomationRunbook -AutomationAccountName "Contoso17" </dev:code> <dev:remarks> <maml:para>This command gets all runbooks in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397905</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureAutomationRunbookDefinition</command:name> <maml:description> <maml:para>Gets a runbook definition.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAutomationRunbookDefinition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureAutomationRunbookDefinition cmdlet gets the draft definition, the published definition, or both definitions of an Azure Automation runbook. By default, both runbook definitions are returned. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAutomationRunbookDefinition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>Slot</maml:name> <maml:description> <maml:para> Specifies a runbook definition type. Valid values are: -- Published -- Draft </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationRunbookDefinition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>Slot</maml:name> <maml:description> <maml:para> Specifies a runbook definition type. Valid values are: -- Published -- Draft </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationRunbookDefinition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>Slot</maml:name> <maml:description> <maml:para> Specifies a runbook definition type. Valid values are: -- Published -- Draft </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>VersionId</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </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="false" position="named" aliases="none"> <maml:name>Slot</maml:name> <maml:description> <maml:para> Specifies a runbook definition type. Valid values are: -- Published -- Draft </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>VersionId</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a runbook definition</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAutomationRunbookDefinition -AutomationAccountName "Contoso17" -Name "RunbookDef01" -Slot "Published" </dev:code> <dev:remarks> <maml:para>This command gets the published runbook definition of the runbook named RunbookDef01 in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397906</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationRunbookDefinition</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureAutomationSchedule</command:name> <maml:description> <maml:para>Gets an Azure Automation schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureAutomationSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureAutomationSchedule cmdlet gets a Microsoft Azure Automation schedule. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a schedule.</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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a schedule.</maml:para> </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureAutomationSchedule -AutomationAccountName "Contoso17" -Name "DailySchedule08" </dev:code> <dev:remarks> <maml:para>This command gets the schedule named DailySchedule08.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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= 397907</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureAutomationRunbook</command:name> <maml:description> <maml:para>Creates a new runbook.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureAutomationRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureAutomationRunbook cmdlet creates a new, empty Microsoft Azure Automation runbook. Specify a name to create a new runbook.</maml:para> <maml:para>You can also specify the path to a Windows PowerShell? script (.ps1 ) file to import a runbook. The script to import must contain a single Windows PowerShell? Workflow definition. The name of this Windows PowerShell Workflow becomes the name of the runbook.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies one or more runbook tags. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name for the runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies one or more runbook tags. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookPath"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to a runbook to import.</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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name for the runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookPath"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to a runbook to import.</maml:para> </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="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies one or more runbook tags. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a runbook</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>New-AzureAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbook02" </dev:code> <dev:remarks> <maml:para>This command creates a new runbook named Runbook02 in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397908</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureAutomationSchedule</command:name> <maml:description> <maml:para>Creates an Azure Automation schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureAutomationSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureAutomationSchedule cmdlet creates a schedule in Microsoft Azure Automation. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the schedule.</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" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start time of a schedule as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet.</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="4" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>ExpiryTime</maml:name> <maml:description> <maml:para>Specifies the expiry time of a schedule as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases="none"> <maml:name>DayInterval</maml:name> <maml:description> <maml:para>Specifies an interval for the schedule in days. If you do not specify this parameter, and you do not specify the OneTime parameter, then the day interval of the schedule is 1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the schedule.</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" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start time of a schedule as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet.</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="4" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OneTime</maml:name> <maml:description> <maml:para>Specifies that the cmdlet creates a one-time schedule. </maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases="none"> <maml:name>DayInterval</maml:name> <maml:description> <maml:para>Specifies an interval for the schedule in days. If you do not specify this parameter, and you do not specify the OneTime parameter, then the day interval of the schedule is 1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="4" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="none"> <maml:name>ExpiryTime</maml:name> <maml:description> <maml:para>Specifies the expiry time of a schedule as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OneTime</maml:name> <maml:description> <maml:para>Specifies that the cmdlet creates a one-time schedule. </maml:para> </maml:description> <command:parameterValue required="true" 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" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the start time of a schedule as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet.</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>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$StartDate = Get-Date -Day 12 -Month 6 -Year 2016 PS C:\> $EndDate = Get-Date -Day 12 -Month 6 -Year 2023 PS C:\> New-AzureAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -StartTime $StartDate -ExpiryTime $EndDate </dev:code> <dev:remarks> <maml:para>The first command creates a date object by using the Get-Date cmdlet, and then stores the object in the $StartDate variable. Specify a time that is at least five minutes in the future. For more information, type Get-Help Get-Date.</maml:para> <maml:para>The second command creates a date object by using the Get-Date cmdlet, and then stores the object in the $EndDate variable. The command specifies a future time. </maml:para> <maml:para>The final command creates a daily schedule named Schedule01 to begin at the time stored in $StartDate and expire at the time stored in $EndDate.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397909</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-AzureAutomationRunbook</command:name> <maml:description> <maml:para>Publishes a runbook.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>AzureAutomationRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Publish-AzureAutomationRunbook cmdlet publishes a runbook for use in the production environment of Microsoft Azure Automation. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Publish a runbook</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Publish-AzureAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" </dev:code> <dev:remarks> <maml:para>This command publishes the runbook named Runbk01 in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397910</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-AzureAutomationScheduledRunbook</command:name> <maml:description> <maml:para>Associates a runbook with a schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Register</command:verb> <command:noun>AzureAutomationScheduledRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Register-AzureAutomationScheduleRunbook cmdlet associates a runbook with a schedule. The runbook starts based on the schedule you specify using the ScheduleName parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-AzureAutomationScheduledRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values. When the runbook starts in response to when the associated schedule fires, these parameters are passed to the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</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" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. To create a schedule in Azure Automation, use the New-AzureAutomationSchedule cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Register-AzureAutomationScheduledRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values. When the runbook starts in response to when the associated schedule fires, these parameters are passed to the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. To create a schedule in Azure Automation, use the New-AzureAutomationSchedule cmdlet.</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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </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="named" aliases="none"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values. When the runbook starts in response to when the associated schedule fires, these parameters are passed to the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</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="named" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. To create a schedule in Azure Automation, use the New-AzureAutomationSchedule 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>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Associate a runbook with a schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Register-AzureAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ScheduleName "Sched01" </dev:code> <dev:remarks> <maml:para>This command associates the runbook named Runbk01 with the schedule named Sched01 in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397911</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-AzureAutomationScheduledRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureAutomationRunbook</command:name> <maml:description> <maml:para>Removes a runbook.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureAutomationRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureAutomationRunbook cmdlet removes a runbook from Microsoft Azure Automation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</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 running the cmdlet.Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</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 running the cmdlet.Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</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="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a runbook</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Remove-AzureAutomationRunbook -AutomationAccountName "Contoso17" -Name "MyRunbook" </dev:code> <dev:remarks> <maml:para>This command removes the runbook named MyRunbook in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397912</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureAutomationSchedule</command:name> <maml:description> <maml:para>Deletes an Azure Automation schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureAutomationSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureAutomationSchedule cmdlet deletes a schedule from Microsoft Azure Automation. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a schedule.</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" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</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 running the cmdlet.Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</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 running the cmdlet.Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</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="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Remove-AzureAutomationSchedule -AutomationAccountName "Contoso17" -Name "MySchedule" </dev:code> <dev:remarks> <maml:para>This command removes the schedule named MySchedule.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397913</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-AzureAutomationJob</command:name> <maml:description> <maml:para>Resumes a suspended Azure Automation job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>AzureAutomationJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Resume-AzureAutomationJob cmdlet resumes a suspended Microsoft Azure Automation job. Specify the suspended job. </maml:para> <maml:para>To suspend a job, use the Suspend-AzureAutomationJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-AzureAutomationJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Resume a suspended job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Resume-AzureAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 </dev:code> <dev:remarks> <maml:para>This command resumes the job that has the specified ID.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397914</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureAutomationRunbook</command:name> <maml:description> <maml:para>Modifies the configuration of a runbook.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureAutomationRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureAutomationRunbook cmdlet modifies the configuration of a Microsoft Azure Automation runbook.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>LogDebug</maml:name> <maml:description> <maml:para>Indicates whether debug output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>LogProgress</maml:name> <maml:description> <maml:para>Indicates whether progress output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>LogVerbose</maml:name> <maml:description> <maml:para>Indicates whether verbose output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies one or more runbook tags. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>LogDebug</maml:name> <maml:description> <maml:para>Indicates whether debug output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>LogProgress</maml:name> <maml:description> <maml:para>Indicates whether progress output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>LogVerbose</maml:name> <maml:description> <maml:para>Indicates whether verbose output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies one or more runbook tags. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="none"> <maml:name>LogDebug</maml:name> <maml:description> <maml:para>Indicates whether debug output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="named" aliases="none"> <maml:name>LogProgress</maml:name> <maml:description> <maml:para>Indicates whether progress output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="named" aliases="none"> <maml:name>LogVerbose</maml:name> <maml:description> <maml:para>Indicates whether verbose output is logged for jobs of this runbook.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </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="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies one or more runbook tags. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Enable verbose logging for a runbook</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Set-AzureAutomationRunbook -AutomationAccountName "Contoso17" -Name "MyRunbook" -LogVerbose $True </dev:code> <dev:remarks> <maml:para>This command enables verbose logging for the jobs of the specified runbook in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397915</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureAutomationRunbookDefinition</command:name> <maml:description> <maml:para>Updates the draft definition of a runbook.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureAutomationRunbookDefinition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureAutomationRunbookDefinition cmdlet updates the draft definition of a Microsoft Azure Automation runbook. Provide a Windows PowerShell? script (.ps1) file that contains a runbook which becomes the draft runbook. If a draft already exists, use the Overwrite parameter to force the cmdlet to overwrite the existing draft.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureAutomationRunbookDefinition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an automation 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" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that the new draft runbook overwrites the existing draft, if one exists.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</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" aliases="RunbookPath"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the new draft runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureAutomationRunbookDefinition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an automation 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" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that the new draft runbook overwrites the existing draft, if one exists.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookPath"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the new draft runbook.</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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </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="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that the new draft runbook overwrites the existing draft, if one 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookPath"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to the new draft runbook.</maml:para> </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Overwrite an existing draft definition of a runbook</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Set-AzureAutomationRunbookDefinition -AutomationAccountName "Contoso17" -Name "Runbk01" -Path App01.ps1 -Overwrite </dev:code> <dev:remarks> <maml:para>This command overwrites the existing draft definition of a runbook.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397916</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationRunbookDefinition</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureAutomationSchedule</command:name> <maml:description> <maml:para>Modifies an Azure Automation schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureAutomationSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureAutomationSchedule cmdlet modifies a schedule in Microsoft Azure Automation. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a schedule.</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" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureAutomationSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description. </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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a schedule.</maml:para> </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Modify a schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Set-AzureAutomationSchedule -AutomationAccountName "Contoso17" -Name "Schedule01" -Description "Automation Schedule" </dev:code> <dev:remarks> <maml:para>This command modifies the description of the schedule named Schedule01.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397917</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-AzureAutomationRunbook</command:name> <maml:description> <maml:para>Starts a runbook job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>AzureAutomationRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-AzureAutomationRunbook cmdlet starts a Microsoft Azure Automation runbook job. Specify the ID or name of a runbook. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-AzureAutomationRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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" aliases="none"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </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="named" aliases="none"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Start a runbook job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Start-AzureAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" </dev:code> <dev:remarks> <maml:para>This command starts a runbook job for the runbook named Runbk01 in the Azure Automation account named Contoso17.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397918</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureAutomationRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-AzureAutomationJob</command:name> <maml:description> <maml:para>Stops an Azure Automation job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureAutomationJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-AzureAutomationJob cmdlet stops a Microsoft Azure Automation job. Specify a running automation job. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureAutomationJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Stop a job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Stop-AzureAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 </dev:code> <dev:remarks> <maml:para>This command stops the job that has the specified ID.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397919</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-AzureAutomationJob</command:name> <maml:description> <maml:para>Suspends an Azure Automation job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>AzureAutomationJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Suspend-AzureAutomationJob cmdlet suspends a Microsoft Azure Automation job. Specify a running Automation job. </maml:para> <maml:para>To resume a suspended job, use the Resume-AzureAutomationJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-AzureAutomationJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="JobId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Suspend a job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Suspend-AzureAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64 </dev:code> <dev:remarks> <maml:para>This command suspends the job that has the specified ID.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397920</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AzureAutomationJob</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-AzureAutomationScheduledRunbook</command:name> <maml:description> <maml:para>Removes an association between a runbook and a schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unregister</command:verb> <command:noun>AzureAutomationScheduledRunbook</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Unregister-AzureAutomationScheduledRunbook cmdlet removes the association between a Microsoft Azure Automation runbook and a schedule, which stops the runbook from starting when the schedule fires. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-AzureAutomationScheduledRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</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" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Unregister-AzureAutomationScheduledRunbook</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation account.</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" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. </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" aliases="none"> <maml:name>AutomationAccountName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure Automation 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>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="RunbookId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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="named" aliases="RunbookName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a runbook.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Specifies the name of a schedule. </maml:para> </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:uri> <maml:description> <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:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove the association between a runbook and a schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Unregister-AzureAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ScheduleName "Runbk01Sched" </dev:code> <dev:remarks> <maml:para>This command removes the association between the runbook named Runbk01 and the schedule named Runbk01Sched.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <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=397921</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-AzureAutomationScheduledRunbook</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, utilities</maml:para> </maml:alert> </maml:alertSet> </command:command> </helpItems> |