Private Endpoint Connection - Get By Name

Servizio:

API Management

Versione API:

2024-05-01

Ottiene i dettagli della connessione endpoint privato specificata dal relativo identificatore.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
privateEndpointConnectionName	path	True	string	Nome della connessione all'endpoint privato.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateEndpointConnection	OK
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementGetPrivateEndpointConnection

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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"
    }
  }
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
PrivateEndpoint	Risorsa endpoint privato.
PrivateEndpointConnection	Risorsa connessione endpoint privato.
PrivateEndpointConnectionProvisioningState	Stato di provisioning corrente.
PrivateEndpointServiceConnectionStatus	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionState	Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

PrivateEndpoint

Object

Risorsa endpoint privato.

Nome	Tipo	Descrizione
id	string	Identificatore arm per endpoint privato

PrivateEndpointConnection

Object

Risorsa connessione endpoint privato.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.privateEndpoint	PrivateEndpoint	Risorsa dell'endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stato di provisioning della risorsa di connessione dell'endpoint privato.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumerazione

Stato di provisioning corrente.

Valore	Descrizione
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumerazione

Stato della connessione dell'endpoint privato.

Valore	Descrizione
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Raccolta di informazioni sullo stato della connessione tra consumer di servizi e provider.

Nome	Tipo	Descrizione
actionsRequired	string	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.
description	string	Motivo dell'approvazione/rifiuto della connessione.
status	PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.