az iot central api-token

  • Reference

Poznámka

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.37.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az iot central api-token . Přečtěte si další informace o rozšířeních.

Správa tokenů rozhraní API pro vaši aplikaci IoT Central

IoT Central umožňuje generovat a spravovat tokeny rozhraní API, které se použijí pro přístup k rozhraní IoT Central API. Další informace o rozhraních API najdete na adrese https://aka.ms/iotcentraldocsapi.

Příkazy

Name Description Typ Stav
az iot central api-token create

Vygenerujte token rozhraní API přidružený k vaší aplikaci IoT Central.

 Rozšíření GA
az iot central api-token delete

Odstraňte token rozhraní API přidružený k aplikaci IoT Central.

 Rozšíření GA
az iot central api-token list

Získejte seznam tokenů rozhraní API přidružených k vaší aplikaci IoT Central.

 Rozšíření GA
az iot central api-token show

Získejte podrobnosti o tokenu rozhraní API přidruženého k vaší aplikaci IoT Central.

 Rozšíření GA

az iot central api-token create

Vygenerujte token rozhraní API přidružený k vaší aplikaci IoT Central.

Poznámka: Po vygenerování tokenu si poznamenejte, protože ho nebudete moct znovu načíst.

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]

Příklady

Přidání nového tokenu rozhraní API

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

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--role -r

Role, která bude přidružená k tomuto tokenu nebo uživateli. Můžete zadat jednu z předdefinovaných rolí nebo zadat ID role vlastní role. Další informace najdete na adrese https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

ID IoT Central přidružené k tomuto tokenu [0-9a-zA-Z-] je povolené, maximální délka je 40. Zadejte ID, které pak použijete při úpravě nebo odstranění tohoto tokenu později prostřednictvím rozhraní příkazového řádku nebo rozhraní API.

Volitelné parametry

--api-version --av
Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

výchozí hodnota: azureiotcentral.com
--org-id --organization-id

ID organizace pro přiřazení role tokenu. K dispozici pouze pro api-version == 1.1-preview.

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot central api-token delete

Odstraňte token rozhraní API přidružený k aplikaci IoT Central.

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

Příklady

Odstranění tokenu rozhraní API

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

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--tkid --token-id

ID IoT Central přidružené k tomuto tokenu [0-9a-zA-Z-] je povolené, maximální délka je 40. Zadejte ID, které pak použijete při úpravě nebo odstranění tohoto tokenu později prostřednictvím rozhraní příkazového řádku nebo rozhraní API.

Volitelné parametry

--api-version --av
Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

výchozí hodnota: azureiotcentral.com
--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot central api-token list

Získejte seznam tokenů rozhraní API přidružených k vaší aplikaci IoT Central.

Informace v seznamu obsahují základní informace o tokenech v aplikaci a neobsahují hodnoty tokenů.

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

Příklady

Seznam tokenů rozhraní API

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

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

Volitelné parametry

--api-version --av
Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

výchozí hodnota: azureiotcentral.com
--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot central api-token show

Získejte podrobnosti o tokenu rozhraní API přidruženého k vaší aplikaci IoT Central.

Uveďte podrobnosti, jako je její přidružená role, pro token rozhraní API ve vaší aplikaci IoT Central.

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

Příklady

Získání tokenu rozhraní API

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

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--tkid --token-id

ID IoT Central přidružené k tomuto tokenu [0-9a-zA-Z-] je povolené, maximální délka je 40. Zadejte ID, které pak použijete při úpravě nebo odstranění tohoto tokenu později prostřednictvím rozhraní příkazového řádku nebo rozhraní API.

Volitelné parametry

--api-version --av
Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

výchozí hodnota: azureiotcentral.com
--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.