Shared Private Link Resources - Get

Szolgáltatás:: Search Management

API-verzió:: 2024-03-01-preview

Lekéri az adott erőforráscsoport keresési szolgáltatása által felügyelt megosztott privát kapcsolati erőforrás részleteit.

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	A megadott erőforráscsoporthoz társított Azure AI Search szolgáltatás neve.
sharedPrivateLinkResourceName	path	True	string	Az Azure AI Search szolgáltatás által a megadott erőforráscsoporton belül felügyelt megosztott privát kapcsolatú erőforrás neve.
subscriptionId	path	True	string	A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használandó API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Válaszok

Név	Típus	Description
200 OK	SharedPrivateLinkResource	A megosztott privát kapcsolat erőforrásának definícióját sikerült lekérni, és a válaszban szerepel.
Other Status Codes	CloudError	HTTP 404 (Nem található): Az előfizetés, az erőforráscsoport, a keresési szolgáltatás vagy a megosztott privát kapcsolat erőforrása nem található.

Biztonság

azure_auth

Implicit engedélyezési folyamatot határoz meg a Microsoft Identity platformon támogatott módon.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

SharedPrivateLinkResourceGet

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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
  }
}

Definíciók

Név	Description
CloudError	Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
SharedPrivateLinkResource	Az Azure AI Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrás leírása.
SharedPrivateLinkResourceProperties	Az Azure AI Search szolgáltatás által felügyelt meglévő megosztott privát kapcsolati erőforrás tulajdonságait ismerteti.
SharedPrivateLinkResourceProvisioningState	A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
SharedPrivateLinkResourceStatus	A megosztott privát kapcsolat erőforrásának állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

CloudError

Tárgy

Api-hibával kapcsolatos információkat tartalmaz.

Név	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
message	string	A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg a "error.message" tulajdonságot).

CloudErrorBody

Tárgy

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Név	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

SharedPrivateLinkResource

Tárgy

Az Azure AI Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrás leírása.

Név	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	SharedPrivateLinkResourceProperties	Az Azure AI Search szolgáltatás által felügyelt megosztott privát kapcsolatú erőforrás tulajdonságait ismerteti.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Tárgy

Az Azure AI Search szolgáltatás által felügyelt meglévő megosztott privát kapcsolati erőforrás tulajdonságait ismerteti.

Név	Típus	Description
groupId	string	Annak az erőforrásnak a csoportazonosítója, amelyre a megosztott privát kapcsolat erőforrása tartozik.
privateLinkResourceId	string	Annak az erőforrásnak az erőforrás-azonosítója, amelyre a megosztott privát kapcsolat erőforrása tartozik.
provisioningState	SharedPrivateLinkResourceProvisioningState	A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
requestMessage	string	A megosztott privát kapcsolat erőforrásának jóváhagyását kérő üzenet.
resourceRegion	string	Opcionális. Megadhatja annak az erőforrásnak az Azure Resource Manager-helyét, amelyhez megosztott privát hivatkozást hoz létre. Ez csak azokhoz az erőforrásokhoz szükséges, amelyek DNS-konfigurációja regionális (például Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	A megosztott privát kapcsolat erőforrásának állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

SharedPrivateLinkResourceProvisioningState

Felsorolás

A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.

Érték	Description
Updating	A megosztott privát kapcsolati erőforrás létrehozása folyamatban van a többi erőforrással együtt, hogy teljes mértékben működőképes legyen.
Deleting	A megosztott privát kapcsolat erőforrásának törlése folyamatban van.
Failed	A megosztott privát kapcsolat erőforrását nem sikerült kiépíteni vagy törölni.
Succeeded	A megosztott privát kapcsolat erőforrása befejezte a kiépítést, és készen áll a jóváhagyásra.
Incomplete	A megosztott privát kapcsolati erőforrásra vonatkozó kiépítési kérelmet elfogadták, de a létrehozási folyamat még nem kezdődött el.

SharedPrivateLinkResourceStatus

Felsorolás

A megosztott privát kapcsolat erőforrásának állapota. Az érvényes értékek függőben, jóváhagyva, elutasítva vagy leválasztva.

Érték	Description
Pending	A megosztott privát kapcsolat erőforrása létrejött, és jóváhagyásra vár.
Approved	A megosztott privát kapcsolat erőforrása jóvá van hagyva, és használatra kész.
Rejected	A megosztott privát kapcsolat erőforrása elutasítva, és nem használható.
Disconnected	A megosztott privát kapcsolat erőforrása el lett távolítva a szolgáltatásból.