Share via


Iot Hub Resource - Check Name Availability

Ellenőrizze, hogy elérhető-e IoT Hub-név.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

URI-paraméterek

Name In Kötelező Típus Description
subscriptionId
path True

string

Az előfizetés azonosítója.

api-version
query True

string

Az API verziója.

Kérelem törzse

Name Kötelező Típus Description
name True

string

Az ellenőrizni kívánt IoT Hub neve.

Válaszok

Name Típus Description
200 OK

IotHubNameAvailabilityInfo

Ez egy szinkron művelet. A törzs egy JSON-szerializált választ tartalmaz, amely meghatározza, hogy elérhető-e az IoT Hub neve. Ha a név nem érhető el, a törzs tartalmazza az okot.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Biztonság

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 felhasználói fiók megszemélyesítése

Példák

IotHubResource_CheckNameAvailability

Sample Request

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

{
  "name": "test-request"
}

Sample Response

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": ""
}

Definíciók

Name Description
ErrorDetails

Hiba részletei.

IotHubNameAvailabilityInfo

A tulajdonságok, amelyek azt jelzik, hogy elérhető-e egy adott IoT Hub-név.

IotHubNameUnavailabilityReason

Az elérhetetlenség oka.

OperationInputs

Bemeneti értékek.

ErrorDetails

Hiba részletei.

Name Típus Description
code

string

A hibakód.

details

string

A hiba részletei.

httpStatusCode

string

A HTTP-állapotkód.

message

string

A hibaüzenet.

IotHubNameAvailabilityInfo

A tulajdonságok, amelyek azt jelzik, hogy elérhető-e egy adott IoT Hub-név.

Name Típus Description
message

string

A részletes okról tájékoztató üzenet.

nameAvailable

boolean

Az érték, amely jelzi, hogy a megadott név elérhető-e.

reason

IotHubNameUnavailabilityReason

Az elérhetetlenség oka.

IotHubNameUnavailabilityReason

Az elérhetetlenség oka.

Name Típus Description
AlreadyExists

string

Invalid

string

OperationInputs

Bemeneti értékek.

Name Típus Description
name

string

Az ellenőrizni kívánt IoT Hub neve.