Admin Keys - Regenerate

Tjänst:
Search Management
API-version:
2025-02-01-preview

Återskapar antingen den primära eller sekundära administratörs-API-nyckeln. Du kan bara återskapa en nyckel i taget.

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

URI-parametrar

Name I Obligatorisk Typ Description
keyKind
 path True

AdminKeyKind

Anger vilken nyckel som ska återskapas. Giltiga värden inkluderar "primär" och "sekundär".
resourceGroupName
 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.
searchServiceName
 path True

string

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

Namnet på azure AI Search-tjänsten som är associerad med den angivna resursgruppen.
subscriptionId
 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 det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name Typ Description
200 OK

AdminKeyResult

Den angivna administratörsnyckeln har återskapats. Båda administratörsnycklarna ingår i svaret, inklusive den nyligen återskapade nyckeln.
Other Status Codes

CloudError

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

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

SearchRegenerateAdminKey

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AdminKeyKind

Anger vilken nyckel som ska återskapas. Giltiga värden inkluderar "primär" och "sekundär".
AdminKeyResult

Svar som innehåller api-nycklarna för primär och sekundär administratör för en viss Azure AI Search-tjänst.
CloudError

Innehåller information om ett API-fel.
CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

AdminKeyKind

Uppräkning

Anger vilken nyckel som ska återskapas. Giltiga värden inkluderar "primär" och "sekundär".

Värde Description
primary

Den primära API-nyckeln för söktjänsten.
secondary

Den sekundära API-nyckeln för söktjänsten.

AdminKeyResult

Objekt

Svar som innehåller api-nycklarna för primär och sekundär administratör för en viss Azure AI Search-tjä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

Objekt

Innehåller information om ett API-fel.

Name Typ Description
error

CloudErrorBody

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

Objekt

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

CloudErrorBody[]

Innehåller kapslade fel som är relaterade till det här felet.
message

string

Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target

string

Målet för det specifika felet (till exempel namnet på egenskapen i fel).