Shared Private Link Resources - List By Service

服務:: Search Management

API 版本:: 2023-11-01

取得由指定服務管理的所有共用私人鏈接資源清單。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?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	SharedPrivateLinkResourceListResult	作業成功。回應包含由指定服務管理的所有共用私人鏈接資源清單。
Other Status Codes	CloudError	作業期間發生未預期的錯誤。

安全性

azure_auth

Microsoft Entra ID OAuth2 授權流程。

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

範圍

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

範例

ListSharedPrivateLinkResourcesByService

範例要求

HTTP

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

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "name": "testResource",
      "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
      "properties": {
        "requestMessage": "please approve",
        "groupId": "blob",
        "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
        "status": "Pending",
        "resourceRegion": null
      }
    }
  ]
}

定義

名稱	Description
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
SharedPrivateLinkResource	描述由搜尋服務管理的共用私人鏈接資源。
SharedPrivateLinkResourceListResult	包含共用私人鏈接資源清單的回應。
SharedPrivateLinkResourceProperties	描述搜尋服務所管理之現有共用私人鏈接資源的屬性。
SharedPrivateLinkResourceProvisioningState	共用私人鏈接資源的布建狀態。有效值為更新、刪除、失敗、成功或不完整。
SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

CloudError

Object

包含 API 錯誤的相關信息。

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

CloudErrorBody

Object

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

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

SharedPrivateLinkResource

Object

描述由搜尋服務管理的共用私人鏈接資源。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	SharedPrivateLinkResourceProperties	描述搜尋服務所管理之共用私人鏈接資源的屬性。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SharedPrivateLinkResourceListResult

Object

包含共用私人鏈接資源清單的回應。

名稱	類型	Description
nextLink	string	如果有的話，取得下一組共用私人鏈接資源的URL。
value	SharedPrivateLinkResource[]	共用私人鏈接資源的清單。

SharedPrivateLinkResourceProperties

Object

描述搜尋服務所管理之現有共用私人鏈接資源的屬性。

名稱	類型	Description
groupId	string	共用私人鏈接資源提供者的群組標識碼。
privateLinkResourceId	string	共用私人鏈接資源的資源資源識別碼。
provisioningState	SharedPrivateLinkResourceProvisioningState	共用私人鏈接資源的布建狀態。有效值為更新、刪除、失敗、成功或不完整。
requestMessage	string	要求核准共用私人鏈接資源的要求訊息。
resourceRegion	string	選擇性。可用來指定要建立共用私人鏈接之資源的 Azure Resource Manager 位置。只有 DNS 設定為區域的資源（例如 Azure Kubernetes Service）才需要此專案。
status	SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

SharedPrivateLinkResourceProvisioningState

列舉型別

共用私人鏈接資源的布建狀態。有效值為更新、刪除、失敗、成功或不完整。

值	Description
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

列舉型別

共用私人鏈接資源的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

值	Description
Pending
Approved
Rejected
Disconnected