az hybridaks

  • プレビュー
  • リファレンス

Note

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

このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

hybridaks のプロビジョニング済みクラスターを管理します。

コマンド

名前 説明 型 Status
az hybridaks create

ハイブリッド AKS プロビジョニング クラスターを作成します。

 拡張機能 プレビュー
az hybridaks delete

Hybrid AKS によってプロビジョニングされたクラスターを削除します。

 拡張機能 プレビュー
az hybridaks get-upgrades

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

 拡張機能 プレビュー
az hybridaks list

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

 拡張機能 プレビュー
az hybridaks nodepool

hybridaks によってプロビジョニングされたクラスター内のノードプールを管理します。

 拡張機能 プレビュー
az hybridaks nodepool add

ハイブリッド AKS プロビジョニング クラスターにノードプールを追加します。

 拡張機能 プレビュー
az hybridaks nodepool delete

Hybrid AKS によってプロビジョニングされたクラスター内のノードプールを削除します。

 拡張機能 プレビュー
az hybridaks nodepool list

ハイブリッド AKS プロビジョニング クラスター内のすべてのノードプールを一覧表示します。

 拡張機能 プレビュー
az hybridaks nodepool scale

Hybrid AKS によってプロビジョニングされたクラスター内のノードプールをスケーリングします。

 拡張機能 プレビュー
az hybridaks nodepool show

ハイブリッド AKS プロビジョニング クラスター内のノードプールを取得します。

 拡張機能 プレビュー
az hybridaks notice

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

 拡張機能 プレビュー
az hybridaks proxy

接続されているハイブリッド AKS プロビジョニング クラスターへのアクセスを取得します。

 拡張機能 プレビュー
az hybridaks show

ハイブリッド AKS プロビジョニングクラスターを取得します。

 拡張機能 プレビュー
az hybridaks update

ハイブリッド AKS プロビジョニング クラスターを更新します。

 拡張機能 プレビュー
az hybridaks upgrade

ハイブリッド AKS プロビジョニング クラスターをアップグレードします。

 拡張機能 プレビュー
az hybridaks vnet

Hybridak の仮想ネットワークを管理します。

 拡張機能 プレビュー
az hybridaks vnet create

ハイブリッド AKS 仮想ネットワークを作成します。

 拡張機能 プレビュー
az hybridaks vnet delete

ハイブリッド AKS 仮想ネットワークを削除します。

 拡張機能 プレビュー
az hybridaks vnet list

リソース グループまたはサブスクリプション別のハイブリッド AKS 仮想ネットワークを一覧表示します。

 拡張機能 プレビュー
az hybridaks vnet show

ハイブリッド AKS 仮想ネットワークを取得します。

 拡張機能 プレビュー

az hybridaks create

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ハイブリッド AKS プロビジョニング クラスターを作成します。

az hybridaks create --custom-location
                    --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--addon]
                    [--arc-agent-auto-upgrade]
                    [--arc-agent-version]
                    [--control-plane-count]
                    [--control-plane-ip]
                    [--control-plane-vm-size]
                    [--generate-ssh-keys]
                    [--kubernetes-version]
                    [--load-balancer-count]
                    [--load-balancer-sku]
                    [--load-balancer-vm-size]
                    [--location]
                    [--no-ssh-key]
                    [--no-wait]
                    [--node-count]
                    [--node-vm-size]
                    [--pod-cidr]
                    [--service-cidr]
                    [--ssh-key-value]
                    [--tags]
                    [--vnet-ids]
                    [--zones]

例

PutProvisionedCluster

az hybridaks create -g sample-rg --custom-location sample-cl -n sample-hybridakscluster --vnet-id vnet1

必須のパラメーター

--custom-location

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

--name -n

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

--resource-group -g

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

省略可能のパラメーター

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

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

--addon -a

アドオンを有効にします。 このフラグを指定することで、複数のアドオンを追加できます。 使用法: --addon name=addon-name [config_key=config_value ...]。

--arc-agent-auto-upgrade

Arc エージェントの自動アップグレード。

既定値: Enabled
--arc-agent-version

Arc エージェントのバージョン。

--control-plane-count

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

--control-plane-ip

コントロール プレーンの API サーバーの IP アドレス。

--control-plane-vm-size

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

--generate-ssh-keys

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

既定値: False
--kubernetes-version -k

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

--load-balancer-count

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

--load-balancer-sku

ロード バランサーの種類。 オプション: "unstacked-haproxy" |"stacked-kube-vip" |"stacked-metallb" |"unmanaged"。

--load-balancer-vm-size

ロード バランサーの VM サイズ。

--location -l

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

--no-ssh-key -x

公開 SSH キーを挿入しないでください。

既定値: False
--no-wait

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

既定値: False
--node-count -c

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

--node-vm-size

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

--pod-cidr

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

--service-cidr

Kubenet を使用している場合、サービス クラスター IP を割り当てる CIDR 表記の IP 範囲。

--ssh-key-value

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

既定値: ~\.ssh\id_rsa.pub
--tags

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

--vnet-ids

HybridAKS VNet の ARM リソース ID。

--zones -z

コントロール プレーン ノードが配置される可用性ゾーンのコンマ区切りの一覧。

グローバル パラメーター
--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 hybridaks delete

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Hybrid AKS によってプロビジョニングされたクラスターを削除します。

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

例

DeleteProvisionedCluster

az hybridaks delete --name "sample-hybridakscluster" --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 hybridaks get-upgrades

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

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

az hybridaks get-upgrades --name
                          --resource-group

例

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

az hybridaks 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 hybridaks list

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

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

az hybridaks list [--resource-group]

例

ListProvisionedClusterByResourceGroup

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

ListProvisionedClusterBySubscription

az hybridaks 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 hybridaks notice

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

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

az hybridaks notice --output-filepath

例

GetNoticeFile

az hybridaks 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 hybridaks proxy

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

接続されているハイブリッド AKS プロビジョニング クラスターへのアクセスを取得します。

az hybridaks proxy [--file]
                   [--ids]
                   [--kube-context]
                   [--name]
                   [--port]
                   [--resource-group]
                   [--subscription]
                   [--token]

例

接続されている kubernetes クラスターにアクセスします。

az hybridaks proxy -n clusterName -g resourceGroupName

カスタム ポートを使用して接続された kubernetes クラスターにアクセスする

az hybridaks proxy -n clusterName -g resourceGroupName --port portValue

サービス アカウント トークンを使用して接続された kubernetes クラスターにアクセスする

az hybridaks proxy -n clusterName -g resourceGroupName --token tokenValue

カスタム kubeconfig の場所を指定して、接続されている kubernetes クラスターにアクセスする

az hybridaks proxy -n clusterName -g resourceGroupName -f path/to/kubeconfig

カスタム コンテキストを指定して、接続されている kubernetes クラスターにアクセスする

az hybridaks proxy -n clusterName -g resourceGroupName --kube-context contextName

省略可能のパラメーター

--file -f

更新する Kubernetes 構成ファイル。 指定しない場合は、ファイル '~/.kube/config' を更新します。 代わりに 、'-' を使用して YAML を stdout に出力します。

既定値: ~\.kube\config
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--kube-context

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

--name -n

ハイブリッド AKS プロビジョニング クラスターの名前。

--port

接続されたクラスターへのアクセスに使用されるポート。

既定値: 47013
--resource-group -g

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

--subscription

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

--token

Kubernetes クラスターに対する認証に使用するサービス アカウント トークン。

グローバル パラメーター
--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 hybridaks show

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ハイブリッド AKS プロビジョニングクラスターを取得します。

az hybridaks show --name
                  --resource-group

例

GetProvisionedCluster

az hybridaks show --name "sample-hybridakscluster" --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 hybridaks update

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ハイブリッド AKS プロビジョニング クラスターを更新します。

az hybridaks update --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--tags]

例

UpdateProvisionedCluster

az hybridaks update --tags additionalProperties="sample" --name "sample-hybridakscluster" --resource-group "sample-rg"

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

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

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

--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 hybridaks upgrade

プレビュー

コマンド グループ "hybridaks" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ハイブリッド AKS プロビジョニング クラスターをアップグレードします。

az hybridaks upgrade --name
                     --resource-group
                     [--kubernetes-version]
                     [--no-wait]
                     [--node-image-only]
                     [--yes]

例

UpgradeProvisionedCluster

az hybridaks upgrade --name "sample-hybridakscluster" --resource-group "sample-rg" --kubernetes-version v1.22.2

UpgradeProvisionedClusterNodeImage

az hybridaks upgrade --name "sample-hybridakscluster" --resource-group "sample-rg" --node-image-only

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

--kubernetes-version -k

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

--no-wait

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

既定値: False
--node-image-only

ノード イメージのみをアップグレードするためのフラグ。

既定値: 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 を使います。