< Back

Get-AzureRmEnvironment

Tue Jan 29, 2019 10:00 pm

NAME Get-AzureRmEnvironment



SYNOPSIS

Get endpoints and metadata for an instance of Azure services.





SYNTAX

Get-AzureRmEnvironment [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmEnvironment cmdlet gets endpoints and metadata for an instance of Azure services.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the Azure instance to get.



Required? false

Position? 0

Default value None

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 (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

PSAzureEnvironment







NOTES









Example 1: Getting the AzureCloud environment



PS C:\\> Get-AzureRmEnvironment AzureCloud



Name : AzureCloud

EnableAdfsAuthentication : False

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

AdTenant :

GalleryUrl : https://gallery.azure.com/

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

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

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

ResourceManagerUrl : https://management.azure.com/

SqlDatabaseDnsSuffix : .database.windows.net

StorageEndpointSuffix : core.windows.net

ActiveDirectoryAuthority : https://login.microsoftonline.com/

GraphUrl : https://graph.windows.net/

GraphEndpointResourceId : https://graph.windows.net/

TrafficManagerDnsSuffix : trafficmanager.net

AzureKeyVaultDnsSuffix : vault.azure.net

AzureDataLakeStoreFileSystemEndpointSuffix : azuredatalakestore.net

AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix : azuredatalakeanalytics.net

AzureKeyVaultServiceEndpointResourceId : https://vault.azure.net



This example shows how to get the endpoints and metadata for the AzureCloud (default) environment.





Example 2: Getting the AzureChinaCloud environment



PS C:\\> Get-AzureRmEnvironment AzureChinaCloud



Name : AzureChinaCloud

EnableAdfsAuthentication : False

ActiveDirectoryServiceEndpointResourceId : https://management.core.chinacloudapi.cn/

AdTenant :

GalleryUrl : https://gallery.chinacloudapi.cn/

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

ServiceManagementUrl : https://management.core.chinacloudapi.cn/

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

ResourceManagerUrl : https://management.chinacloudapi.cn/

SqlDatabaseDnsSuffix : .database.chinacloudapi.cn

StorageEndpointSuffix : core.chinacloudapi.cn

ActiveDirectoryAuthority : https://login.chinacloudapi.cn/

GraphUrl : https://graph.chinacloudapi.cn/

GraphEndpointResourceId : https://graph.chinacloudapi.cn/

TrafficManagerDnsSuffix : trafficmanager.cn

AzureKeyVaultDnsSuffix : vault.azure.cn

AzureDataLakeStoreFileSystemEndpointSuffix :

AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :

AzureKeyVaultServiceEndpointResourceId : https://vault.azure.cn



This example shows how to get the endpoints and metadata for the AzureChinaCloud environment.





Example 3: Getting the AzureUSGovernment environment



PS C:\\> Get-AzureRmEnvironment AzureUSGovernment



Name : AzureUSGovernment

EnableAdfsAuthentication : False

ActiveDirectoryServiceEndpointResourceId : https://management.core.usgovcloudapi.net/

AdTenant :

GalleryUrl : https://gallery.usgovcloudapi.net/

ManagementPortalUrl : https://manage.windowsazure.us

ServiceManagementUrl : https://management.core.usgovcloudapi.net/

PublishSettingsFileUrl : https://manage.windowsazure.us/publishsettings/index

ResourceManagerUrl : https://management.usgovcloudapi.net/

SqlDatabaseDnsSuffix : .database.usgovcloudapi.net

StorageEndpointSuffix : core.usgovcloudapi.net

ActiveDirectoryAuthority : https://login.microsoftonline.us/

GraphUrl : https://graph.windows.net/

GraphEndpointResourceId : https://graph.windows.net/

TrafficManagerDnsSuffix : usgovtrafficmanager.net

AzureKeyVaultDnsSuffix : vault.usgovcloudapi.net

AzureDataLakeStoreFileSystemEndpointSuffix :

AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :

AzureKeyVaultServiceEndpointResourceId : https://vault.usgovcloudapi.net



This example shows how to get the endpoints and metadata for the AzureUSGovernment environment.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... nvironment

Add-AzureRmEnvironment

Remove-AzureRmEnvironment

Set-AzureRMEnvironment