az network private-endpoint

管理私人端點。

命令

名稱	Description	類型	狀態
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-configs 建立私人端點。

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

要連線之私人端點的資源標識符。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--subnet

現有子網的名稱或標識碼。 如果指定名稱，也指定 --vnet-name。 如果您想要在其他資源群組或訂用帳戶中使用現有的子網，請提供標識碼，而不是子網的名稱，但不指定 --vnet-name。

選擇性參數

--asg --asgs

私人端點應用程式安全組。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。 單一旗標：--asg。

--edge-zone

邊緣區域的名稱。

--group-id --group-ids

從此私人端點應該連線到之遠端資源的群組標識碼。 您可以使用 “az network private-link-resource list” 來取得支援的群組標識符。 除了 PrivateLinkService.、支援速記語法、json-file 和 yaml-file 以外，您必須提供此專案。 請嘗試 “？？” 以顯示更多。

--ip-config --ip-configs

私人端點 IP 組態。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。 單一旗標：--ip-config。

--location -l

位置。 值的來源：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

與子網相關聯的虛擬網路 （VNet）（如果提供子網標識符則省略）。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

私人端點的名稱。

--no-wait

請勿等候長時間執行的作業完成。

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

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

位置。 值的來源：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

訂用帳戶的名稱或標識碼。 您可以使用 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

私人端點的名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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 or JSON string>.

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

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

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

私人端點的名稱。

--no-wait

請勿等候長時間執行的作業完成。

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

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

--request-message

傳遞至具有此連線要求之遠端資源擁有者的訊息。 限制為140個字元。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--set

指定要設定的屬性路徑和值，以更新物件。 範例： --set property1.property2=<value>.

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--interval

輪詢間隔以秒為單位。

預設值: 30

--name -n

私人端點的名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。