Private Endpoint Connections - Delete
Trennt die verbindung des privaten Endpunkts und löscht sie aus dem Suchdienst. Gibt bei erfolgreicher Löschung 200 (OK) mit den gelöschten Verbindungsdetails zurück, oder 404 (Nicht gefunden), falls die Verbindung nicht existiert. HINWEIS: Das Verhalten der zurückgebenden 404 entspricht nicht den ARM-Richtlinien. Kunden sollten in zukünftigen Versionen mit einer 204-Antwort rechnen und neue Abhängigkeiten von der 404-Antwort vermeiden.
DELETE 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 |
|---|---|---|---|---|
|
private
|
path | True |
string |
Der Name der privaten Endpunktverbindung mit dem Azure AI Search-Dienst mit der angegebenen Ressourcengruppe. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
|
search
|
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. |
|
subscription
|
path | True |
string (uuid) |
Die ID des Zielabonnements. Der Wert muss eine UUID sein. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang 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. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Der Azure-Vorgang wurde erfolgreich abgeschlossen. |
|
| 404 Not Found |
Der Server kann die angeforderte Ressource nicht finden. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
PrivateEndpointConnectionDelete
Beispielanforderung
Beispiel für eine Antwort
{
"name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
"type": "Microsoft.Search/searchServices/privateEndpointConnections",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
},
"privateLinkServiceConnectionState": {
"description": "",
"actionsRequired": "None",
"status": "Disconnected"
}
}
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Cloud |
Enthält Informationen zu einem API-Fehler. |
|
Cloud |
Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung. |
|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
|
Private |
Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure AI Search-Dienst. |
|
Private |
Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst. |
|
Private |
Die private Endpunktressource vom Microsoft.Network-Anbieter. |
|
Private |
Beschreibt den aktuellen Status einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt. |
|
Private |
Der Bereitstellungsstatus der Verbindung mit dem privaten Linkdienst. Gültige Werte sind "Aktualisieren", "Löschen", "Fehlgeschlagen", "Erfolgreich", "Unvollständig" oder "Abgebrochen". |
|
Private |
Status der Verbindung mit dem privaten Linkdienst. Gültige Werte sind ausstehend, genehmigt, abgelehnt oder getrennt. |
|
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
CloudError
Enthält Informationen zu einem API-Fehler.
| Name | Typ | Beschreibung |
|---|---|---|
| error |
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
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 |
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
Der Identitätstyp, der die Ressource erstellt hat.
| Wert | Beschreibung |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
PrivateEndpointConnection
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 |
Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Azure AI Search-Dienst. |
|
| 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
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 |
Die private Endpunktressource vom Microsoft.Network-Anbieter. |
|
| privateLinkServiceConnectionState |
Private |
Beschreibt den aktuellen Status einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten Endpunkt. |
| provisioningState |
Der Bereitstellungsstatus der Verbindung mit dem privaten Linkdienst. Gültige Werte sind "Aktualisieren", "Löschen", "Fehlgeschlagen", "Erfolgreich", "Unvollständig" oder "Abgebrochen". |
PrivateEndpointConnectionPropertiesPrivateEndpoint
Die private Endpunktressource vom Microsoft.Network-Anbieter.
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Die Ressourcen-ID der privaten Endpunktressource vom Microsoft.Network-Anbieter. |
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState
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 |
Status der Verbindung mit dem privaten Linkdienst. Gültige Werte sind ausstehend, genehmigt, abgelehnt oder getrennt. |
PrivateLinkServiceConnectionProvisioningState
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. |
PrivateLinkServiceConnectionStatus
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
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 |
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 |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |