Private Endpoint Connections - Update By Host Pool

服務:

Desktop Virtualization

API 版本:

2025-10-10

核准或拒絕私人端點連線。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2025-10-10

URI 參數

名稱	位於	必要	類型	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	指定資源群組內主機集區的名稱
privateEndpointConnectionName	path	True	string	與 Azure 資源相關的私有端點連線名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
properties.privateLinkServiceConnectionState	True	PrivateLinkServiceConnectionState	關於服務 consumer 與提供者之間連結狀態的資訊彙集。
properties.privateEndpoint		PrivateEndpoint	私人端點資源。

回應

名稱	類型	Description
200 OK	PrivateEndpointConnectionWithSystemData	已成功更新。
Other Status Codes	CloudError	自動化錯誤回應，說明作業失敗的原因。

範例

PrivateEndpointConnection_UpdateByHostPool

範例要求

HTTP

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b?api-version=2025-10-10

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by admin@consoto.com",
      "actionsRequired": "None"
    }
  }
}

範例回覆

狀態碼:

200

{
  "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b",
  "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by admin@consoto.com",
      "actionsRequired": "None"
    }
  }
}

定義

名稱	Description
CloudError	雲端錯誤物件。
CloudErrorProperties	雲端錯誤物件屬性。
createdByType	建立資源的身分識別類型。
PrivateEndpoint	私人端點資源。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateEndpointConnectionWithSystemData	私人端點聯機資源。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	關於服務 consumer 與提供者之間連結狀態的資訊彙集。
systemData	與建立和上次修改資源相關的元數據。

CloudError

Object

雲端錯誤物件。

名稱	類型	Description
error	CloudErrorProperties	雲端錯誤物件屬性。

CloudErrorProperties

Object

雲端錯誤物件屬性。

名稱	類型	Description
code	string	錯誤碼
message	string	錯誤訊息，指出作業失敗的原因。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

PrivateEndpoint

Object

私人端點資源。

名稱	類型	Description
id	string	私人端點的ARM標識碼。

PrivateEndpointConnectionProvisioningState

列舉型別

目前的布建狀態。

值	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionWithSystemData

Object

私人端點聯機資源。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.groupIds	string[]	私人端點資源的群組標識碼。
properties.privateEndpoint	PrivateEndpoint	私人端點資源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	關於服務 consumer 與提供者之間連結狀態的資訊彙集。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機資源的布建狀態。
systemData	systemData	Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。
type	string	資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointServiceConnectionStatus

列舉型別

私人端點連線狀態。

值	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

關於服務 consumer 與提供者之間連結狀態的資訊彙集。

名稱	類型	Description
actionsRequired	string	一則訊息指示服務提供者的變更是否需要對 consumer 進行任何更新。
description	string	核准/拒絕連線的原因。
status	PrivateEndpointServiceConnectionStatus	指出服務擁有者是否已核准/拒絕/移除連線。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。