< Back

Get-AzureEnvironment

Wed Jan 30, 2019 5:41 pm

NAME Get-AzureEnvironment



SYNOPSIS

Gets Azure environments





SYNTAX

Get-AzureEnvironment [[-Name] <String>] [<CommonParameters>]





DESCRIPTION

The Get-AzureEnvironment cmdlet gets the Azure environments that are available to Windows PowerShell.



An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by

21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see Azure Pack

(http://www.microsoft.com/en-us/server-c ... fault.aspx).



The Get-AzureEnvironment cmdlet gets environments from your subscription data file, not from Azure. If the subscription data file is outdated, run the

Add-AzureAccount or Import-PublishSettingsFile cmdlet to refresh it.



This topic describes the cmdlet in the .7.2 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from

the Azure PowerShell console, type (get-module azure).version.





PARAMETERS

-Name <String>

Gets only the specified environment. Type the environment name. The parameter value is case-sensitive. Wildcard characters are not permitted.



Required? false

Position? 1

Default value

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None



You can pipe input to this cmdlet by property name, but not by value.





OUTPUTS

System.Management.Automation.PSCustomObject



By default, Get-AzureEnvironment returns a custom object.



Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment



When you run Get-AzureEnvironment with the Name parameter, it returns a WindowsAzureEnvironment object.





NOTES





Keywords: azure, azuresm, servicemanagement, management, service, utilities



Example 1: Get all environments



PS C:\\>Get-AzureEnvironment

EnvironmentName ServiceEndpoint ResourceManagerEndpoint PublishSettingsFileUrl

--------------- --------------- ----------------------- ----------------------



AzureCloud https://management.core.wi... https://management.azure.com/ http://go.microsoft.com/fw...

AzureChinaCloud https://management.core.ch... https://not-supported-serv... http://go.microsoft.com/fw...



This command gets all environments that are available to Windows PowerShell.

Example 2: Get an environment by name



PS C:\\>Get-AzureEnvironment -Name AzureCloud

Name : AzureCloud



PublishSettingsFileUrl : http://go.microsoft.com/fwlink/?LinkID=301775



ServiceEndpoint : https://management.core.windows.net/



ResourceManagerEndpoint : https://management.azure.com/



ManagementPortalUrl : http://go.microsoft.com/fwlink/?LinkId=254433



ActiveDirectoryEndpoint : https://login.windows.net/



ActiveDirectoryCommonTenantId : common



StorageEndpointSuffix : core.windows.net



StorageBlobEndpointFormat : {0}://{1}.blob.core.windows.net/



StorageQueueEndpointFormat : {0}://{1}.queue.core.windows.net/



StorageTableEndpointFormat : {0}://{1}.table.core.windows.net/



GalleryEndpoint : https://gallery.azure.com/



This example gets the AzureCloud environment.

Example 3: Get all properties of all environments



PS C:\\>Get-AzureEnvironment | ForEach-Object {Get-AzureEnvironment -Name $_.EnvironmentName}



This command gets all properties of all environments.



The command uses the Get-AzureEnvironment cmdlet to get all Azure environments for this account. Then, it uses the Foreach-Object cmdlet to run a

Get-AzureEnvironment command with the Name parameter on each environment. The value of the Name parameter is the EnvironmentName property of each

environment.



Without parameters, Get-AzureEnvironment gets only selected properties of an environment.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=397621

Add-AzureAccount

Add-AzureEnvironment

Get-AzurePublishSettingsFile

Import-AzurePublishSettingsFile

Remove-AzureEnvironment

Set-AzureEnvironment