Query Keys - List By Search Service

Service:

Search Management

API Version:

2023-11-01

Vrátí seznam klíčů rozhraní API pro dotazy pro danou vyhledávací službu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
searchServiceName	path	True	string	Název vyhledávací služby přidružené k zadané skupině prostředků.
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager, nástrojů příkazového řádku nebo portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	Hodnota identifikátoru GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadaný, bude součástí informací o odpovědi jako způsob, jak žádost sledovat.

Odpovědi

Name	Typ	Description
200 OK	ListQueryKeysResult	Všechny klíče dotazů pro danou vyhledávací službu byly úspěšně načteny a jsou v odpovědi. Libovolný klíč dotazu můžete použít jako hodnotu parametru api-key v rozhraní REST API roviny dat nebo v sadě Azure SDK k provádění operací jen pro čtení s kolekcí dokumentů vašich indexů vyhledávání, jako je dotazování a vyhledávání dokumentů podle ID.
Other Status Codes	CloudError	HTTP 404 (Nenalezena): Nepodařilo se najít předplatné, skupinu prostředků nebo vyhledávací službu. HTTP 409 (konflikt): Zadané předplatné je zakázané.

Zabezpečení

azure_auth

Microsoft Entra ID tok autorizace OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

SearchListQueryKeysBySearchService

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2023-11-01

Java

/** Samples for QueryKeys ListBySearchService. */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * SearchListQueryKeysBySearchService.json
     */
    /**
     * Sample code: SearchListQueryKeysBySearchService.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchListQueryKeysBySearchService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getQueryKeys().listBySearchService("rg1", "mysearchservice",
            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_list_query_keys_by_search_service.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.list_by_search_service(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListQueryKeysBySearchService.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/SearchListQueryKeysBySearchService.json
func ExampleQueryKeysClient_NewListBySearchServicePager() {
	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)
	}
	pager := clientFactory.NewQueryKeysClient().NewListBySearchServicePager("rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListQueryKeysResult = armsearch.ListQueryKeysResult{
		// 	Value: []*armsearch.QueryKey{
		// 		{
		// 			Name: to.Ptr("Query key for browser-based clients"),
		// 			Key: to.Ptr("<a query API key>"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Query key for mobile clients"),
		// 			Key: to.Ptr("<another 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 Returns the list of query API keys for the given Azure Cognitive Search service.
 *
 * @summary Returns the list of query API keys for the given Azure Cognitive Search service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListQueryKeysBySearchService.json
 */
async function searchListQueryKeysBySearchService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.queryKeys.listBySearchService(
    resourceGroupName,
    searchServiceName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/SearchListQueryKeysBySearchService.json
// this example is just showing the usage of "QueryKeys_ListBySearchService" 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 and iterate over the result
await foreach (SearchServiceQueryKey item in searchService.GetQueryKeysBySearchServiceAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another query API key>"
    }
  ]
}

Definice

Name	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
ListQueryKeysResult	Odpověď obsahující klíče rozhraní API pro dotazy pro danou vyhledávací službu
QueryKey	Popisuje klíč rozhraní API pro danou vyhledávací službu, který má oprávnění pouze pro operace dotazů.

CloudError

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které s touto chybou souvisejí.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

ListQueryKeysResult

Odpověď obsahující klíče rozhraní API pro dotazy pro danou vyhledávací službu

Name	Typ	Description
nextLink	string	Adresa URL požadavku, kterou je možné použít k dotazování další stránky klíčů dotazů. Vrátí se, když celkový počet požadovaných klíčů dotazu překročí maximální velikost stránky.
value	QueryKey[]	Klíče dotazu pro vyhledávací službu.

QueryKey

Popisuje klíč rozhraní API pro danou vyhledávací službu, který má oprávnění pouze pro operace dotazů.

Name	Typ	Description
key	string	Hodnota klíče rozhraní API pro dotazy.
name	string	Název klíče rozhraní API pro dotazy; může být prázdný.