az aksarc
手記
このリファレンスは、Azure CLI (バージョン 2.32.0 以降) の aksarc 拡張機能の一部です。 拡張機能は、az aksarc コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
プロビジョニングされたクラスターを管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az aksarc create |
プロビジョニングされたクラスターを作成します。 |
延長 | ジョージア 州 |
az aksarc delete |
プロビジョニングされたクラスターを削除します。 |
延長 | ジョージア 州 |
az aksarc get-credentials |
プロビジョニングされたクラスターのローカル kubeconfig を取得します。 |
延長 | ジョージア 州 |
az aksarc get-logs |
プロビジョニングされたクラスターと基になるインフラストラクチャからログを収集します。 |
延長 | ジョージア 州 |
az aksarc get-upgrades |
プロビジョニングされたクラスターで使用できるアップグレード バージョンを取得します。 |
延長 | ジョージア 州 |
az aksarc get-versions |
指定したカスタムの場所で、サポートされている Kubernetes のバージョンを一覧表示します。 |
延長 | ジョージア 州 |
az aksarc list |
リソース グループまたはサブスクリプション内のプロビジョニング済みクラスターを一覧表示します。 |
延長 | ジョージア 州 |
az aksarc logs |
廃止。 代わりに 'az aksarc get-logs' を使用してください。 |
延長 | ジョージア 州 |
az aksarc logs hci |
プロビジョニングされたクラスターと基になるインフラストラクチャからログを収集します。 |
延長 | 廃止 |
az aksarc nodepool |
プロビジョニングされたクラスター内のノードプールを管理します。 |
延長 | ジョージア 州 |
az aksarc nodepool add |
プロビジョニングされたクラスターにノードプールを追加します。 |
延長 | ジョージア 州 |
az aksarc nodepool delete |
プロビジョニングされたクラスター内の nodepool を削除します。 |
延長 | ジョージア 州 |
az aksarc nodepool list |
プロビジョニングされたクラスター内のすべてのノードプールを一覧表示します。 |
延長 | ジョージア 州 |
az aksarc nodepool scale |
プロビジョニングされたクラスター内の nodepool をスケーリングします。 |
延長 | ジョージア 州 |
az aksarc nodepool show |
プロビジョニングされたクラスター内のノードプールを取得します。 |
延長 | ジョージア 州 |
az aksarc nodepool update |
プロビジョニングされたクラスター内のノードプールを更新します。 |
延長 | ジョージア 州 |
az aksarc notice |
ユーザー指定のファイルパスに NOTICE ファイルを出力します。 |
延長 | ジョージア 州 |
az aksarc release |
プロビジョニングされたクラスターの VHD イメージを管理します。 |
延長 | プレビュー |
az aksarc release download |
リリースから VHD イメージをダウンロードします。 |
延長 | プレビュー |
az aksarc release save |
ダウンロードした VHD イメージを Arc リソース ブリッジにプロビジョニングします。 |
延長 | プレビュー |
az aksarc show |
プロビジョニングされたクラスターを取得します。 |
延長 | ジョージア 州 |
az aksarc update |
プロビジョニングされたクラスターを更新します。 |
延長 | ジョージア 州 |
az aksarc upgrade |
プロビジョニングされたクラスターをアップグレードします。 |
延長 | ジョージア 州 |
az aksarc vmsize |
プロビジョニングされたクラスターの仮想マシン SKU を管理します。 |
延長 | ジョージア 州 |
az aksarc vmsize list |
指定したカスタムの場所でサポートされている仮想マシンのサイズを一覧表示します。 |
延長 | ジョージア 州 |
az aksarc vnet |
プロビジョニングされたクラスターの仮想ネットワークを管理します。 |
延長 | ジョージア 州 |
az aksarc vnet create |
仮想ネットワークを作成します。 |
延長 | ジョージア 州 |
az aksarc vnet delete |
仮想ネットワークを削除します。 |
延長 | ジョージア 州 |
az aksarc vnet list |
リソース グループまたはサブスクリプション別に仮想ネットワークを一覧表示します。 |
延長 | ジョージア 州 |
az aksarc vnet show |
仮想ネットワークを取得します。 |
延長 | ジョージア 州 |
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-ai-toolchain-operator]
[--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]
[--validate]
例
PutProvisionedCluster
az aksarc create --resource-group sample-rg --custom-location sample-cl --name sample-aksarccluster --vnet-ids "vnet-arm-id"
必須のパラメーター
プロビジョニングされたクラスターに使用するカスタムの場所の名前または ID。
プロビジョニングされたクラスターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
aksarc 仮想ネットワークまたは Azure ローカル論理ネットワークの ARM リソース ID。
省略可能のパラメーター
プロビジョニングされたクラスターのクラスター管理者として設定される、aad グループ オブジェクト ID のコンマ区切りの一覧。
クラスター オートスケーラーを構成するためのキーと値のペアのスペース区切りの一覧。 空の文字列を渡してプロファイルをクリアします。
コントロール プレーン ノードの数。
Kubernetes APIServer IPAddress。 IPAddress は、参照されるネットワーク サブネットの一部である必要 VM.It、Azure Resource Bridge Appliance からルーティング可能である必要があります。ルーティング不可能な IPAddress が渡されると、クラスターの作成が失敗したりタイムアウトしたりする可能性があります。
コントロール プレーンの VM サイズ。
プロビジョニングされたクラスターの NFS ドライバーを無効にします。
プロビジョニングされたクラスターの SMB ドライバーを無効にします。
プロビジョニングされたクラスターに対して Azure ハイブリッド ユーザー特典 (AHUB) を有効にします。
プロビジョニングされたクラスターに対して AI Toolchain Operator を有効にします。
Azure RBAC を有効にして、クラスターの承認チェックを制御します。
プロビジョニングされたクラスターのクラスター 自動スケーラーを有効にします。
OIDC 発行者を有効にします。
ワークロード ID アドオンを有効にします。
プロビジョニングされたクラスターのゲートウェイ Arm ID。
ssh キーペアが存在しない場合は生成します。
プロビジョニングされたクラスターの kubernetes バージョン。
ロード バランサー ノードの数。
場所。 値の取得場所: az account list-locations
.
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
自動スケーリングのノードの最大数。
ノードで実行できるポッドの最大数。
自動スケーリング用のノードの最小数。
実行時間の長い操作が完了するまで待つ必要はありません。
nodepool に作成されるノードの数。
ノード プール内のノードの VM サイズ。
スペース区切りのラベル: key[=value] [key[=value] ...]
nodepool テイントのコンマ区切りリスト。
ポッド IP の割り当て元となる CIDR 表記 IP 範囲。
クラスター VM への SSH 接続が許可されている IP アドレスまたは CIDR のコンマ区切りの一覧。
コントロール プレーンに挿入する ssh 公開キーへのパス。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
実際にクラスターを作成せずに、クラスターの入力パラメーターを検証します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az aksarc delete
プロビジョニングされたクラスターを削除します。
az aksarc delete --name
--resource-group
[--no-wait]
[--yes]
例
DeleteProvisionedCluster
az aksarc delete --name "sample-aksarccluster" --resource-group "sample-rg"
必須のパラメーター
プロビジョニングされたクラスターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
実行時間の長い操作が完了するまで待つ必要はありません。
確認を求めないでください。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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"
必須のパラメーター
プロビジョニングされたクラスターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
クラスター管理者の資格情報を取得します。
指定した場合は、既定のコンテキスト名を上書きします。
更新する Kubernetes 構成ファイル。 指定しない場合は、ファイル '~/.kube/config' を更新します。
既存のクラスター エントリを同じ名前で上書きします。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az aksarc get-logs
プロビジョニングされたクラスターと基になるインフラストラクチャからログを収集します。
az aksarc get-logs [--credentials-dir]
[--ip]
[--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
省略可能のパラメーター
ノードに接続するための SSH 資格情報へのパス 。ファイルまたはディレクトリid_rsa受け入れられます。
ログを収集する必要があるノード (コントロール プレーン ノードまたはワーカー ノード) の IP アドレス。
クラスターに接続する kubeconfig ファイルへのパス。
収集されたログを格納する出力ディレクトリ。 指定しない場合、ログは現在のディレクトリに格納されます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az aksarc get-upgrades
プロビジョニングされたクラスターで使用できるアップグレード バージョンを取得します。
az aksarc get-upgrades --name
--resource-group
例
ハイブリッド AKS プロビジョニング クラスターで使用できるアップグレード バージョンを取得する
az aksarc get-upgrades --name "samplecluster" --resource-group "sample-rg"
必須のパラメーター
プロビジョニングされたクラスターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
サポートされている k8s バージョンの表示に使用するカスタムの場所の名前。
省略可能のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az aksarc list
リソース グループまたはサブスクリプション内のプロビジョニング済みクラスターを一覧表示します。
az aksarc list [--resource-group]
例
ListProvisionedClusterByResourceGroup
az aksarc list --resource-group "sample-rg"
ListProvisionedClusterBySubscription
az aksarc list
省略可能のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az aksarc notice
ユーザー指定のファイルパスに NOTICE ファイルを出力します。
az aksarc notice --output-filepath
例
GetNoticeFile
az aksarc notice --output-filepath "./Notice"
必須のパラメーター
NOTICE ファイルの出力ファイルパス。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az aksarc show
プロビジョニングされたクラスターを取得します。
az aksarc show --name
--resource-group
例
GetProvisionedCluster
az aksarc show --name "sample-aksarccluster" --resource-group "sample-rg"
必須のパラメーター
プロビジョニングされたクラスターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az aksarc update
プロビジョニングされたクラスターを更新します。
az aksarc update --name
--resource-group
[--aad-admin-group-object-ids]
[--ca-profile]
[--control-plane-count]
[--disable-ahub]
[--disable-ai-toolchain-operator]
[--disable-cluster-autoscaler]
[--disable-gateway]
[--disable-nfs-driver]
[--disable-smb-driver]
[--enable-ahub]
[--enable-ai-toolchain-operator]
[--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
必須のパラメーター
プロビジョニングされたクラスターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
プロビジョニングされたクラスターのクラスター管理者として設定される、aad グループ オブジェクト ID のコンマ区切りの一覧。
クラスター オートスケーラーを構成するためのキーと値のペアのスペース区切りの一覧。 空の文字列を渡してプロファイルをクリアします。
コントロール プレーンをスケーリングするノードの数。
プロビジョニングされたクラスターの Azure ハイブリッド ユーザー特典 (AHUB) を無効にします。
プロビジョニングされたクラスターの AI Toolchain オペレーターを無効にします。
プロビジョニングされたクラスターのクラスター 自動スケーラーを無効にします。
プロビジョニングされたクラスターのゲートウェイを無効にします。
プロビジョニングされたクラスターの NFS ドライバーを無効にします。
プロビジョニングされたクラスターの SMB ドライバーを無効にします。
プロビジョニングされたクラスターに対して Azure ハイブリッド ユーザー特典 (AHUB) を有効にします。
プロビジョニングされたクラスターに対して AI Toolchain Operator を有効にします。
プロビジョニングされたクラスターのクラスター 自動スケーラーを有効にします。
プロビジョニングされたクラスターの NFS ドライバーを有効にします。
プロビジョニングされたクラスターの SMB ドライバーを有効にします。
プロビジョニングされたクラスターのゲートウェイ Arm ID。
自動スケーリングのノードの最大数。
自動スケーリング用のノードの最小数。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
プロビジョニングされたクラスターのクラスター 自動スケーラーを更新します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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"
必須のパラメーター
プロビジョニングされたクラスターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
プロビジョニングされたクラスターの kubernetes バージョン。
実行時間の長い操作が完了するまで待つ必要はありません。
確認プロンプトを無効にするフラグ。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
Azure CLI