次の方法で共有

az k8s-runtime load-balancer

Note

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

Arc Kubernetes クラスターのロード バランサーを管理します。

コマンド

名前 説明 型 状態
az k8s-runtime load-balancer create

LoadBalancer を作成します。

 Extension GA
az k8s-runtime load-balancer delete

LoadBalancer を削除します。

 Extension GA
az k8s-runtime load-balancer disable

接続されたクラスター load_balancerサービスを無効にします。

 Extension GA
az k8s-runtime load-balancer enable

接続されたクラスターでロード バランサー サービスを有効にします。

 Extension GA
az k8s-runtime load-balancer list

LoadBalancer リソースを親別に一覧表示します。

 Extension GA
az k8s-runtime load-balancer show

LoadBalancer を取得します。

 Extension GA
az k8s-runtime load-balancer update

LoadBalancer を更新します。

 Extension GA
az k8s-runtime load-balancer wait

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

 Extension GA

az k8s-runtime load-balancer create

LoadBalancer を作成します。

az k8s-runtime load-balancer create --load-balancer-name
                                    --resource-uri
                                    [--addresses]
                                    [--advertise-mode {ARP, BGP, Both}]
                                    [--bgp-peers]
                                    [--communities]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--service-selector]

例

ロード バランサーを作成する

az k8s-runtime load-balancer create --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --addresses "192.168.50.1/32" --advertise-mode ARP --service-selector ""

必須のパラメーター

--load-balancer-name

LoadBalancer の名前。

--resource-uri

リソースの完全修飾 Azure Resource Manager 識別子。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--addresses

IP 範囲 短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--advertise-mode

アドバタイズ モード。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: ARP, BGP, Both
--bgp-peers

アドバタイズする必要がある BGP ピアの一覧。 Null または空は、すべてのピアにアドバタイズすることを意味します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--communities

BGP コミュニティでは、短縮構文、json ファイル、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--service-selector

関連するサービスを選択するための動的ラベル マッピング。 たとえば、ラベル "a=b" のサービスにのみロード バランサーを作成する場合は、フィールドに {"a": "b"} を指定してください。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az k8s-runtime load-balancer delete

LoadBalancer を削除します。

az k8s-runtime load-balancer delete --load-balancer-name
                                    --resource-uri
                                    [--yes]

例

ロード バランサーを削除する

az k8s-runtime load-balancer delete --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必須のパラメーター

--load-balancer-name

LoadBalancer の名前。

--resource-uri

リソースの完全修飾 Azure Resource Manager 識別子。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az k8s-runtime load-balancer disable

接続されたクラスター load_balancerサービスを無効にします。

az k8s-runtime load-balancer disable --resource-uri

必須のパラメーター

--resource-uri

接続されているクラスターのリソース URI。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az k8s-runtime load-balancer enable

接続されたクラスターでロード バランサー サービスを有効にします。

az k8s-runtime load-balancer enable --resource-uri

必須のパラメーター

--resource-uri

接続されているクラスターのリソース URI。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az k8s-runtime load-balancer list

LoadBalancer リソースを親別に一覧表示します。

az k8s-runtime load-balancer list --resource-uri
                                  [--max-items]
                                  [--next-token]

例

クラスター内のすべてのロード バランサーを一覧表示する

az k8s-runtime load-balancer list --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必須のパラメーター

--resource-uri

リソースの完全修飾 Azure Resource Manager 識別子。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--max-items

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

プロパティ 値
パラメーター グループ: Pagination Arguments
--next-token

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

プロパティ 値
パラメーター グループ: Pagination Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az k8s-runtime load-balancer show

LoadBalancer を取得します。

az k8s-runtime load-balancer show --load-balancer-name
                                  --resource-uri

例

ロード バランサーを取得する

az k8s-runtime load-balancer show --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必須のパラメーター

--load-balancer-name

LoadBalancer の名前。

--resource-uri

リソースの完全修飾 Azure Resource Manager 識別子。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az k8s-runtime load-balancer update

LoadBalancer を更新します。

az k8s-runtime load-balancer update --load-balancer-name
                                    --resource-uri
                                    [--add]
                                    [--addresses]
                                    [--advertise-mode {ARP, BGP, Both}]
                                    [--bgp-peers]
                                    [--communities]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--remove]
                                    [--service-selector]
                                    [--set]

例

ロード バランサーを更新する

az k8s-runtime load-balancer update --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --advertise-mode ARP

必須のパラメーター

--load-balancer-name

LoadBalancer の名前。

--resource-uri

リソースの完全修飾 Azure Resource Manager 識別子。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--add

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

プロパティ 値
パラメーター グループ: Generic Update Arguments
--addresses

IP 範囲 短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--advertise-mode

アドバタイズ モード。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: ARP, BGP, Both
--bgp-peers

アドバタイズする必要がある BGP ピアの一覧。 Null または空は、すべてのピアにアドバタイズすることを意味します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--communities

BGP コミュニティでは、短縮構文、json ファイル、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--force-string

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

プロパティ 値
パラメーター グループ: Generic Update Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

プロパティ 値
パラメーター グループ: Generic Update Arguments
--service-selector

関連するサービスを選択するための動的ラベル マッピング。 たとえば、ラベル "a=b" のサービスにのみロード バランサーを作成する場合は、フィールドに {"a": "b"} を指定してください。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--set

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

プロパティ 値
パラメーター グループ: Generic Update Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az k8s-runtime load-balancer wait

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

az k8s-runtime load-balancer wait --load-balancer-name
                                  --resource-uri
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--interval]
                                  [--timeout]
                                  [--updated]

必須のパラメーター

--load-balancer-name

LoadBalancer の名前。

--resource-uri

リソースの完全修飾 Azure Resource Manager 識別子。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--created

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--custom

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
--deleted

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--exists

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--interval

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 30
--timeout

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False