az k8s-runtime bgp-peer

Note

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

Arc Kubernetes クラスターの BGP ピアを管理します。

コマンド

名前	説明	型	状態
az k8s-runtime bgp-peer create	BgpPeer を作成します。	Extension	GA
az k8s-runtime bgp-peer delete	BgpPeer を削除します。	Extension	GA
az k8s-runtime bgp-peer list	BgpPeer リソースを親別に一覧表示します。	Extension	GA
az k8s-runtime bgp-peer show	BgpPeer を取得します。	Extension	GA
az k8s-runtime bgp-peer update	BgpPeer を更新します。	Extension	GA
az k8s-runtime bgp-peer wait	条件が満たされるまで CLI を待機状態にします。	Extension	GA

az k8s-runtime bgp-peer create

BgpPeer を作成します。

az k8s-runtime bgp-peer create --bgp-peer-name
                               --resource-uri
                               [--bfd-profile]
                               [--bgp-multi-hop {Disabled, Enabled}]
                               [--hold-time]
                               [--keep-alive-time]
                               [--my-asn]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--node-selector]
                               [--peer-address]
                               [--peer-asn]
                               [--peer-port]

例

BGP ピアを作成する

az k8s-runtime bgp-peer create --bgp-peer-name bgpPeer1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --my-asn 10000 --peer-asn 20000 --peer-address 192.168.50.1

必須のパラメーター

--bgp-peer-name

BgpPeer の名前。

--resource-uri

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

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

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

--bfd-profile

BFD プロファイル。

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

--bgp-multi-hop

EBGP マルチホップ。

プロパティ	値
パラメーターグループ:	Properties Arguments
指定可能な値:	Disabled, Enabled

--hold-time

RFC4271ごとの保留時間。

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

--keep-alive-time

RFC4271ごとのキープアライブ時間。

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

--my-asn

自分の ASN。

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

--no-wait

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

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

--node-selector

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

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

--peer-address

ピアアドレス。

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

--peer-asn

ピア ASN。

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

--peer-port

ピア BGP ポート。

プロパティ	値
パラメーターグループ:	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 bgp-peer delete

BgpPeer を削除します。

az k8s-runtime bgp-peer delete --bgp-peer-name
                               --resource-uri
                               [--yes]

例

BGP ピアを削除する

az k8s-runtime bgp-peer delete --bgp-peer-name bgpPeer1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必須のパラメーター

--bgp-peer-name

BgpPeer の名前。

--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 bgp-peer list

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

az k8s-runtime bgp-peer list --resource-uri
                             [--max-items]
                             [--next-token]

例

クラスター内のすべての BGP ピアを一覧表示する

az k8s-runtime bgp-peer 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 bgp-peer show

BgpPeer を取得します。

az k8s-runtime bgp-peer show --bgp-peer-name
                             --resource-uri

例

BGP ピアを取得する

az k8s-runtime bgp-peer show --bgp-peer-name bgpPeer1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必須のパラメーター

--bgp-peer-name

BgpPeer の名前。

--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 bgp-peer update

BgpPeer を更新します。

az k8s-runtime bgp-peer update --bgp-peer-name
                               --resource-uri
                               [--add]
                               [--bfd-profile]
                               [--bgp-multi-hop {Disabled, Enabled}]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--hold-time]
                               [--keep-alive-time]
                               [--my-asn]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--node-selector]
                               [--peer-address]
                               [--peer-asn]
                               [--peer-port]
                               [--remove]
                               [--set]

例

BGP ピアを更新する

az k8s-runtime bgp-peer update --bgp-peer-name bgpPeer1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --my-asn 10000 --peer-asn 20000 --peer-address 192.168.50.1

必須のパラメーター

--bgp-peer-name

BgpPeer の名前。

--resource-uri

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

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

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

--add

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

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

--bfd-profile

BFD プロファイル。

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

--bgp-multi-hop

EBGP マルチホップ。

プロパティ	値
パラメーターグループ:	Properties Arguments
指定可能な値:	Disabled, Enabled

--force-string

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

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

--hold-time

RFC4271ごとの保留時間。

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

--keep-alive-time

RFC4271ごとのキープアライブ時間。

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

--my-asn

自分の ASN。

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

--no-wait

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

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

--node-selector

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

--peer-address

ピアアドレス。

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

--peer-asn

ピア ASN。

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

--peer-port

ピア BGP ポート。

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

--remove

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

プロパティ	値
パラメーターグループ:	Generic Update 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 bgp-peer wait

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

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

必須のパラメーター

--bgp-peer-name

BgpPeer の名前。

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

フィードバック

このページはお役に立ちましたか?

次の方法で共有

az k8s-runtime bgp-peer

コマンド

az k8s-runtime bgp-peer create

例

必須のパラメーター

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

az k8s-runtime bgp-peer delete

例

必須のパラメーター

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

az k8s-runtime bgp-peer list

例

必須のパラメーター

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

az k8s-runtime bgp-peer show

例

必須のパラメーター

az k8s-runtime bgp-peer update

例

必須のパラメーター

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

az k8s-runtime bgp-peer wait

必須のパラメーター

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

フィードバック