Shared Private Link Resources - Create Or Update

Tjänst:: Search Management

API-version:: 2024-03-01-preview

Initierar skapandet eller uppdateringen av en resurs för delad privat länk som hanteras av söktjänsten i den angivna resursgruppen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Namnet på azure AI Search-tjänsten som är associerad med den angivna resursgruppen.
sharedPrivateLinkResourceName	path	True	string	Namnet på den delade privata länkresursen som hanteras av Azure AI Search-tjänsten i den angivna resursgruppen.
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
api-version	query	True	string	DEN API-version som ska användas för varje begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Begärandetext

Name	Typ	Description
properties	SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.

Svar

Name	Typ	Description
200 OK	SharedPrivateLinkResource	Information om den delade privata länkresursen som skapades eller uppdaterades.
202 Accepted		Åtgärden för att skapa eller uppdatera den delade privata länken har godkänts och slutförs asynkront.
Other Status Codes	CloudError	HTTP 400 (felaktig begäran): Det angivna resursnamnet för delad privat länk eller resursdefinitionen för delad privat länk är ogiltig. Mer information finns i felkoden och meddelandet i svaret. HTTP 404 (hittades inte): Det gick inte att hitta prenumerationen, resursgruppen, söktjänsten eller resursen för delad privat länk. HTTP 409 (konflikt): Den angivna prenumerationen är inaktiverad.

Säkerhet

azure_auth

Anger ett implicit beviljandeflöde som stöds på Microsoft Identity-plattformen.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SharedPrivateLinkResourceCreateOrUpdate

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

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

Definitioner

Name	Description
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
SharedPrivateLinkResource	Beskriver en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.
SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.
SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
SharedPrivateLinkResourceStatus	Status för resursen för delad privat länk. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

SharedPrivateLinkResource

Objekt

Beskriver en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties	SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Objekt

Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI Search-tjänsten.

Name	Typ	Description
groupId	string	Grupp-ID:t från resursprovidern som resursen delad privat länk är till för.
privateLinkResourceId	string	Resurs-ID:t för resursen som resursen för den delade privata länken är till för.
provisioningState	SharedPrivateLinkResourceProvisioningState	Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
requestMessage	string	Meddelandet för att begära godkännande av resursen för delad privat länk.
resourceRegion	string	Valfritt. Kan användas för att ange Azure Resource Manager-platsen för resursen som en delad privat länk skapas för. Detta krävs endast för de resurser vars DNS-konfiguration är regional (till exempel Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status för resursen för delad privat länk. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

SharedPrivateLinkResourceProvisioningState

Uppräkning

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

Värde	Description
Updating	Resursen för delad privat länk håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut.
Deleting	Resursen för delad privat länk håller på att tas bort.
Failed	Resursen för den delade privata länken kunde inte etableras eller tas bort.
Succeeded	Resursen för delad privat länk har slutfört etableringen och är redo för godkännande.
Incomplete	Etableringsbegäran för resursen för delad privat länk har godkänts, men processen för att skapa har inte påbörjats ännu.

SharedPrivateLinkResourceStatus

Uppräkning

Status för resursen för delad privat länk. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

Värde	Description
Pending	Resursen för delad privat länk har skapats och väntar på godkännande.
Approved	Resursen för delad privat länk är godkänd och är redo att användas.
Rejected	Resursen för delad privat länk har avvisats och kan inte användas.
Disconnected	Resursen för delad privat länk har tagits bort från tjänsten.