az iot central enrollment-group

  • Reference

Poznámka:

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

Správa a konfigurace skupiny registrací IoT Central

Příkazy

Name Description Typ Stav
az iot central enrollment-group create

Vytvořte skupinu registrací.

 Rozšíření GA
az iot central enrollment-group delete

Odstraňte skupinu registrací podle ID.

 Rozšíření GA
az iot central enrollment-group generate-verification-code

Vygenerujte ověřovací kód pro primární nebo sekundární certifikát x509 skupiny registrací.

 Rozšíření GA
az iot central enrollment-group list

Získejte seznam skupin registrací v aplikaci.

 Rozšíření GA
az iot central enrollment-group show

Získejte podrobnosti o skupině registrací podle ID.

 Rozšíření GA
az iot central enrollment-group update

Aktualizujte skupinu registrací.

 Rozšíření GA
az iot central enrollment-group verify-certificate

Ověřte primární nebo sekundární certifikát x509 skupiny registrací.

 Rozšíření GA

az iot central enrollment-group create

Vytvořte skupinu registrací.

az iot central enrollment-group create --app-id
                                       --at {symmetricKey, x509}
                                       --display-name
                                       --group-id
                                       --type
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-path]
                                       [--etag]
                                       [--pk]
                                       [--provisioning-status {disabled, enabled}]
                                       [--scp]
                                       [--secondary-key]
                                       [--token]

Příklady

Vytvoření skupiny registrací

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

Vytvoření skupiny registrací s primární certifikací x509

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

Vytvoření skupiny registrací s danou certifikací symetrického klíče

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

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.

--at --attestation-type

Mechanismus ověření identity pro skupinu registrací. Jsou povoleny pouze hodnoty x509 nebo symmetricKey. Ve výchozím nastavení se pro ověření identity použije symetrický klíč.

Přípustné hodnoty: symmetricKey, x509
Default value: symmetricKey
--display-name

Zobrazovaný název skupiny registrací

--group-id --id

Jedinečný identifikátor skupiny registrací.

--type

Typ zařízení, která se připojují přes skupinu

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řípustné hodnoty: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

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

Default value: azureiotcentral.com
--certificate-path --cp

Cesta k souboru obsahujícímu primární certifikát.

--etag -e

Značka Etag nebo značka entity odpovídající poslednímu stavu prostředku. Pokud není k dispozici žádná značka etag, použije se hodnota *.

--pk --primary-key

Primární symetrický sdílený přístupový klíč uložený ve formátu base64.

--provisioning-status --ps

Určuje, jestli se zařízení používající skupinu můžou připojit ke službě IoT Central. Ano nebo ne

Přípustné hodnoty: disabled, enabled
Default value: enabled
--scp --secondary-certificate-path

Cesta k souboru obsahujícímu sekundární certifikát.

--secondary-key --sk

Sekundární symetrický sdílený přístupový klíč uložený ve formátu base64.

--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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: 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 enrollment-group delete

Odstraňte skupinu registrací podle ID.

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

Příklady

Odstranění skupiny registrací podle ID

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

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.

--group-id --id

Jedinečný identifikátor skupiny registrací.

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řípustné hodnoty: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

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

Default value: 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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: 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 enrollment-group generate-verification-code

Vygenerujte ověřovací kód pro primární nebo sekundární certifikát x509 skupiny registrací.

az iot central enrollment-group generate-verification-code --app-id
                                                           --group-id
                                                           [--api-version {2022-06-30-preview, 2022-07-31}]
                                                           [--central-api-uri]
                                                           [--certificate-entry {primary, secondary}]
                                                           [--token]

Příklady

Vygenerování ověřovacího kódu pro primární certifikát x509 skupiny registrací

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

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.

--group-id --id

Jedinečný identifikátor skupiny registrací.

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řípustné hodnoty: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

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

Default value: azureiotcentral.com
--certificate-entry --entry

Typ položky certifikátu x509, který povoluje pouze "primární" a "sekundární".

Přípustné hodnoty: primary, secondary
--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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: 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 enrollment-group list

Získejte seznam skupin registrací v aplikaci.

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

Příklady

Získání seznamu skupin registrací v aplikaci

az iot central enrollment-group 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řípustné hodnoty: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

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

Default value: 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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: 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 enrollment-group show

Získejte podrobnosti o skupině registrací podle ID.

az iot central enrollment-group show --app-id
                                     --group-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--certificate-entry {primary, secondary}]
                                     [--token]

Příklady

Získání podrobností o skupině registrací podle ID

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

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.

--group-id --id

Jedinečný identifikátor skupiny registrací.

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řípustné hodnoty: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

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

Default value: azureiotcentral.com
--certificate-entry --entry

Typ položky certifikátu x509, který povoluje pouze "primární" a "sekundární".

Přípustné hodnoty: primary, secondary
--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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: 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 enrollment-group update

Aktualizujte skupinu registrací.

az iot central enrollment-group update --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-entry {primary, secondary}]
                                       [--certificate-path]
                                       [--display-name]
                                       [--etag]
                                       [--provisioning-status {disabled, enabled}]
                                       [--remove-x509 {false, true}]
                                       [--scp]
                                       [--token]
                                       [--type]

Příklady

Aktualizace skupiny registrací

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

Odebrání primárního certifikátu x509 ze skupiny registrací

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

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.

--group-id --id

Jedinečný identifikátor skupiny registrací.

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řípustné hodnoty: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

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

Default value: azureiotcentral.com
--certificate-entry --entry

Typ položky certifikátu x509, který povoluje pouze "primární" a "sekundární".

Přípustné hodnoty: primary, secondary
--certificate-path --cp

Cesta k souboru obsahujícímu primární certifikát.

--display-name

Zobrazovaný název skupiny registrací

--etag

ETag sloužící k zabránění konfliktům v aktualizacích skupiny registrací.

--provisioning-status --ps

Určuje, jestli se zařízení používající skupinu můžou připojit ke službě IoT Central. Ano nebo ne

Přípustné hodnoty: disabled, enabled
Default value: enabled
--remove-x509

Zda má být certifikát x509 odebrán ze skupiny. Ano nebo ne

Přípustné hodnoty: false, true
--scp --secondary-certificate-path

Cesta k souboru obsahujícímu sekundární certifikát.

--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.

--type

Typ zařízení, která se připojují přes skupinu

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: 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 enrollment-group verify-certificate

Ověřte primární nebo sekundární certifikát x509 skupiny registrací.

Ověřte primární nebo sekundární certifikát x509 skupiny registrací tím, že poskytnete certifikát s podepsaným ověřovacím kódem.

Upozorňujeme, že pokud byla skupina registrací vytvořená s neověřeným certifikátem x509, bude potřeba vytvořit ověřovací certifikát pomocí neověřených certifikátů x509 a ověřovacího kódu před použitím tohoto příkazu. Ověřovací kód je možné vygenerovat prostřednictvím rozhraní příkazového řádku pomocí příkazu enrollment-group generate-verification-code. Přečtěte si další informace o tom, jak vytvořit ověřovací certifikáty pomocí ověřovacího kódu na adrese https://video2.skills-academy.com/en-us/azure/iot-central/core/how-to-connect-devices-x509.

az iot central enrollment-group verify-certificate --app-id
                                                   --group-id
                                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                                   [--central-api-uri]
                                                   [--certificate-path]
                                                   [--scp]
                                                   [--token]

Příklady

Ověření primárního certifikátu x509 skupiny registrací

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

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.

--group-id --id

Jedinečný identifikátor skupiny registrací.

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řípustné hodnoty: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

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

Default value: azureiotcentral.com
--certificate-path --cp

Cesta k souboru obsahujícímu primární certifikát.

--scp --secondary-certificate-path

Cesta k souboru obsahujícímu sekundární certifikát.

--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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: 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.