Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Get-AzEnvironment.md #14704

Merged
merged 1 commit into from
Apr 10, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 46 additions & 20 deletions src/Accounts/Accounts/help/Get-AzEnvironment.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,45 @@ The Get-AzEnvironment cmdlet gets endpoints and metadata for an instance of Azur

## EXAMPLES

### Example 1: Getting the AzureCloud environment
### Example 1: Getting all Azure environments
```powershell
PS C:\> Get-AzEnvironment

Name Resource Manager Url ActiveDirectory Authority Type
---- -------------------- ------------------------- ----
AzureUSGovernment https://management.usgovcloudapi.net/ https://login.microsoftonline.us/ Built-in
AzureGermanCloud https://management.microsoftazure.de/ https://login.microsoftonline.de/ Built-in
AzureCloud https://management.azure.com/ https://login.microsoftonline.com/ Built-in
AzureChinaCloud https://management.chinacloudapi.cn/ https://login.chinacloudapi.cn/ Built-in
```
PS C:\> Get-AzEnvironment AzureCloud

Name Resource Manager Url ActiveDirectory Authority
---- -------------------- -------------------------
AzureCloud https://management.azure.com/ https://login.microsoftonline.com/
This example shows how to get the endpoints and metadata for the AzureCloud (default) environment.

### Example 2: Getting the AzureCloud environment
```powershell
PS C:\> Get-AzEnvironment -Name AzureCloud

Name Resource Manager Url ActiveDirectory Authority Type
---- -------------------- ------------------------- ----
AzureCloud https://management.azure.com/ https://login.microsoftonline.com/ Built-in
```

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

### Example 2: Getting the AzureChinaCloud environment
```
PS C:\> Get-AzEnvironment AzureChinaCloud | Format-List
### Example 3: Getting the AzureChinaCloud environment
```powershell
PS C:\> Get-AzEnvironment -Name AzureChinaCloud | Format-List

Name : AzureChinaCloud
Type : Built-in
EnableAdfsAuthentication : False
OnPremise : False
ActiveDirectoryServiceEndpointResourceId : https://management.core.chinacloudapi.cn/
AdTenant :
GalleryUrl : https://gallery.chinacloudapi.cn/
ManagementPortalUrl : http://go.microsoft.com/fwlink/?LinkId=301902
AdTenant : Common
GalleryUrl : https://gallery.azure.com/
ManagementPortalUrl : https://go.microsoft.com/fwlink/?LinkId=301902
ServiceManagementUrl : https://management.core.chinacloudapi.cn/
PublishSettingsFileUrl : http://go.microsoft.com/fwlink/?LinkID=301776
PublishSettingsFileUrl : https://go.microsoft.com/fwlink/?LinkID=301776
ResourceManagerUrl : https://management.chinacloudapi.cn/
SqlDatabaseDnsSuffix : .database.chinacloudapi.cn
StorageEndpointSuffix : core.chinacloudapi.cn
Expand All @@ -52,20 +68,30 @@ GraphUrl : https://graph.chinacloudapi.
GraphEndpointResourceId : https://graph.chinacloudapi.cn/
TrafficManagerDnsSuffix : trafficmanager.cn
AzureKeyVaultDnsSuffix : vault.azure.cn
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
DataLakeEndpointResourceId :
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId : https://vault.azure.cn
ContainerRegistryEndpointSuffix : azurecr.cn
AzureOperationalInsightsEndpointResourceId :
AzureOperationalInsightsEndpoint :
AzureAnalysisServicesEndpointSuffix : asazure.chinacloudapi.cn
AnalysisServicesEndpointResourceId : https://region.asazure.chinacloudapi.cn
AzureAttestationServiceEndpointSuffix :
AzureAttestationServiceEndpointResourceId :
AzureSynapseAnalyticsEndpointSuffix : dev.azuresynapse.azure.cn
AzureSynapseAnalyticsEndpointResourceId : https://dev.azuresynapse.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-AzEnvironment AzureUSGovernment
### Example 4: Getting the AzureUSGovernment environment
```powershell
PS C:\> Get-AzEnvironment -Name AzureUSGovernment

Name Resource Manager Url ActiveDirectory Authority
---- -------------------- -------------------------
AzureUSGovernment https://management.usgovcloudapi.net/ https://login.microsoftonline.us/
Name Resource Manager Url ActiveDirectory Authority Type
---- -------------------- ------------------------- ----
AzureUSGovernment https://management.usgovcloudapi.net/ https://login.microsoftonline.us/ Built-in
```

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