Shared Private Link Resources - Create Or Update

Dienst:: Search Management

API-Version:: 2025-05-01

Initiiert die Erstellung oder Aktualisierung einer freigegebenen privaten Linkressource, die vom Suchdienst in der angegebenen Ressourcengruppe verwaltet wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
sharedPrivateLinkResourceName	path	True	string	Der Name der freigegebenen privaten Linkressource, die vom Azure AI Search-Dienst innerhalb der angegebenen Ressourcengruppe verwaltet wird.
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
api-version	query	True	string	Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein vom Client generierter GUID-Wert, der diese Anforderung identifiziert. Wenn angegeben, wird dies in Antwortinformationen eingeschlossen, um die Anforderung nachzuverfolgen.

Anforderungstext

Name	Typ	Beschreibung
properties	SharedPrivateLinkResourceProperties	Beschreibt die Eigenschaften einer freigegebenen privaten Linkressource, die vom Azure AI Search-Dienst verwaltet wird.

Antworten

Name	Typ	Beschreibung
200 OK	SharedPrivateLinkResource	Die Details der freigegebenen privaten Linkressource, die erstellt oder aktualisiert wurde.
202 Accepted		Der Erstellungs- oder Aktualisierungsvorgang für die freigegebene private Verknüpfungsressource wurde akzeptiert und wird asynchron abgeschlossen.
Other Status Codes	CloudError	HTTP 400 (ungültige Anforderung): Der angegebene Name der Ressource für freigegebene private Links oder die Definition der Ressource für freigegebene private Verknüpfungen ist ungültig. Ausführliche Informationen finden Sie im Fehlercode und in der Antwort. HTTP 404 (Nicht gefunden): Das Abonnement, die Ressourcengruppe, der Suchdienst oder die freigegebene private Linkressource wurde nicht gefunden. HTTP 409 (Konflikt): Das angegebene Abonnement ist deaktiviert.

Sicherheit

azure_auth

Gibt einen impliziten Genehmigungsfluss an, der auf der Microsoft Identity Platform unterstützt wird.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

SharedPrivateLinkResourceCreateOrUpdate

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:: 202

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

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

Definitionen

Name	Beschreibung
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
SharedPrivateLinkResource	Beschreibt eine freigegebene private Linkressource, die vom Azure AI Search-Dienst verwaltet wird.
SharedPrivateLinkResourceProperties	Beschreibt die Eigenschaften einer vorhandenen freigegebenen privaten Linkressource, die vom Azure AI Search-Dienst verwaltet wird.
SharedPrivateLinkResourceProvisioningState	Der Bereitstellungsstatus der freigegebenen ressource für private Verknüpfungen. Gültige Werte sind "Aktualisieren", "Löschen", "Fehlgeschlagen", "Erfolgreich" oder "Unvollständig".
SharedPrivateLinkResourceStatus	Status der freigegebenen privaten Linkressource. Gültige Werte sind ausstehend, genehmigt, abgelehnt oder getrennt.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Objekt

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
message	string	Eine kurze Beschreibung des Fehlers, der darauf hinweist, was schief gelaufen ist (details/Debugginginformationen beziehen sich auf die Eigenschaft "error.message").

CloudErrorBody

Objekt

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
message	string	Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key