次の方法で共有

az hdinsight-on-aks clusterpool

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

Note

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

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

Clusterpool 操作。

コマンド

名前 説明 型 Status
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 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]
                                       [--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 をサポートします。 詳細を表示するには、"??" を試してください。

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

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

--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、または JSON 文字列>。

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

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

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

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

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

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

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

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

--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 を使います。