az iot central api-token

  • Riferimento

Nota

Questo riferimento fa parte dell'estensione azure-iot per l'interfaccia della riga di comando di Azure (versione 2.46.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot central api-token . Altre informazioni sulle estensioni.

Gestire i token API per l'applicazione IoT Central.

IoT Central consente di generare e gestire i token API da usare per accedere all'API IoT Central. Altre informazioni sulle API sono disponibili in https://aka.ms/iotcentraldocsapi.

Comandi

Nome Descrizione Tipo Status
az iot central api-token create

Generare un token API associato all'applicazione IoT Central.

 Estensione Disponibilità generale
az iot central api-token delete

Eliminare un token API associato all'applicazione IoT Central.

 Estensione Disponibilità generale
az iot central api-token list

Ottenere l'elenco dei token API associati all'applicazione IoT Central.

 Estensione Disponibilità generale
az iot central api-token show

Ottenere i dettagli per un token API associato all'applicazione IoT Central.

 Estensione Disponibilità generale

az iot central api-token create

Generare un token API associato all'applicazione IoT Central.

Nota: annotare il token dopo che è stato generato perché non sarà possibile recuperarlo di nuovo.

az iot central api-token create --app-id
                                --role
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--org-id]
                                [--token]

Esempio

Aggiungere un nuovo token API

az iot central api-token create --token-id {tokenId} --app-id {appId} --role admin

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

--role -r

Ruolo che verrà associato a questo token o utente. È possibile specificare uno dei ruoli predefiniti o specificare l'ID ruolo di un ruolo personalizzato. Per altre informazioni, vedere https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

ID IoT Central associato a questo token, [0-9a-zA-Z-] consentito, limite di lunghezza massima a 40. Specificare un ID che verrà quindi usato per modificare o eliminare questo token in un secondo momento tramite l'interfaccia della riga di comando o l'API.

Parametri facoltativi

--api-version --av
Deprecato

L'argomento 'api_version' è stato deprecato e verrà rimosso in una versione futura.

Questo parametro di comando è stato deprecato e verrà ignorato. Nella versione futura verranno supportate solo le API IoT Central dalla versione disponibile a livello generale più recente. Se un'API non è ancora disponibile a livello generale, verrà chiamata la versione di anteprima più recente.

Valori accettati: 2022-06-30-preview, 2022-07-31
Valore predefinito: 2022-07-31
--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

Valore predefinito: azureiotcentral.com
--org-id --organization-id

ID dell'organizzazione per l'assegnazione di ruolo del token. Disponibile solo per api-version == 1.1-preview.

--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot central api-token delete

Eliminare un token API associato all'applicazione IoT Central.

az iot central api-token delete --app-id
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--token]

Esempio

Eliminare un token API

az iot central api-token delete --app-id {appid} --token-id {tokenId}

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

--tkid --token-id

ID IoT Central associato a questo token, [0-9a-zA-Z-] consentito, limite di lunghezza massima a 40. Specificare un ID che verrà quindi usato per modificare o eliminare questo token in un secondo momento tramite l'interfaccia della riga di comando o l'API.

Parametri facoltativi

--api-version --av
Deprecato

L'argomento 'api_version' è stato deprecato e verrà rimosso in una versione futura.

Questo parametro di comando è stato deprecato e verrà ignorato. Nella versione futura verranno supportate solo le API IoT Central dalla versione disponibile a livello generale più recente. Se un'API non è ancora disponibile a livello generale, verrà chiamata la versione di anteprima più recente.

Valori accettati: 2022-06-30-preview, 2022-07-31
Valore predefinito: 2022-07-31
--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

Valore predefinito: azureiotcentral.com
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot central api-token list

Ottenere l'elenco dei token API associati all'applicazione IoT Central.

Le informazioni nell'elenco contengono informazioni di base sui token nell'applicazione e non includono i valori dei token.

az iot central api-token list --app-id
                              [--api-version {2022-06-30-preview, 2022-07-31}]
                              [--central-api-uri]
                              [--token]

Esempio

Elenco di token API

az iot central api-token list --app-id {appid}

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

Parametri facoltativi

--api-version --av
Deprecato

L'argomento 'api_version' è stato deprecato e verrà rimosso in una versione futura.

Questo parametro di comando è stato deprecato e verrà ignorato. Nella versione futura verranno supportate solo le API IoT Central dalla versione disponibile a livello generale più recente. Se un'API non è ancora disponibile a livello generale, verrà chiamata la versione di anteprima più recente.

Valori accettati: 2022-06-30-preview, 2022-07-31
Valore predefinito: 2022-07-31
--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

Valore predefinito: azureiotcentral.com
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az iot central api-token show

Ottenere i dettagli per un token API associato all'applicazione IoT Central.

Elencare i dettagli, ad esempio il ruolo associato, per un token API nell'app IoT Central.

az iot central api-token show --app-id
                              --tkid
                              [--api-version {2022-06-30-preview, 2022-07-31}]
                              [--central-api-uri]
                              [--token]

Esempio

Ottenere il token API

az iot central api-token show --app-id {appid} --token-id {tokenId}

Parametri necessari

--app-id -n

ID app dell'app IoT Central che si vuole gestire. È possibile trovare l'ID app nella pagina "Informazioni" per l'applicazione nel menu della Guida.

--tkid --token-id

ID IoT Central associato a questo token, [0-9a-zA-Z-] consentito, limite di lunghezza massima a 40. Specificare un ID che verrà quindi usato per modificare o eliminare questo token in un secondo momento tramite l'interfaccia della riga di comando o l'API.

Parametri facoltativi

--api-version --av
Deprecato

L'argomento 'api_version' è stato deprecato e verrà rimosso in una versione futura.

Questo parametro di comando è stato deprecato e verrà ignorato. Nella versione futura verranno supportate solo le API IoT Central dalla versione disponibile a livello generale più recente. Se un'API non è ancora disponibile a livello generale, verrà chiamata la versione di anteprima più recente.

Valori accettati: 2022-06-30-preview, 2022-07-31
Valore predefinito: 2022-07-31
--central-api-uri --central-dns-suffix

Suffisso DNS di IoT Central associato all'applicazione.

Valore predefinito: azureiotcentral.com
--token

Se si preferisce inviare la richiesta senza eseguire l'autenticazione nell'interfaccia della riga di comando di Azure, è possibile specificare un token utente valido per autenticare la richiesta. È necessario specificare il tipo di chiave come parte della richiesta. Per ulteriori informazioni, vedi https://aka.ms/iotcentraldocsapi.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
Valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.