Shared Private Link Resources - Create Or Update

Reference

Service:: Search Management

API Version:: 2023-11-01

Zahájí vytvoření nebo aktualizaci prostředku sdíleného privátního propojení spravovaného vyhledávací službou v dané skupině prostředků.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
searchServiceName	path	True	string	Název vyhledávací služby přidružené k zadané skupině prostředků.
sharedPrivateLinkResourceName	path	True	string	Název sdíleného prostředku privátního propojení spravovaného vyhledávací službou v rámci zadané skupiny prostředků.
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager, nástrojů příkazového řádku nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	Hodnota identifikátoru GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadaný, bude součástí informací o odpovědi jako způsob, jak žádost sledovat.

Text požadavku

Name	Typ	Description
properties	SharedPrivateLinkResourceProperties	Popisuje vlastnosti sdíleného prostředku Private Link spravovaného vyhledávací službou.

Odpovědi

Name	Typ	Description
200 OK	SharedPrivateLinkResource	Podrobnosti o vytvořeném nebo aktualizovaném sdíleném prostředku privátního propojení
202 Accepted		Operace vytvoření nebo aktualizace prostředku sdíleného privátního propojení byla přijata a dokončí se asynchronně.
Other Status Codes	CloudError	HTTP 400 (Chybný požadavek): Zadaný název prostředku sdíleného privátního propojení nebo definice prostředku sdíleného privátního propojení je neplatná. Podrobnosti najdete v kódu chyby a zprávě v odpovědi. HTTP 404 (Nenalezený): Nepodařilo se najít předplatné, skupinu prostředků, vyhledávací službu nebo prostředek sdíleného privátního propojení. HTTP 409 (konflikt): Zadané předplatné je zakázané.

Zabezpečení

azure_auth

Microsoft Entra ID tok autorizace OAuth2.

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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
  }
}

Definice

Name	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
SharedPrivateLinkResource	Popisuje sdílený Private Link prostředek spravovaný vyhledávací službou.
SharedPrivateLinkResourceProperties	Popisuje vlastnosti existujícího sdíleného prostředku Private Link spravovaného vyhledávací službou.
SharedPrivateLinkResourceProvisioningState	Stav zřizování prostředku sdíleného privátního propojení. Platné hodnoty jsou Aktualizace, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.
SharedPrivateLinkResourceStatus	Stav prostředku sdíleného privátního propojení Platné hodnoty jsou Čekající, Schváleno, Odmítnuto nebo Odpojeno.

CloudError

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které s touto chybou souvisejí.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

SharedPrivateLinkResource

Popisuje sdílený Private Link prostředek spravovaný vyhledávací službou.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name	string	Název prostředku
properties	SharedPrivateLinkResourceProperties	Popisuje vlastnosti sdíleného prostředku Private Link spravovaného vyhledávací službou.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceProperties

Popisuje vlastnosti existujícího sdíleného prostředku Private Link spravovaného vyhledávací službou.

Name	Typ	Description
groupId	string	ID skupiny od poskytovatele prostředku, pro který je prostředek sdíleného privátního propojení určený.
privateLinkResourceId	string	ID prostředku, pro který je prostředek sdíleného privátního propojení určen.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stav zřizování prostředku sdíleného privátního propojení. Platné hodnoty jsou Aktualizace, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.
requestMessage	string	Zpráva žádosti o schválení prostředku sdíleného privátního propojení.
resourceRegion	string	Nepovinný parametr. Dá se použít k určení umístění azure Resource Manager prostředku, ke kterému se má vytvořit sdílené privátní propojení. To se vyžaduje jenom u prostředků, jejichž konfigurace DNS je místní (například Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stav prostředku sdíleného privátního propojení Platné hodnoty jsou Čekající, Schváleno, Odmítnuto nebo Odpojeno.

SharedPrivateLinkResourceProvisioningState

Stav zřizování prostředku sdíleného privátního propojení. Platné hodnoty jsou Aktualizace, Odstraňování, Neúspěšné, Úspěšné nebo Neúplné.

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

SharedPrivateLinkResourceStatus

Stav prostředku sdíleného privátního propojení Platné hodnoty jsou Čekající, Schváleno, Odmítnuto nebo Odpojeno.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string