Shared Private Link Resources - Create Or Update

Referensi

Service:: Search Management

API Version:: 2020-08-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=2020-08-01

Parameter URI

Name	In	Required	Type	Description
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 Azure Cognitive Search yang terkait dengan grup sumber daya yang ditentukan.
sharedPrivateLinkResourceName	path	True	string	Nama sumber daya tautan privat bersama yang dikelola oleh layanan Azure Cognitive Search 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 atau portal.
api-version	query	True	string	Versi API yang digunakan untuk setiap permintaan.

Header Permintaan

Name	Required	Type	Description
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

Name	Type	Description
properties	SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang dikelola oleh layanan Azure Cognitive Search.

Respons

Name	Type	Description
200 OK	SharedPrivateLinkResource	Detail sumber daya tautan privat bersama yang dibuat.
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

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
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=2020-08-01

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

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/tree/main/specification/search/resource-manager/Microsoft.Search/stable/2020-08-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()
	client, err := armsearch.NewSharedPrivateLinkResourcesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/2020-08-01/examples/CreateOrUpdateSharedPrivateLinkResource.json
 */
async function sharedPrivateLinkResourceCreateOrUpdate() {
  const subscriptionId = "subid";
  const resourceGroupName = "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);
}

sharedPrivateLinkResourceCreateOrUpdate().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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=2020-08-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2020-08-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

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 Azure Cognitive Search.
SharedPrivateLinkResourceProperties	Menjelaskan properti Sumber Daya Private Link Bersama yang sudah ada yang dikelola oleh layanan Azure Cognitive Search.
SharedPrivateLinkResourceProvisioningState	Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.
SharedPrivateLinkResourceStatus	Status sumber daya tautan privat bersama. Bisa Tertunda, Disetujui, Ditolak, atau Terputus.

CloudError

Berisi informasi tentang kesalahan API.

Name	Type	Description
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Name	Type	Description
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 Azure Cognitive Search.

Name	Type	Description
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 Azure Cognitive Search.
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 Azure Cognitive Search.

Name	Type	Description
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. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.
requestMessage	string	Pesan permintaan untuk meminta persetujuan sumber daya tautan privat bersama.
resourceRegion	string	Opsional. 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. Bisa Tertunda, Disetujui, Ditolak, atau Terputus.

SharedPrivateLinkResourceProvisioningState

Status penyediaan sumber daya tautan privat bersama. Dapat berupa Memperbarui, Menghapus, Gagal, Berhasil, atau Tidak Lengkap.

Name	Type	Description
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

Status sumber daya tautan privat bersama. Bisa Tertunda, Disetujui, Ditolak, atau Terputus.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string