Query Keys - List By Search Service

Referencia

Szolgáltatás:: Search Management

API-verzió:: 2023-11-01

Az adott keresési szolgáltatás lekérdezési API-kulcsainak listáját adja vissza.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
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, a parancssori eszközökből vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használandó 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	ListQueryKeysResult	Az adott keresési szolgáltatás összes lekérdezési kulcsa sikeresen le lett kérve, és a válaszban szerepel. A lekérdezési kulcsok bármelyikét használhatja az "api-key" paraméter értékeként az adatsík REST API-jában vagy egy Azure SDK-ban, hogy írásvédett műveleteket hajtson végre a keresési indexek dokumentumgyűjteményén, például a dokumentumok azonosító alapján történő lekérdezéséhez és kereséséhez.
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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Példák

SearchListQueryKeysBySearchService

Sample request

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


/** 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

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

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

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

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>"
    }
  ]
}

Definíciók

Name	Description
CloudError	Egy API-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ismertet hibakóddal és üzenettel.
ListQueryKeysResult	Adott keresési szolgáltatás lekérdezési API-kulcsait tartalmazó válasz.
QueryKey	Egy olyan API-kulcsot ismertet egy adott keresési szolgáltatáshoz, amely csak lekérdezési műveletekhez rendelkezik engedélyekkel.

CloudError

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

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

CloudErrorBody

Egy adott API-hibát ismertet hibakóddal és üzenettel.

Name	Típus	Description
code	string	Egy hibakód, amely pontosabban írja le a hibaállapotot, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon lehet kezelni.
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 tartalmaz.
target	string	Az adott hiba célja (például a hibás tulajdonság neve).

ListQueryKeysResult

Adott keresési szolgáltatás lekérdezési API-kulcsait tartalmazó válasz.

Name	Típus	Description
nextLink	string	Kérelem URL-címe, amely a lekérdezési kulcsok következő oldalának lekérdezéséhez használható. Akkor adja vissza, ha a kért lekérdezési kulcsok teljes száma meghaladja a maximális oldalméretet.
value	QueryKey[]	A keresési szolgáltatás lekérdezési kulcsai.

QueryKey

Egy olyan API-kulcsot ismertet egy adott keresési szolgáltatáshoz, amely csak 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.