Private Endpoint Connections - Get
Získá podrobnosti o připojení privátního koncového bodu k vyhledávací službě v dané skupině prostředků.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-03-01-previewParametry identifikátoru URI
| Název | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
private
|
path | True |
string |
Název připojení privátního koncového bodu ke službě Azure AI Search se zadanou skupinou prostředků. |
|
resource
|
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. |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
Název služby Azure AI Search přidružené k zadané skupině prostředků. |
|
subscription
|
path | True |
string |
Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru 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 |
Definice připojení privátního koncového bodu byla úspěšně načtena a je v odpovědi. |
|
| Other Status Codes |
HTTP 404 (Nenalezena): Nepodařilo se najít připojení k předplatnému, skupině prostředků, vyhledávací službě nebo privátnímu koncovému bodu. |
Zabezpečení
azure_auth
Určuje implicitní tok udělení, který se podporuje na platformě Microsoft Identity Platform.
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
PrivateEndpointConnectionGet
Ukázkový požadavek
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2024-03-01-preview
Ukázková odpověď
{
"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"
}
}
}Definice
| Název | Description |
|---|---|
|
Cloud |
Obsahuje informace o chybě rozhraní API. |
|
Cloud |
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou. |
|
Private |
Prostředek privátního koncového bodu od poskytovatele Microsoft.Network. |
|
Private |
Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search. |
|
Private |
Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě. |
|
Private |
Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené. |
|
Private |
Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu. |
|
Private |
Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené. |
CloudError
Obsahuje informace o chybě rozhraní API.
| Název | Typ | Description |
|---|---|---|
| error |
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou. |
|
| message |
string |
Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message). |
CloudErrorBody
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 |
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ě). |
PrivateEndpoint
Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.
| Název | Typ | Description |
|---|---|---|
| id |
string |
ID prostředku prostředku privátního koncového bodu od poskytovatele Microsoft.Network. |
PrivateEndpointConnection
Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search.
| 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 |
Popisuje vlastnosti existujícího připojení privátního koncového bodu ke službě Azure AI Search. |
|
| type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
PrivateEndpointConnectionProperties
Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.
| Název | Typ | Description |
|---|---|---|
| groupId |
string |
ID skupiny prostředku Azure, pro který je služba private link určená. |
| privateEndpoint |
Prostředek privátního koncového bodu od poskytovatele Microsoft.Network. |
|
| privateLinkServiceConnectionState |
Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu. |
|
| provisioningState |
Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené. |
PrivateLinkServiceConnectionProvisioningState
Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.
| Hodnota | Description |
|---|---|
| Updating |
Připojení služby Private Link probíhá v procesu vytváření spolu s dalšími prostředky, aby bylo plně funkční. |
| Deleting |
Připojení služby Private Link probíhá v procesu odstranění. |
| Failed |
Připojení služby Private Link se nepodařilo zřídit nebo odstranit. |
| Succeeded |
Připojení služby Private Link dokončilo zřizování a je připravené ke schválení. |
| Incomplete |
Žádost o zřízení prostředku připojení služby Private Link byla přijata, ale proces vytvoření ještě nebyl zahájen. |
| Canceled |
Žádost o zřízení prostředku připojení služby Private Link byla zrušena. |
PrivateLinkServiceConnectionState
Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.
| Název | Typ | Default value | Description |
|---|---|---|---|
| actionsRequired |
string |
None |
Popis všech dodatečných akcí, které mohou být vyžadovány. |
| description |
string |
Popis stavu připojení služby Private Link. |
|
| status |
Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené. |
PrivateLinkServiceConnectionStatus
Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.
| Hodnota | Description |
|---|---|
| Pending |
Připojení privátního koncového bodu se vytvořilo a čeká na schválení. |
| Approved |
Připojení privátního koncového bodu je schválené a je připravené k použití. |
| Rejected |
Připojení privátního koncového bodu bylo odmítnuto a nelze ho použít. |
| Disconnected |
Připojení privátního koncového bodu bylo ze služby odebráno. |