Shared Private Link Resources - Get

Služba:: Search Management

Verze rozhraní API:: 2023-11-01

Získá podrobnosti o prostředku sdíleného privátního propojení spravovaného vyhledávací službou v dané skupině prostředků.

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

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
searchServiceName	path	True	string	Název vyhledávací služby přidružené k zadané skupině prostředků.
sharedPrivateLinkResourceName	path	True	string	Název prostředku sdíleného privátního propojení spravovaného vyhledávací službou v zadané skupině prostředků.
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru, nástrojů příkazového řádku nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Název	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Odpovědi

Název	Typ	Description
200 OK	SharedPrivateLinkResource	Definice prostředku sdíleného privátního propojení byla úspěšně načtena a je v odpovědi.
Other Status Codes	CloudError	HTTP 404 (Nenalezena): Nepodařilo se najít prostředek předplatného, skupiny prostředků, vyhledávací služby nebo sdíleného privátního propojení.

Zabezpečení

azure_auth

Tok autorizace Microsoft Entra ID OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Název	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

SharedPrivateLinkResourceGet

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
  }
}

Definice

Název	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
SharedPrivateLinkResource	Popisuje prostředek sdíleného privátního propojení spravovaný vyhledávací službou.
SharedPrivateLinkResourceProperties	Popisuje vlastnosti existujícího sdíleného prostředku Private Link spravovaného vyhledávací službou.
SharedPrivateLinkResourceProvisioningState	Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.
SharedPrivateLinkResourceStatus	Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Název	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Název	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

SharedPrivateLinkResource

Objekt

Popisuje prostředek sdíleného privátního propojení spravovaný vyhledávací službou.

Název	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties	SharedPrivateLinkResourceProperties	Popisuje vlastnosti prostředku sdíleného privátního propojení spravovaného vyhledávací službou.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceProperties

Objekt

Popisuje vlastnosti existujícího sdíleného prostředku Private Link spravovaného vyhledávací službou.

Název	Typ	Description
groupId	string	ID skupiny od poskytovatele prostředku, pro který je sdílený prostředek privátního propojení určený.
privateLinkResourceId	string	ID prostředku prostředku, pro který je sdílený prostředek privátního propojení.
provisioningState	SharedPrivateLinkResourceProvisioningState	Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.
requestMessage	string	Zpráva žádosti o schválení sdíleného prostředku privátního propojení.
resourceRegion	string	Volitelný. Můžete použít k určení umístění prostředku Azure Resource Manageru, ke kterému se má vytvořit sdílené privátní propojení. To se vyžaduje jenom pro prostředky, jejichž konfigurace DNS je regionální (například Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

SharedPrivateLinkResourceProvisioningState

Výčet

Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.

Hodnota	Description
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

Výčet

Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Hodnota	Description
Pending
Approved
Rejected
Disconnected