Admin Keys - Get

Service:
Search Management
API-versie:
2026-11-01

Hiermee haalt u de primaire en secundaire beheer-API-sleutels op voor de opgegeven Azure AI Zoeken-service.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2026-11-01

URI-parameters

Naam In Vereist Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

De naam van de resource group. De naam is hoofdletterongevoelig.
searchServiceName
 path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

De naam van de Azure AI Zoeken-service die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId
 path True

string (uuid)

De ID van het doelabonnement. De waarde moet een UUID zijn.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Naam Vereist Type Description
x-ms-client-request-id

string (uuid)

Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Naam Type Description
200 OK

AdminKeyResult

Azure-operatie succesvol voltooid.
Other Status Codes

CloudError

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Naam Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

SearchGetAdminKeys

Voorbeeldaanvraag

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2026-11-01

Voorbeeldrespons

Statuscode:
200 
{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Definities

Naam Description
AdminKeyResult

Antwoord met de primaire en secundaire beheerders-API-sleutels voor een bepaalde Azure AI Zoeken-dienst.
CloudError

Bevat informatie over een API-fout.
CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

AdminKeyResult

Object

Antwoord met de primaire en secundaire beheerders-API-sleutels voor een bepaalde Azure AI Zoeken-dienst.

Naam Type Description
primaryKey

string

De primaire beheer-API-sleutel van de zoekservice.
secondaryKey

string

De secundaire beheer-API-sleutel van de zoekservice.

CloudError

Object

Bevat informatie over een API-fout.

Naam Type Description
error

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message

string

Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Naam Type Description
code

string

Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details

CloudErrorBody[]

Bevat geneste fouten die betrekking hebben op deze fout.
message

string

Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target

string

Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).