Query Keys - Create

Szolgáltatás:

Search Management

API-verzió:

2023-11-01

Létrehoz egy új lekérdezési kulcsot a megadott keresési szolgáltatáshoz. Szolgáltatásonként legfeljebb 50 lekérdezési kulcsot hozhat létre.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	Az új lekérdezési API-kulcs neve.
resourceGroupName	path	True	string	Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
searchServiceName	path	True	string	A megadott erőforráscsoporthoz társított keresési szolgáltatás neve.
subscriptionId	path	True	string	A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, parancssori eszközökből vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használni kívánt API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string uuid	Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Válaszok

Name	Típus	Description
200 OK	QueryKey	A lekérdezési kulcs létrehozása sikerült, és a válaszban szerepel. A lekérdezési kulcsot az "api-key" paraméter értékeként használhatja a REST API adatsíkban vagy egy Azure SDK-ban, hogy írásvédett műveleteket hajtson végre a keresési indexeken, például lekérdezheti és azonosító alapján megkeresheti a dokumentumokat.
Other Status Codes	CloudError	HTTP 404 (Nem található): Az előfizetés, az erőforráscsoport vagy a keresési szolgáltatás nem található. HTTP 409 (ütközés): A megadott előfizetés le van tiltva.

Biztonság

azure_auth

Microsoft Entra ID OAuth2 engedélyezési folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

SearchCreateQueryKey

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/Query key for browser-based clients?api-version=2023-11-01

Java

/**
 * Samples for QueryKeys Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchCreateQueryKey.json
     */
    /**
     * Sample code: SearchCreateQueryKey.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchCreateQueryKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getQueryKeys().createWithResponse("rg1", "mysearchservice",
            "Query key for browser-based clients", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

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="Query key for browser-based clients",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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

Go

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/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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", "Query key for browser-based clients", &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("Query key for browser-based clients"),
	// 	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

JavaScript

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/stable/2023-11-01/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 = "Query key for browser-based clients";
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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 = "Query key for browser-based clients";
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

Mintaválasz

Állapotkód:

200

{
  "name": "Query key for browser-based clients",
  "key": "<a query API key>"
}

Definíciók

Name	Description
CloudError	API-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le hibakóddal és üzenettel.
QueryKey	Egy adott keresési szolgáltatás API-kulcsát ismerteti, amely csak a lekérdezési műveletekhez rendelkezik engedélyekkel.

CloudError

API-hibával kapcsolatos információkat tartalmaz.

Name	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le hibakóddal és üzenettel.

CloudErrorBody

Egy adott API-hibát ír le hibakóddal és üzenettel.

Name	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaesetek programozott kezelésére használható.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat nyújt.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

QueryKey

Egy adott keresési szolgáltatás API-kulcsát ismerteti, amely csak a lekérdezési műveletekhez rendelkezik engedélyekkel.

Name	Típus	Description
key	string	A lekérdezési API-kulcs értéke.
name	string	A lekérdezési API-kulcs neve; lehet, hogy üres.