Shared Private Link Resources - Create Or Update

Referensi

Service:: Search Management

API Version:: 2023-11-01

Memulai pembuatan atau pembaruan sumber daya tautan privat bersama yang dikelola oleh layanan pencarian di grup sumber daya yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan saat ini. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
searchServiceName	path	True	string	Nama layanan pencarian yang terkait dengan grup sumber daya yang ditentukan.
sharedPrivateLinkResourceName	path	True	string	Nama sumber daya tautan privat bersama yang dikelola oleh layanan pencarian dalam grup sumber daya yang ditentukan.
subscriptionId	path	True	string	Pengidentifikasi unik untuk langganan Microsoft Azure. Anda dapat memperoleh nilai ini dari Azure Resource Manager API, alat baris perintah, atau portal.
api-version	query	True	string	Versi API yang digunakan untuk setiap permintaan.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	Nilai GUID yang dihasilkan klien yang mengidentifikasi permintaan ini. Jika ditentukan, ini akan disertakan dalam informasi respons sebagai cara untuk melacak permintaan.

Isi Permintaan

Nama	Jenis	Deskripsi
properties	SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang dikelola oleh layanan pencarian.

Respons

Nama	Jenis	Deskripsi
200 OK	SharedPrivateLinkResource	Detail sumber daya tautan privat bersama yang dibuat atau diperbarui.
202 Accepted		Operasi pembuatan atau pembaruan sumber daya tautan privat bersama telah diterima dan akan selesai secara asinkron.
Other Status Codes	CloudError	HTTP 400 (Permintaan Buruk): Nama sumber daya tautan privat bersama yang diberikan atau definisi sumber daya tautan privat bersama tidak valid; Lihat kode kesalahan dan pesan dalam respons untuk detailnya. HTTP 404 (Tidak Ditemukan): Langganan, grup sumber daya, layanan pencarian, atau sumber daya tautan privat bersama tidak dapat ditemukan. HTTP 409 (Konflik): Langganan yang ditentukan dinonaktifkan.

Keamanan

azure_auth

Microsoft Entra ID alur otorisasi OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

SharedPrivateLinkResourceCreateOrUpdate

Sample Request

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

Sample Response

Status code:: 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

Status code:: 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
  }
}

Definisi

Nama	Deskripsi
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
SharedPrivateLinkResource	Menjelaskan Sumber Daya Private Link Bersama yang dikelola oleh layanan pencarian.
SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan pencarian.
SharedPrivateLinkResourceProvisioningState	Status penyediaan sumber daya tautan privat bersama. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.
SharedPrivateLinkResourceStatus	Status sumber daya tautan privat bersama. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

CloudError

Berisi informasi tentang kesalahan API.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.
details	CloudErrorBody[]	Berisi kesalahan berlapis yang terkait dengan kesalahan ini.
message	string	Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.
target	string	Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

SharedPrivateLinkResource

Menjelaskan Sumber Daya Private Link Bersama yang dikelola oleh layanan pencarian.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties	SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang dikelola oleh layanan pencarian.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan pencarian.

Nama	Jenis	Deskripsi
groupId	string	Id grup dari penyedia sumber daya untuk sumber daya tautan privat bersama adalah untuk.
privateLinkResourceId	string	Id sumber daya sumber daya untuk sumber daya tautan privat bersama adalah untuk.
provisioningState	SharedPrivateLinkResourceProvisioningState	Status penyediaan sumber daya tautan privat bersama. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.
requestMessage	string	Pesan permintaan untuk meminta persetujuan sumber daya tautan privat bersama.
resourceRegion	string	Pilihan. Dapat digunakan untuk menentukan lokasi Azure Resource Manager sumber daya tempat tautan privat bersama akan dibuat. Ini hanya diperlukan untuk sumber daya yang konfigurasi DNS-nya regional (seperti Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status sumber daya tautan privat bersama. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

SharedPrivateLinkResourceProvisioningState

Status penyediaan sumber daya tautan privat bersama. Nilai yang valid adalah Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.

Nama	Jenis	Deskripsi
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Nilai yang valid tertunda, Disetujui, Ditolak, atau Terputus.

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string