Shared Private Link Resources - Get
Hämtar information om den delade privata länkresursen som hanteras av söktjänsten i den angivna resursgruppen.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2024-03-01-preview
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen. |
search
|
path | True |
string |
Namnet på Den Azure AI-tjänsten Search som är associerad med den angivna resursgruppen. Reguljärt uttrycksmönster: |
shared
|
path | True |
string |
Namnet på den delade privata länkresursen som hanteras av Azure AI-tjänsten Search i den angivna resursgruppen. |
subscription
|
path | True |
string |
Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen. |
api-version
|
query | True |
string |
DEN API-version som ska användas för varje begäran. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Ett klientgenererat GUID-värde som identifierar den här begäran. Om detta anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Definitionen av resursen för den delade privata länken har hämtats och finns i svaret. |
|
Other Status Codes |
HTTP 404 (hittades inte): Det gick inte att hitta prenumerationen, resursgruppen, söktjänsten eller den delade privata länkresursen. |
Säkerhet
azure_auth
Anger ett implicit beviljandeflöde som stöds på Microsoft Identity-plattformen.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
SharedPrivateLinkResourceGet
Exempelbegäran
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2024-03-01-preview
Exempelsvar
{
"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
}
}
Definitioner
Name | Description |
---|---|
Cloud |
Innehåller information om ett API-fel. |
Cloud |
Beskriver ett visst API-fel med en felkod och ett meddelande. |
Shared |
Beskriver en resurs för delad privat länk som hanteras av Azure AI-tjänsten Search. |
Shared |
Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI-tjänsten Search. |
Shared |
Etableringstillståndet för resursen för den delade privata länken. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig. |
Shared |
Status för resursen för den delade privata länken. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad. |
CloudError
Innehåller information om ett API-fel.
Name | Typ | Description |
---|---|---|
error |
Beskriver ett visst API-fel med en felkod och ett meddelande. |
|
message |
string |
En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message"). |
CloudErrorBody
Beskriver ett visst API-fel med en felkod och ett meddelande.
Name | Typ | Description |
---|---|---|
code |
string |
En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall. |
details |
Innehåller kapslade fel som är relaterade till det här felet. |
|
message |
string |
Ett meddelande som beskriver felet i detalj och innehåller felsökningsinformation. |
target |
string |
Målet för det specifika felet (till exempel namnet på egenskapen i fel). |
SharedPrivateLinkResource
Beskriver en resurs för delad privat länk som hanteras av Azure AI-tjänsten Search.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties |
Beskriver egenskaperna för en resurs för delad privat länk som hanteras av Azure AI-tjänsten Search. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
SharedPrivateLinkResourceProperties
Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI-tjänsten Search.
Name | Typ | Description |
---|---|---|
groupId |
string |
Grupp-ID:t från resursprovidern som den delade privata länkresursen är till för. |
privateLinkResourceId |
string |
Resurs-ID för resursen som den delade privata länkresursen är för. |
provisioningState |
Etableringstillståndet för resursen för den delade privata länken. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig. |
|
requestMessage |
string |
Meddelandet för att begära godkännande av resursen för delad privat länk. |
resourceRegion |
string |
Valfritt. Kan användas för att ange azure-Resource Manager plats för resursen som en delad privat länk skapas för. Detta krävs endast för de resurser vars DNS-konfiguration är regional (till exempel Azure Kubernetes Service). |
status |
Status för resursen för den delade privata länken. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad. |
SharedPrivateLinkResourceProvisioningState
Etableringstillståndet för resursen för den delade privata länken. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
Name | Typ | Description |
---|---|---|
Deleting |
string |
Resursen för den delade privata länken håller på att tas bort. |
Failed |
string |
Resursen för den delade privata länken kunde inte etableras eller tas bort. |
Incomplete |
string |
Etableringsbegäran för resursen för den delade privata länken har accepterats, men processen för att skapa har inte påbörjats ännu. |
Succeeded |
string |
Den delade privata länkresursen har slutfört etableringen och är redo för godkännande. |
Updating |
string |
Den delade privata länkresursen håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut. |
SharedPrivateLinkResourceStatus
Status för resursen för den delade privata länken. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.
Name | Typ | Description |
---|---|---|
Approved |
string |
Resursen för den delade privata länken är godkänd och är redo att användas. |
Disconnected |
string |
Resursen för den delade privata länken har tagits bort från tjänsten. |
Pending |
string |
Resursen för den delade privata länken har skapats och väntar på godkännande. |
Rejected |
string |
Resursen för den delade privata länken har avvisats och kan inte användas. |