Shared Private Link Resources - Get

Servizio:: Search Management

Versione API:: 2024-03-01-preview

Ottiene i dettagli della risorsa collegamento privato condiviso gestita dal servizio di ricerca nel gruppo di risorse specificato.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2024-03-01-preview

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 pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nome del servizio Ricerca intelligenza artificiale di Azure associato al gruppo di risorse specificato.
sharedPrivateLinkResourceName	path	True	string	Nome della risorsa di collegamento privato condiviso gestita dal servizio Ricerca intelligenza artificiale di Azure all'interno del 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 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	SharedPrivateLinkResource	La definizione della risorsa collegamento privato condiviso è stata recuperata correttamente e si trova nella risposta.
Other Status Codes	CloudError	HTTP 404 (non trovato): impossibile trovare la sottoscrizione, il gruppo di risorse, il servizio di ricerca o la risorsa collegamento privato condiviso.

Sicurezza

azure_auth

Specifica un flusso di concessione implicita, come supportato in Microsoft Identity Platform.

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

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

SharedPrivateLinkResourceGet

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

{
  "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 di collegamento privato condivisa gestita dal servizio Ricerca intelligenza artificiale di Azure.
SharedPrivateLinkResourceProperties	Descrive le proprietà di una risorsa di collegamento privato condiviso esistente gestita dal servizio Ricerca intelligenza artificiale di Azure.
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.
message	string	Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/debug fare riferimento alla proprietà 'error.message').

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 di collegamento privato condivisa gestita dal servizio Ricerca intelligenza artificiale di Azure.

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 di collegamento privato condiviso gestita dal servizio Ricerca intelligenza artificiale di Azure.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Oggetto

Descrive le proprietà di una risorsa di collegamento privato condiviso esistente gestita dal servizio Ricerca intelligenza artificiale di Azure.

Nome	Tipo	Descrizione
groupId	string	L'ID gruppo del provider della risorsa per la risorsa collegamento privato condiviso è per.
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 per richiedere l'approvazione della risorsa di collegamento privato condiviso.
resourceRegion	string	Opzionale. Può essere usato per specificare il percorso di Azure Resource Manager della risorsa per cui viene creato 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	La risorsa di collegamento privato condiviso sta per essere creata insieme ad altre risorse affinché sia completamente funzionante.
Deleting	La risorsa collegamento privato condiviso sta per essere eliminata.
Failed	Impossibile effettuare il provisioning o l'eliminazione della risorsa collegamento privato condiviso.
Succeeded	Il provisioning della risorsa collegamento privato condiviso è terminato ed è pronto per l'approvazione.
Incomplete	La richiesta di provisioning per la risorsa collegamento privato condiviso è stata accettata, ma il processo di creazione non è ancora stato avviato.

SharedPrivateLinkResourceStatus

Enumerazione

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

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