az networkfabric neighborgroup

Note

This reference is part of the managednetworkfabric extension for the Azure CLI (version 2.70.0 or higher). 该扩展会在首次运行 az networkfabric neighborgroup 命令时自动安装。 Learn more about extensions.

管理邻居组资源。

命令

名称	说明	类型	Status
az networkfabric neighborgroup create	创建邻居组资源。	Extension	GA
az networkfabric neighborgroup delete	删除邻居组资源。	Extension	GA
az networkfabric neighborgroup list	列出提供的资源组或订阅中的所有邻居组。	Extension	GA
az networkfabric neighborgroup show	显示提供的邻居组资源的详细信息。	Extension	GA
az networkfabric neighborgroup update	更新邻居组资源。	Extension	GA
az networkfabric neighborgroup wait	将 CLI 置于等待状态，直到满足条件。	Extension	GA

az networkfabric neighborgroup create

创建邻居组资源。

az networkfabric neighborgroup create --destination
                                      --resource-group
                                      --resource-name
                                      [--annotation]
                                      [--location]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--tags]

示例

创建邻居组

az networkfabric neighborgroup create --resource-group "example-rg" --location "westus3" --resource-name "example-neighborgroup" --destination "{ipv4Addresses:['10.10.10.10']}"

可以使用速记语法“？？”查看特定父级下子参数的帮助文本。 有关速记语法的详细信息，请参阅 https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md。

az networkfabric neighborgroup create --destination "??"

必需参数

--destination

目标 IPv4 地址或 IPv6 地址的数组。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--resource-name

邻居组的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--annotation

切换配置说明。

属性	值
Parameter group:	Properties Arguments

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

属性	值
Parameter group:	Resource Arguments

--no-wait

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

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

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Resource Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	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 networkfabric neighborgroup delete

删除邻居组资源。

az networkfabric neighborgroup delete [--ids]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--resource-name]
                                      [--subscription]

示例

删除邻居组

az networkfabric neighborgroup delete --resource-group "example-rg" --resource-name "example-neighborgroup"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--resource-name

邻居组的名称。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az networkfabric neighborgroup list

列出提供的资源组或订阅中的所有邻居组。

az networkfabric neighborgroup list [--max-items]
                                    [--next-token]
                                    [--resource-group]

示例

列出资源组的邻居组

az networkfabric neighborgroup list --resource-group "example-rg"

列出订阅的邻居组

az networkfabric neighborgroup list --subscription "<subscriptionId>"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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

属性	值
Parameter group:	Pagination Arguments

--next-token

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

属性	值
Parameter group:	Pagination Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	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 networkfabric neighborgroup show

显示提供的邻居组资源的详细信息。

az networkfabric neighborgroup show [--ids]
                                    [--resource-group]
                                    [--resource-name]
                                    [--subscription]

示例

显示邻居组

az networkfabric neighborgroup show --resource-group "example-rg" --resource-name "example-neighborgroup"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--resource-name

邻居组的名称。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az networkfabric neighborgroup update

更新邻居组资源。

az networkfabric neighborgroup update [--annotation]
                                      [--destination]
                                      [--ids]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--resource-name]
                                      [--subscription]
                                      [--tags]

示例

更新邻居组

az networkfabric neighborgroup update --resource-group "example-rg" --resource-name "example-neighborgroup" --destination "{ipv4Addresses:['10.10.10.10'],ipv6Addresses:['2F::/100']}"

可以使用速记语法“？？”查看特定父级下子参数的帮助文本。 有关速记语法的详细信息，请参阅 https://github.com/Azure/azure-cli/tree/dev/doc/shorthand_syntax.md。

az networkfabric neighborgroup update --destination "??"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--annotation

切换配置说明。

属性	值
Parameter group:	Properties Arguments

--destination

目标 IPv4 地址或 IPv6 地址的数组。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--resource-name

邻居组的名称。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az networkfabric neighborgroup wait

将 CLI 置于等待状态，直到满足条件。

az networkfabric neighborgroup wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--resource-group]
                                    [--resource-name]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

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

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--interval

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--resource-name

邻居组的名称。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--timeout

最大等待（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

--updated

等到 provisioningState 更新为“Succeeded”。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False