Query Keys - Create
Hiermee genereert u een nieuwe querysleutel voor de opgegeven zoekservice. U kunt maximaal 50 querysleutels per service maken.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2025-05-01URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
name
|
path | True |
string |
De naam van de nieuwe query-API-sleutel. |
|
resource
|
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. |
|
search
|
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. |
|
subscription
|
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 |
De querysleutel is gemaakt en staat in het antwoord. U kunt de querysleutel gebruiken als de waarde van de parameter 'api-key' in de REST API of SDK van de Azure AI Search-service om alleen-lezenbewerkingen uit te voeren op uw zoekindexen, zoals het uitvoeren van query's en het opzoeken van documenten op id. |
|
| Other Status Codes |
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
SearchCreateQueryKey
Voorbeeldaanvraag
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-05-01
Voorbeeldrespons
{
"name": "An API key granting read-only access to the documents collection of an index.",
"key": "<a query API key>"
}Definities
| Name | Description |
|---|---|
|
Cloud |
Bevat informatie over een API-fout. |
|
Cloud |
Beschrijft een bepaalde API-fout met een foutcode en een bericht. |
|
Query |
Beschrijft een API-sleutel voor een bepaalde Azure AI Search-service die alleen-lezenmachtigingen overbrengt voor de documentenverzameling van een index. |
CloudError
Bevat informatie over een API-fout.
| Name | Type | Description |
|---|---|---|
| error |
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
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 |
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). |
QueryKey
Beschrijft een API-sleutel voor een bepaalde Azure AI Search-service die alleen-lezenmachtigingen overbrengt voor de documentenverzameling van een index.
| Name | Type | Description |
|---|---|---|
| key |
string |
De waarde van de query-API-sleutel. |
| name |
string |
De naam van de query-API-sleutel. Querynamen zijn optioneel, maar als u een naam toewijst, kunt u onthouden hoe deze wordt gebruikt. |