Shared Private Link Resources - Create Or Update

參考

服務:: Search Management

API 版本:: 2023-11-01

起始建立或更新由指定資源群組中搜尋服務管理的共用私人鏈接資源。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	目前訂用帳戶內的資源組名。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
searchServiceName	path	True	string	與指定之資源群組相關聯的搜尋服務名稱。
sharedPrivateLinkResourceName	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
properties	SharedPrivateLinkResourceProperties	描述由搜尋服務管理的共用 Private Link 資源屬性。

回應

名稱	類型	Description
200 OK	SharedPrivateLinkResource	已建立或更新之共用私人鏈接資源的詳細數據。
202 Accepted		共用的私人鏈接資源建立或更新作業已接受，且會以異步方式完成。
Other Status Codes	CloudError	HTTP 400 (不正確的要求) ：指定的共用私人鏈接資源名稱或共用私人鏈接資源定義無效;如需詳細資訊，請參閱回應中的錯誤碼和訊息。找不到 HTTP 404 () ：找不到訂用帳戶、資源群組、搜尋服務或共用私人鏈接資源。 HTTP 409 (衝突) ：指定的訂用帳戶已停用。

安全性

azure_auth

Microsoft Entra ID OAuth2 授權流程。

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

範圍

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

範例

SharedPrivateLinkResourceCreateOrUpdate

範例要求

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

{
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "resourceRegion": null
  }
}


import com.azure.resourcemanager.search.fluent.models.SharedPrivateLinkResourceInner;
import com.azure.resourcemanager.search.models.SharedPrivateLinkResourceProperties;

/**
 * Samples for SharedPrivateLinkResources CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * CreateOrUpdateSharedPrivateLinkResource.json
     */
    /**
     * Sample code: SharedPrivateLinkResourceCreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void sharedPrivateLinkResourceCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getSharedPrivateLinkResources().createOrUpdate("rg1",
            "mysearchservice", "testResource",
            new SharedPrivateLinkResourceInner().withProperties(new SharedPrivateLinkResourceProperties()
                .withPrivateLinkResourceId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName")
                .withGroupId("blob").withRequestMessage("please approve")),
            null, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python create_or_update_shared_private_link_resource.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.shared_private_link_resources.begin_create_or_update(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        shared_private_link_resource_name="testResource",
        shared_private_link_resource={
            "properties": {
                "groupId": "blob",
                "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
                "requestMessage": "please approve",
                "resourceRegion": None,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/CreateOrUpdateSharedPrivateLinkResource.json
if __name__ == "__main__":
    main()

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

package armsearch_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/CreateOrUpdateSharedPrivateLinkResource.json
func ExampleSharedPrivateLinkResourcesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSharedPrivateLinkResourcesClient().BeginCreateOrUpdate(ctx, "rg1", "mysearchservice", "testResource", armsearch.SharedPrivateLinkResource{
		Properties: &armsearch.SharedPrivateLinkResourceProperties{
			GroupID:               to.Ptr("blob"),
			PrivateLinkResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName"),
			RequestMessage:        to.Ptr("please approve"),
		},
	}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SharedPrivateLinkResource = armsearch.SharedPrivateLinkResource{
	// 	Name: to.Ptr("testResource"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices/sharedPrivateLinkResources"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource"),
	// 	Properties: &armsearch.SharedPrivateLinkResourceProperties{
	// 		GroupID: to.Ptr("blob"),
	// 		PrivateLinkResourceID: to.Ptr("/subscriptions/subid/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

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
 *
 * @summary Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/CreateOrUpdateSharedPrivateLinkResource.json
 */
async function sharedPrivateLinkResourceCreateOrUpdate() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const sharedPrivateLinkResourceName = "testResource";
  const sharedPrivateLinkResource = {
    properties: {
      groupId: "blob",
      privateLinkResourceId:
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
      requestMessage: "please approve",
      resourceRegion: undefined,
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.sharedPrivateLinkResources.beginCreateOrUpdateAndWait(
    resourceGroupName,
    searchServiceName,
    sharedPrivateLinkResourceName,
    sharedPrivateLinkResource
  );
  console.log(result);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/CreateOrUpdateSharedPrivateLinkResource.json
// this example is just showing the usage of "SharedPrivateLinkResources_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// get the collection of this SharedSearchServicePrivateLinkResource
SharedSearchServicePrivateLinkResourceCollection collection = searchService.GetSharedSearchServicePrivateLinkResources();

// invoke the operation
string sharedPrivateLinkResourceName = "testResource";
SharedSearchServicePrivateLinkResourceData data = new SharedSearchServicePrivateLinkResourceData()
{
    Properties = new SharedSearchServicePrivateLinkResourceProperties()
    {
        PrivateLinkResourceId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName"),
        GroupId = "blob",
        RequestMessage = "please approve",
        ResourceRegion = null,
    },
};
ArmOperation<SharedSearchServicePrivateLinkResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, sharedPrivateLinkResourceName, data);
SharedSearchServicePrivateLinkResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SharedSearchServicePrivateLinkResourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

範例回覆

狀態碼:: 202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2023-11-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2023-11-01

狀態碼:: 200

{
  "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	描述由搜尋服務管理的共用 Private Link 資源。
SharedPrivateLinkResourceProperties	描述由搜尋服務管理之現有共用 Private Link 資源的屬性。
SharedPrivateLinkResourceProvisioningState	共用私人鏈接資源的布建狀態。有效值為 [更新]、[刪除]、[失敗]、[成功] 或 [不完整]。
SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態。有效值為 Pending、Approved、Rejected 或 Disconnected。

CloudError

包含 API 錯誤的相關信息。

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

CloudErrorBody

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

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

SharedPrivateLinkResource

描述由搜尋服務管理的共用 Private Link 資源。

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

SharedPrivateLinkResourceProperties

描述由搜尋服務管理之現有共用 Private Link 資源的屬性。

名稱	類型	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
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

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

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string