Private Endpoint Connections - Update

Dienst:: Search Management

API-Version:: 2025-05-01

Aktualisiert eine private Endpunktverbindung mit dem Suchdienst in der angegebenen Ressourcengruppe.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
privateEndpointConnectionName	path	True	string	Der Name der privaten Endpunktverbindung mit dem Azure AI Search-Dienst mit der angegebenen Ressourcengruppe.
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.
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	PrivateEndpointConnectionProperties	Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Azure AI Search-Dienst.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	Die vorhandene Definition der privaten Endpunktverbindung wurde erfolgreich aktualisiert.
Other Status Codes	CloudError	HTTP 400 (ungültige Anforderung): Der angegebene Name der privaten Endpunktverbindung oder die Definition der privaten Endpunktverbindung ist ungültig. Ausführliche Informationen finden Sie im Fehlercode und in der Antwort. HTTP 404 (Nicht gefunden): Die Verbindung zwischen Abonnement, Ressourcengruppe, Suchdienst oder privaten Endpunkten 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

PrivateEndpointConnectionUpdate

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2025-05-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason."
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "Rejected for some reason.",
      "actionsRequired": "None"
    }
  }
}

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.
PrivateEndpoint	Die private Endpunktressource vom Microsoft.Network-Anbieter.
PrivateEndpointConnection	Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure AI Search-Dienst.
PrivateEndpointConnectionProperties	Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst.
PrivateLinkServiceConnectionProvisioningState	Der Bereitstellungsstatus der Verbindung mit dem privaten Linkdienst. Gültige Werte sind "Aktualisieren", "Löschen", "Fehlgeschlagen", "Erfolgreich", "Unvollständig" oder "Abgebrochen".
PrivateLinkServiceConnectionState	Beschreibt den aktuellen Status einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt.
PrivateLinkServiceConnectionStatus	Status der Verbindung mit dem privaten Linkdienst. 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

PrivateEndpoint

Objekt

Die private Endpunktressource vom Microsoft.Network-Anbieter.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der privaten Endpunktressource vom Microsoft.Network-Anbieter.

PrivateEndpointConnection

Objekt

Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure AI Search-Dienst.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	PrivateEndpointConnectionProperties	Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Azure AI Search-Dienst.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Objekt

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst.

Name	Typ	Beschreibung
groupId	string	Die Gruppen-ID der Azure-Ressource, für die der private Linkdienst vorgesehen ist.
privateEndpoint	PrivateEndpoint	Die private Endpunktressource vom Microsoft.Network-Anbieter.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Beschreibt den aktuellen Status einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Der Bereitstellungsstatus der Verbindung mit dem privaten Linkdienst. Gültige Werte sind "Aktualisieren", "Löschen", "Fehlgeschlagen", "Erfolgreich", "Unvollständig" oder "Abgebrochen".

PrivateLinkServiceConnectionProvisioningState

Enumeration

Der Bereitstellungsstatus der Verbindung mit dem privaten Linkdienst. Gültige Werte sind "Aktualisieren", "Löschen", "Fehlgeschlagen", "Erfolgreich", "Unvollständig" oder "Abgebrochen".

Wert	Beschreibung
Updating	Die Verbindung mit dem privaten Linkdienst wird zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig sind.
Deleting	Die Verbindung mit dem privaten Linkdienst wird gerade gelöscht.
Failed	Die Verbindung mit dem privaten Linkdienst konnte nicht bereitgestellt oder gelöscht werden.
Succeeded	Die Verbindung mit dem privaten Linkdienst hat die Bereitstellung abgeschlossen und ist zur Genehmigung bereit.
Incomplete	Die Bereitstellungsanforderung für die Verbindungsressource für den privaten Linkdienst wurde akzeptiert, der Erstellungsprozess wurde jedoch noch nicht begonnen.
Canceled	Die Bereitstellungsanforderung für die Verbindungsressource für den privaten Linkdienst wurde abgebrochen.

PrivateLinkServiceConnectionState

Objekt

Beschreibt den aktuellen Status einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt.

Name	Typ	Standardwert	Beschreibung
actionsRequired	string	None	Eine Beschreibung aller zusätzlichen Aktionen, die erforderlich sein können.
description	string		Die Beschreibung für den Verbindungsstatus des privaten Linkdiensts.
status	PrivateLinkServiceConnectionStatus		Status der Verbindung mit dem privaten Linkdienst. Gültige Werte sind ausstehend, genehmigt, abgelehnt oder getrennt.

PrivateLinkServiceConnectionStatus

Enumeration

Status der Verbindung mit dem privaten Linkdienst. Gültige Werte sind ausstehend, genehmigt, abgelehnt oder getrennt.

Wert	Beschreibung
Pending	Die private Endpunktverbindung wurde erstellt und steht aus.
Approved	Die private Endpunktverbindung ist genehmigt und kann verwendet werden.
Rejected	Die private Endpunktverbindung wurde abgelehnt und kann nicht verwendet werden.
Disconnected	Die private Endpunktverbindung wurde aus dem Dienst entfernt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Private Endpoint Connections - Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

PrivateEndpointConnectionUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

createdByType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

systemData