Share via


Iot Hub Resource - Check Name Availability

Controllare se è disponibile un nome dell'hub IoT.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione dell'API.

Corpo della richiesta

Nome Necessario Tipo Descrizione
name True

string

Nome dell'hub IoT da controllare.

Risposte

Nome Tipo Descrizione
200 OK

IotHubNameAvailabilityInfo

Si tratta di un'operazione sincrona. Il corpo contiene una risposta serializzata JSON che specifica se il nome dell'hub IoT è disponibile. Se il nome non è disponibile, il corpo contiene il motivo.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

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": ""
}

Definizioni

Nome Descrizione
ErrorDetails

Dettagli errore.

IotHubNameAvailabilityInfo

Proprietà che indicano se è disponibile un determinato nome dell'hub IoT.

IotHubNameUnavailabilityReason

Motivo dell'indisponibilità.

OperationInputs

Valori di input.

ErrorDetails

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore.

details

string

Dettagli dell'errore.

httpStatusCode

string

Codice di stato HTTP.

message

string

Messaggio di errore.

IotHubNameAvailabilityInfo

Proprietà che indicano se è disponibile un determinato nome dell'hub IoT.

Nome Tipo Descrizione
message

string

Messaggio motivo dettagliato.

nameAvailable

boolean

Valore che indica se il nome specificato è disponibile.

reason

IotHubNameUnavailabilityReason

Motivo dell'indisponibilità.

IotHubNameUnavailabilityReason

Motivo dell'indisponibilità.

Nome Tipo Descrizione
AlreadyExists

string

Invalid

string

OperationInputs

Valori di input.

Nome Tipo Descrizione
name

string

Nome dell'hub IoT da controllare.