Query Keys - List By Search Service

Szolgáltatás:: Search Management

API-verzió:: 2025-05-01

Az adott Azure AI Search 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=2025-05-01

URI-paraméterek

Név	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	A megadott erőforráscsoporthoz társított Azure AI Search szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem fejléce

Név	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

Név	Típus	Description
200 OK	ListQueryKeysResult	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

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

Hatókörök

Név	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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

Mintaválasz

Állapotkó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>"
    }
  ]
}

Definíciók

Név	Description
CloudError	Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
ListQueryKeysResult	Adott Azure AI Search szolgáltatás lekérdezési API-kulcsait tartalmazó válasz.
QueryKey	Egy adott Azure AI Search szolgáltatás API-kulcsát ismerteti, amely írásvédett engedélyeket ad át egy index dokumentumgyűjteményéhez.

CloudError

Tárgy

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

Név	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
message	string	A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg a "error.message" tulajdonságot).

CloudErrorBody

Tárgy

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

Név	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

ListQueryKeysResult

Tárgy

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

Név	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[]	Az Azure AI Search szolgáltatás lekérdezési kulcsai.

QueryKey

Tárgy

Egy adott Azure AI Search szolgáltatás API-kulcsát ismerteti, amely írásvédett engedélyeket ad át egy index dokumentumgyűjteményéhez.

Név	Típus	Description
key	string	A lekérdezési API-kulcs értéke.
name	string	A lekérdezési API-kulcs neve. A lekérdezésnevek megadása nem kötelező, de a név hozzárendelése segíthet emlékezni a használatukra.