az aksarc

コマンド

名前	説明	型	状態
az aksarc create	プロビジョニングされたクラスターを作成します。	Extension	GA
az aksarc delete	プロビジョニングされたクラスターを削除します。	Extension	GA
az aksarc get-credentials	プロビジョニングされたクラスターのローカル kubeconfig を取得します。	Extension	GA
az aksarc get-logs	プロビジョニングされたクラスターと基になるインフラストラクチャからログを収集します。	Extension	GA
az aksarc get-upgrades	プロビジョニングされたクラスターで使用できるアップグレード バージョンを取得します。	Extension	GA
az aksarc get-versions	指定したカスタムの場所で、サポートされている Kubernetes のバージョンを一覧表示します。	Extension	GA
az aksarc list	リソース グループまたはサブスクリプション内のプロビジョニング済みクラスターを一覧表示します。	Extension	GA
az aksarc logs	Deprecated. 代わりに 'az aksarc get-logs' を使用してください。	Extension	GA
az aksarc logs hci	プロビジョニングされたクラスターと基になるインフラストラクチャからログを収集します。	Extension	Deprecated
az aksarc nodepool	プロビジョニングされたクラスター内のノードプールを管理します。	Extension	GA
az aksarc nodepool add	プロビジョニングされたクラスターにノードプールを追加します。	Extension	GA
az aksarc nodepool delete	プロビジョニングされたクラスター内の nodepool を削除します。	Extension	GA
az aksarc nodepool list	プロビジョニングされたクラスター内のすべてのノードプールを一覧表示します。	Extension	GA
az aksarc nodepool scale	プロビジョニングされたクラスター内の nodepool をスケーリングします。	Extension	GA
az aksarc nodepool show	プロビジョニングされたクラスター内のノードプールを取得します。	Extension	GA
az aksarc nodepool update	プロビジョニングされたクラスター内のノードプールを更新します。	Extension	GA
az aksarc notice	ユーザー指定のファイルパスに NOTICE ファイルを出力します。	Extension	GA
az aksarc release	プロビジョニングされたクラスターの VHD イメージを管理します。	Extension	Preview
az aksarc release download	リリースから VHD イメージをダウンロードします。	Extension	Preview
az aksarc release save	ダウンロードした VHD イメージを Arc リソース ブリッジにプロビジョニングします。	Extension	Preview
az aksarc show	プロビジョニングされたクラスターを取得します。	Extension	GA
az aksarc update	プロビジョニングされたクラスターを更新します。	Extension	GA
az aksarc upgrade	プロビジョニングされたクラスターをアップグレードします。	Extension	GA
az aksarc vmsize	プロビジョニングされたクラスターの仮想マシン SKU を管理します。	Extension	GA
az aksarc vmsize list	指定したカスタムの場所でサポートされている仮想マシンのサイズを一覧表示します。	Extension	GA
az aksarc vnet	プロビジョニングされたクラスターの仮想ネットワークを管理します。	Extension	GA
az aksarc vnet create	仮想ネットワークを作成します。	Extension	GA
az aksarc vnet delete	仮想ネットワークを削除します。	Extension	GA
az aksarc vnet list	リソース グループまたはサブスクリプション別に仮想ネットワークを一覧表示します。	Extension	GA
az aksarc vnet show	仮想ネットワークを取得します。	Extension	GA

az aksarc create --custom-location
                 --name
                 --resource-group
                 --vnet-id --vnet-ids
                 [--aad-admin-group-object-ids]
                 [--acquire-policy-token]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--change-reference]
                 [--control-plane-count --control-plane-node-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-ai-toolchain-operator --enable-kaito]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--enable-oidc-issuer]
                 [--enable-wi --enable-workload-identity]
                 [--gateway-id]
                 [--generate-ssh-keys]
                 [--kubernetes-version]
                 [--load-balancer-count]
                 [--location]
                 [--max-count]
                 [--max-pods]
                 [--min-count]
                 [--no-wait]
                 [--node-count]
                 [--node-vm-size]
                 [--nodepool-labels]
                 [--nodepool-taints]
                 [--pod-cidr]
                 [--ssh-auth-ips --ssh-authorized-ip-ranges]
                 [--ssh-key-value]
                 [--tags]
                 [--validate]

例

PutProvisionedCluster

az aksarc create --resource-group sample-rg --custom-location sample-cl --name sample-aksarccluster --vnet-ids "vnet-arm-id"

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc delete --name
                 --resource-group
                 [--acquire-policy-token]
                 [--change-reference]
                 [--no-wait]
                 [--yes]

例

DeleteProvisionedCluster

az aksarc delete --name "sample-aksarccluster" --resource-group "sample-rg"

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc get-credentials --name
                          --resource-group
                          [--acquire-policy-token]
                          [--admin]
                          [--change-reference]
                          [--context]
                          [--file]
                          [--overwrite-existing]

例

GetAdminCredential

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg" --admin

GetAADUserCredential

az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg"

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc get-logs [--acquire-policy-token]
                   [--change-reference]
                   [--credentials-dir --ssh-key]
                   [--ip --ips]
                   [--kubeconfig]
                   [--out-dir]

例

IP アドレスと SSH 資格情報を使用してログを収集する

az aksarc get-logs --ip 192.168.200.31 192.168.200.32 --ssh-key ~/.ssh --out-dir ./logs

kubeconfig と SSH 資格情報を使用してログを収集します。kubeconfig は IP アドレスの収集にのみ使用され、ssh キー ファイル パスはディレクトリの代わりに使用されます

az aksarc get-logs --kubeconfig ~/.kube/config --ssh-key ~/.ssh/id_rsa --out-dir ./logs

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc get-upgrades --name
                       --resource-group
                       [--acquire-policy-token]
                       [--change-reference]

例

ハイブリッド AKS プロビジョニング クラスターで使用できるアップグレード バージョンを取得する

az aksarc get-upgrades --name "samplecluster" --resource-group "sample-rg"

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc get-versions --custom-location
                       [--acquire-policy-token]
                       [--change-reference]
                       [--resource-group]

例

VMListSkus

az aksarc get-versions -g sample-rg --custom-location sample-cl

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc list [--resource-group]

例

ListProvisionedClusterByResourceGroup

az aksarc list --resource-group "sample-rg"

ListProvisionedClusterBySubscription

az aksarc list

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc notice --output-filepath
                 [--acquire-policy-token]
                 [--change-reference]

例

GetNoticeFile

az aksarc notice --output-filepath "./Notice"

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc show --name
               --resource-group

例

GetProvisionedCluster

az aksarc show --name "sample-aksarccluster" --resource-group "sample-rg"

必須のパラメーター

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--acquire-policy-token]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--change-reference]
                 [--control-plane-count --control-plane-node-count]
                 [--disable-ahub]
                 [--disable-ai-toolchain-operator --disable-kaito]
                 [--disable-cluster-autoscaler]
                 [--disable-gateway]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-ai-toolchain-operator --enable-kaito]
                 [--enable-cluster-autoscaler]
                 [--enable-nfs-driver]
                 [--enable-smb-driver]
                 [--gateway-id]
                 [--max-count]
                 [--min-count]
                 [--tags]
                 [--update-cluster-autoscaler]

例

UpdateProvisionedCluster

az aksarc update --tags additionalProperties="sample" --name "sample-aksarccluster" --resource-group "sample-rg"

プロビジョニングされたクラスター Azureハイブリッド ユーザー特典機能を有効にします。

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --enable-ahub

プロビジョニングされたクラスター Azureハイブリッド ユーザー特典機能を無効にします。

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg"--disable-ahub

コントロール プレーン ノードをスケールアップします。

az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --control-plane-node-count 5

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False

az aksarc upgrade --name
                  --resource-group
                  [--acquire-policy-token]
                  [--change-reference]
                  [--kubernetes-version]
                  [--no-wait]
                  [--yes]

例

UpgradeProvisionedCluster

az aksarc upgrade --name "sample-aksarccluster" --resource-group "sample-rg" --kubernetes-version "1.22.2"

必須のパラメーター

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

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

プロパティ	値
規定値:	False