az hdinsight-on-aks clusterpool

プレビュー
リファレンス

Note

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

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

Clusterpool 操作。

コマンド

名前	説明	型	状態
az hdinsight-on-aks clusterpool create	クラスタープールを作成します。	拡張子	プレビュー
az hdinsight-on-aks clusterpool delete	クラスタープールを削除します。	拡張子	プレビュー
az hdinsight-on-aks clusterpool list	サブスクリプション内のクラスタープールの一覧を一覧表示します。	拡張子	プレビュー
az hdinsight-on-aks clusterpool show	クラスタープールを取得します。	拡張子	プレビュー
az hdinsight-on-aks clusterpool update	クラスタープールを更新します。	拡張子	プレビュー
az hdinsight-on-aks clusterpool upgrade	clusterpool をアップグレードします。	拡張子	プレビュー
az hdinsight-on-aks clusterpool upgrade history	アップグレード履歴の一覧を一覧表示します。	拡張子	プレビュー
az hdinsight-on-aks clusterpool upgrade list	使用可能なクラスタープールのアップグレードを一覧表示します。	拡張子	プレビュー
az hdinsight-on-aks clusterpool upgrade run	クラスタープールをアップグレードします。	拡張子	プレビュー
az hdinsight-on-aks clusterpool wait	条件が満たされるまで CLI を待機状態にします。	拡張子	プレビュー

az hdinsight-on-aks clusterpool create

プレビュー

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

クラスタープールを作成します。

az hdinsight-on-aks clusterpool create --cluster-pool-name
                                       --resource-group
                                       [--api-server-authorized-ip-ranges]
                                       [--availability-zones]
                                       [--cluster-pool-version]
                                       [--enable-log-analytics {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--la-workspace-id]
                                       [--location]
                                       [--managed-rg-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--outbound-type {loadBalancer, userDefinedRouting}]
                                       [--private-server-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--subnet-id]
                                       [--tags]
                                       [--workernode-size]

例

クラスタープールを作成します。

az hdinsight-on-aks clusterpool create -g {RG} -n {poolName} -l {westus3} --workernode-size {Standard_E4s_v3} --version {1.1}

必須のパラメーター

--cluster-pool-name --name -n

クラスタープールの名前。

--resource-group -g

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

省略可能のパラメーター

--api-server-authorized-ip-ranges --api-server-ip-ranges

IP 範囲は CIDR 形式で指定されます (例: 137.117.106.88/29)。この機能は、プライベート AKS クラスターと互換性がありません。そのため、enablePrivateApiServer を true と apiServerAuthorizedIpRanges に同時に設定することはできません。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--availability-zones

AKS VMSS ノードに使用する可用性ゾーンの一覧。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--cluster-pool-version --version

クラスタープールのバージョンは 2 部構成のバージョンです。

--enable-log-analytics

クラスタープールに対してログ分析が有効な場合は True、それ以外の場合は false。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--la-workspace-id --log-analytic-workspace-id

OMS エージェントに関連付けるログ分析ワークスペース。

--location -l

リソースが存在する地理的な場所を指定しない場合は、リソースグループの場所が使用されます。

--managed-rg-name

RP によって作成されたリソースグループ。RP によって作成されたリソースを顧客に代わって保持します。また、パターンによって aksManagedResourceGroupName を生成するためにも使用されます:MC_{managedResourceGroupName}{clusterPoolName}{region}。リソースグループ名の制限を満たしていることを確認してください。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--outbound-type

これはクラスタープールの作成時にのみ設定でき、後で変更することはできません。

指定可能な値: loadBalancer, userDefinedRouting

規定値: loadBalancer

--private-server-enabled

ClusterPool は AKS クラスターに基づいています。 AKS クラスターでは、API サーバーが既定でパブリックインターネットに公開されます。このプロパティを true に設定すると、プライベート AKS クラスターが作成され、パブリックインターネットに公開されていないプライベート apiserver が使用されます。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--subnet-id

クラスタープールのサブネットリソース ID。

--tags

リソースタグ。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--workernode-size

仮想マシン SKU。

グローバルパラメーター

--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 hdinsight-on-aks clusterpool delete

プレビュー

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

クラスタープールを削除します。

az hdinsight-on-aks clusterpool delete [--cluster-pool-name]
                                       [--ids]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

例

クラスタープールを削除します。

az hdinsight-on-aks clusterpool delete -g {RG} -n {poolName}

省略可能のパラメーター

--cluster-pool-name --name -n

クラスタープールの名前。

--ids

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

--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 hdinsight-on-aks clusterpool list

プレビュー

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

サブスクリプション内のクラスタープールの一覧を一覧表示します。

az hdinsight-on-aks clusterpool list [--max-items]
                                     [--next-token]
                                     [--resource-group]

例

リソースグループ内の clusterpool の一覧を一覧表示します。

az hdinsight-on-aks clusterpool list -g {RG}

サブスクリプション内のクラスタープールの一覧を一覧表示します。

az hdinsightonaks clusterpool list

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。これは、以前に切り捨てられた応答からのトークン値です。

--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 hdinsight-on-aks clusterpool show

プレビュー

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

クラスタープールを取得します。

az hdinsight-on-aks clusterpool show [--cluster-pool-name]
                                     [--ids]
                                     [--resource-group]
                                     [--subscription]

例

クラスタープールを取得します。

az hdinsight-on-aks clusterpool show -g {RG} -n {poolName}

省略可能のパラメーター

--cluster-pool-name --name -n

クラスタープールの名前。

--ids

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 hdinsight-on-aks clusterpool update

プレビュー

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

クラスタープールを更新します。

az hdinsight-on-aks clusterpool update [--add]
                                       [--api-server-authorized-ip-ranges]
                                       [--cluster-pool-name]
                                       [--cluster-pool-version]
                                       [--compute-profile]
                                       [--enable-log-analytics {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--la-workspace-id]
                                       [--managed-rg-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--outbound-type {loadBalancer, userDefinedRouting}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--subnet-id]
                                       [--subscription]
                                       [--tags]

例

既存のクラスターを更新して、ログ分析を有効にします。

az hdinsight-on-aksclusterpool update -g {RG} -n {poolName} --enable-log-analytics --log-analytic-workspace-id {"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/microsoft.operationalinsights/workspaces/yourworkspace"}

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>.

--api-server-authorized-ip-ranges --api-server-ip-ranges

--cluster-pool-name --name -n

クラスタープールの名前。

--cluster-pool-version --version

クラスタープールのバージョンは 2 部構成のバージョンです。

--compute-profile

CLuster プールのコンピューティングプロファイル。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--enable-log-analytics

クラスタープールに対してログ分析が有効な場合は True、それ以外の場合は false。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

--la-workspace-id --log-analytic-workspace-id

OMS エージェントに関連付けるログ分析ワークスペース。

--managed-rg-name

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--outbound-type

これはクラスタープールの作成時にのみ設定でき、後で変更することはできません。

指定可能な値: loadBalancer, userDefinedRouting

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=。

--subnet-id

クラスタープールのサブネットリソース ID。

--subscription

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

--tags

リソースタグ。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

グローバルパラメーター

--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 hdinsight-on-aks clusterpool wait

プレビュー

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

条件が満たされるまで CLI を待機状態にします。

az hdinsight-on-aks clusterpool wait [--cluster-pool-name]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

省略可能のパラメーター

--cluster-pool-name --name -n

クラスタープールの名前。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--ids

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--resource-group -g

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

--subscription

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

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: 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 hdinsight-on-aks clusterpool

コマンド

az hdinsight-on-aks clusterpool create

例

必須のパラメーター

省略可能のパラメーター

az hdinsight-on-aks clusterpool delete

例

省略可能のパラメーター

az hdinsight-on-aks clusterpool list

例

省略可能のパラメーター

az hdinsight-on-aks clusterpool show

例

省略可能のパラメーター

az hdinsight-on-aks clusterpool update

例

省略可能のパラメーター

az hdinsight-on-aks clusterpool wait

省略可能のパラメーター

その他のリソース