Query Keys - Create

Menghasilkan kunci kueri baru untuk layanan pencarian yang ditentukan. Anda dapat membuat hingga 50 kunci kueri per layanan.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
name
path True

string

Nama kunci API kueri baru.

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

QueryKey

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

SearchCreateQueryKey

Permintaan sampel

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2025-05-01

Respon sampel

{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

Definisi

Nama Deskripsi
CloudError

Berisi informasi tentang kesalahan API.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

QueryKey

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

CloudError

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

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).

QueryKey

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.