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

az network private-link-service

  • 参考

管理专用链接资源。

命令

名称 说明 类型 状态
az network private-link-service connection

管理专用链接服务终结点连接。

 核心 GA
az network private-link-service connection delete

删除专用链接服务终结点连接。

 核心 GA
az network private-link-service connection update

更新专用链接服务终结点连接。

 核心 GA
az network private-link-service connection wait

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

 核心 GA
az network private-link-service create

创建专用链接服务。

 核心 GA
az network private-link-service delete

删除专用链接服务。

 核心 GA
az network private-link-service list

列出专用链接服务。

 核心 GA
az network private-link-service list-auto-approved

列出所有可以链接到专用终结点的专用链接服务 ID，并在此区域中在此订阅中自动批准。

 核心 GA
az network private-link-service show

获取专用链接服务的详细信息。

 核心 GA
az network private-link-service update

更新专用链接服务。

 核心 GA
az network private-link-service wait

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

 核心 GA
编辑

创建专用链接服务。

az network private-link-service create --lb-frontend-ip-configs
                                       --name
                                       --resource-group
                                       --subnet
                                       [--auto-approval]
                                       [--edge-zone]
                                       [--enable-proxy-protocol {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--fqdns]
                                       [--lb-name]
                                       [--location]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--private-ip-address]
                                       [--private-ip-address-version {IPv4, IPv6}]
                                       [--private-ip-allocation-method {Dynamic, Static}]
                                       [--tags]
                                       [--visibility]
                                       [--vnet-name]

创建专用链接服务

az network private-link-service create -g MyResourceGroup -n MyPLSName --vnet-name MyVnetName --subnet MySubnet --lb-name MyLBName --lb-frontend-ip-configs LoadBalancerFrontEnd -l centralus
--lb-frontend-ip-configs

要链接到的负载均衡器前端 IP 配置的名称或 ID 的空格分隔列表。 如果使用名称，也提供 --lb-name。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--name -n

专用链接服务的名称。

--resource-group -g

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

--subnet

要使用的子网的名称或 ID。 如果提供名称，则还提供 --vnet-name。

--auto-approval

要自动批准的订阅 ID 的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--edge-zone

边缘区域的名称。

--enable-proxy-protocol

为专用链接服务启用代理协议。

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

空格分隔的 FQDN 列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--lb-name

要从中检索前端 IP 配置的负载均衡器的名称。 如果提供了前端 IP 配置 ID，则忽略。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

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

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

要使用的静态专用 IP 地址。

--private-ip-address-version

专用 IP 地址的 IP 版本。

接受的值: IPv4, IPv6
默认值: IPv4
--private-ip-allocation-method

专用 IP 地址分配方法。

接受的值: Dynamic, Static
--tags

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

--visibility

专用链接服务的订阅 ID 的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--vnet-name

虚拟网络（VNet）名称。

全局参数
--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 network private-link-service delete [--ids]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

删除专用链接服务。

az network private-link-service delete --name MyPrivateLinkService --resource-group MyResourceGroup
--ids

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

--name -n

专用链接服务的名称。

--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 配置默认订阅。

全局参数
--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 network private-link-service list [--max-items]
                                     [--next-token]
                                     [--resource-group]

列出专用链接服务。

az network private-link-service list --resource-group MyResourceGroup
--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 获取完整的调试日志。

编辑

列出所有可以链接到专用终结点的专用链接服务 ID，并在此区域中在此订阅中自动批准。

az network private-link-service list-auto-approved [--location]
                                                   [--max-items]
                                                   [--next-token]
                                                   [--resource-group]

列出所有可链接到具有自动批准的专用终结点的专用链接服务

az network private-link-service list-auto-approved -l westus
--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。 如果未指定，将使用资源组的位置。

--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 network private-link-service show [--expand]
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

获取专用链接服务的详细信息。

az network private-link-service show --name MyPrivateLinkService --resource-group MyResourceGroup
--expand

展开引用的资源。 默认值为 None。

--ids

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

--name -n

专用链接服务的名称。

--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 network private-link-service update [--add]
                                       [--auto-approval]
                                       [--enable-proxy-protocol {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--fqdns]
                                       [--ids]
                                       [--lb-frontend-ip-configs]
                                       [--lb-name]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--subscription]
                                       [--tags]
                                       [--visibility]

更新专用链接服务

az network private-link-service update -g MyResourceGroup -n MyPLSName --visibility SubId1 SubId2 --auto-approval SubId1 SubId2
--add

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

--auto-approval

要自动批准的订阅 ID 的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--enable-proxy-protocol

为专用链接服务启用代理协议。

接受的值: 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
--fqdns

空格分隔的 FQDN 列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--ids

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

--lb-frontend-ip-configs

要链接到的负载均衡器前端 IP 配置的名称或 ID 的空格分隔列表。 如果使用名称，也提供 --lb-name。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--lb-name

要从中检索前端 IP 配置的负载均衡器的名称。 如果提供了前端 IP 配置 ID，则忽略。

--name -n

专用链接服务的名称。

--no-wait

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

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

从列表中删除属性或元素。 示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--set

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

--subscription

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

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--visibility

专用链接服务的订阅 ID 的空格分隔列表。 支持速记语法、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 获取完整的调试日志。

编辑

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

az network private-link-service wait [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--expand]
                                     [--ids]
                                     [--interval]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]
--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--expand

展开引用的资源。 默认值为 None。

--ids

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

--interval

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

默认值: 30
--name -n

专用链接服务的名称。

--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 获取完整的调试日志。