Query Keys - List By Search Service

Layanan:: Search Management

Versi API:: 2025-05-01

Mengembalikan daftar kunci API kueri untuk layanan Pencarian Azure AI yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nama layanan Azure AI Search yang terkait dengan grup sumber daya yang ditentukan.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string (uuid)	Nilai GUID yang dihasilkan klien yang mengidentifikasi permintaan ini. Jika ditentukan, ini akan disertakan dalam informasi respons sebagai cara untuk melacak permintaan.

Respons

Nama	Jenis	Deskripsi
200 OK	ListQueryKeysResult	Operasi Azure berhasil diselesaikan.
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Respon sampel

Kode status:: 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>"
    }
  ]
}

Definisi

Nama	Deskripsi
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
ListQueryKeysResult	Respons yang berisi kunci API kueri untuk layanan Pencarian Azure AI tertentu.
QueryKey	Menjelaskan kunci API untuk layanan Pencarian Azure AI tertentu yang menyampaikan izin baca-saja pada kumpulan dokumen indeks.

CloudError

Objek

Berisi informasi tentang kesalahan API.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
message	string	Deskripsi singkat tentang kesalahan yang mengisyaratkan apa yang salah (untuk informasi detail/penelusuran kesalahan merujuk ke properti 'error.message').

CloudErrorBody

Objek

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.
details	CloudErrorBody[]	Berisi kesalahan berlapis yang terkait dengan kesalahan ini.
message	string	Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.
target	string	Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

ListQueryKeysResult

Objek

Respons yang berisi kunci API kueri untuk layanan Pencarian Azure AI tertentu.

Nama	Jenis	Deskripsi
nextLink	string	URL permintaan yang dapat digunakan untuk mengkueri halaman kunci kueri berikutnya. Dikembalikan ketika jumlah total kunci kueri yang diminta melebihi ukuran halaman maksimum.
value	QueryKey[]	Kunci kueri untuk layanan Azure AI Search.

QueryKey

Objek

Menjelaskan kunci API untuk layanan Pencarian Azure AI tertentu yang menyampaikan izin baca-saja pada kumpulan dokumen indeks.

Nama	Jenis	Deskripsi
key	string	Nilai kunci API kueri.
name	string	Nama kunci API kueri. Nama kueri bersifat opsional, tetapi menetapkan nama dapat membantu Anda mengingat cara menggunakannya.