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

--query-examples

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.

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.

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 -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, 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.

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

az cloud show

Get the details of a registered cloud.

az cloud show [--name]
              [--query-examples]

Optional Parameters

--name -n

Name of a registered cloud.

default value: AzureCloud
--query-examples

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.

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.

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 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, 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.