Query Keys - Create

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

Genererar en ny frågenyckel för den angivna söktjänsten. Du kan skapa upp till 50 frågenycklar per tjänst.

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

URI-parametrar

Name I Obligatorisk Typ Description
name
 path True

string

Namnet på den nya fråge-API-nyckeln.
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

QueryKey

Frågenyckeln har skapats och finns i svaret. Du kan använda frågenyckeln som värdet för parametern "api-key" i Rest-API:et för Azure AI Search-tjänsten eller SDK för att utföra skrivskyddade åtgärder i dina sökindex, till exempel genom att fråga efter och leta upp dokument efter ID.
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

SearchCreateQueryKey

Exempelbegäran

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2025-02-01-preview

Exempelsvar

Statuskod:
200 
{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

Definitioner

Name Description
CloudError

Innehåller information om ett API-fel.
CloudErrorBody

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

Beskriver en API-nyckel för en viss Azure AI Search-tjänst som förmedlar skrivskyddade behörigheter för dokumentsamlingen för ett index.

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

QueryKey

Objekt

Beskriver en API-nyckel för en viss Azure AI Search-tjänst som förmedlar skrivskyddade behörigheter för dokumentsamlingen för ett index.

Name Typ Description
key

string

Värdet för fråge-API-nyckeln.
name

string

Namnet på fråge-API-nyckeln. Frågenamn är valfria, men om du tilldelar ett namn kan du komma ihåg hur det används.