Delen via

Admin Keys - Get

Service:
Search Management
API-versie:
2025-05-01

Hiermee haalt u de primaire en secundaire api-sleutels voor de opgegeven Azure AI Search-service op.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName
 path True

string

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

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

string

De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
api-version
 query True

string

De API-versie die voor elke aanvraag moet worden gebruikt.

Aanvraagkoptekst

Name 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

Name Type Description
200 OK

AdminKeyResult

De beheerderssleutels zijn opgehaald en staan in het antwoord. U kunt de primaire of secundaire sleutel gebruiken als de waarde van de parameter 'api-key' in de REST API van de Azure AI Search-service of SDK om bewerkingen uit te voeren op uw zoekservice, inclusief bevoegde bewerkingen. Bevoegde bewerkingen omvatten het beheren van resources, zoals indexen en gegevensbronnen, en het uploaden, wijzigen of verwijderen van gegevens in uw indexen.
Other Status Codes

CloudError

HTTP 404 (niet gevonden): het abonnement, de resourcegroep of de zoekservice is niet gevonden. HTTP 409 (conflict): het opgegeven abonnement is uitgeschakeld.

Beveiliging

azure_auth

Hiermee geeft u een impliciete toekenningsstroom op, zoals ondersteund op het Microsoft Identity-platform.

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

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

SearchGetAdminKeys

Voorbeeldaanvraag

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2025-05-01

Voorbeeldrespons

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

Definities

Name Description
AdminKeyResult

Antwoord met de primaire en secundaire beheerders-API-sleutels voor een bepaalde Azure AI Search-service.
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 Search-service.

Name 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.

Name 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.

Name 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).