Freigeben über

Query Keys - Create

Dienst:
Search Management
API-Version:
2025-05-01

Generiert einen neuen Abfrageschlüssel für den angegebenen Suchdienst. Sie können bis zu 50 Abfrageschlüssel pro Dienst erstellen.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
name
 path True

string

Der Name des neuen Abfrage-API-Schlüssels.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
searchServiceName
 path True

string

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

Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
subscriptionId
 path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string (uuid)

Ein vom Client generierter GUID-Wert, der diese Anforderung identifiziert. Wenn angegeben, wird dies in Antwortinformationen eingeschlossen, um die Anforderung nachzuverfolgen.

Antworten

Name Typ Beschreibung
200 OK

QueryKey

Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes

CloudError

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

SearchCreateQueryKey

Beispielanforderung

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CloudError

Enthält Informationen zu einem API-Fehler.
CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
QueryKey

Beschreibt einen API-Schlüssel für einen bestimmten Azure AI Search-Dienst, der schreibgeschützte Berechtigungen für die Docs-Auflistung eines Indexes vermittelt.

CloudError

Objekt

Enthält Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
message

string

Eine kurze Beschreibung des Fehlers, der darauf hinweist, was schief gelaufen ist (details/Debugginginformationen beziehen sich auf die Eigenschaft "error.message").

CloudErrorBody

Objekt

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details

CloudErrorBody[]

Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
message

string

Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target

string

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

QueryKey

Objekt

Beschreibt einen API-Schlüssel für einen bestimmten Azure AI Search-Dienst, der schreibgeschützte Berechtigungen für die Docs-Auflistung eines Indexes vermittelt.

Name Typ Beschreibung
key

string

Der Wert des Abfrage-API-Schlüssels.
name

string

Der Name des Abfrage-API-Schlüssels. Abfragenamen sind optional, aber das Zuweisen eines Namens kann Ihnen helfen, sich zu merken, wie sie verwendet wird.