Private Endpoint Connections - Get

服務:: Search Management

API 版本:: 2025-02-01-preview

取得指定資源群組中搜尋服務的私人端點連線詳細數據。

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

URI 參數

名稱	位於	必要	類型	Description
privateEndpointConnectionName	path	True	string	具有指定資源群組之 Azure AI 搜尋服務的私人端點連線名稱。
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。您可以從 Azure Resource Manager API 或入口網站取得此值。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	與指定資源群組相關聯的 Azure AI 搜尋服務名稱。
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	PrivateEndpointConnection	已成功擷取私人端點連線的定義，且在回應中。
Other Status Codes	CloudError	HTTP 404 （找不到）：找不到訂用帳戶、資源群組、搜尋服務或私人端點連線。

安全性

azure_auth

指定Microsoft身分識別平台上支援的隱含授與流程。

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

範圍

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

範例

PrivateEndpointConnectionGet

範例要求

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2025-02-01-preview

範例回覆

狀態碼:: 200

{
  "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	描述與 Azure AI 搜尋服務的現有私人端點連線。
PrivateEndpointConnectionProperties	描述與搜尋服務的現有私人端點連線屬性。
PrivateLinkServiceConnectionProvisioningState	私人鏈接服務連線的布建狀態。有效值為更新、刪除、失敗、成功、不完整或取消。
PrivateLinkServiceConnectionState	描述現有 Azure Private Link 服務連線至私人端點的目前狀態。
PrivateLinkServiceConnectionStatus	私人鏈接服務連線的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
message	string	錯誤簡短描述，其中提示發生錯誤的原因（如需詳細數據/偵錯資訊，請參閱 'error.message' 屬性。

CloudErrorBody

Object

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

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

PrivateEndpoint

Object

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

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

PrivateEndpointConnection

Object

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

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

PrivateEndpointConnectionProperties

Object

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

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

PrivateLinkServiceConnectionProvisioningState

列舉型別

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

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

PrivateLinkServiceConnectionState

Object

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

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

PrivateLinkServiceConnectionStatus

列舉型別

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

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