Microsoft.Azure.Commands.Profile.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureRmAccount</command:name> <maml:description> <maml:para>Log in to authenticate cmdlets with Azure Resource Manager.</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>NOTE THAT THIS CMDLET AUTHENTICATES ONLY AZURE RESOURCE MANAGER CMDLETS. SERVICE MANAGEMENT CMDLETS MUST BE SEPARATELY AUTHENTICATED USING THE ADD-AZUREACCOUNT OR IMPORT-AZUREPUBLISHSETTINGSFILE CMDLETS.</maml:para> <maml:para>Log in to Azure Resource manager to provide authentication for management cmdlets. Microsoft Account (Live Id) and Organization Id credentials may be provided through the dialog prompt. Organizational ID and Service Principal credentials may be provided through a -Credential parameter. Access Token credentials may be provided through the AccessToken credential. By default, user is authenticated against all available tenants. The TenantId parameter may be provided to streamline authentication when access to only a single tenant is needed. The SubscriptionId parameter may be provided to select a particular subscription by default, otherwise the first listed subscription will be selected.</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"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Azure environment to authenticate with. Built-in environments include AzureCloud (the default setting) and AzureChinaCloud for access to Azure China.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Securely provide the user id and password for Organization Id credentials or the Application Id and Secret for Service Principal credentials. The provided credentials will be used to acquire tokens for authenticating ARM cmdlets with Azure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>If provided, limit authentication to only the provided tenant. This parameter is required for authentication as a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>If provided, determines the subscription that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>If provided, determines the subscription name that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Azure environment to authenticate with. Built-in environments include AzureCloud (the default setting) and AzureChinaCloud for access to Azure China.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Securely provide the user id and password for Organization Id credentials or the Application Id and Secret for Service Principal credentials. The provided credentials will be used to acquire tokens for authenticating ARM cmdlets with Azure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>When provided, indicates that service principal credentials will be provided via the Credential parameter and the Tenant containing the given Service Principal will be provided in the TenantId parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>If provided, limit authentication to only the provided tenant. This parameter is required for authentication as a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>If provided, determines the subscription that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>If provided, determines the subscription name that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Azure environment to authenticate with. Built-in environments include AzureCloud (the default setting) and AzureChinaCloud for access to Azure China.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>When provided, indicates which certificate thumbprint to use for ServicePrincipal authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>ClientId of the application which will be used for ServicePrincipal authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>When provided, indicates that service principal credentials will be provided via the Credential parameter and the Tenant containing the given Service Principal will be provided in the TenantId parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>If provided, limit authentication to only the provided tenant. This parameter is required for authentication as a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>If provided, determines the subscription that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>If provided, determines the subscription name that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Azure environment to authenticate with. Built-in environments include AzureCloud (the default setting) and AzureChinaCloud for access to Azure China.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>If provided, limit authentication to only the provided tenant. This parameter is required for authentication as a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>When provided, indicates that authentication with Azure Resource Manager should use the given access token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>When provided, indicates account Id for access token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>If provided, determines the subscription that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>If provided, determines the subscription name that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the Azure environment to authenticate with. Built-in environments include AzureCloud (the default setting) and AzureChinaCloud for access to Azure China.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureEnvironment</command:parameterValue> <dev:type> <maml:name>AzureEnvironment</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AzureCloud</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Securely provide the user id and password for Organization Id credentials or the Application Id and Secret for Service Principal credentials. The provided credentials will be used to acquire tokens for authenticating ARM cmdlets with Azure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>If provided, limit authentication to only the provided tenant. This parameter is required for authentication as a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Common</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>If provided, determines the subscription that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted. </maml:para> </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"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>If provided, determines the subscription name that will be targeted by default after log in. If this parameter is not provided, the first listed subscription will be targeted.</maml:para> </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"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>When provided, indicates that service principal credentials will be provided via the Credential parameter and the Tenant containing the given Service Principal will be provided in the TenantId parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Common</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>When provided, indicates which certificate thumbprint to use for ServicePrincipal authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>ClientId of the application which will be used for ServicePrincipal authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>When provided, indicates that authentication with Azure Resource Manager should use the given access token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>When provided, indicates account Id for access token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Interactive Login --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-AzureRmAccount</dev:code> <dev:remarks> <maml:para>Displays a dialog where Microsoft Account or Organizational Id credentials may be provided. The given credentials will be used to acquire a token for authentication with Azure Resource Manager. Note that if multi-factor authentication (MFA) is enabled for your credentials, you must log in using the interactive option, or use Service Principal authentication.</maml:para> <maml:para /> <maml:para /> <maml:para>Account: azureuser@contoso.com Environment: AzureCloud SubscriptionId: xxxx-xxxx-xxxx-xxxx TenantId: xxxx-xxxx-xxxx-xxxx</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Organization Id Login --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$credential = Get-Credential Add-AzureRmAccount -Credential $credential</dev:code> <dev:remarks> <maml:para>Log in for authentication with Azure Resource Manager using Organization Id parameters.</maml:para> <maml:para>Note that multi-factor authentication (MFA) and Microsoft Account credentials (Live ID) will not work with this option.</maml:para> <maml:para /> <maml:para /> <maml:para>Account: azureuser@contoso.onmicrosoft.cn Environment: AzureChinacloud SubscriptionId: xxxx-xxxx-xxxx-xxxx TenantId: xxxx-xxxx-xxxx-xxxx</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Service Principal Login --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$credential = Get-Credential Add-AzureRmAccount -Credential $credential -TenantId xxxx-xxxx-xxxx-xxxx -ServicePrincipal</dev:code> <dev:remarks> <maml:para>Log in to Azure Resource Manager using the provided AD Application ID and Application secret</maml:para> <maml:para /> <maml:para /> <maml:para>Account: xxxx-xxxx-xxxx-xxxx Environment: AzureCloud Subscription: yyyy-yyyy-yyyy-yyyy TenantId: zzzz-zzzz-zzzz-zzzz</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Select tenant and subscription --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-AzureRmAccount -TenantId xxxx-xxxx-xxxx-xxxx -SubscriptionId yyyy-yyyy-yyyy-yyyy</dev:code> <dev:remarks> <maml:para>Log in to the given tenant in Azure Resource Manager and target management cmdlets at the given subscription by default</maml:para> <maml:para /> <maml:para /> <maml:para>Account: user@example.com Environment: AzureCloud SubscriptionId: yyyy-yyyy-yyyy-yyyy TenantId: xxxx-xxxx-xxxx-xxxx</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmSubscription</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Save-AzureRmProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-AzureRmProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTenant</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureRmEnvironment</command:name> <maml:description> <maml:para>Add 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>Add endpoints and metdata that allow Azure Resource Manager cmdlets to connect with a new instance of Azure Resource Manager. 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="0"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>The url where PublishSettings files may be downloaded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Service Management (RDFE) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>The url for the management portal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>The endpoint for storage (blob, table, queue, file) access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>The base authority for Azure Active Directory authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>The Url for Azure Resource Manager requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Azure Resource Manager gallery of deployment templates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>GraphEndpoint</maml:name> <maml:description> <maml:para>The url for graph (Active Directory metadata) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for access tokens that authorize requests for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>TrafficManagerDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Traffic Manager Services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="13"> <maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Sql database servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="14"> <maml:name>EnableAdfsAuthentication</maml:name> <maml:description> <maml:para>Indicates whether ADFS (on premise) authentication is allowed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="15"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>The default Active Directory Tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>The url where PublishSettings files may be downloaded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Service Management (RDFE) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>The url for the management portal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>The endpoint for storage (blob, table, queue, file) access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>The base authority for Azure Active Directory authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>The Url for Azure Resource Manager requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Azure Resource Manager gallery of deployment templates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>GraphEndpoint</maml:name> <maml:description> <maml:para>The url for graph (Active Directory metadata) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for access tokens that authorize requests for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>TrafficManagerDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Traffic Manager Services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="13"> <maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Sql database servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="14"> <maml:name>EnableAdfsAuthentication</maml:name> <maml:description> <maml:para>Indicates whether 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="15"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>The default Active Directory Tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Common</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para>Returns the set of endpoints and metadata needed to communicate with an instace of Azure.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmContext</command:name> <maml:description> <maml:para>Get the current metadata used to authenticate Azure Resource Manager requests. Includes the active directory account, Active Directory tenant, Azure subscription, and the targeted azure environemtn. Azure Resource Manager cmdlets use these settings by default when making 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>Get the current metadata used to authenticate Azure Resource Manager requests. Includes the active directory account, Active Directory tenant, Azure subscription, and the targeted azure environemtn. 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para>Returns the account, tenant, and subscription used by Azure Resource Manager cmdlets.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureRmContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureRmAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmEnvironment</command:name> <maml:description> <maml:para>Get endpoints and metadata for the given 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>Get endpoints and metadata for the given 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="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the azure instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the azure instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmSubscription</command:name> <maml:description> <maml:para>Get detailed information about subscriptions 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>Get detailed information, including subscription id, subscription name, and home tenant about subscriptions the current account can access.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription to target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant containing subscriptions to get or list details about.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" 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"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant containing subscriptions to get or list details about.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" 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="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription to target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant containing subscriptions to get or list details about.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- List all subscriptions in all tenants --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmSubscription</dev:code> <dev:remarks> <maml:para>List all subscriptions in all tenants that are authorized for the current account.</maml:para> <maml:para /> <maml:para /> <maml:para>SubscriptionId: xxxx-xxxx-xxxx-xxxx TenantId: yyyy-yyyy-yyyy-yyyy Subscription Name: Contoso Subscription 1</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- List all subscription in one tenant --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmSubscription -TenantId xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks> <maml:para>List all subscriptions in the given tenant that are authorized for the current account.</maml:para> <maml:para /> <maml:para /> <maml:para>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</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Change the current context to target a particular subscription --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx -TenantId yyyy-yyyy-yyyy-yyyy | Set-AzureRmContext</dev:code> <dev:remarks> <maml:para>Set the context to use the given subscription. All subsequent cmdlets in this session will use the new subscription by default.</maml:para> <maml:para /> <maml:para /> <maml:para>SubscriptionId: xxxx-xxxx-xxxx-xxxx TenantId: yyyy-yyyy-yyyy-yyyy Subscription Name: Contoso Subscription 1</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmTenant</command:name> <maml:description> <maml:para>Get detailed information about tenants 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>Get detailed information about 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="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>TenantId to get information about. If not provided, all authorized tenants are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>TenantId to get information about. If not provided, all authorized tenants are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para>Tenant Id and associated domain information for tenants authorized for the current account.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmEnvironment</command:name> <maml:description> <maml:para>Remove endpoints and metadata information 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>Remove 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="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the environment to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force removal without prompts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force removal without prompts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Save-AzureRmProfile</command:name> <maml:description> <maml:para>Save 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>Save 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="0"> <maml:name>Profile</maml:name> <maml:description> <maml:para>If provided, saves the given profile to the provided path. If no profile is provided, the currently active profile will be saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureRmProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path of the file to save authentication information to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Profile</maml:name> <maml:description> <maml:para>If provided, saves the given profile to the provided path. If no profile is provided, the currently active profile will be saved.</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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path of the file to save authentication information to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRmAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Select-AzureRmProfile</command:name> <maml:description> <maml:para>Load authentication information from the given file. This sets the current context and azure environment metadata used by all cmdlets in the current session.</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>Load authentication information from the given file. This sets the current context and azure environment metadata used by all cmdlets in the current session.</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="0"> <maml:name>Profile</maml:name> <maml:description> <maml:para>The profile to select as the current profile in the given session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureRmProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to profile information previously saved using Save-AzureRmProfile. Cmdlets executed in the current session will use this information to authenticate requests to Azure Resource Manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Profile</maml:name> <maml:description> <maml:para>The profile to select as the current profile in the given session.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to profile information previously saved using Save-AzureRmProfile. Cmdlets executed in the current session will use this information to authenticate requests to Azure Resource Manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmContext</command:name> <maml:description> <maml:para>Set the tenant, subscription, and environment to be used by cmdlets in this 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>Set authentication information for cmdlets executed in the current session. Includes subscription, tenant, and environment information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmContext</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant for Azure Resource Manager cmdlets to target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The Subscription Id for executed cmdlets to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant for Azure Resource Manager cmdlets to target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The Subscription Id for executed cmdlets to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <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"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant to target in this session.</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"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription to target in this session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureSubscription</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant for Azure Resource Manager cmdlets to target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The Subscription Id for executed cmdlets to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The tenant to target in this session.</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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Subscription</maml:name> <maml:description> <maml:para>The subscription to target in this session.</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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Select a subscription --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx</dev:code> <dev:remarks> <maml:para>Select the given subscription.</maml:para> <maml:para /> <maml:para /> <maml:para>Account: user@contoso.com Environment: AzureCloud SubscriptionId: xxxx-xxxx-xxxx-xxxx TenantId: yyyy-yyyy-yyyy-yyyy</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmContext</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Login-AzureRmAccount</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmEnvironment</command:name> <maml:description> <maml:para>Set properties for the given Azure instance.</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>Set endpoints and metadata for connecting to the given Azure instance.</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="0"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>The url where PublishSettings files may be downloaded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Service Management (RDFE) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>The url for the management portal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>The endpoint for storage (blob, table, queue, file) access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>The base authority for Azure Active Directory authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>The Url for Azure Resource Manager requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Azure Resource Manager gallery of deployment templates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>GraphEndpoint</maml:name> <maml:description> <maml:para>The url for graph (Active Directory metadata) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for access tokens that authorize requests for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>TrafficManagerDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Traffic Manager Services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="13"> <maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Sql database servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="14"> <maml:name>EnableAdfsAuthentication</maml:name> <maml:description> <maml:para>Indicates whether ADFS (on premise) authentication is allowed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="15"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>The default Active Directory Tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>PublishSettingsFileUrl</maml:name> <maml:description> <maml:para>The url where PublishSettings files may be downloaded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ServiceEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Service Management (RDFE) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>ManagementPortalUrl</maml:name> <maml:description> <maml:para>The url for the management portal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StorageEndpoint</maml:name> <maml:description> <maml:para>The endpoint for storage (blob, table, queue, file) access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>ActiveDirectoryEndpoint</maml:name> <maml:description> <maml:para>The base authority for Azure Active Directory authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>ResourceManagerEndpoint</maml:name> <maml:description> <maml:para>The Url for Azure Resource Manager requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="7"> <maml:name>GalleryEndpoint</maml:name> <maml:description> <maml:para>The endpoint for Azure Resource Manager gallery of deployment templates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="8"> <maml:name>ActiveDirectoryServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="9"> <maml:name>GraphEndpoint</maml:name> <maml:description> <maml:para>The url for graph (Active Directory metadata) requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="10"> <maml:name>AzureKeyVaultDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="11"> <maml:name>AzureKeyVaultServiceEndpointResourceId</maml:name> <maml:description> <maml:para>The audience for access tokens that authorize requests for Key Vault services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="12"> <maml:name>TrafficManagerDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Traffic Manager Services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="13"> <maml:name>SqlDatabaseDnsSuffix</maml:name> <maml:description> <maml:para>The domain name suffix for Azure Sql database servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="14"> <maml:name>EnableAdfsAuthentication</maml:name> <maml:description> <maml:para>Indicates whether 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="15"> <maml:name>AdTenant</maml:name> <maml:description> <maml:para>The default Active Directory Tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, profile, common, login, account</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmEnvironment</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |