Private Endpoint Connections - Delete

Trennt die private Endpunktverbindung und löscht sie aus dem Suchdienst.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2021-04-01-preview

URI-Parameter

Name In Required Type Description
privateEndpointConnectionName
path True
  • string

Der Name der privaten Endpunktverbindung mit dem Azure Cognitive Search Dienst mit der angegebenen Ressourcengruppe.

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

searchServiceName
path True
  • string

Der Name des Azure Cognitive Search Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.

subscriptionId
path True
  • string

Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

api-version
query True
  • string

Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name Required Type Description
x-ms-client-request-id
  • string
uuid

Ein vom Client generierter GUID-Wert zur Identifizierung dieser Anforderung. Wenn angegeben, wird dies in Antwortinformationen als Möglichkeit zum Nachverfolgen der Anforderung eingeschlossen.

Antworten

Name Type Description
200 OK

Die private Endpunktverbindung wurde erfolgreich getrennt und aus dem Suchdienst entfernt. Die Antwort enthält die aktualisierte Definition der privaten Endpunktverbindung.

404 Not Found

Die Verbindung zwischen Abonnement, Ressourcengruppe, Suchdienst oder privater Endpunkt konnte nicht gefunden werden.

Other Status Codes

Während des Vorgangs ist ein unerwarteter Fehler aufgetreten.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

PrivateEndpointConnectionDelete

Sample Request

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

Sample Response

{
  "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": "Disconnected",
      "description": "",
      "actionsRequired": "None"
    }
  }
}

Definitionen

CloudError

Enthält Informationen zu einem API-Fehler.

CloudErrorBody

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

PrivateEndpoint

Die private Endpunktressource vom Microsoft.Network-Anbieter.

PrivateEndpointConnection

Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure Cognitive Search Dienst.

PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Azure Cognitive Search Dienst.

PrivateLinkServiceConnectionState

Beschreibt den aktuellen Status einer vorhandenen Private Link Dienstverbindung mit dem Azure Private Endpoint.

PrivateLinkServiceConnectionStatus

Status der Verbindung mit dem privaten Linkdienst. Kann ausstehend, genehmigt, abgelehnt oder getrennt sein.

CloudError

Enthält Informationen zu einem API-Fehler.

Name Type Description
error

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

message
  • string

Eine kurze Beschreibung des Fehlers, der darauf hinweist, was falsch war (details/Debugginginformationen beziehen sich auf die Eigenschaft "error.message").

CloudErrorBody

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

Name Type Description
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 ausführlich beschreibt und Debugginginformationen bereitstellt.

target
  • string

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

PrivateEndpoint

Die private Endpunktressource vom Microsoft.Network-Anbieter.

Name Type Description
id
  • string

Die Ressourcen-ID der privaten Endpunktressource vom Microsoft.Network-Anbieter.

PrivateEndpointConnection

Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure Cognitive Search Dienst.

Name Type Description
id
  • string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Der Name der Ressource

properties

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Azure Cognitive Search Dienst.

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 Azure Cognitive Search Dienst.

Name Type Description
privateEndpoint

Die private Endpunktressource vom Microsoft.Network-Anbieter.

privateLinkServiceConnectionState

Beschreibt den aktuellen Status einer vorhandenen Private Link Dienstverbindung mit dem Azure Private Endpoint.

PrivateLinkServiceConnectionState

Beschreibt den aktuellen Status einer vorhandenen Private Link Dienstverbindung mit dem Azure Private Endpoint.

Name Type Default Value Description
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. Kann ausstehend, genehmigt, abgelehnt oder getrennt sein.

PrivateLinkServiceConnectionStatus

Status der Verbindung mit dem privaten Linkdienst. Kann ausstehend, genehmigt, abgelehnt oder getrennt sein.

Name Type Description
Approved
  • string

Die private Endpunktverbindung ist genehmigt und kann verwendet werden.

Disconnected
  • string

Die private Endpunktverbindung wurde aus dem Dienst entfernt.

Pending
  • string

Die private Endpunktverbindung wurde erstellt und ist ausstehende Genehmigung.

Rejected
  • string

Die private Endpunktverbindung wurde abgelehnt und kann nicht verwendet werden.