Iot Dps Resource - Check Provisioning Service Name Availability

Referensi

Layanan:: IoT Hub Device Provisioning Service

Versi API:: 2022-12-12

Periksa apakah nama layanan provisi tersedia. Ini akan memvalidasi apakah namanya valid secara sintaksis dan jika nama tersebut dapat digunakan

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
name	True	string	Nama Layanan Provisi yang akan diperiksa.

Respons

Nama	Jenis	Deskripsi
200 OK	NameAvailabilityInfo	Ini adalah operasi sinkron. Isi berisi respons berseri JSON yang menentukan apakah nama layanan provisi tersedia. Jika nama tidak tersedia, isi berisi alasannya.
Other Status Codes	ErrorDetails	Respons kesalahan default.

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

DPSCheckName

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

{
  "name": "test213123"
}

Respon sampel

Kode status:: 200

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": "name is valid"
}

Definisi

Nama	Deskripsi
ErrorDetails	Detail kesalahan.
NameAvailabilityInfo	Deskripsi ketersediaan nama.
NameUnavailabilityReason	menentukan alasan nama tidak tersedia
OperationInputs	Nilai input untuk panggilan hasil operasi.

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
code	integer	Kode kesalahan.
details	string	Detail kesalahan.
httpStatusCode	string	Kode status HTTP.
message	string	Pesan kesalahan.

NameAvailabilityInfo

Deskripsi ketersediaan nama.

Nama	Jenis	Deskripsi
message	string	pesan yang berisi nama alasan terperinci tidak tersedia
nameAvailable	boolean	menentukan apakah nama tersedia atau tidak
reason	NameUnavailabilityReason	menentukan alasan nama tidak tersedia

NameUnavailabilityReason

menentukan alasan nama tidak tersedia

Nama	Jenis	Deskripsi
AlreadyExists	string
Invalid	string

OperationInputs

Nilai input untuk panggilan hasil operasi.

Nama	Jenis	Deskripsi
name	string	Nama Layanan Provisi yang akan diperiksa.

Bagikan melalui