Private Endpoint Connections - List By Service

Dienst:: Search Management

API-Version:: 2023-11-01

Ruft eine Liste aller privaten Endpunktverbindungen im angegebenen Dienst ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections?api-version=2023-11-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	Der Name des Suchdiensts, 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, den Befehlszeilentools 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.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnectionListResult	Der Vorgang war erfolgreich. Die Antwort enthält die Liste aller privaten Endpunktverbindungen für den angegebenen Dienst.
Other Status Codes	CloudError	Unerwarteter Fehler während des Vorgangs.

Sicherheit

azure_auth

Microsoft Entra ID OAuth2-Autorisierungsfluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ListPrivateEndpointConnectionsByService

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2023-11-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "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": "Approved",
          "description": "",
          "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.
PrivateEndpoint	Die private Endpunktressource vom Microsoft.Network-Anbieter.
PrivateEndpointConnection	Beschreibt eine vorhandene private Endpunktverbindung mit dem Suchdienst.
PrivateEndpointConnectionListResult	Antwort, die eine Liste der privaten Endpunktverbindungen enthält.
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" oder "Unvollständig"
PrivateLinkServiceConnectionState	Beschreibt den aktuellen Status einer vorhandenen Verbindung mit dem privaten Azure-Endpunkt.
PrivateLinkServiceConnectionStatus	Status der Verbindung mit dem privaten Linkdienst. Gültige Werte sind ausstehend, genehmigt, abgelehnt oder getrennt.

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.

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).

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 Suchdienst.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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 Suchdienst.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Objekt

Antwort, die eine Liste der privaten Endpunktverbindungen enthält.

Name	Typ	Beschreibung
nextLink	string	Anforderungs-URL, die zum Abfragen der nächsten Seite privater Endpunktverbindungen verwendet werden kann. Wird zurückgegeben, wenn die Gesamtanzahl der angeforderten privaten Endpunktverbindungen die maximale Seitengröße überschreitet.
value	PrivateEndpointConnection[]	Die Liste der privaten Endpunktverbindungen.

PrivateEndpointConnectionProperties

Objekt

Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst.

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

PrivateLinkServiceConnectionProvisioningState

Enumeration

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

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 Verbindung mit dem privaten Azure-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.