Shared Private Link Resources - List By Service

Servizio:: Search Management

Versione API:: 2023-11-01

Ottiene un elenco di tutte le risorse di collegamento privato condivise gestite dal servizio specificato.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?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	SharedPrivateLinkResourceListResult	Operazione riuscita. La risposta contiene l'elenco di tutte le risorse di collegamento privato condivise gestite dal 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

ListSharedPrivateLinkResourcesByService

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "name": "testResource",
      "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
      "properties": {
        "requestMessage": "please approve",
        "groupId": "blob",
        "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
        "status": "Pending",
        "resourceRegion": null
      }
    }
  ]
}

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.
SharedPrivateLinkResource	Descrive una risorsa collegamento privato condiviso gestita dal servizio di ricerca.
SharedPrivateLinkResourceListResult	Risposta contenente un elenco di risorse collegamento privato condiviso.
SharedPrivateLinkResourceProperties	Descrive le proprietà di una risorsa collegamento privato condiviso esistente gestita dal servizio di ricerca.
SharedPrivateLinkResourceProvisioningState	Stato di provisioning della risorsa collegamento privato condiviso. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Operazione completata o Incompleta.
SharedPrivateLinkResourceStatus	Stato della risorsa collegamento privato condiviso. 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.

SharedPrivateLinkResource

Oggetto

Descrive una risorsa collegamento privato condiviso gestita dal 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	SharedPrivateLinkResourceProperties	Descrive le proprietà di una risorsa collegamento privato condiviso gestita dal servizio di ricerca.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceListResult

Oggetto

Risposta contenente un elenco di risorse collegamento privato condiviso.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set successivo di risorse di collegamento privato condiviso, se presenti.
value	SharedPrivateLinkResource[]	Elenco di risorse collegamento privato condiviso.

SharedPrivateLinkResourceProperties

Oggetto

Descrive le proprietà di una risorsa collegamento privato condiviso esistente gestita dal servizio di ricerca.

Nome	Tipo	Descrizione
groupId	string	L'ID del gruppo del provider della risorsa per cui la risorsa collegamento privato condiviso è destinata.
privateLinkResourceId	string	L'ID risorsa della risorsa per cui la risorsa collegamento privato condiviso è destinata.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stato di provisioning della risorsa collegamento privato condiviso. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Operazione completata o Incompleta.
requestMessage	string	Messaggio di richiesta per richiedere l'approvazione della risorsa collegamento privato condiviso.
resourceRegion	string	Opzionale. Può essere usato per specificare la posizione di Azure Resource Manager della risorsa a cui creare un collegamento privato condiviso. Questa operazione è necessaria solo per le risorse la cui configurazione DNS è a livello di area, ad esempio il servizio Azure Kubernetes.
status	SharedPrivateLinkResourceStatus	Stato della risorsa collegamento privato condiviso. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

SharedPrivateLinkResourceProvisioningState

Enumerazione

Stato di provisioning della risorsa collegamento privato condiviso. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Operazione completata o Incompleta.

Valore	Descrizione
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

Enumerazione

Stato della risorsa collegamento privato condiviso. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

Valore	Descrizione
Pending
Approved
Rejected
Disconnected