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

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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 -n

Name of a registered cloud.

Default value: AzureCloud

--show-all

Show all available profiles supported in the CLI.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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, 2020-09-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
{
  "endpoints":{
    "activeDirectory": "https://login.microsoftonline.us"
  },
  "suffixes":{
    "acrLoginServerEndpoint": ".azurecr.us"
  }
}

Required Parameters

--name -n

Name of a registered cloud.

Optional Parameters

--cloud-config

JSON encoded cloud configuration. Use @{file} to load from a file.

--endpoint-active-directory

The Active Directory login endpoint.

--endpoint-active-directory-data-lake-resource-id

The Active Directory resource ID for data lake services.

--endpoint-active-directory-graph-resource-id

The Active Directory resource ID.

--endpoint-active-directory-resource-id

The resource ID to obtain AD tokens for.

--endpoint-gallery

The template gallery endpoint.

--endpoint-management

The management service endpoint.

--endpoint-resource-manager

The resource management endpoint.

--endpoint-sql-management

The sql server management endpoint.

--endpoint-vm-image-alias-doc

The uri of the document which caches commonly used virtual machine images.

--profile

Profile to use for this cloud.

Accepted values: 2017-03-09-profile, 2018-03-01-hybrid, 2019-03-01-hybrid, 2020-09-01-hybrid, latest

--suffix-acr-login-server-endpoint

The Azure Container Registry login server suffix.

--suffix-azure-datalake-analytics-catalog-and-job-endpoint

The Data Lake analytics job and catalog service dns suffix.

--suffix-azure-datalake-store-file-system-endpoint

The Data Lake store filesystem service dns suffix.

--suffix-keyvault-dns

The Key Vault service dns suffix.

--suffix-sql-server-hostname

The dns suffix for sql servers.

--suffix-storage-endpoint

The endpoint suffix for storage accounts.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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, 2020-09-01-hybrid, latest}]

Examples

Set the active cloud. (autogenerated)

az cloud set --name MyRegisteredCloud

Required Parameters

--name -n

Name of a registered cloud.

Optional Parameters

--profile

Profile to use for this cloud.

Accepted values: 2017-03-09-profile, 2018-03-01-hybrid, 2019-03-01-hybrid, 2020-09-01-hybrid, latest

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cloud show

Get the details of a registered cloud.

az cloud show [--name]

Optional Parameters

--name -n

Name of a registered cloud.

Default value: AzureCloud

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cloud unregister

Unregister a cloud.

az cloud unregister --name

Examples

Unregister a cloud. (autogenerated)

az cloud unregister --name MyRegisteredCloud

Required Parameters

--name -n

Name of a registered cloud.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

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, 2020-09-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 latest

Optional Parameters

--cloud-config

JSON encoded cloud configuration. Use @{file} to load from a file.

--endpoint-active-directory

The Active Directory login endpoint.

--endpoint-active-directory-data-lake-resource-id

The Active Directory resource ID for data lake services.

--endpoint-active-directory-graph-resource-id

The Active Directory resource ID.

--endpoint-active-directory-resource-id

The resource ID to obtain AD tokens for.

--endpoint-gallery

The template gallery endpoint.

--endpoint-management

The management service endpoint.

--endpoint-resource-manager

The resource management endpoint.

--endpoint-sql-management

The sql server management endpoint.

--endpoint-vm-image-alias-doc

The uri of the document which caches commonly used virtual machine images.

--name -n

Name of a registered cloud.

Default value: AzureCloud

--profile

Profile to use for this cloud.

Accepted values: 2017-03-09-profile, 2018-03-01-hybrid, 2019-03-01-hybrid, 2020-09-01-hybrid, latest

--suffix-acr-login-server-endpoint

The Azure Container Registry login server suffix.

--suffix-azure-datalake-analytics-catalog-and-job-endpoint

The Data Lake analytics job and catalog service dns suffix.

--suffix-azure-datalake-store-file-system-endpoint

The Data Lake store filesystem service dns suffix.

--suffix-keyvault-dns

The Key Vault service dns suffix.

--suffix-sql-server-hostname

The dns suffix for sql servers.

--suffix-storage-endpoint

The endpoint suffix for storage accounts.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.