az cloud

登録済みの Azure クラウドを管理します。

コマンド

名前	説明	型	状態
az cloud list	登録済みクラウドを一覧表示します。	Core	GA
az cloud list-profiles	クラウドでサポートされているプロファイルを一覧表示します。	Core	GA
az cloud register	クラウドを登録します。	Core	GA
az cloud set	アクティブなクラウドを設定します。	Core	GA
az cloud show	登録済みクラウドの詳細を取得します。	Core	GA
az cloud unregister	クラウドの登録を解除します。	Core	GA
az cloud update	クラウドの構成を更新します。	Core	GA

az cloud list

登録済みクラウドを一覧表示します。

az cloud list

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az cloud list-profiles

クラウドでサポートされているプロファイルを一覧表示します。

az cloud list-profiles [--name]
                       [--show-all]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name -n

登録済みクラウドの名前。

プロパティ	値
規定値:	AzureCloud

--show-all

CLI でサポートされているすべての使用可能なプロファイルを表示します。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az cloud register

クラウドを登録します。

クラウドを登録するときは、他のエンドポイントの自動検出用のリソース マネージャー エンドポイントのみを指定します。

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]

例

構成ファイルを使用してクラウドを登録する

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"
  }
}

必須のパラメーター

--name -n

登録済みクラウドの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cloud-config

JSON でエンコードされたクラウド構成。 @{file} を使用してファイルから読み込みます。

--endpoint-active-directory

Active Directory ログイン エンドポイント。

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

データ レイク サービスの Active Directory リソース ID。

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

Active Directory リソース ID。

--endpoint-active-directory-resource-id

AD トークンを取得するリソース ID。

--endpoint-gallery

テンプレート ギャラリー エンドポイント。

--endpoint-management

管理サービス エンドポイント。

--endpoint-microsoft-graph-resource-id

Microsoft Graph リソース ID。

--endpoint-resource-manager

リソース管理エンドポイント。

--endpoint-sql-management

SQL Server 管理エンドポイント。

--endpoint-vm-image-alias-doc

一般的に使用される仮想マシン イメージをキャッシュするドキュメントの URI。

--profile

このクラウドに使用するプロファイル。 Azure Stack プロファイルの 2017-03-09-profile2018-03-01-hybrid2019-03-01-hybrid と 2020-09-01-hybrid は非推奨となり、削除されました。 Azure Stack を引き続き使用するには、Azure CLI 2.66.* (LTS) バージョンをインストールしてください。 詳細については、「 https://learn.microsoft.com/en-us/cli/azure/whats-new-overview#important-notice-for-azure-stack-hub-customers」を参照してください。

プロパティ	値
指定可能な値:	latest

--skip-endpoint-discovery

指定した場合、クラウド エンドポイントの自動検出はスキップされます。

プロパティ	値
規定値:	False

--suffix-acr-login-server-endpoint

Azure Container Registry ログイン サーバーサフィックス。

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

Data Lake Analytics ジョブとカタログ サービスの DNS サフィックス。

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

Data Lake Store ファイルシステム サービスの DNS サフィックス。

--suffix-keyvault-dns

Key Vault サービスの DNS サフィックス。

--suffix-sql-server-hostname

SQL サーバーの DNS サフィックス。

--suffix-storage-endpoint

ストレージ アカウントのエンドポイント サフィックス。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az cloud set

アクティブなクラウドを設定します。

az cloud set --name
             [--profile {latest}]

例

アクティブなクラウドを設定します。 (autogenerated)

az cloud set --name MyRegisteredCloud

必須のパラメーター

--name -n

登録済みクラウドの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--profile

このクラウドに使用するプロファイル。 Azure Stack プロファイルの 2017-03-09-profile2018-03-01-hybrid2019-03-01-hybrid と 2020-09-01-hybrid は非推奨となり、削除されました。 Azure Stack を引き続き使用するには、Azure CLI 2.66.* (LTS) バージョンをインストールしてください。 詳細については、「 https://learn.microsoft.com/en-us/cli/azure/whats-new-overview#important-notice-for-azure-stack-hub-customers」を参照してください。

プロパティ	値
指定可能な値:	latest

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az cloud show

登録済みクラウドの詳細を取得します。

az cloud show [--name]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name -n

登録済みクラウドの名前。

プロパティ	値
規定値:	AzureCloud

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az cloud unregister

クラウドの登録を解除します。

az cloud unregister --name

例

クラウドの登録を解除します。 (autogenerated)

az cloud unregister --name MyRegisteredCloud

必須のパラメーター

--name -n

登録済みクラウドの名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az cloud update

クラウドの構成を更新します。

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]

例

クラウドの構成を更新します。 (autogenerated)

az cloud update --profile latest

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cloud-config

JSON でエンコードされたクラウド構成。 @{file} を使用してファイルから読み込みます。

--endpoint-active-directory

Active Directory ログイン エンドポイント。

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

データ レイク サービスの Active Directory リソース ID。

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

Active Directory リソース ID。

--endpoint-active-directory-resource-id

AD トークンを取得するリソース ID。

--endpoint-gallery

テンプレート ギャラリー エンドポイント。

--endpoint-management

管理サービス エンドポイント。

--endpoint-microsoft-graph-resource-id

Microsoft Graph リソース ID。

--endpoint-resource-manager

リソース管理エンドポイント。

--endpoint-sql-management

SQL Server 管理エンドポイント。

--endpoint-vm-image-alias-doc

一般的に使用される仮想マシン イメージをキャッシュするドキュメントの URI。

--name -n

登録済みクラウドの名前。

プロパティ	値
規定値:	AzureCloud

--profile

このクラウドに使用するプロファイル。 Azure Stack プロファイルの 2017-03-09-profile2018-03-01-hybrid2019-03-01-hybrid と 2020-09-01-hybrid は非推奨となり、削除されました。 Azure Stack を引き続き使用するには、Azure CLI 2.66.* (LTS) バージョンをインストールしてください。 詳細については、「 https://learn.microsoft.com/en-us/cli/azure/whats-new-overview#important-notice-for-azure-stack-hub-customers」を参照してください。

プロパティ	値
指定可能な値:	latest

--skip-endpoint-discovery

指定した場合、クラウド エンドポイントの自動検出はスキップされます。

プロパティ	値
規定値:	False

--suffix-acr-login-server-endpoint

Azure Container Registry ログイン サーバーサフィックス。

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

Data Lake Analytics ジョブとカタログ サービスの DNS サフィックス。

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

Data Lake Store ファイルシステム サービスの DNS サフィックス。

--suffix-keyvault-dns

Key Vault サービスの DNS サフィックス。

--suffix-sql-server-hostname

SQL サーバーの DNS サフィックス。

--suffix-storage-endpoint

ストレージ アカウントのエンドポイント サフィックス。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False