az iot central api-token

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.37.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot-zentralen API-Token-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Verwalten Sie API-Token für Ihre IoT Central-Anwendung.

IoT Central ermöglicht Es Ihnen, API-Token zu generieren und zu verwalten, die für den Zugriff auf die IoT Central-API verwendet werden. Weitere Informationen zu APIs finden Sie unter https://aka.ms/iotcentraldocsapi.

Befehle

Name Beschreibung Typ Status
az iot central api-token create

Generieren Sie ein API-Token, das Ihrer IoT Central-Anwendung zugeordnet ist.

Durchwahl Allgemein verfügbar
az iot central api-token delete

Löschen Sie ein API-Token, das Ihrer IoT Central-Anwendung zugeordnet ist.

Durchwahl Allgemein verfügbar
az iot central api-token list

Rufen Sie die Liste der API-Token ab, die Ihrer IoT Central-Anwendung zugeordnet sind.

Durchwahl Allgemein verfügbar
az iot central api-token show

Rufen Sie Details zu einem API-Token ab, das Ihrer IoT Central-Anwendung zugeordnet ist.

Durchwahl Allgemein verfügbar

az iot central api-token create

Generieren Sie ein API-Token, das Ihrer IoT Central-Anwendung zugeordnet ist.

Hinweis: Notieren Sie ihr Token, sobald es generiert wurde, da Sie es nicht mehr wieder abrufen können.

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]

Beispiele

Hinzufügen eines neuen API-Tokens

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--role -r

Die Rolle, die diesem Token oder Benutzer zugeordnet wird. Sie können eine der integrierten Rollen angeben oder die Rollen-ID einer benutzerdefinierten Rolle angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

Die ioT Central ID, die diesem Token zugeordnet ist, [0-9a-zA-Z-] zulässig, maximale Längenbeschränkung auf 40. Geben Sie eine ID an, die Sie dann verwenden, wenn Sie dieses Token später über die CLI oder API ändern oder löschen.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Zulässige Werte: 2022-06-30-preview, 2022-07-31
Standardwert: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--org-id --organization-id

Die ID der Organisation für die Tokenrollenzuweisung. Nur für api-version verfügbar == 1.1-preview.

--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central api-token delete

Löschen Sie ein API-Token, das Ihrer IoT Central-Anwendung zugeordnet ist.

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

Beispiele

Löschen eines API-Tokens

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--tkid --token-id

Die ioT Central ID, die diesem Token zugeordnet ist, [0-9a-zA-Z-] zulässig, maximale Längenbeschränkung auf 40. Geben Sie eine ID an, die Sie dann verwenden, wenn Sie dieses Token später über die CLI oder API ändern oder löschen.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Zulässige Werte: 2022-06-30-preview, 2022-07-31
Standardwert: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central api-token list

Rufen Sie die Liste der API-Token ab, die Ihrer IoT Central-Anwendung zugeordnet sind.

Informationen in der Liste enthalten grundlegende Informationen zu den Token in der Anwendung und enthalten keine Tokenwerte.

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

Beispiele

Liste der API-Token

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Zulässige Werte: 2022-06-30-preview, 2022-07-31
Standardwert: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central api-token show

Rufen Sie Details zu einem API-Token ab, das Ihrer IoT Central-Anwendung zugeordnet ist.

Listen Sie Details wie die zugehörige Rolle für ein API-Token in Ihrer IoT Central-App auf.

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

Beispiele

API-Token abrufen

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--tkid --token-id

Die ioT Central ID, die diesem Token zugeordnet ist, [0-9a-zA-Z-] zulässig, maximale Längenbeschränkung auf 40. Geben Sie eine ID an, die Sie dann verwenden, wenn Sie dieses Token später über die CLI oder API ändern oder löschen.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Dieser Befehlsparameter ist veraltet und wird ignoriert. In der zukünftigen Version werden wir nur IoT Central APIs von der neuesten GA-Version unterstützen. Wenn eine API noch nicht GA ist, rufen wir die neueste Vorschauversion auf.

Zulässige Werte: 2022-06-30-preview, 2022-07-31
Standardwert: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.