Iot Dps Resource - Check Provisioning Service Name Availability

Service:

IoT Hub Device Provisioning Service

API Version:

2022-12-12

Sağlama hizmeti adının kullanılabilir olup olmadığını denetleyin. Bu, adın sağlam bir şekilde geçerli olup olmadığını ve adın kullanılabilir olup olmadığını doğrular

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
api-version	query	True	string	API'nin sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
name	True	string	Denetlenecek Sağlama Hizmeti'nin adı.

Yanıtlar

Name	Tür	Description
200 OK	NameAvailabilityInfo	Bu zaman uyumlu bir işlemdir. Gövde, sağlama hizmeti adının kullanılabilir olup olmadığını belirten JSON serileştirilmiş bir yanıt içerir. Ad kullanılamıyorsa, gövde nedeni içerir.
Other Status Codes	ErrorDetails	Varsayılan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

DPSCheckName

Sample Request

HTTP

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

{
  "name": "test213123"
}

Sample Response

Status code:

200

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

Tanımlar

Name	Description
ErrorDetails	Hata ayrıntıları.
NameAvailabilityInfo	Ad kullanılabilirliğinin açıklaması.
NameUnavailabilityReason	bir adın kullanılamama nedenini belirtir
OperationInputs	İşlem sonuçları çağrısı için giriş değerleri.

ErrorDetails

Hata ayrıntıları.

Name	Tür	Description
code	integer	Hata kodu.
details	string	Hata ayrıntıları.
httpStatusCode	string	HTTP durum kodu.
message	string	Hata iletisi.

NameAvailabilityInfo

Ad kullanılabilirliğinin açıklaması.

Name	Tür	Description
message	string	ayrıntılı bir neden adı içeren ileti kullanılamıyor
nameAvailable	boolean	bir adın kullanılabilir olup olmadığını belirtir
reason	NameUnavailabilityReason	bir adın kullanılamama nedenini belirtir

NameUnavailabilityReason

bir adın kullanılamama nedenini belirtir

Name	Tür	Description
AlreadyExists	string
Invalid	string

OperationInputs

İşlem sonuçları çağrısı için giriş değerleri.

Name	Tür	Description
name	string	Denetlenecek Sağlama Hizmeti'nin adı.