Shared Private Link Resources - Create Or Update

Service:

Search Management

API-versie:

2024-03-01-preview

Hiermee start u het maken of bijwerken van een gedeelde Private Link-resource die wordt beheerd door de zoekservice in de opgegeven resourcegroep.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName	path	True	string	De naam van de Azure AI-Search-service die is gekoppeld aan de opgegeven resourcegroep. Regex-patroon: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
sharedPrivateLinkResourceName	path	True	string	De naam van de gedeelde Private Link-resource die wordt beheerd door de Azure AI-Search-service binnen de opgegeven resourcegroep.
subscriptionId	path	True	string	De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
api-version	query	True	string	De API-versie die voor elke aanvraag moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in de antwoordinformatie als een manier om de aanvraag bij te houden.

Aanvraagbody

Name	Type	Description
properties	SharedPrivateLinkResourceProperties	Hierin worden de eigenschappen beschreven van een gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.

Antwoorden

Name	Type	Description
200 OK	SharedPrivateLinkResource	De details van de gedeelde Private Link-resource die is gemaakt of bijgewerkt.
202 Accepted		De bewerking voor het maken of bijwerken van de gedeelde privékoppeling is geaccepteerd en wordt asynchroon uitgevoerd.
Other Status Codes	CloudError	HTTP 400 (ongeldige aanvraag): de opgegeven resourcenaam van de gedeelde privékoppeling of de definitie van de gedeelde privékoppelingsresource is ongeldig; Zie de foutcode en het bericht in het antwoord voor meer informatie. HTTP 404 (niet gevonden): het abonnement, de resourcegroep, de zoekservice of de gedeelde privékoppelingsresource is niet gevonden. HTTP 409 (conflict): het opgegeven abonnement is uitgeschakeld.

Beveiliging

azure_auth

Hiermee geeft u een impliciete toekenningsstroom op, zoals ondersteund op het Microsoft Identity-platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

SharedPrivateLinkResourceCreateOrUpdate

Voorbeeldaanvraag

HTTP

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

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

Python

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/preview/2024-03-01-preview/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

Go

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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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

JavaScript

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/preview/2024-03-01-preview/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

dotnet

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

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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

Voorbeeldrespons

Statuscode:

202

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

Statuscode:

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

Definities

Name	Description
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
SharedPrivateLinkResource	Beschrijft een gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.
SharedPrivateLinkResourceProperties	Hierin worden de eigenschappen beschreven van een bestaande gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.
SharedPrivateLinkResourceProvisioningState	De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.
SharedPrivateLinkResourceStatus	Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

CloudError

Bevat informatie over een API-fout.

Name	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message	string	Een korte beschrijving van de fout die aangeeft wat er mis is gegaan (raadpleeg de eigenschap 'error.message' voor meer informatie/foutopsporing).

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

SharedPrivateLinkResource

Beschrijft een gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties	SharedPrivateLinkResourceProperties	Hierin worden de eigenschappen beschreven van een gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SharedPrivateLinkResourceProperties

Hierin worden de eigenschappen beschreven van een bestaande gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.

Name	Type	Description
groupId	string	De groeps-id van de provider van de resource waarvoor de gedeelde Private Link-resource is bedoeld.
privateLinkResourceId	string	De resource-id van de resource waarvoor de gedeelde Private Link-resource is bedoeld.
provisioningState	SharedPrivateLinkResourceProvisioningState	De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.
requestMessage	string	Het bericht voor het aanvragen van goedkeuring van de gedeelde Private Link-resource.
resourceRegion	string	Optioneel. Kan worden gebruikt om de Azure Resource Manager locatie op te geven van de resource waarvoor een gedeelde privékoppeling wordt gemaakt. Dit is alleen vereist voor resources waarvan de DNS-configuratie regionaal is (zoals Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

SharedPrivateLinkResourceProvisioningState

De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.

Name	Type	Description
Deleting	string	De gedeelde privékoppelingsresource wordt momenteel verwijderd.
Failed	string	De gedeelde privékoppelingsresource is niet ingericht of verwijderd.
Incomplete	string	De inrichtingsaanvraag voor de gedeelde Private Link-resource is geaccepteerd, maar het proces voor het maken is nog niet gestart.
Succeeded	string	De gedeelde privékoppelingsresource is klaar met het inrichten en is gereed voor goedkeuring.
Updating	string	De gedeelde privékoppelingsresource wordt samen met andere resources gemaakt om deze volledig functioneel te maken.

SharedPrivateLinkResourceStatus

Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

Name	Type	Description
Approved	string	De gedeelde Private Link-resource is goedgekeurd en is klaar voor gebruik.
Disconnected	string	De gedeelde Private Link-resource is verwijderd uit de service.
Pending	string	De gedeelde private link-resource is gemaakt en wacht op goedkeuring.
Rejected	string	De gedeelde privékoppelingsresource is geweigerd en kan niet worden gebruikt.