Query Keys - List By Search Service

Služba:: Search Management

Verze rozhraní API:: 2025-05-01

Vrátí seznam klíčů rozhraní API dotazu pro danou službu Azure AI Search.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Název služby Azure AI Search přidružené k zadané skupině prostředků.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Odpovědi

Name	Typ	Description
200 OK	ListQueryKeysResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

SearchListQueryKeysBySearchService

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2025-05-01

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/v2"
)

// Generated from example definition: 2025-05-01/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("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewQueryKeysClient().NewListBySearchServicePager("rg1", "mysearchservice", 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 = armsearch.QueryKeysClientListBySearchServiceResponse{
		// 	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

Ukázková odpověď

Stavový kód:: 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 dotazu pro danou službu Azure AI Search
QueryKey	Popisuje klíč rozhraní API pro danou službu Azure AI Search, která vyjadřuje oprávnění jen pro čtení v kolekci dokumentů indexu.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
message	string	Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Objekt

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

Name	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
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

Objekt

Odpověď obsahující klíče rozhraní API dotazu pro danou službu Azure AI Search

Name	Typ	Description
nextLink	string	Adresa URL požadavku, která se dá použít k dotazování na další stránku klíčů dotazu. 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 službu Azure AI Search.

QueryKey

Objekt

Popisuje klíč rozhraní API pro danou službu Azure AI Search, která vyjadřuje oprávnění jen pro čtení v kolekci dokumentů indexu.

Name	Typ	Description
key	string	Hodnota klíče rozhraní API dotazu.
name	string	Název klíče rozhraní API dotazu. Názvy dotazů jsou volitelné, ale přiřazení názvu vám může pomoct zapamatovat si, jak se používá.