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

az network private-endpoint

管理专用终结点。

命令

名称	说明	类型	Status
az network private-endpoint asg	管理专用终结点应用程序安全组。	核心	GA
az network private-endpoint asg add	添加专用终结点应用程序安全组。	核心	GA
az network private-endpoint asg list	列出专用终结点中的应用程序安全组。	核心	GA
az network private-endpoint asg remove	删除专用终结点应用程序安全组。	核心	GA
az network private-endpoint asg wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az network private-endpoint create	创建专用终结点。	核心	GA
az network private-endpoint delete	删除专用终结点。	核心	GA
az network private-endpoint dns-zone-group	管理专用终结点 dns 区域组。	核心	GA
az network private-endpoint dns-zone-group add	将专用终结点 dns 区域添加到 dns 区域组中。	核心	GA
az network private-endpoint dns-zone-group create	创建专用终结点 dns 区域组。	核心	GA
az network private-endpoint dns-zone-group delete	删除专用终结点 dns 区域组。	核心	GA
az network private-endpoint dns-zone-group list	列出所有专用终结点 DNS 区域组。	核心	GA
az network private-endpoint dns-zone-group remove	将专用终结点 dns 区域删除到 dns 区域组中。	核心	GA
az network private-endpoint dns-zone-group show	显示专用终结点 dns 区域组。	核心	GA
az network private-endpoint dns-zone-group wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az network private-endpoint ip-config	管理专用终结点 IP 配置。	核心	GA
az network private-endpoint ip-config add	添加专用终结点 IP 配置。	核心	GA
az network private-endpoint ip-config list	列出专用终结点中的 IP 配置。	核心	GA
az network private-endpoint ip-config remove	删除专用终结点 IP 配置。	核心	GA
az network private-endpoint ip-config wait	将 CLI 置于等待状态，直到满足条件。	核心	GA
az network private-endpoint list	列出专用终结点。	核心	GA
az network private-endpoint list-types	返回可链接到此区域中此订阅中的专用终结点的所有资源类型。	核心	GA
az network private-endpoint show	获取专用终结点的详细信息。	核心	GA
az network private-endpoint update	更新专用终结点。	核心	GA
az network private-endpoint wait	将 CLI 置于等待状态，直到满足条件。	核心	GA

az network private-endpoint create

创建专用终结点。

az network private-endpoint create --connection-name
                                   --name
                                   --private-connection-resource-id
                                   --resource-group
                                   --subnet
                                   [--asg]
                                   [--edge-zone]
                                   [--group-id]
                                   [--ip-config]
                                   [--location]
                                   [--manual-request {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--nic-name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--request-message]
                                   [--tags]
                                   [--vnet-name]

示例

创建专用终结点。

az network private-endpoint create -g MyResourceGroup -n MyPE --vnet-name MyVnetName --subnet MySubnet --private-connection-resource-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/privateLinkServices/MyPLS" --connection-name tttt -l centralus

使用 ASG 创建专用终结点。

az network private-endpoint create -n MyPE -g MyResourceGroup --vnet-name MyVnetName --subnet MySubnet --connection-name MyConnectionName --group-id MyGroupId --private-connection-resource-id MyResourceId --asg id=MyAsgId --asg id=MyAsgId

使用 ip-config 创建专用终结点。

az network private-endpoint create -n MyPE -g MyResourceGroup --vnet-name MyVnetName --subnet MySubnet --connection-name MyConnectionName --group-id MyGroupId --private-connection-resource-id MyResourceId --ip-configs [{name:Myipconfig1,group-id:MyGroupId ,member-name:MyMemberName,private-ip-address:10.0.0.4},{name:Myipconfig2,private-ip-address:10.0.0.6}]

必需参数

--connection-name

专用链接服务连接的名称。

--name -n

专用终结点的名称。

--private-connection-resource-id

要连接到的专用终结点的资源 ID。

--resource-group -g

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

--subnet

现有子网的名称或 ID。 如果指定了名称，则还指定 --vnet-name。 如果要在其他资源组或订阅中使用现有子网，请提供 ID 而不是子网的名称，但不指定 --vnet-name。

可选参数

--asg --asgs

专用终结点应用程序安全组。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。 单一标志： --asg。

--edge-zone

边缘区域的名称。

--group-id --group-ids

从此专用终结点应连接到的远程资源获取的组的 ID。 可以使用“az network private-link-resource list”获取支持的组 ID。 除了 PrivateLinkService.、支持速记语法、json-file 和 yaml-file 之外，必须提供此项。 请尝试“？？” 以显示更多内容。

--ip-config --ip-configs

专用终结点 IP 配置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。 单一标志： --ip-config。

--location -l

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

--manual-request

使用手动请求建立连接。 当无权访问专用链接服务的订阅时，将其配置为“true”。

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

--nic-name

附加到专用终结点的网络接口的自定义名称。

--no-wait

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

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

--request-message

使用此连接请求传递给远程资源的所有者的消息。 限制为 140 个字符。

--tags

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

--vnet-name

与子网关联的虚拟网络（如果提供子网 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-endpoint delete

删除专用终结点。

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

示例

删除专用终结点。

az network private-endpoint delete --name MyPrivateEndpoint --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-endpoint list

列出专用终结点。

az network private-endpoint list [--resource-group]

示例

列出专用终结点。

az network private-endpoint list -g MyResourceGroup

可选参数

--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-endpoint list-types

返回可链接到此区域中此订阅中的专用终结点的所有资源类型。

az network private-endpoint list-types [--location]
                                       [--resource-group]

示例

列出所有资源类型

az network private-endpoint list-types -l centralus

可选参数

--location -l

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

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

获取专用终结点的详细信息。

az network private-endpoint show [--expand]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

示例

获取专用终结点的详细信息

az network private-endpoint show --name MyPrivateEndpoint --resource-group MyResourceGroup

可选参数

--expand

展开引用的资源。

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

更新专用终结点。

az network private-endpoint update [--add]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--remove]
                                   [--request-message]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]
                                   [--tags]

示例

更新专用终结点。

az network private-endpoint update -g MyResourceGroup -n MyPE --request-message "test" --tags mytag=hello

更新专用终结点。

az network private-endpoint update --name MyPE --resource-group MyResourceGroup --set useRemoteGateways=true

可选参数

--add

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

--force-string

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

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

--ids

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

--name -n

专用终结点的名称。

--no-wait

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

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

--remove

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

--request-message

使用此连接请求传递给远程资源的所有者的消息。 限制为 140 个字符。

--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。 请尝试“？？” 以显示更多内容。

全局参数

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

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

az network private-endpoint 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

展开引用的资源。

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