Microsoft.Azure.Commands.Profile.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-AzureRmAccount</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmAccount</command:noun> <maml:description><maml:para>Adds an authenticated account to use for Azure Resource Manager cmdlet requests. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmAcccount cmdlet adds an authenticated Azure account to use for Azure Resource Manager cmdlet requests. </maml:para> <maml:para>You can use this authenticated account only with Azure Resource Manager cmdlets. To add an authenticated account for use with Service Management cmdlets, use the Add-AzureAccount or the Import-AzurePublishSettingsFile cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AccessToken</maml:name> <maml:Description><maml:para>Specifies an access token. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AccountId</maml:name> <maml:Description><maml:para>Account Id for access token </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </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 (ByValue)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the ID of the subscription. If you do not specify this parameter, the first subscription from the subscription list is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AccessToken</maml:name> <maml:Description><maml:para>Specifies an access token. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AccountId</maml:name> <maml:Description><maml:para>Account Id for access token </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionName</maml:name> <maml:Description><maml:para>Subscription 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApplicationId</maml:name> <maml:Description><maml:para>SPN </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateThumbprint</maml:name> <maml:Description><maml:para>Certificate Hash (Thumbprint) </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ServicePrincipal</maml:name> <maml:Description><maml:para>Indicates that this account authenticates by providing service principal credentials. </maml:para> </maml:Description> <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="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the ID of the subscription. If you do not specify this parameter, the first subscription from the subscription list is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApplicationId</maml:name> <maml:Description><maml:para>SPN </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateThumbprint</maml:name> <maml:Description><maml:para>Certificate Hash (Thumbprint) </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ServicePrincipal</maml:name> <maml:Description><maml:para>Indicates that this account authenticates by providing service principal credentials. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionName</maml:name> <maml:Description><maml:para>Subscription 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. </maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </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 (ByValue)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the ID of the subscription. If you do not specify this parameter, the first subscription from the subscription list is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. </maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionName</maml:name> <maml:Description><maml:para>Subscription 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. </maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ServicePrincipal</maml:name> <maml:Description><maml:para>Indicates that this account authenticates by providing service principal credentials. </maml:para> </maml:Description> <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="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the ID of the subscription. If you do not specify this parameter, the first subscription from the subscription list is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. </maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ServicePrincipal</maml:name> <maml:Description><maml:para>Indicates that this account authenticates by providing service principal credentials. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionName</maml:name> <maml:Description><maml:para>Subscription 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AccessToken</maml:name> <maml:Description><maml:para>Specifies an access token. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AccountId</maml:name> <maml:Description><maml:para>Account Id for access token </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApplicationId</maml:name> <maml:Description><maml:para>SPN </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateThumbprint</maml:name> <maml:Description><maml:para>Certificate Hash (Thumbprint) </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Specifies a PSCredential object. For more information about the PSCredential object, type Get-Help Get-Credential. </maml:para> <maml:para>The PSCredential object provides the user ID and password for organizational ID credentials, or the application ID and secret for service principal credentials. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Environment</maml:name> <maml:Description><maml:para>Environment containing the account to log into </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type><maml:name>AzureEnvironment</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EnvironmentName</maml:name> <maml:Description><maml:para>Specifies the Azure environment. Valid values are: AzureCloud, AzureChinaCloud, AzureUSGovernment. The default is AzureCloud. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ServicePrincipal</maml:name> <maml:Description><maml:para>Indicates that this account authenticates by providing service principal credentials. </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="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the ID of the subscription. If you do not specify this parameter, the first subscription from the subscription list is used. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>SubscriptionName</maml:name> <maml:Description><maml:para>Subscription 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Optional tenant name or ID </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureProfile</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add an account that requires interactive login</maml:title> <dev:code>PS C:\>Add-AzureRmAccount Account: azureuser@contoso.com Environment: AzureCloud Subscription: xxxx-xxxx-xxxx-xxxx Tenant: xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks><maml:para>This command adds an Azure Resource Manager account. </maml:para> <maml:para>To run Azure Resource Manager cmdlets with this account, you must provide Microsoft account or organizational ID credentials at the prompt. </maml:para> <maml:para>If multi-factor authentication is enabled for your credentials, you must log in using the interactive option or use service principal authentication. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Add an account that authenticates with organizational ID credentials</maml:title> <dev:code>PS C:\>$Credential = Get-Credential PS C:\> Add-AzureRmAccount -Credential $Credential Account: azureuser@contoso.com Environment: AzureChinaCloud Subscription: xxxx-xxxx-xxxx-xxxx Tenant: xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks><maml:para>The first command gets the user credentials, and then stores them in the $Credential variable. </maml:para> <maml:para>The second command adds an Azure Resource Manager account with the credentials in $Credential. </maml:para> <maml:para>This account authenticates with Azure Resource Manager using organizational ID credentials. You cannot use multi-factor authentication or Microsoft account credentials to run Azure Resource Manager cmdlets with this account. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Add an account that authenticates with service principal credentials</maml:title> <dev:code>PS C:\>$Credential = Get-Credential PS C:\> Add-AzureRmAccount -Credential $Credential -Tenant "xxxx-xxxx-xxxx-xxxx" -ServicePrincipal Account: xxxx-xxxx-xxxx-xxxx Environment: AzureCloud Subscription: yyyy-yyyy-yyyy-yyyy Tenant: xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks><maml:para>The first command gets the user credentials, and then stores them in the $Credential variable. </maml:para> <maml:para>The second command adds an Azure Resource Manager account with the credentials stored in $Credential for the specified Tenant. The ServicePrincipal switch parameter indicates that the account authenticates as a service principal. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Add an account for a specific tenant and subscription</maml:title> <dev:code>PS C:\>Add-AzureRmAccount -Tenant "xxxx-xxxx-xxxx-xxxx" -SubscriptionId "yyyy-yyyy-yyyy-yyyy" Account: pfuller@contoso.com Environment: AzureCloud Subscription: yyyy-yyyy-yyyy-yyyy Tenant: xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks><maml:para>This command adds an Azure Resource Manager account to run cmdlets for the specified tenant and subscription by default. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmEnvironment</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmEnvironment</command:noun> <maml:description><maml:para>Adds endpoints and metadata for an instance of Azure Resource Manager. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmEnvironment cmdlet adds endpoints and metadata to enable Azure Resource Manager cmdlets to connect with a new instance of Azure Resource Manager. The built-in environments AzureCloud and AzureChinaCloud target existing public instances of Azure Resource Manager. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the environment to add. </maml:para> </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="1" aliases="none"><maml:name>PublishSettingsFileUrl</maml:name> <maml:Description><maml:para>Specifies the URL from which .publishsettings files can be downloaded. </maml:para> </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="10" aliases="none"><maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain name suffix for Key Vault services. </maml:para> </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="11" aliases="none"><maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for access tokens that authorize requests for Key Vault services. </maml:para> </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="12" aliases="none"><maml:name>TrafficManagerDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure Traffic Manager services. </maml:para> </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="13" aliases="none"><maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure SQL Database servers. </maml:para> </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="14" aliases="none"><maml:name>AzureDataLakeStoreFileSystemEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="15" aliases="none"><maml:name>AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Analytics job and catalog services </maml:para> </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="16" aliases="OnPremise"><maml:name>EnableAdfsAuthentication</maml:name> <maml:Description><maml:para>Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. </maml:para> </maml:Description> <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="True (ByPropertyName)" position="17" aliases="none"><maml:name>AdTenant</maml:name> <maml:Description><maml:para>Specifies the default Active Directory tenant. </maml:para> </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="18" aliases="GraphEndpointResourceId, GraphResourceId"><maml:name>GraphAudience</maml:name> <maml:Description><maml:para>The audience for tokens authenticating with the AD Graph Endpoint. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="ServiceManagement, ServiceManagementUrl"><maml:name>ServiceEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for Service Management (RDFE) requests. </maml:para> </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="3" aliases="none"><maml:name>ManagementPortalUrl</maml:name> <maml:Description><maml:para>Specifies the URL for the Management 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="StorageEndpointSuffix"><maml:name>StorageEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for storage (blob, table, queue, and file) access. </maml:para> </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="5" aliases="AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority"><maml:name>ActiveDirectoryEndpoint</maml:name> <maml:Description><maml:para>Specifies the base authority for Azure Active Directory authentication. </maml:para> </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="6" aliases="ResourceManager, ResourceManagerUrl"><maml:name>ResourceManagerEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Azure Resource Manager requests. </maml:para> </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="7" aliases="Gallery, GalleryUrl"><maml:name>GalleryEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="8" aliases="none"><maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. </maml:para> </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="9" aliases="Graph, GraphUrl"><maml:name>GraphEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Graph (Active Directory metadata) requests. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority"><maml:name>ActiveDirectoryEndpoint</maml:name> <maml:Description><maml:para>Specifies the base authority for Azure Active Directory authentication. </maml:para> </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="8" aliases="none"><maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. </maml:para> </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="17" aliases="none"><maml:name>AdTenant</maml:name> <maml:Description><maml:para>Specifies the default Active Directory tenant. </maml:para> </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="15" aliases="none"><maml:name>AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Analytics job and catalog services </maml:para> </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="14" aliases="none"><maml:name>AzureDataLakeStoreFileSystemEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="10" aliases="none"><maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain name suffix for Key Vault services. </maml:para> </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="11" aliases="none"><maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for access tokens that authorize requests for Key Vault services. </maml:para> </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="16" aliases="OnPremise"><maml:name>EnableAdfsAuthentication</maml:name> <maml:Description><maml:para>Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. </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="True (ByPropertyName)" position="7" aliases="Gallery, GalleryUrl"><maml:name>GalleryEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="18" aliases="GraphEndpointResourceId, GraphResourceId"><maml:name>GraphAudience</maml:name> <maml:Description><maml:para>The audience for tokens authenticating with the AD Graph Endpoint. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="9" aliases="Graph, GraphUrl"><maml:name>GraphEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Graph (Active Directory metadata) requests. </maml:para> </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="3" aliases="none"><maml:name>ManagementPortalUrl</maml:name> <maml:Description><maml:para>Specifies the URL for the Management 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the environment to add. </maml:para> </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="1" aliases="none"><maml:name>PublishSettingsFileUrl</maml:name> <maml:Description><maml:para>Specifies the URL from which .publishsettings files can be downloaded. </maml:para> </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="6" aliases="ResourceManager, ResourceManagerUrl"><maml:name>ResourceManagerEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Azure Resource Manager requests. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="ServiceManagement, ServiceManagementUrl"><maml:name>ServiceEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for Service Management (RDFE) requests. </maml:para> </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="13" aliases="none"><maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure SQL Database servers. </maml:para> </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="4" aliases="StorageEndpointSuffix"><maml:name>StorageEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for storage (blob, table, queue, and file) access. </maml:para> </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="12" aliases="none"><maml:name>TrafficManagerDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure Traffic Manager services. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureEnvironment</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns the set of endpoints and metadata needed to communicate with an instance of Azure. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Creating and modifying a new environment</maml:title> <dev:code>PS C:\> Add-AzureRmEnvironment -Name TestEnvironment ` -ActiveDirectoryEndpoint TestADEndpoint ` -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` -ResourceManagerEndpoint TestRMEndpoint ` -GalleryEndpoint TestGalleryEndpoint ` -GraphEndpoint TestGraphEndpoint Name : TestEnvironment EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : TestADApplicationId AdTenant : GalleryUrl : TestGalleryEndpoint ManagementPortalUrl : ServiceManagementUrl : PublishSettingsFileUrl : ResourceManagerUrl : TestRMEndpoint SqlDatabaseDnsSuffix : StorageEndpointSuffix : ActiveDirectoryAuthority : TestADEndpoint GraphUrl : TestGraphEndpoint GraphEndpointResourceId : TrafficManagerDnsSuffix : AzureKeyVaultDnsSuffix : AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId : PS C:\> Set-AzureRmEnvironment -Name TestEnvironment -ActiveDirectoryEndpoint NewTestADEndpoint -GraphEndpoint NewTestGraphEndpoint Name : TestEnvironment EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : TestADApplicationId AdTenant : GalleryUrl : TestGalleryEndpoint ManagementPortalUrl : ServiceManagementUrl : PublishSettingsFileUrl : ResourceManagerUrl : TestRMEndpoint SqlDatabaseDnsSuffix : StorageEndpointSuffix : ActiveDirectoryAuthority : NewTestADEndpoint GraphUrl : NewTestGraphEndpoint GraphEndpointResourceId : TrafficManagerDnsSuffix : AzureKeyVaultDnsSuffix : AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId :</dev:code> <dev:remarks><maml:para>In this example we are creating a new Azure environment with sample endpoints using Add-AzureRmEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzureRmEnvironment. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Disable-AzureRmDataCollection</command:name> <command:verb>Disable</command:verb> <command:noun>AzureRmDataCollection</command:noun> <maml:description><maml:para>Opts out of collecting data to improve the AzurePowerShell cmdlets. Data is not collected unless you explicitly opt in. </maml:para> </maml:description> </command:details> <maml:description><maml:para>You can improve the experience of using the Microsoft Cloud and Azure PowerShell by opting in to data collection. Azure PowerShell does not collect data without your consent - you must explicitly opt in by executing Enable-AzureRmDataCollection, or by answering yes when Azure PowerShell prompts you about collecting data the first time you execute a cmdlet. Microsoft aggregates collected data to identify patterns of usage, to identify common issues and to improve the experience of using Azure PowerShell. Microsoft Azure PowerShell does not collect any private data, or any personally identifiable information. </maml:para> <maml:para>Run the Disable-AzureRMDataCollection cmdlet to disable data collection for the current user. This will prevent the current user from being prompted about data collection the first time cmdlets are executed. </maml:para> <maml:para>To enable data collection for the current user, run the Enable-AzureRmDataCollection cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Disable-AzureRmDataCollection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Disabling data collection for the current user</maml:title> <dev:code>PS C:\> Disable-AzureRmDataCollection</dev:code> <dev:remarks><maml:para>This example shows how to disable data collection for the current user. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Enable-AzureRmDataCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Enable-AzureRmDataCollection</command:name> <command:verb>Enable</command:verb> <command:noun>AzureRmDataCollection</command:noun> <maml:description><maml:para>Enables Azure PowerShell to collect data to improve the user experience with AzurePowerShell cmdlets. Executing this cmdlet opts in to data collection for the current user on the current machine. No data is collected unless you explicitly opt in. </maml:para> </maml:description> </command:details> <maml:description><maml:para>You can improve the experience of using the Microsoft Cloud and Azure PowerShell by opting in to data collection. Azure PowerShell does not collect data without your consent - you must explicitly opt in by executing Enable-AzureRmDataCollection, or by answering yes when Azure PowerShell prompts you about collecting data the first time you execute a cmdlet. Microsoft aggregates collected data to identify patterns of usage, to identify common issues and to improve the experience of using Azure PowerShell. Microsoft Azure PowerShell does not collect any private data, or any personally identifiable information. </maml:para> <maml:para>Run the Enable-AzureRMDataCollection cmdlet to enable data collection for the current user on the current machine. This will prevent the current user from being prompted about data collection the first time cmdlets are executed. </maml:para> <maml:para>To disable data collection for the current user, run the Disable-AzureRmDataCollection cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Enable-AzureRmDataCollection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Enabling data collection for the current user</maml:title> <dev:code>PS C:\> Enable-AzureRmDataCollection</dev:code> <dev:remarks><maml:para>This example shows how to enable data collection for the current user. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Disable-AzureRmDataCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmContext</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmContext</command:noun> <maml:description><maml:para>Gets the metadata used to authenticate Azure Resource Manager requests. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmContext cmdlet gets the current metadata used to authenticate Azure Resource Manager requests. </maml:para> <maml:para>This cmdlet gets the Active Directory account, Active Directory tenant, Azure subscription, and the targeted Azure environment. Azure Resource Manager cmdlets use these settings by default when making Azure Resource Manager requests. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmContext</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureContext</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns the account, tenant, and subscription used by Azure Resource Manager cmdlets. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Getting the current context</maml:title> <dev:code>PS C:\> Add-AzureRmAccount PS C:\> Get-AzureRmContext Environment : AzureCloud Account : test@outlook.com TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy SubscriptionName : Test Subscription CurrentStorageAccount :</dev:code> <dev:remarks><maml:para>In this example we are logging into our account with an Azure subscription using Add-AzureRmAccount, and then we are getting the context of the current session by calling Get-AzureRmContext. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Set-AzureRMContext</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmEnvironment</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmEnvironment</command:noun> <maml:description><maml:para>Get endpoints and metadata for an instance of Azure services. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmEnvironment cmdlet gets endpoints and metadata for an instance of Azure services. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmEnvironment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Azure instance to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the Azure instance to get. </maml:para> </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureEnvironment</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Getting the AzureCloud environment</maml:title> <dev:code>PS C:\> Get-AzureRmEnvironment AzureCloud Name : AzureCloud EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : https://management.core.windows.net/ AdTenant : GalleryUrl : https://gallery.azure.com/ ManagementPortalUrl : http://go.microsoft.com/fwlink/?LinkId=254433 ServiceManagementUrl : https://management.core.windows.net/ PublishSettingsFileUrl : http://go.microsoft.com/fwlink/?LinkID=301775 ResourceManagerUrl : https://management.azure.com/ SqlDatabaseDnsSuffix : .database.windows.net StorageEndpointSuffix : core.windows.net ActiveDirectoryAuthority : https://login.microsoftonline.com/ GraphUrl : https://graph.windows.net/ GraphEndpointResourceId : https://graph.windows.net/ TrafficManagerDnsSuffix : trafficmanager.net AzureKeyVaultDnsSuffix : vault.azure.net AzureDataLakeStoreFileSystemEndpointSuffix : azuredatalakestore.net AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : azuredatalakeanalytics.net AzureKeyVaultServiceEndpointResourceId : https://vault.azure.net</dev:code> <dev:remarks><maml:para>This example shows how to get the endpoints and metadata for the AzureCloud (default) environment. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Getting the AzureChinaCloud environment</maml:title> <dev:code>PS C:\> Get-AzureRmEnvironment AzureChinaCloud Name : AzureChinaCloud EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : https://management.core.chinacloudapi.cn/ AdTenant : GalleryUrl : https://gallery.chinacloudapi.cn/ ManagementPortalUrl : http://go.microsoft.com/fwlink/?LinkId=301902 ServiceManagementUrl : https://management.core.chinacloudapi.cn/ PublishSettingsFileUrl : http://go.microsoft.com/fwlink/?LinkID=301776 ResourceManagerUrl : https://management.chinacloudapi.cn/ SqlDatabaseDnsSuffix : .database.chinacloudapi.cn StorageEndpointSuffix : core.chinacloudapi.cn ActiveDirectoryAuthority : https://login.chinacloudapi.cn/ GraphUrl : https://graph.chinacloudapi.cn/ GraphEndpointResourceId : https://graph.chinacloudapi.cn/ TrafficManagerDnsSuffix : trafficmanager.cn AzureKeyVaultDnsSuffix : vault.azure.cn AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId : https://vault.azure.cn</dev:code> <dev:remarks><maml:para>This example shows how to get the endpoints and metadata for the AzureChinaCloud environment. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Getting the AzureUSGovernment environment</maml:title> <dev:code>PS C:\> Get-AzureRmEnvironment AzureUSGovernment Name : AzureUSGovernment EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : https://management.core.usgovcloudapi.net/ AdTenant : GalleryUrl : https://gallery.usgovcloudapi.net/ ManagementPortalUrl : https://manage.windowsazure.us ServiceManagementUrl : https://management.core.usgovcloudapi.net/ PublishSettingsFileUrl : https://manage.windowsazure.us/publishsettings/index ResourceManagerUrl : https://management.usgovcloudapi.net/ SqlDatabaseDnsSuffix : .database.usgovcloudapi.net StorageEndpointSuffix : core.usgovcloudapi.net ActiveDirectoryAuthority : https://login-us.microsoftonline.com/ GraphUrl : https://graph.windows.net/ GraphEndpointResourceId : https://graph.windows.net/ TrafficManagerDnsSuffix : usgovtrafficmanager.net AzureKeyVaultDnsSuffix : vault.usgovcloudapi.net AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId : https://vault.usgovcloudapi.net</dev:code> <dev:remarks><maml:para>This example shows how to get the endpoints and metadata for the AzureUSGovernment environment. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Add-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmSubscription</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmSubscription</command:noun> <maml:description><maml:para>Get subscriptions that the current account can access. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmSubscription cmdlet gets the subscription ID, subscription name, and home tenant for subscriptions that the current account can access. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmSubscription</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the ID of the subscription to get. </maml:para> </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>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant that contains subscriptions to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmSubscription</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionName</maml:name> <maml:Description><maml:para>Specifies the name of the subscription to get. </maml:para> </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>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant that contains subscriptions to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the ID of the subscription to get. </maml:para> </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>SubscriptionName</maml:name> <maml:Description><maml:para>Specifies the name of the subscription to get. </maml:para> </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>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant that contains subscriptions to get. </maml:para> </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureSubscription</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all subscriptions in all tenants</maml:title> <dev:code>PS C:\>Get-AzureRmSubscription -All Subscription Name : Contoso Subscription 1 SubscriptionId : xxxx-xxxx-xxxx-xxxx TenantId : yyyy-yyyy-yyyy-yyyy</dev:code> <dev:remarks><maml:para>This command gets all subscriptions in all tenants that are authorized for the current account. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get all subscriptions for a specific tenant</maml:title> <dev:code>PS C:\>Get-AzureRmSubscription -TenantId "xxxx-xxxx-xxxx-xxxx" Subscription Name : Contoso Subscription 1 SubscriptionId : yyyy-yyyy-yyyy-yyyy TenantId : xxxx-xxxx-xxxx-xxxx Subscription Name : Contoso Subscription 2 SubscriptionId : yyyy-yyyy-yyyy-yyyy TenantId : xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks><maml:para>List all subscriptions in the given tenant that are authorized for the current account. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get all subscriptions in the current tenant</maml:title> <dev:code>PS C:\>Get-AzureRmSubscription Subscription Name : Contoso Subscription 1 SubscriptionId : yyyy-yyyy-yyyy-yyyy TenantId : xxxx-xxxx-xxxx-xxxx Subscription Name : Contoso Subscription 2 SubscriptionId : yyyy-yyyy-yyyy-yyyy TenantId : xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks><maml:para>This command gets all subscriptions in the current tenant that are authorized for the current user. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Change the current context to use a specific subscription</maml:title> <dev:code>PS C:\>Get-AzureRmSubscription -SubscriptionId "xxxx-xxxx-xxxx-xxxx" -TenantId "yyyy-yyyy-yyyy-yyyy" | Set-AzureRmContext Subscription Name : Contoso Subscription 1 SubscriptionId : xxxx-xxxx-xxxx-xxxx TenantId : yyyy-yyyy-yyyy-yyyy</dev:code> <dev:remarks><maml:para>This command gets the specified subscription, and then sets the current context to use it. All subsequent cmdlets in this session use the new subscription (Contoso Subscription 1) by default. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmTenant</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmTenant</command:noun> <maml:description><maml:para>Gets tenants that are authorized for the current user. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmTenant cmdlet gets tenants authorized for the current user. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmTenant</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Domain, Tenant"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Domain, Tenant"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant that this cmdlet gets. </maml:para> </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureTenant</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns the tenant ID and associated domain information for tenants authorized for the current account. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Getting all tenants</maml:title> <dev:code>PS C:\> Add-AzureRmAccount PS C:\> Get-AzureRmTenant TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Domain : microsoft.com TenantId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy Domain : microsoft.com</dev:code> <dev:remarks><maml:para>This example shows how to get all of the authorized tenants of an Azure account. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Getting a specific tenant</maml:title> <dev:code>PS C:\> Add-AzureRmAccount PS C:\> Get-AzureRmTenant -TenantId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Domain : microsoft.com</dev:code> <dev:remarks><maml:para>This example shows how to get a specific authorized tenant of an Azure account. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Import-AzureRmContext</command:name> <command:verb>Import</command:verb> <command:noun>AzureRmContext</command:noun> <maml:description><maml:para>Loads Azure authentication information from a file. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Import-AzureRmContext cmdlet loads authentication information from a file to set the Azure environment and context. Cmdlets that you run in the current session use this information to authenticate requests to Azure Resource Manager. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Import-AzureRmContext</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Profile"><maml:name>AzureContext</maml:name> <maml:Description><maml:para>Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMProfile</command:parameterValue> <dev:type><maml:name>AzureRMProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Import-AzureRmContext</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the path to context information saved by using Save-AzureRMContext. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Profile"><maml:name>AzureContext</maml:name> <maml:Description><maml:para>Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMProfile</command:parameterValue> <dev:type><maml:name>AzureRMProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the path to context information saved by using Save-AzureRMContext. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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>Microsoft.Azure.Commands.Common.Authentication.Models.AzureRMProfile</maml:name> </dev:type> <maml:description><maml:para>System.String </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureProfile</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Importing a context from a AzureRmProfile</maml:title> <dev:code>PS C:\> Import-AzureRmContext -AzureContext (Add-AzureRmAccount) Environment : AzureCloud Account : test@outlook.com TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy SubscriptionName : Test Subscription CurrentStorageAccount :</dev:code> <dev:remarks><maml:para>This example imports a context from a PSAzureProfile that is passed through to the cmdlet. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Importing a context from a JSON file</maml:title> <dev:code>PS C:\> Import-AzureRmContext -Path C:\test.json Environment : AzureCloud Account : test@outlook.com TenantId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx SubscriptionId : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy SubscriptionName : Test Subscription CurrentStorageAccount :</dev:code> <dev:remarks><maml:para>This example selects a context from a JSON file that is passed through to the cmdlet. This JSON file can be created from Import-AzureRmContext. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmEnvironment</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmEnvironment</command:noun> <maml:description><maml:para>Removes endpoints and metadata for connecting to a given Azure instance. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmEnvironment cmdlet removes endpoints and metadata information for connecting to a given Azure instance. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the environment 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the environment 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureEnvironment</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Creating and removing a test environment</maml:title> <dev:code>PS C:\> Add-AzureRmEnvironment -Name TestEnvironment ` -ActiveDirectoryEndpoint TestADEndpoint ` -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` -ResourceManagerEndpoint TestRMEndpoint ` -GalleryEndpoint TestGalleryEndpoint ` -GraphEndpoint TestGraphEndpoint Name : TestEnvironment EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : TestADApplicationId AdTenant : GalleryUrl : TestGalleryEndpoint ManagementPortalUrl : ServiceManagementUrl : PublishSettingsFileUrl : ResourceManagerUrl : TestRMEndpoint SqlDatabaseDnsSuffix : StorageEndpointSuffix : ActiveDirectoryAuthority : TestADEndpoint GraphUrl : TestGraphEndpoint GraphEndpointResourceId : TrafficManagerDnsSuffix : AzureKeyVaultDnsSuffix : AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId : PS C:\> Remove-AzureRmEnvironment -Name TestEnvironment Name : TestEnvironment EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : TestADApplicationId AdTenant : GalleryUrl : TestGalleryEndpoint ManagementPortalUrl : ServiceManagementUrl : PublishSettingsFileUrl : ResourceManagerUrl : TestRMEndpoint SqlDatabaseDnsSuffix : StorageEndpointSuffix : ActiveDirectoryAuthority : TestADEndpoint GraphUrl : TestGraphEndpoint GraphEndpointResourceId : TrafficManagerDnsSuffix : AzureKeyVaultDnsSuffix : AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId :</dev:code> <dev:remarks><maml:para>This example shows how to create an environment using Add-AzureRmEnvironment, and then how to delete the environment using Remove-AzureRmEnvironment. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Add-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Save-AzureRmContext</command:name> <command:verb>Save</command:verb> <command:noun>AzureRmContext</command:noun> <maml:description><maml:para>Saves the current authentication information for use in other PowerShell sessions. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Save-AzureRmContext cmdlet saves the current authentication information for use in other PowerShell sessions. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Save-AzureRmContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name> <maml:Description><maml:para>Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMProfile</command:parameterValue> <dev:type><maml:name>AzureRMProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the path of the file to which to save authentication information. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Overwrite the given file if it exists </maml:para> </maml:Description> <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" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Overwrite the given file if it exists </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the path of the file to which to save authentication information. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name> <maml:Description><maml:para>Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMProfile</command:parameterValue> <dev:type><maml:name>AzureRMProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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>Microsoft.Azure.Commands.Common.Authentication.Models.AzureRMProfile</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureProfile</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Saving the current session's context</maml:title> <dev:code>PS C:\> Add-AzureRmAccount PS C:\> Save-AzureRmContext -Path C:\test.json</dev:code> <dev:remarks><maml:para>This example saves the current session's Azure context to the JSON file provided. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Saving a given context</maml:title> <dev:code>PS C:\> Save-AzureRmContext -Profile (Add-AzureRmAccount) -Path C:\test.json</dev:code> <dev:remarks><maml:para>This example saves the Azure context that is passed through to the cmdlet to the JSON file provided. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Save-AzureRmContext</command:name> <command:verb>Save</command:verb> <command:noun>AzureRmContext</command:noun> <maml:description><maml:para>Saves the current authentication information for use in other PowerShell sessions. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Save-AzureRmContext cmdlet saves the current authentication information for use in other PowerShell sessions. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Save-AzureRmContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name> <maml:Description><maml:para>Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMProfile</command:parameterValue> <dev:type><maml:name>AzureRMProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the path of the file to which to save authentication information. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Overwrite the given file if it exists </maml:para> </maml:Description> <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" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Overwrite the given file if it exists </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the path of the file to which to save authentication information. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Profile</maml:name> <maml:Description><maml:para>Specifies the Azure context from which this cmdlet reads. If you do not specify a context, this cmdlet reads from the local default context. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureRMProfile</command:parameterValue> <dev:type><maml:name>AzureRMProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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>Microsoft.Azure.Commands.Common.Authentication.Models.AzureRMProfile</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureProfile</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Saving the current session's context</maml:title> <dev:code>PS C:\> Add-AzureRmAccount PS C:\> Save-AzureRmContext -Path C:\test.json</dev:code> <dev:remarks><maml:para>This example saves the current session's Azure context to the JSON file provided. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Saving a given context</maml:title> <dev:code>PS C:\> Save-AzureRmContext -Profile (Add-AzureRmAccount) -Path C:\test.json</dev:code> <dev:remarks><maml:para>This example saves the Azure context that is passed through to the cmdlet to the JSON file provided. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmContext</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmContext</command:noun> <maml:description><maml:para>Sets the tenant, subscription, and environment for cmdlets to use in the current session. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmContext cmdlet sets authentication information for cmdlets that you run in the current session. The context includes tenant, subscription, and environment information. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmContext</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the context for the current session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSAzureContext</command:parameterValue> <dev:type><maml:name>PSAzureContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-AzureRmContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID for the context that this cmdlet sets for the current session. </maml:para> </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="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant for for the context that this cmdlet sets for the current session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-AzureRmContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionName</maml:name> <maml:Description><maml:para>Specifies the subscription name for the context that this cmdlet sets for the current session. </maml:para> </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="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant for for the context that this cmdlet sets for the current session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the context for the current session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSAzureContext</command:parameterValue> <dev:type><maml:name>PSAzureContext</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>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID for the context that this cmdlet sets for the current session. </maml:para> </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>SubscriptionName</maml:name> <maml:Description><maml:para>Specifies the subscription name for the context that this cmdlet sets for the current session. </maml:para> </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="Domain"><maml:name>TenantId</maml:name> <maml:Description><maml:para>Specifies the ID of the tenant for for the context that this cmdlet sets for the current session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureContext</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set the subscription context</maml:title> <dev:code>PS C:\>Set-AzureRmContext -SubscriptionId "xxxx-xxxx-xxxx-xxxx" Account : PFuller@contoso.com Environment : AzureCloud Subscription : xxxx-xxxx-xxxx-xxxx Tenant : yyyy-yyyy-yyyy-yyyy</dev:code> <dev:remarks><maml:para>This command sets the context to use the specified subscription. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRMContext</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmEnvironment</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmEnvironment</command:noun> <maml:description><maml:para>Sets properties for an Azure environment. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRMEnvironment cmdlet sets endpoints and metadata for connecting to an instance of Azure. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the environment to modify. </maml:para> </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="1" aliases="none"><maml:name>PublishSettingsFileUrl</maml:name> <maml:Description><maml:para>Specifies the URL from which .publishsettings files can be downloaded. </maml:para> </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="10" aliases="none"><maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain name suffix for Key Vault services. </maml:para> </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="11" aliases="none"><maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for access tokens that authorize requests for Key Vault services. </maml:para> </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="12" aliases="none"><maml:name>TrafficManagerDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure Traffic Manager services. </maml:para> </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="13" aliases="none"><maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure SQL Database servers. </maml:para> </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="14" aliases="none"><maml:name>AzureDataLakeStoreFileSystemEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="15" aliases="none"><maml:name>AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Analytics job and catalog services </maml:para> </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="16" aliases="OnPremise"><maml:name>EnableAdfsAuthentication</maml:name> <maml:Description><maml:para>Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. </maml:para> </maml:Description> <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="True (ByPropertyName)" position="17" aliases="none"><maml:name>AdTenant</maml:name> <maml:Description><maml:para>Specifies the default Active Directory tenant. </maml:para> </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="18" aliases="GraphEndpointResourceId, GraphResourceId"><maml:name>GraphAudience</maml:name> <maml:Description><maml:para>The audience for tokens authenticating with the AD Graph Endpoint. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="ServiceManagement, ServiceManagementUrl"><maml:name>ServiceEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for Service Management (RDFE) requests. </maml:para> </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="3" aliases="none"><maml:name>ManagementPortalUrl</maml:name> <maml:Description><maml:para>Specifies the URL for the Management 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="StorageEndpointSuffix"><maml:name>StorageEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for storage (blob, table, queue, and file) access. </maml:para> </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="5" aliases="AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority"><maml:name>ActiveDirectoryEndpoint</maml:name> <maml:Description><maml:para>Specifies the base authority for Azure Active Directory authentication. </maml:para> </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="6" aliases="ResourceManager, ResourceManagerUrl"><maml:name>ResourceManagerEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Azure Resource Manager requests. </maml:para> </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="7" aliases="Gallery, GalleryUrl"><maml:name>GalleryEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="8" aliases="none"><maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. </maml:para> </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="9" aliases="Graph, GraphUrl"><maml:name>GraphEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Graph (Active Directory metadata) requests. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <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" aliases="wi"><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> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority"><maml:name>ActiveDirectoryEndpoint</maml:name> <maml:Description><maml:para>Specifies the base authority for Azure Active Directory authentication. </maml:para> </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="8" aliases="none"><maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints. </maml:para> </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="17" aliases="none"><maml:name>AdTenant</maml:name> <maml:Description><maml:para>Specifies the default Active Directory tenant. </maml:para> </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="15" aliases="none"><maml:name>AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Analytics job and catalog services </maml:para> </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="14" aliases="none"><maml:name>AzureDataLakeStoreFileSystemEndpointSuffix</maml:name> <maml:Description><maml:para>Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="10" aliases="none"><maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain name suffix for Key Vault services. </maml:para> </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="11" aliases="none"><maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:Description><maml:para>Specifies the audience for access tokens that authorize requests for Key Vault services. </maml:para> </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="16" aliases="OnPremise"><maml:name>EnableAdfsAuthentication</maml:name> <maml:Description><maml:para>Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed. </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="True (ByPropertyName)" position="7" aliases="Gallery, GalleryUrl"><maml:name>GalleryEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="18" aliases="GraphEndpointResourceId, GraphResourceId"><maml:name>GraphAudience</maml:name> <maml:Description><maml:para>The audience for tokens authenticating with the AD Graph Endpoint. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="9" aliases="Graph, GraphUrl"><maml:name>GraphEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Graph (Active Directory metadata) requests. </maml:para> </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="3" aliases="none"><maml:name>ManagementPortalUrl</maml:name> <maml:Description><maml:para>Specifies the URL for the Management 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the environment to modify. </maml:para> </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="1" aliases="none"><maml:name>PublishSettingsFileUrl</maml:name> <maml:Description><maml:para>Specifies the URL from which .publishsettings files can be downloaded. </maml:para> </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="6" aliases="ResourceManager, ResourceManagerUrl"><maml:name>ResourceManagerEndpoint</maml:name> <maml:Description><maml:para>Specifies the URL for Azure Resource Manager requests. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="ServiceManagement, ServiceManagementUrl"><maml:name>ServiceEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for Service Management (RDFE) requests. </maml:para> </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="13" aliases="none"><maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure SQL Database servers. </maml:para> </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="4" aliases="StorageEndpointSuffix"><maml:name>StorageEndpoint</maml:name> <maml:Description><maml:para>Specifies the endpoint for storage (blob, table, queue, and file) access. </maml:para> </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="12" aliases="none"><maml:name>TrafficManagerDnsSuffix</maml:name> <maml:Description><maml:para>Specifies the domain-name suffix for Azure Traffic Manager services. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><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" aliases="wi"><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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>PSAzureEnvironment</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Creating and modifying a new environment</maml:title> <dev:code>PS C:\> Add-AzureRmEnvironment -Name TestEnvironment ` -ActiveDirectoryEndpoint TestADEndpoint ` -ActiveDirectoryServiceEndpointResourceId TestADApplicationId ` -ResourceManagerEndpoint TestRMEndpoint ` -GalleryEndpoint TestGalleryEndpoint ` -GraphEndpoint TestGraphEndpoint Name : TestEnvironment EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : TestADApplicationId AdTenant : GalleryUrl : TestGalleryEndpoint ManagementPortalUrl : ServiceManagementUrl : PublishSettingsFileUrl : ResourceManagerUrl : TestRMEndpoint SqlDatabaseDnsSuffix : StorageEndpointSuffix : ActiveDirectoryAuthority : TestADEndpoint GraphUrl : TestGraphEndpoint GraphEndpointResourceId : TrafficManagerDnsSuffix : AzureKeyVaultDnsSuffix : AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId : PS C:\> Set-AzureRmEnvironment -Name TestEnvironment -ActiveDirectoryEndpoint NewTestADEndpoint -GraphEndpoint NewTestGraphEndpoint Name : TestEnvironment EnableAdfsAuthentication : False ActiveDirectoryServiceEndpointResourceId : TestADApplicationId AdTenant : GalleryUrl : TestGalleryEndpoint ManagementPortalUrl : ServiceManagementUrl : PublishSettingsFileUrl : ResourceManagerUrl : TestRMEndpoint SqlDatabaseDnsSuffix : StorageEndpointSuffix : ActiveDirectoryAuthority : NewTestADEndpoint GraphUrl : NewTestGraphEndpoint GraphEndpointResourceId : TrafficManagerDnsSuffix : AzureKeyVaultDnsSuffix : AzureDataLakeStoreFileSystemEndpointSuffix : AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : AzureKeyVaultServiceEndpointResourceId :</dev:code> <dev:remarks><maml:para>In this example we are creating a new Azure environment with sample endpoints using Add-AzureRmEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzureRmEnvironment. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Add-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRMEnvironment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |