Services - Check Name Availability
Memeriksa apakah nama layanan pencarian yang diberikan tersedia untuk digunakan atau tidak. Cari nama layanan harus unik secara global karena merupakan bagian dari URI layanan (https://< name.search.windows.net>).
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
|
subscription
|
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. |
Isi Permintaan
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| name | True |
string |
Nama layanan pencarian untuk divalidasi. Nama layanan pencarian hanya boleh berisi huruf kecil, digit, atau tanda hubung, tidak dapat menggunakan tanda hubung sebagai dua karakter pertama atau terakhir, tidak boleh berisi tanda hubung berturut-turut, dan panjangnya harus antara 2 dan 60 karakter. |
| type | True |
enum:
search |
Jenis sumber daya yang namanya akan divalidasi. Nilai ini harus selalu 'searchServices'. |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 OK |
Permintaan telah berhasil. |
|
| Other Status Codes |
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
SearchCheckNameAvailability
Permintaan sampel
Respon sampel
{
"message": "",
"nameAvailable": false,
"reason": "AlreadyExists"
}
Definisi
| Nama | Deskripsi |
|---|---|
|
Check |
Input API ketersediaan nama pemeriksaan. |
|
Check |
Output api ketersediaan nama pemeriksaan. |
|
Cloud |
Berisi informasi tentang kesalahan API. |
|
Cloud |
Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan. |
|
Unavailable |
Alasan mengapa nama tidak tersedia. 'Tidak valid' menunjukkan nama yang disediakan tidak cocok dengan persyaratan penamaan (panjang yang salah, karakter yang tidak didukung, dll.). 'AlreadyExists' menunjukkan bahwa nama sudah digunakan dan karenanya tidak tersedia. |
CheckNameAvailabilityInput
Input API ketersediaan nama pemeriksaan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| name |
string |
Nama layanan pencarian untuk divalidasi. Nama layanan pencarian hanya boleh berisi huruf kecil, digit, atau tanda hubung, tidak dapat menggunakan tanda hubung sebagai dua karakter pertama atau terakhir, tidak boleh berisi tanda hubung berturut-turut, dan panjangnya harus antara 2 dan 60 karakter. |
| type |
enum:
search |
Jenis sumber daya yang namanya akan divalidasi. Nilai ini harus selalu 'searchServices'. |
CheckNameAvailabilityOutput
Output api ketersediaan nama pemeriksaan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| message |
string |
Pesan yang menjelaskan mengapa nama tidak valid dan menyediakan persyaratan penamaan sumber daya. Tersedia hanya jika 'Tidak Valid' dikembalikan dalam properti 'alasan'. |
| nameAvailable |
boolean |
Nilai yang menunjukkan apakah nama tersedia. |
| reason |
Alasan mengapa nama tidak tersedia. 'Tidak valid' menunjukkan nama yang disediakan tidak cocok dengan persyaratan penamaan (panjang yang salah, karakter yang tidak didukung, dll.). 'AlreadyExists' menunjukkan bahwa nama sudah digunakan dan karenanya tidak tersedia. |
CloudError
Berisi informasi tentang kesalahan API.
| Nama | Jenis | Deskripsi |
|---|---|---|
| error |
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 |
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). |
UnavailableNameReason
Alasan mengapa nama tidak tersedia. 'Tidak valid' menunjukkan nama yang disediakan tidak cocok dengan persyaratan penamaan (panjang yang salah, karakter yang tidak didukung, dll.). 'AlreadyExists' menunjukkan bahwa nama sudah digunakan dan karenanya tidak tersedia.
| Nilai | Deskripsi |
|---|---|
| Invalid |
Nama layanan pencarian tidak cocok dengan persyaratan penamaan. |
| AlreadyExists |
Nama layanan pencarian sudah ditetapkan ke layanan pencarian yang berbeda. |