Shared Private Link Resources - List By Service

服務:: Search Management

API 版本:: 2025-05-01

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

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	與指定資源群組相關聯的 Azure AI 搜尋服務名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

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

回應

名稱	類型	Description
200 OK	SharedPrivateLinkResourceListResult	要求已成功。
Other Status Codes	CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

範圍

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

範例

ListSharedPrivateLinkResourcesByService

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources?api-version=2025-05-01

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/ListSharedPrivateLinkResourcesByService.json
func ExampleSharedPrivateLinkResourcesClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSharedPrivateLinkResourcesClient().NewListByServicePager("rg1", "mysearchservice", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsearch.SharedPrivateLinkResourcesClientListByServiceResponse{
		// 	SharedPrivateLinkResourceListResult: armsearch.SharedPrivateLinkResourceListResult{
		// 		Value: []*armsearch.SharedPrivateLinkResource{
		// 			{
		// 				Name: to.Ptr("testResource"),
		// 				Type: to.Ptr("Microsoft.Search/searchServices/sharedPrivateLinkResources"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource"),
		// 				Properties: &armsearch.SharedPrivateLinkResourceProperties{
		// 					GroupID: to.Ptr("blob"),
		// 					PrivateLinkResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName"),
		// 					RequestMessage: to.Ptr("please approve"),
		// 					Status: to.Ptr(armsearch.SharedPrivateLinkResourceStatusPending),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 200

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

定義

名稱	Description
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
createdByType	建立資源的身分識別類型。
SharedPrivateLinkResource	描述 Azure AI 搜尋服務所管理的共用私人鏈接資源。
SharedPrivateLinkResourceListResult	包含共用私人鏈接資源清單的回應。
SharedPrivateLinkResourceProperties	描述 Azure AI 搜尋服務所管理之現有共用私人鏈接資源的屬性。
SharedPrivateLinkResourceProvisioningState	共用私人鏈接資源的布建狀態。有效值為更新、刪除、失敗、成功或不完整。
SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。
systemData	與建立和上次修改資源相關的元數據。

CloudError

Object

包含 API 錯誤的相關信息。

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

CloudErrorBody

Object

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

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

createdByType

列舉型別

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

值	Description
User
Application
ManagedIdentity
Key

SharedPrivateLinkResource

Object

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

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties	SharedPrivateLinkResourceProperties	描述 Azure AI 搜尋服務所管理之共用私人鏈接資源的屬性。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SharedPrivateLinkResourceListResult

Object

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

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

SharedPrivateLinkResourceProperties

Object

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

名稱	類型	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	共用的私人鏈接資源已從服務中移除。

systemData

Object

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

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