Admin Keys - Get
Mendapatkan kunci API admin primer dan sekunder untuk layanan pencarian yang ditentukan.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2023-11-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Nama grup sumber daya dalam langganan saat ini. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal. |
search
|
path | True |
string |
Nama layanan pencarian yang terkait dengan grup sumber daya yang ditentukan. |
subscription
|
path | True |
string |
Pengidentifikasi unik untuk langganan Microsoft Azure. Anda dapat memperoleh nilai ini dari Azure Resource Manager API, alat baris perintah, atau portal. |
api-version
|
query | True |
string |
Versi API yang 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 |
Kunci admin berhasil diambil dan berada dalam respons. Anda dapat menggunakan kunci primer atau sekunder sebagai nilai parameter 'api-key' di REST API bidang data atau Azure SDK 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 |
HTTP 404 (Tidak Ditemukan): Langganan, grup sumber daya, atau layanan pencarian tidak dapat ditemukan. HTTP 409 (Konflik): Langganan yang ditentukan dinonaktifkan. |
Keamanan
azure_auth
Microsoft Entra ID alur otorisasi OAuth2.
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
Respon sampel
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definisi
Nama | Deskripsi |
---|---|
Admin |
Respons yang berisi kunci API admin primer dan sekunder untuk layanan pencarian tertentu. |
Cloud |
Berisi informasi tentang kesalahan API. |
Cloud |
Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan. |
AdminKeyResult
Respons yang berisi kunci API admin primer dan sekunder untuk layanan pencarian tertentu.
Nama | Jenis | Deskripsi |
---|---|---|
primaryKey |
string |
Kunci API admin utama dari layanan pencarian. |
secondaryKey |
string |
Kunci API admin sekunder dari layanan pencarian. |
CloudError
Berisi informasi tentang kesalahan API.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan. |
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 |
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). |