Admin Keys - Get
Hämtar api-nycklarna för den primära och sekundära administratören för den angivna söktjänsten.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2023-11-01
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å söktjänsten som är associerad med 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, kommandoradsverktyg 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 |
Administratörsnycklarna har hämtats och finns i svaret. Du kan använda antingen den primära eller sekundära nyckeln som värdet för parametern "api-key" i rest-API:et för dataplanet eller en Azure SDK för att utföra åtgärder i söktjänsten, inklusive privilegierade åtgärder. Privilegierade åtgärder omfattar hantering av resurser som index och datakällor samt överföring, ändring eller borttagning av data i dina index. |
|
Other Status Codes |
HTTP 404 (hittades inte): Det gick inte att hitta prenumerationen, resursgruppen eller söktjänsten. HTTP 409 (konflikt): Den angivna prenumerationen är inaktiverad. |
Säkerhet
azure_auth
Microsoft Entra ID OAuth2-auktoriseringsflöde.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
SearchGetAdminKeys
Exempelbegäran
Exempelsvar
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definitioner
Name | Description |
---|---|
Admin |
Svar som innehåller de primära och sekundära api-nycklarna för administratörer för en viss söktjänst. |
Cloud |
Innehåller information om ett API-fel. |
Cloud |
Beskriver ett visst API-fel med en felkod och ett meddelande. |
AdminKeyResult
Svar som innehåller de primära och sekundära api-nycklarna för administratörer för en viss söktjänst.
Name | Typ | Description |
---|---|---|
primaryKey |
string |
Den primära administratörs-API-nyckeln för söktjänsten. |
secondaryKey |
string |
Den sekundära administratörs-API-nyckeln för söktjänsten. |
CloudError
Innehåller information om ett API-fel.
Name | Typ | Description |
---|---|---|
error |
Beskriver ett visst API-fel med en felkod och ett meddelande. |
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). |