Generiert einen neuen Abfrageschlüssel für den angegebenen Suchdienst. Pro Dienst können Sie bis zu 50 Abfrageschlüssel erstellen.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2024-03-01-preview
URI-Parameter
| Name |
In |
Erforderlich |
Typ |
Beschreibung |
|
name
|
path |
True
|
string
|
Der Name des neuen Abfrage-API-Schlüssels.
|
|
resourceGroupName
|
path |
True
|
string
|
Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
|
|
searchServiceName
|
path |
True
|
string
|
Der Name der Azure AI-Suchdienst der angegebenen Ressourcengruppe zugeordnet.
RegEx-Muster: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
|
subscriptionId
|
path |
True
|
string
|
Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
|
|
api-version
|
query |
True
|
string
|
Die API-Version, die für jede Anforderung verwendet werden soll.
|
| Name |
Erforderlich |
Typ |
Beschreibung |
|
x-ms-client-request-id
|
|
string
uuid
|
Ein vom Client generierter GUID-Wert zur Identifizierung dieser Anforderung. Falls angegeben, wird dies in die Antwortinformationen aufgenommen, um die Anforderung nachzuverfolgen.
|
Antworten
| Name |
Typ |
Beschreibung |
|
200 OK
|
QueryKey
|
Der Abfrageschlüssel wurde erfolgreich erstellt und befindet sich in der Antwort. Sie können den Abfrageschlüssel als Wert des Parameters "api-key" in der Azure AI-Suchdienst REST-API oder im SDK verwenden, um schreibgeschützte Vorgänge für Ihre Suchindizes auszuführen, z. B. Abfragen und Suchen von Dokumenten nach ID.
|
|
Other Status Codes
|
CloudError
|
HTTP 404 (Nicht gefunden): Das Abonnement, die Ressourcengruppe oder der Suchdienst konnte nicht gefunden werden. HTTP 409 (Konflikt): Das angegebene Abonnement ist deaktiviert.
|
Sicherheit
azure_auth
Gibt einen impliziten Gewährungsflow an, der auf der Microsoft Identity Platform unterstützt wird.
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/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=2024-03-01-preview
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_create_query_key.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.query_keys.create(
resource_group_name="rg1",
search_service_name="mysearchservice",
name="An API key granting read-only access to the documents collection of an index.",
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCreateQueryKey.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCreateQueryKey.json
func ExampleQueryKeysClient_Create() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQueryKeysClient().Create(ctx, "rg1", "mysearchservice", "An API key granting read-only access to the documents collection of an index.", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.QueryKey = armsearch.QueryKey{
// Name: to.Ptr("An API key granting read-only access to the documents collection of an index."),
// Key: to.Ptr("<a query API key>"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Generates a new query key for the specified search service. You can create up to 50 query keys per service.
*
* @summary Generates a new query key for the specified search service. You can create up to 50 query keys per service.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCreateQueryKey.json
*/
async function searchCreateQueryKey() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const name = "An API key granting read-only access to the documents collection of an index.";
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.queryKeys.create(resourceGroupName, searchServiceName, name);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCreateQueryKey.json
// this example is just showing the usage of "QueryKeys_Create" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
string name = "An API key granting read-only access to the documents collection of an index.";
SearchServiceQueryKey result = await searchService.CreateQueryKeyAsync(name);
Console.WriteLine($"Succeeded: {result}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Beispiel für eine Antwort
{
"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 eine bestimmte Azure KI-Suchdienst, der schreibgeschützte Berechtigungen für die Dokumentationssammlung eines Indexes übermittelt.
|
CloudError
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, die darauf hinweist, was schief gelaufen ist (ausführliche Informationen zum Debuggen finden Sie in der Eigenschaft "error.message").
|
CloudErrorBody
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-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
|
|
details
|
CloudErrorBody[]
|
Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.
|
|
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
Beschreibt einen API-Schlüssel für eine bestimmte Azure KI-Suchdienst, der schreibgeschützte Berechtigungen für die Dokumentationssammlung eines Indexes übermittelt.
| 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 daran zu erinnern, wie er verwendet wird.
|