az cloud
Manage registered Azure clouds.
Commands
| az cloud list |
List registered clouds. |
| az cloud list-profiles |
List the supported profiles for a cloud. |
| az cloud register |
Register a cloud. |
| az cloud set |
Set the active cloud. |
| az cloud show |
Get the details of a registered cloud. |
| az cloud unregister |
Unregister a cloud. |
| az cloud update |
Update the configuration of a cloud. |
az cloud list
List registered clouds.
az cloud list [--query-examples]Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cloud list-profiles
List the supported profiles for a cloud.
az cloud list-profiles [--name]
[--show-all]Optional Parameters
Name of a registered cloud.
Show all available profiles supported in the CLI.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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-resource-manager]
[--endpoint-sql-management]
[--endpoint-vm-image-alias-doc]
[--profile {2017-03-09-profile, 2018-03-01-hybrid, 2019-03-01-hybrid, latest}]
[--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
{
"endpoint":{
"activeDirectory": "https://login.microsoftonline.us"
},
"suffix":{
"acrLoginServerEndpoint": ".azurecr.us"
}
}Required Parameters
Name of a registered cloud.
Optional Parameters
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 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 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.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cloud set
Set the active cloud.
az cloud set --name
[--profile {2017-03-09-profile, 2018-03-01-hybrid, 2019-03-01-hybrid, latest}]Examples
Set the active cloud. (autogenerated)
az cloud set --name MyRegisteredCloudRequired Parameters
Name of a registered cloud.
Optional Parameters
Profile to use for this cloud.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cloud show
Get the details of a registered cloud.
az cloud show [--name]
[--query-examples]Optional Parameters
Name of a registered cloud.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az cloud unregister
Unregister a cloud.
az cloud unregister --nameExamples
Unregister a cloud. (autogenerated)
az cloud unregister --name MyRegisteredCloudRequired Parameters
Name of a registered cloud.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
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-resource-manager]
[--endpoint-sql-management]
[--endpoint-vm-image-alias-doc]
[--name]
[--profile {2017-03-09-profile, 2018-03-01-hybrid, 2019-03-01-hybrid, latest}]
[--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 latestOptional Parameters
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 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.
Profile to use for this cloud.
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.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.