Microsoft.Azure.Commands.Profile.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Updatable Help Version 2.0.1.0 --> <command:command xmlns:maml="http://schemas.microsoft.com/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> <maml:description> <maml:para>Adds an authenticated account to use for Azure Resource Manager cmdlet requests.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureRmAccount</command:noun> <dev:version /> </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="false" variableLength="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the name of the subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated for all available tenants. </maml:para> <maml:para>You must specify the Tenant parameter to authenticate as a service principal.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Specifies an access token. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" 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="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the name of the subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated for all available tenants. </maml:para> <maml:para>You must specify the Tenant parameter to authenticate as a service principal.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" 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="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the name of the subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated for all available tenants. </maml:para> <maml:para>You must specify the Tenant parameter to authenticate as a service principal.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>Indicates that this account authenticates by providing service principal credentials. </maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named" 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="false" 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="false" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="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="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Specifies the name of the subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies a tenant. If you do not specify this parameter, the account is authenticated for all available tenants. </maml:para> <maml:para>You must specify the Tenant parameter to authenticate as a service principal.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Add an account that requires interactive login</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Add an account that authenticates with organizational ID credentials</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example3: Add an account that authenticates with service principal credentials</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Add an account for a specific tenant and subscription </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AzureRmEnvironment</command:name> <maml:description> <maml:para>Adds endpoints and metadata for an instance of Azure Resource Manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureRmEnvironment</command:noun> <dev:version /> </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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="10" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="11" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="12" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="13" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="14" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="15" 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:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="16" aliases="none"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>Specifies the default Active Directory tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>Specifies the URL from which .publishsettings files can be downloaded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="4" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="6" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="7" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="8" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="9" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="6" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="9" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="16" aliases="none"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>Specifies the default Active Directory tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="11" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="12" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="15" 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="8" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="10" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="4" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" 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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="7" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="14" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="13" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>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> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AzureRmDataCollection</command:name> <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> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>AzureRmDataCollection</command:noun> <dev:version /> </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:syntaxItem> </command:syntax> <command:parameters/> <command:inputTypes/> <command:returnValues /> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-AzureRmDataCollection</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AzureRmDataCollection</command:name> <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> <maml:copyright /> <command:verb>Enable</command:verb> <command:noun>AzureRmDataCollection</command:noun> <dev:version /> </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:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-AzureRmDataCollection</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmContext</command:name> <maml:description> <maml:para>Gets the metadata used to authenticate Azure Resource Manager requests. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmContext</command:noun> <dev:version /> </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:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns the account, tenant, and subscription used by Azure Resource Manager cmdlets.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureRMContext</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmEnvironment</command:name> <maml:description> <maml:para>Get endpoints and metadata for an instance of Azure services.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmEnvironment</command:noun> <dev:version /> </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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmSubscription</command:name> <maml:description> <maml:para>Get subscriptions that the current account can access.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmSubscription</command:noun> <dev:version /> </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="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that this operation gets subscription details for all subscriptions in all tenants that are authorized for the current account.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmSubscription</maml:name> <command:parameter required="false" variableLength="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>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="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmSubscription</maml:name> <command:parameter required="false" variableLength="false" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>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="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Indicates that this operation gets subscription details for all subscriptions in all tenants that are authorized for the current account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all subscriptions in all tenants </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureRmSubscription -All SubscriptionId: xxxx-xxxx-xxxx-xxxx TenantId: yyyy-yyyy-yyyy-yyyy Subscription Name: Contoso Subscription 1 </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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all subscriptions for a specific tenant</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureRmSubscription -TenantId "xxxx-xxxx-xxxx-xxxx" SubscriptionId: yyyy-yyyy-yyyy-yyyy 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 </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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all subscriptions in the current tenant </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureRmSubscription SubscriptionId: yyyy-yyyy-yyyy-yyyy 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 </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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Change the current context to use a specific subscription </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureRmSubscription -SubscriptionId "xxxx-xxxx-xxxx-xxxx" -TenantId "yyyy-yyyy-yyyy-yyyy" | Set-AzureRmContext SubscriptionId: xxxx-xxxx-xxxx-xxxx TenantId: yyyy-yyyy-yyyy-yyyy Subscription Name: Contoso Subscription 1 </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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmTenant</command:name> <maml:description> <maml:para>Gets tenants that are authorized for the current user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmTenant</command:noun> <dev:version /> </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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Domain"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies the tenant to get. If you do not specify this parameter, all authorized tenants are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Domain"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies the tenant to get. If you do not specify this parameter, all authorized tenants are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>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> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmEnvironment</command:name> <maml:description> <maml:para>Removes endpoints and metadata for connecting to a given Azure instance.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRmEnvironment</command:noun> <dev:version /> </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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" 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> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-AzureRMProfile</command:name> <maml:description> <maml:para>Saves the current authentication information for use in other PowerShell sessions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>AzureRMProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Save-AzureRmProfile cmdlet saves the current authentication information for use in other PowerShell sessions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AzureRMProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureRMProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" 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> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" 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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureRMProfile</command:parameterValue> <dev:type> <maml:name>AzureRMProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Select-AzureRMProfile</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-AzureRMProfile</command:name> <maml:description> <maml:para>Loads Azure authentication information from a file. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Select</command:verb> <command:noun>AzureRMProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Select-AzureRmProfile 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>Select-AzureRMProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to profile information saved by using Save-AzureRMProfile. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Select-AzureRMProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureRMProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the path to profile information saved by using Save-AzureRMProfile. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRMContext</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRMContext</command:name> <maml:description> <maml:para>Sets the tenant, subscription, and environment for cmdlets to use in the current session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRMContext</command:noun> <dev:version /> </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="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies the tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureTenant</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>Specifies the subscription to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureSubscription</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRMContext</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the ID of the tenant. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Specifies the subscription ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRMContext</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Specifies the subscription ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRMContext</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the ID of the tenant. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>Specifies the subscription to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureSubscription</command:parameterValue> <dev:type> <maml:name>AzureSubscription</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Specifies the subscription 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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Tenant</maml:name> <maml:description> <maml:para>Specifies the tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureTenant</command:parameterValue> <dev:type> <maml:name>AzureTenant</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the ID of the 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example1: Set the subscription context</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <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 /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRMContext</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmEnvironment</command:name> <maml:description> <maml:para>Sets properties for an Azure environment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRmEnvironment</command:noun> <dev:version /> </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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="10" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="11" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="12" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="13" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="14" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="15" 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:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="16" aliases="none"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>Specifies the default Active Directory tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>Specifies the URL from which .publishsettings files can be downloaded.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="4" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="6" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="7" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="8" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="9" 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="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="6" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="9" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="16" aliases="none"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>Specifies the default Active Directory tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="11" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="12" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="15" 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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="8" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="10" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="4" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" 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="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="7" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="14" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases="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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="13" 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="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para> </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRMEnvironment</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |