Private Endpoint Connection - List By Service
Elenca tutte le connessioni endpoint privato dell'istanza del servizio Gestione API.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio di Gestione API. Regex pattern: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementListPrivateEndpointConnections
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"name": "privateEndpointProxyName",
"properties": {
"provisioningState": "Pending",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks",
"actionsRequired": "None"
}
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"name": "privateEndpointProxyName2",
"properties": {
"provisioningState": "Pending",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName2"
},
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks",
"actionsRequired": "None"
}
}
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo di errore. |
Error |
Risposta errore. |
Private |
Risorsa endpoint privato. |
Private |
Risorsa Connessione endpoint privato. |
Private |
Elenco di connessioni all'endpoint privato associate all'account di archiviazione specificato |
Private |
Stato di provisioning corrente. |
Private |
Stato della connessione dell'endpoint privato. |
Private |
Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider. |
ErrorFieldContract
Contratto campo di errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
PrivateEndpoint
Risorsa endpoint privato.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore arm per endpoint privato |
PrivateEndpointConnection
Risorsa Connessione endpoint privato.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.privateEndpoint |
Risorsa dell'endpoint privato. |
|
properties.privateLinkServiceConnectionState |
Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider. |
|
properties.provisioningState |
Stato di provisioning della risorsa di connessione dell'endpoint privato. |
|
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionListResult
Elenco di connessioni all'endpoint privato associate all'account di archiviazione specificato
Nome | Tipo | Descrizione |
---|---|---|
value |
Matrice di connessioni di endpoint privato |
PrivateEndpointConnectionProvisioningState
Stato di provisioning corrente.
Nome | Tipo | Descrizione |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
Stato della connessione dell'endpoint privato.
Nome | Tipo | Descrizione |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.
Nome | Tipo | Descrizione |
---|---|---|
actionsRequired |
string |
Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer. |
description |
string |
Motivo dell'approvazione/rifiuto della connessione. |
status |
Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio. |