Apps - Check Name Availability
Verificare se è disponibile un nome applicazione IoT Central.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
subscription
|
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'istanza dell'applicazione IoT Central da controllare. |
type |
string |
Tipo della risorsa IoT Central da eseguire una query. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Si tratta di un'operazione sincrona. Il corpo contiene una risposta serializzata JSON che specifica se il nome dell'applicazione IoT Central è disponibile. Se il nome non è disponibile, il corpo contiene il motivo. |
|
Other Status Codes |
DefaultErrorResponse |
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
Apps_CheckNameAvailability
Esempio di richiesta
Risposta di esempio
code: 200
{
"nameAvailable": true
}
{
"error": {
"code": "Error code",
"message": "Error message",
"target": "Error target"
}
}
Definizioni
Nome | Descrizione |
---|---|
App |
Le proprietà che indicano se è disponibile un determinato nome o sottodominio di IoT Central. |
Cloud |
Dettagli degli errori. |
Cloud |
Dettagli della risposta all'errore. |
Operation |
Valori di input. |
AppAvailabilityInfo
Le proprietà che indicano se è disponibile un determinato nome o sottodominio di IoT Central.
Nome | Tipo | Descrizione |
---|---|---|
message |
string |
Messaggio di motivo dettagliato. |
nameAvailable |
boolean |
Valore che indica se il nome specificato è disponibile. |
reason |
string |
Motivo dell'indisponibilità. |
CloudError
Dettagli degli errori.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore. |
error.details |
Elenco di dettagli aggiuntivi sull'errore. |
|
error.message |
string |
Messaggio di errore. |
error.target |
string |
Destinazione dell'errore specifico. |
CloudErrorBody
Dettagli della risposta all'errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
details |
Elenco di dettagli aggiuntivi sull'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore specifico. |
OperationInputs
Valori di input.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
name |
string |
Nome dell'istanza dell'applicazione IoT Central da controllare. |
|
type |
string |
IoTApps |
Tipo della risorsa IoT Central da eseguire una query. |