Private Endpoint Connections - List By Service

Servizio:: Search Management

Versione API:: 2023-11-01

Ottiene un elenco di tutte le connessioni endpoint private nel servizio specificato.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections?api-version=2023-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione corrente. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
searchServiceName	path	True	string	Nome del servizio di ricerca associato al gruppo di risorse specificato.
subscriptionId	path	True	string	Identificatore univoco per una sottoscrizione di Microsoft Azure. È possibile ottenere questo valore dall'API di Azure Resource Manager, dagli strumenti da riga di comando o dal portale.
api-version	query	True	string	Versione dell'API da usare per ogni richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string (uuid)	Valore GUID generato dal client che identifica questa richiesta. Se specificato, verrà incluso nelle informazioni di risposta come modo per tenere traccia della richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateEndpointConnectionListResult	Operazione riuscita. La risposta contiene l'elenco di tutte le connessioni endpoint private per il servizio specificato.
Other Status Codes	CloudError	Si è verificato un errore imprevisto durante l'operazione.

Sicurezza

azure_auth

Flusso di autorizzazione OAuth2 di Microsoft Entra ID.

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

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ListPrivateEndpointConnectionsByService

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Contiene informazioni su un errore dell'API.
CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
PrivateEndpoint	Risorsa endpoint privato dal provider Microsoft.Network.
PrivateEndpointConnection	Descrive una connessione endpoint privato esistente al servizio di ricerca.
PrivateEndpointConnectionListResult	Risposta contenente un elenco di connessioni endpoint privato.
PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione endpoint privato esistente al servizio di ricerca.
PrivateLinkServiceConnectionProvisioningState	Stato di provisioning della connessione al servizio collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Non riuscito, Operazione riuscita o Incompleto
PrivateLinkServiceConnectionState	Descrive lo stato corrente di una connessione del servizio collegamento privato esistente all'endpoint privato di Azure.
PrivateLinkServiceConnectionStatus	Stato della connessione al servizio collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

CloudError

Oggetto

Contiene informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.

CloudErrorBody

Oggetto

Descrive un particolare errore dell'API con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details	CloudErrorBody[]	Contiene errori annidati correlati a questo errore.
message	string	Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

PrivateEndpoint

Oggetto

Risorsa endpoint privato dal provider Microsoft.Network.

Nome	Tipo	Descrizione
id	string	ID risorsa della risorsa endpoint privato dal provider Microsoft.Network.

PrivateEndpointConnection

Oggetto

Descrive una connessione endpoint privato esistente al servizio di ricerca.

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	PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione endpoint privato esistente al servizio di ricerca.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Oggetto

Risposta contenente un elenco di connessioni endpoint privato.

Nome	Tipo	Descrizione
nextLink	string	URL della richiesta che può essere usato per eseguire una query sulla pagina successiva delle connessioni endpoint private. Restituito quando il numero totale di connessioni endpoint private richieste supera le dimensioni massime della pagina.
value	PrivateEndpointConnection[]	Elenco di connessioni endpoint privato.

PrivateEndpointConnectionProperties

Oggetto

Descrive le proprietà di una connessione endpoint privato esistente al servizio di ricerca.

Nome	Tipo	Descrizione
groupId	string	L'ID gruppo del provider della risorsa per la connessione al servizio di collegamento privato è per .
privateEndpoint	PrivateEndpoint	Risorsa endpoint privato dal provider Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Descrive lo stato corrente di una connessione del servizio collegamento privato esistente all'endpoint privato di Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stato di provisioning della connessione al servizio collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Non riuscito, Operazione riuscita o Incompleto

PrivateLinkServiceConnectionProvisioningState

Enumerazione

Stato di provisioning della connessione al servizio collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Non riuscito, Operazione riuscita o Incompleto

Valore	Descrizione
Updating	La connessione al servizio di collegamento privato è in corso di creazione insieme ad altre risorse affinché sia completamente funzionante.
Deleting	La connessione al servizio collegamento privato è in corso di eliminazione.
Failed	Impossibile effettuare il provisioning o l'eliminazione della connessione al servizio collegamento privato.
Succeeded	Il provisioning della connessione al servizio collegamento privato è terminato ed è pronto per l'approvazione.
Incomplete	La richiesta di provisioning per la risorsa di connessione al servizio di collegamento privato è stata accettata, ma il processo di creazione non è ancora stato avviato.
Canceled	La richiesta di provisioning per la risorsa di connessione al servizio collegamento privato è stata annullata

PrivateLinkServiceConnectionState

Oggetto

Descrive lo stato corrente di una connessione del servizio collegamento privato esistente all'endpoint privato di Azure.

Nome	Tipo	Valore predefinito	Descrizione
actionsRequired	string	None	Descrizione di eventuali azioni aggiuntive che possono essere necessarie.
description	string		Descrizione dello stato della connessione al servizio di collegamento privato.
status	PrivateLinkServiceConnectionStatus		Stato della connessione al servizio collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

PrivateLinkServiceConnectionStatus

Enumerazione

Stato della connessione al servizio collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

Valore	Descrizione
Pending	La connessione all'endpoint privato è stata creata ed è in attesa di approvazione.
Approved	La connessione all'endpoint privato è approvata ed è pronta per l'uso.
Rejected	La connessione all'endpoint privato è stata rifiutata e non può essere usata.
Disconnected	La connessione all'endpoint privato è stata rimossa dal servizio.