az aksarc

Note

このリファレンスは、Azure CLI (バージョン 2.32.0 以降) の aksarc 拡張機能の一部です。 az aksarc コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細を参照してください。

プロビジョニングされたクラスターを管理します。

コマンド

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

az aksarc create

プロビジョニングされたクラスターを作成します。

az aksarc create --custom-location
                 --name
                 --resource-group
                 --vnet-id
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--enable-oidc-issuer]
                 [--enable-wi]
                 [--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-key-value]
                 [--tags]

例

PutProvisionedCluster

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

必須のパラメーター

--custom-location

プロビジョニングされたクラスターに使用するカスタムの場所の名前または ID。

--name -n

プロビジョニングされたクラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--vnet-id --vnet-ids

aksarc 仮想ネットワークまたは Azure Stack HCI 論理ネットワークの ARM リソース ID。

省略可能のパラメーター

--aad-admin-group-object-ids -i

プロビジョニングされたクラスターのクラスター管理者として設定される、aad グループ オブジェクト ID のコンマ区切りの一覧。

--ca-profile --cluster-autoscaler-profile

クラスター オートスケーラーを構成するためのキーと値のペアのスペース区切りの一覧。 空の文字列を渡してプロファイルをクリアします。

--control-plane-count --control-plane-node-count

コントロール プレーン ノードの数。

--control-plane-ip

Kubernetes APIServer IPAddress。 IPAddress は、参照されるネットワーク サブネットの一部である必要 VM.It、Azure Resource Bridge Appliance からルーティング可能である必要があります。ルーティング不可能な IPAddress が渡されると、クラスターの作成が失敗したりタイムアウトしたりする可能性があります。

--control-plane-vm-size

コントロール プレーンの VM サイズ。

--disable-nfs-driver

プロビジョニングされたクラスターの NFS ドライバーを無効にします。

規定値: False

--disable-smb-driver

プロビジョニングされたクラスターの SMB ドライバーを無効にします。

規定値: False

--enable-ahub

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

規定値: False

--enable-azure-rbac

Azure RBAC を有効にして、クラスターの承認チェックを制御します。

規定値: False

--enable-cluster-autoscaler -e

プロビジョニングされたクラスターのクラスター 自動スケーラーを有効にします。

規定値: False

--enable-oidc-issuer

OIDC 発行者を有効にします。

規定値: False

--enable-wi --enable-workload-identity

ワークロード ID アドオンを有効にします。

規定値: False

--gateway-id

プロビジョニングされたクラスターのゲートウェイ Arm ID。

--generate-ssh-keys

ssh キーペアが存在しない場合は生成します。

規定値: False

--kubernetes-version -k

プロビジョニングされたクラスターの kubernetes バージョン。

--load-balancer-count

ロード バランサー ノードの数。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--max-count

自動スケーリングのノードの最大数。

--max-pods -m

ノードで実行できるポッドの最大数。

--min-count

自動スケーリング用のノードの最小数。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--node-count -c

nodepool に作成されるノードの数。

規定値: 1

--node-vm-size

ノード プール内のノードの VM サイズ。

--nodepool-labels

スペース区切りのラベル: key[=value] [key[=value] ...]

--nodepool-taints

nodepool テイントのコンマ区切りリスト。

--pod-cidr

ポッド IP の割り当て元となる CIDR 表記 IP 範囲。

--ssh-auth-ips --ssh-authorized-ip-ranges

クラスター VM への SSH 接続が許可されている IP アドレスまたは CIDR のコンマ区切りの一覧。

--ssh-key-value

コントロール プレーンに挿入する ssh 公開キーへのパス。

規定値: ~\.ssh\id_rsa.pub

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc delete

プロビジョニングされたクラスターを削除します。

az aksarc delete --name
                 --resource-group
                 [--no-wait]
                 [--yes]

例

DeleteProvisionedCluster

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

必須のパラメーター

--name -n

プロビジョニングされたクラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc get-credentials

プロビジョニングされたクラスターのローカル kubeconfig を取得します。

az aksarc get-credentials --name
                          --resource-group
                          [--admin]
                          [--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"

必須のパラメーター

--name -n

プロビジョニングされたクラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--admin -a

クラスター管理者の資格情報を取得します。

規定値: False

--context

指定した場合は、既定のコンテキスト名を上書きします。

--file -f

更新する Kubernetes 構成ファイル。 指定しない場合は、ファイル '~/.kube/config' を更新します。

規定値: ~\.kube\config

--overwrite-existing

既存のクラスター エントリを同じ名前で上書きします。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc get-upgrades

プロビジョニングされたクラスターで使用できるアップグレード バージョンを取得します。

az aksarc get-upgrades --name
                       --resource-group

例

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

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

必須のパラメーター

--name -n

プロビジョニングされたクラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc get-versions

指定したカスタムの場所で、サポートされている Kubernetes のバージョンを一覧表示します。

az aksarc get-versions --custom-location
                       [--resource-group]

例

VMListSkus

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

必須のパラメーター

--custom-location

サポートされている k8s バージョンの表示に使用するカスタムの場所の名前。

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc list

リソース グループまたはサブスクリプション内のプロビジョニング済みクラスターを一覧表示します。

az aksarc list [--resource-group]

例

ListProvisionedClusterByResourceGroup

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

ListProvisionedClusterBySubscription

az aksarc list

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc notice

ユーザー指定のファイルパスに NOTICE ファイルを出力します。

az aksarc notice --output-filepath

例

GetNoticeFile

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

必須のパラメーター

--output-filepath

NOTICE ファイルの出力ファイルパス。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc show

プロビジョニングされたクラスターを取得します。

az aksarc show --name
               --resource-group

例

GetProvisionedCluster

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

必須のパラメーター

--name -n

プロビジョニングされたクラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc update

プロビジョニングされたクラスターを更新します。

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--disable-ahub]
                 [--disable-cluster-autoscaler]
                 [--disable-gateway]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--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

必須のパラメーター

--name -n

プロビジョニングされたクラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--aad-admin-group-object-ids -i

プロビジョニングされたクラスターのクラスター管理者として設定される、aad グループ オブジェクト ID のコンマ区切りの一覧。

--ca-profile --cluster-autoscaler-profile

クラスター オートスケーラーを構成するためのキーと値のペアのスペース区切りの一覧。 空の文字列を渡してプロファイルをクリアします。

--control-plane-count --control-plane-node-count

コントロール プレーンをスケーリングするノードの数。

--disable-ahub

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

規定値: False

--disable-cluster-autoscaler -d

プロビジョニングされたクラスターのクラスター 自動スケーラーを無効にします。

規定値: False

--disable-gateway

プロビジョニングされたクラスターのゲートウェイを無効にします。

規定値: False

--disable-nfs-driver

プロビジョニングされたクラスターの NFS ドライバーを無効にします。

規定値: False

--disable-smb-driver

プロビジョニングされたクラスターの SMB ドライバーを無効にします。

規定値: False

--enable-ahub

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

規定値: False

--enable-cluster-autoscaler -e

プロビジョニングされたクラスターのクラスター 自動スケーラーを有効にします。

規定値: False

--enable-nfs-driver

プロビジョニングされたクラスターの NFS ドライバーを有効にします。

規定値: False

--enable-smb-driver

プロビジョニングされたクラスターの SMB ドライバーを有効にします。

規定値: False

--gateway-id

プロビジョニングされたクラスターのゲートウェイ Arm ID。

--max-count

自動スケーリングのノードの最大数。

--min-count

自動スケーリング用のノードの最小数。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--update-cluster-autoscaler -u

プロビジョニングされたクラスターのクラスター 自動スケーラーを更新します。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az aksarc upgrade

プロビジョニングされたクラスターをアップグレードします。

az aksarc upgrade --name
                  --resource-group
                  [--kubernetes-version]
                  [--no-wait]
                  [--yes]

例

UpgradeProvisionedCluster

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

必須のパラメーター

--name -n

プロビジョニングされたクラスターの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--kubernetes-version -k

プロビジョニングされたクラスターの kubernetes バージョン。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--yes

確認プロンプトを無効にするフラグ。

規定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。