Iot Dps Resource - Check Provisioning Service Name Availability

Riferimento

Servizio:: IoT Hub Device Provisioning Service

Versione API:: 2022-12-12

Verificare se è disponibile un nome del servizio di provisioning. Questa convalida verrà convalidata se il nome è sintatticamente valido e se il nome è utilizzabile

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

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 del servizio di provisioning da controllare.

Risposte

Nome	Tipo	Descrizione
200 OK	NameAvailabilityInfo	Si tratta di un'operazione sincrona. Il corpo contiene una risposta serializzata JSON che specifica se il nome del servizio di provisioning è disponibile. Se il nome non è disponibile, il corpo contiene il motivo.
Other Status Codes	ErrorDetails	Risposta di errore predefinita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

DPSCheckName

Esempio di richiesta

HTTP

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

{
  "name": "test213123"
}

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
ErrorDetails	Dettagli degli errori.
NameAvailabilityInfo	Descrizione della disponibilità dei nomi.
NameUnavailabilityReason	specifica il motivo per cui un nome non è disponibile
OperationInputs	Valori di input per la chiamata dei risultati dell'operazione.

ErrorDetails

Dettagli degli errori.

Nome	Tipo	Descrizione
code	integer	Codice di errore.
details	string	Dettagli dell'errore.
httpStatusCode	string	Codice di stato HTTP.
message	string	Messaggio di errore.

NameAvailabilityInfo

Descrizione della disponibilità dei nomi.

Nome	Tipo	Descrizione
message	string	messaggio contenente un nome di motivo dettagliato non è disponibile
nameAvailable	boolean	specifica se un nome è disponibile o meno
reason	NameUnavailabilityReason	specifica il motivo per cui un nome non è disponibile

NameUnavailabilityReason

specifica il motivo per cui un nome non è disponibile

Nome	Tipo	Descrizione
AlreadyExists	string
Invalid	string

OperationInputs

Valori di input per la chiamata dei risultati dell'operazione.

Nome	Tipo	Descrizione
name	string	Nome del servizio di provisioning da controllare.

Condividi tramite