Admin Keys - Get

Layanan:: Search Management

Versi API:: 2025-02-01-preview

Mendapatkan kunci API admin utama dan sekunder untuk layanan Azure AI Search yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan saat ini. Anda dapat memperoleh nilai ini dari API Azure Resource Manager atau portal.
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	Pengidentifikasi unik untuk langganan Microsoft Azure. Anda dapat memperoleh nilai ini dari API Azure Resource Manager atau portal.
api-version	query	True	string	Versi API yang akan digunakan untuk setiap permintaan.

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	AdminKeyResult	Kunci admin berhasil diambil dan berada dalam respons. Anda dapat menggunakan kunci primer atau sekunder sebagai nilai parameter 'api-key' di REST API atau SDK layanan Pencarian Azure AI untuk melakukan operasi apa pun pada layanan pencarian Anda, termasuk operasi istimewa. Operasi istimewa termasuk mengelola sumber daya seperti indeks dan sumber data serta mengunggah, memodifikasi, atau menghapus data dalam indeks Anda.
Other Status Codes	CloudError	HTTP 404 (Tidak Ditemukan): Langganan, grup sumber daya, atau layanan pencarian tidak dapat ditemukan. HTTP 409 (Konflik): Langganan yang ditentukan dinonaktifkan.

Keamanan

azure_auth

Menentukan alur pemberian implisit, seperti yang didukung pada platform Identitas Microsoft.

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

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

SearchGetAdminKeys

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2025-02-01-preview

Respon sampel

Kode status:: 200

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Definisi

Nama	Deskripsi
AdminKeyResult	Respons yang berisi kunci API admin utama dan sekunder untuk layanan Pencarian Azure AI tertentu.
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

AdminKeyResult

Objek

Respons yang berisi kunci API admin utama dan sekunder untuk layanan Pencarian Azure AI tertentu.

Nama	Jenis	Deskripsi
primaryKey	string	Kunci API admin utama layanan pencarian.
secondaryKey	string	Kunci API admin sekunder dari layanan pencarian.

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