az cloud
Manage registered Azure clouds.
Commands
Name | Description | Type | Status |
---|---|---|---|
az cloud list |
List registered clouds. |
Core | GA |
az cloud list-profiles |
List the supported profiles for a cloud. |
Core | GA |
az cloud register |
Register a cloud. |
Core | GA |
az cloud set |
Set the active cloud. |
Core | GA |
az cloud show |
Get the details of a registered cloud. |
Core | GA |
az cloud unregister |
Unregister a cloud. |
Core | GA |
az cloud update |
Update the configuration of a cloud. |
Core | GA |
az cloud list
List registered clouds.
az cloud list
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az cloud list-profiles
List the supported profiles for a cloud.
az cloud list-profiles [--name]
[--show-all]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of a registered cloud.
Property | Value |
---|---|
Default value: | AzureCloud |
Show all available profiles supported in the CLI.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az cloud register
Register a cloud.
When registering a cloud, specify only the resource manager endpoint for the autodetection of other endpoints.
az cloud register --name
[--cloud-config]
[--endpoint-active-directory]
[--endpoint-active-directory-data-lake-resource-id]
[--endpoint-active-directory-graph-resource-id]
[--endpoint-active-directory-resource-id]
[--endpoint-gallery]
[--endpoint-management]
[--endpoint-microsoft-graph-resource-id]
[--endpoint-resource-manager]
[--endpoint-sql-management]
[--endpoint-vm-image-alias-doc]
[--profile {latest}]
[--skip-endpoint-discovery]
[--suffix-acr-login-server-endpoint]
[--suffix-azure-datalake-analytics-catalog-and-job-endpoint]
[--suffix-azure-datalake-store-file-system-endpoint]
[--suffix-keyvault-dns]
[--suffix-sql-server-hostname]
[--suffix-storage-endpoint]
Examples
Register a cloud with a config file
az cloud register -n MyCloud --cloud-config @"cloud.json"
("cloud.json" supports all the endpoint and suffix options in camel case or the JSON output format from `az cloud show`. See the example content below.)
{
"endpointActiveDirectory": "https://login.microsoftonline.us",
"suffixAcrLoginServerEndpoint": ".azurecr.us"
}
or
{
"endpoints":{
"activeDirectory": "https://login.microsoftonline.us"
},
"suffixes":{
"acrLoginServerEndpoint": ".azurecr.us"
}
}
Required Parameters
Name of a registered cloud.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
JSON encoded cloud configuration. Use @{file} to load from a file.
The Active Directory login endpoint.
The Active Directory resource ID for data lake services.
The Active Directory resource ID.
The resource ID to obtain AD tokens for.
The template gallery endpoint.
The management service endpoint.
The Microsoft Graph resource ID.
The resource management endpoint.
The sql server management endpoint.
The uri of the document which caches commonly used virtual machine images.
Profile to use for this cloud. The azure stack profiles 2017-03-09-profile
2018-03-01-hybrid
2019-03-01-hybrid
and 2020-09-01-hybrid
have been deprecated and removed. To continue using Azure Stack, please install the Azure CLI 2.66.*
(LTS) version. For more details, refer to: https://learn.microsoft.com/en-us/cli/azure/whats-new-overview#important-notice-for-azure-stack-hub-customers.
Property | Value |
---|---|
Accepted values: | latest |
If specified, the cloud endpoints' auto discovery will be skipped.
Property | Value |
---|---|
Default value: | False |
The Azure Container Registry login server suffix.
The Data Lake analytics job and catalog service dns suffix.
The Data Lake store filesystem service dns suffix.
The Key Vault service dns suffix.
The dns suffix for sql servers.
The endpoint suffix for storage accounts.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az cloud set
Set the active cloud.
az cloud set --name
[--profile {latest}]
Examples
Set the active cloud. (autogenerated)
az cloud set --name MyRegisteredCloud
Required Parameters
Name of a registered cloud.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Profile to use for this cloud. The azure stack profiles 2017-03-09-profile
2018-03-01-hybrid
2019-03-01-hybrid
and 2020-09-01-hybrid
have been deprecated and removed. To continue using Azure Stack, please install the Azure CLI 2.66.*
(LTS) version. For more details, refer to: https://learn.microsoft.com/en-us/cli/azure/whats-new-overview#important-notice-for-azure-stack-hub-customers.
Property | Value |
---|---|
Accepted values: | latest |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az cloud show
Get the details of a registered cloud.
az cloud show [--name]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of a registered cloud.
Property | Value |
---|---|
Default value: | AzureCloud |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az cloud unregister
Unregister a cloud.
az cloud unregister --name
Examples
Unregister a cloud. (autogenerated)
az cloud unregister --name MyRegisteredCloud
Required Parameters
Name of a registered cloud.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az cloud update
Update the configuration of a cloud.
az cloud update [--cloud-config]
[--endpoint-active-directory]
[--endpoint-active-directory-data-lake-resource-id]
[--endpoint-active-directory-graph-resource-id]
[--endpoint-active-directory-resource-id]
[--endpoint-gallery]
[--endpoint-management]
[--endpoint-microsoft-graph-resource-id]
[--endpoint-resource-manager]
[--endpoint-sql-management]
[--endpoint-vm-image-alias-doc]
[--name]
[--profile {latest}]
[--skip-endpoint-discovery]
[--suffix-acr-login-server-endpoint]
[--suffix-azure-datalake-analytics-catalog-and-job-endpoint]
[--suffix-azure-datalake-store-file-system-endpoint]
[--suffix-keyvault-dns]
[--suffix-sql-server-hostname]
[--suffix-storage-endpoint]
Examples
Update the configuration of a cloud. (autogenerated)
az cloud update --profile latest
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
JSON encoded cloud configuration. Use @{file} to load from a file.
The Active Directory login endpoint.
The Active Directory resource ID for data lake services.
The Active Directory resource ID.
The resource ID to obtain AD tokens for.
The template gallery endpoint.
The management service endpoint.
The Microsoft Graph resource ID.
The resource management endpoint.
The sql server management endpoint.
The uri of the document which caches commonly used virtual machine images.
Name of a registered cloud.
Property | Value |
---|---|
Default value: | AzureCloud |
Profile to use for this cloud. The azure stack profiles 2017-03-09-profile
2018-03-01-hybrid
2019-03-01-hybrid
and 2020-09-01-hybrid
have been deprecated and removed. To continue using Azure Stack, please install the Azure CLI 2.66.*
(LTS) version. For more details, refer to: https://learn.microsoft.com/en-us/cli/azure/whats-new-overview#important-notice-for-azure-stack-hub-customers.
Property | Value |
---|---|
Accepted values: | latest |
If specified, the cloud endpoints' auto discovery will be skipped.
Property | Value |
---|---|
Default value: | False |
The Azure Container Registry login server suffix.
The Data Lake analytics job and catalog service dns suffix.
The Data Lake store filesystem service dns suffix.
The Key Vault service dns suffix.
The dns suffix for sql servers.
The endpoint suffix for storage accounts.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |