Servers - Check Name Availability

Layanan:

SQL Database

Versi API:

2023-08-01

Menentukan apakah sumber daya dapat dibuat dengan nama yang ditentukan.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan untuk permintaan tersebut.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
name	True	string
type	True	CheckNameAvailabilityResourceType

Respons

Nama	Jenis	Deskripsi
200 OK	CheckNameAvailabilityResponse	Berhasil menyelesaikan pemeriksaan ketersediaan.
Other Status Codes	ErrorResponse	Respons Kesalahan: *** 400 InvalidNameAvailabilityRequest - Permintaan ketersediaan nama pemeriksaan tidak valid. 400 UnknownNameType - Jenis sumber daya tidak diketahui yang ditentukan untuk pemeriksaan ketersediaan nama tingkat langganan.

Contoh

Check for a server name that already exists

Check for a server name that is available

Check for a server name that is invalid

Check for a server name that already exists

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Respon sampel

Kode status:

200

{
  "name": "server1",
  "available": false,
  "reason": "AlreadyExists",
  "message": "Specified server name is already used"
}

Check for a server name that is available

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Respon sampel

Kode status:

200

{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

Respon sampel

Kode status:

200

{
  "name": "SERVER1",
  "available": false,
  "reason": "Invalid",
  "message": "Specified server name contains unsupported characters or is too long. Server name must be no longer than 63 characters long, contain only lower-case characters or digits, cannot contain '.' or '_' characters and can't start or end with '-' character."
}

Definisi

Nama	Deskripsi
CheckNameAvailabilityReason	Kode alasan yang menjelaskan mengapa nama tidak tersedia. Tidak akan ditentukan jika nama tersedia.
CheckNameAvailabilityRequest	Permintaan untuk memeriksa apakah nama yang ditentukan untuk sumber daya tersedia.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	Hasil pemeriksaan ketersediaan nama.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan

CheckNameAvailabilityReason

Enumerasi

Kode alasan yang menjelaskan mengapa nama tidak tersedia. Tidak akan ditentukan jika nama tersedia.

Nilai	Deskripsi
Invalid
AlreadyExists

CheckNameAvailabilityRequest

Objek

Permintaan untuk memeriksa apakah nama yang ditentukan untuk sumber daya tersedia.

Nama	Jenis	Deskripsi
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Enumerasi

Nilai	Deskripsi
Microsoft.Sql/servers

CheckNameAvailabilityResponse

Objek

Hasil pemeriksaan ketersediaan nama.

Nama	Jenis	Deskripsi
available	boolean	True jika nama tersedia, jika tidak salah.
message	string	Pesan yang menjelaskan mengapa nama tidak tersedia. Tidak akan ditentukan jika nama tersedia.
name	string	Nama yang ketersediaannya diperiksa.
reason	CheckNameAvailabilityReason	Kode alasan yang menjelaskan mengapa nama tidak tersedia. Tidak akan ditentukan jika nama tersedia.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.