Private Endpoint Connections - List By Service

服務:: Search Management

API 版本:: 2023-11-01

取得指定服務中所有私人端點連線的清單。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections?api-version=2023-11-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。您可以從 Azure Resource Manager API 或入口網站取得此值。
searchServiceName	path	True	string	與指定資源群組相關聯的搜尋服務名稱。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。您可以從 Azure Resource Manager API、命令行工具或入口網站取得此值。
api-version	query	True	string	每個要求所使用的 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string (uuid)	用戶端產生的 GUID 值，可識別此要求。如果指定，則會以追蹤要求的方式包含在響應資訊中。

回應

名稱	類型	Description
200 OK	PrivateEndpointConnectionListResult	作業成功。回應包含指定服務的所有私人端點連線清單。
Other Status Codes	CloudError	作業期間發生未預期的錯誤。

安全性

azure_auth

Microsoft Entra ID OAuth2 授權流程。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ListPrivateEndpointConnectionsByService

範例要求

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2023-11-01

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "type": "Microsoft.Search/searchServices/privateEndpointConnections",
      "properties": {
        "privateEndpoint": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

定義

名稱	Description
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
PrivateEndpoint	Microsoft.Network 提供者的私人端點資源。
PrivateEndpointConnection	描述與搜尋服務的現有私人端點連線。
PrivateEndpointConnectionListResult	包含私人端點連線清單的回應。
PrivateEndpointConnectionProperties	描述現有私人端點連線至搜尋服務的屬性。
PrivateLinkServiceConnectionProvisioningState	私人鏈接服務連線的布建狀態。有效值為更新、刪除、失敗、成功或不完整
PrivateLinkServiceConnectionState	描述現有私人連結服務連線至 Azure 私人端點的目前狀態。
PrivateLinkServiceConnectionStatus	私人鏈接服務連線的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

CloudErrorBody

Object

描述具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	比 HTTP 狀態代碼更精確地描述錯誤條件的錯誤碼。可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	特定錯誤的目標（例如，錯誤中的屬性名稱）。

PrivateEndpoint

Object

Microsoft.Network 提供者的私人端點資源。

名稱	類型	Description
id	string	來自 Microsoft.Network 提供者的私人端點資源資源標識碼。

PrivateEndpointConnection

Object

描述與搜尋服務的現有私人端點連線。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	PrivateEndpointConnectionProperties	描述與搜尋服務的現有私人端點連線屬性。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionListResult

Object

包含私人端點連線清單的回應。

名稱	類型	Description
nextLink	string	要求 URL，可用來查詢私人端點連線的下一頁。當要求的私人端點連線總數超過頁面大小上限時傳回。
value	PrivateEndpointConnection[]	私人端點連線的清單。

PrivateEndpointConnectionProperties

Object

描述現有私人端點連線至搜尋服務的屬性。

名稱	類型	Description
groupId	string	私人鏈接服務連線的來源資源提供者的群組標識碼。
privateEndpoint	PrivateEndpoint	Microsoft.Network 提供者的私人端點資源。
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	描述現有私人連結服務連線至 Azure 私人端點的目前狀態。
provisioningState	PrivateLinkServiceConnectionProvisioningState	私人鏈接服務連線的布建狀態。有效值為更新、刪除、失敗、成功或不完整

PrivateLinkServiceConnectionProvisioningState

列舉型別

私人鏈接服務連線的布建狀態。有效值為更新、刪除、失敗、成功或不完整

值	Description
Updating	私人鏈接服務連線正與其他資源一起建立，使其可完全正常運作。
Deleting	私人鏈接服務連線正在刪除。
Failed	無法布建或刪除私人連結服務連線。
Succeeded	私人鏈接服務連線已完成佈建，且已準備好進行核准。
Incomplete	已接受私人連結服務連線資源的布建要求，但尚未開始建立程式。
Canceled	已取消私人連結服務連線資源的布建要求

PrivateLinkServiceConnectionState

Object

描述現有私人連結服務連線至 Azure 私人端點的目前狀態。

名稱	類型	預設值	Description
actionsRequired	string	None	任何可能需要的額外動作的描述。
description	string		私人鏈接服務連線狀態的描述。
status	PrivateLinkServiceConnectionStatus		私人鏈接服務連線的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

PrivateLinkServiceConnectionStatus

列舉型別

私人鏈接服務連線的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

值	Description
Pending	已建立私人端點連線，並擱置核准。
Approved	私人端點連線已核准且可供使用。
Rejected	私人端點連線已遭拒絕，且無法使用。
Disconnected	私人端點連線已從服務中移除。