Services - Check Name Availability

Layanan:: Search Management

Versi API:: 2023-11-01

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=2023-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	Pengidentifikasi unik untuk langganan Microsoft Azure. Anda dapat memperoleh nilai ini dari API Azure Resource Manager, alat baris perintah, 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.

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	ResourceType	Jenis sumber daya yang namanya akan divalidasi. Nilai ini harus selalu 'searchServices'.

Respons

Nama	Jenis	Deskripsi
200 OK	CheckNameAvailabilityOutput	Pemeriksaan nama selesai. Respons berisi detail apakah nama valid dan tersedia. Jika nama tidak valid, respons juga berisi pesan yang menjelaskan mengapa tidak.
Other Status Codes	CloudError	HTTP 400 (Permintaan Buruk): Jenis sumber daya yang diberikan bukan 'searchServices'.

Keamanan

azure_auth

Alur otorisasi Microsoft Entra ID OAuth2.

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

HTTP

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/checkNameAvailability?api-version=2023-11-01

{
  "name": "mysearchservice",
  "type": "searchServices"
}

Respon sampel

Kode status:: 200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": ""
}

Definisi

Nama	Deskripsi
CheckNameAvailabilityInput	Input API ketersediaan nama pemeriksaan.
CheckNameAvailabilityOutput	Output api ketersediaan nama pemeriksaan.
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
ResourceType	Jenis sumber daya yang namanya akan divalidasi. Nilai ini harus selalu 'searchServices'.
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.

CheckNameAvailabilityInput

Objek

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	ResourceType	Jenis sumber daya yang namanya akan divalidasi. Nilai ini harus selalu 'searchServices'.

CheckNameAvailabilityOutput

Objek

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

CloudError

Objek

Berisi informasi tentang kesalahan API.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

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

ResourceType

Enumerasi

Jenis sumber daya yang namanya akan divalidasi. Nilai ini harus selalu 'searchServices'.

Nilai	Deskripsi
searchServices	'searchServices' adalah satu-satunya jenis sumber daya yang namanya dapat divalidasi.

UnavailableNameReason

Enumerasi

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.