Private Endpoint Connection - Get By Name

Dienst:

API Management

API-Version:

2024-05-01

Ruft die Details der privaten Endpunktverbindung ab, die durch den Bezeichner angegeben wird.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
privateEndpointConnectionName	path	True	string	Name der privaten Endpunktverbindung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	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.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementGetPrivateEndpointConnection

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
  "type": "Microsoft.ApiManagement/service/privateEndpointConnections",
  "name": "privateEndpointProxyName",
  "properties": {
    "provisioningState": "Pending",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Pending",
      "description": "Please approve my request, thanks",
      "actionsRequired": "None"
    }
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die Private Endpoint Connection-Ressource.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PrivateEndpoint

Objekt

Die Private Endpoint-Ressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte

PrivateEndpointConnection

Objekt

Die Private Endpoint Connection-Ressource.

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.privateEndpoint	PrivateEndpoint	Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

Der Status der privaten Endpunktverbindung.

Wert	Beschreibung
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.