你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az k8s-runtime bgp-peer

参考

注意

此参考是 Azure CLI（版本 2.57.0 或更高版本）的 k8s 运行时扩展的一部分。该扩展将在首次运行 az k8s-runtime bgp-peer 命令时自动安装。详细了解扩展。

管理 Arc Kubernetes 群集的 BGP 对等方。

命令

名称	说明	类型	状态
az k8s-runtime bgp-peer create	创建 BgpPeer。	扩展	GA
az k8s-runtime bgp-peer delete	删除 BgpPeer。	扩展	GA
az k8s-runtime bgp-peer list	按父级列出 BgpPeer 资源。	扩展	GA
az k8s-runtime bgp-peer show	获取 BgpPeer。	扩展	GA
az k8s-runtime bgp-peer update	更新 BgpPeer。	扩展	GA
az k8s-runtime bgp-peer wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az k8s-runtime bgp-peer create

创建 BgpPeer。

az k8s-runtime bgp-peer create --bgp-peer-name
                               --resource-uri
                               [--my-asn]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-address]
                               [--peer-asn]

示例

创建 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 资源管理器标识符。

可选参数

--my-asn

我的 ASN。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--peer-address

对等地址。

--peer-asn

对等 ASN。

全局参数

--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 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 资源管理器标识符。

可选参数

--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 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 资源管理器标识符。

可选参数

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

全局参数

--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 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 资源管理器标识符。

全局参数

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

更新 BgpPeer。

az k8s-runtime bgp-peer update --bgp-peer-name
                               --resource-uri
                               [--add]
                               [--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]
                               [--set]

必需参数

--bgp-peer-name

BgpPeer 的名称。

--resource-uri

资源的完全限定的 Azure 资源管理器标识符。

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 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 OR --remove propertyToRemove。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

全局参数

--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 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 资源管理器标识符。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--interval

轮询间隔（以秒为单位）。

默认值: 30

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

必需参数

可选参数

其他资源