az iot hub module-identity

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 hub module-identity . Přečtěte si další informace o rozšířeních.

Správa modulů zařízení IoT

Příkazy

Name	Description	Typ	Stav
az iot hub module-identity connection-string	Správa připojovací řetězec modulu zařízení IoT	Rozšíření	GA
az iot hub module-identity connection-string show	Zobrazení cílového modulu zařízení IoT připojovací řetězec	Rozšíření	GA
az iot hub module-identity create	Vytvořte modul na cílovém zařízení IoT ve službě IoT Hub.	Rozšíření	GA
az iot hub module-identity delete	Odstranění zařízení ve službě IoT Hub	Rozšíření	GA
az iot hub module-identity list	Výpis modulů umístěných na zařízení IoT ve službě IoT Hub	Rozšíření	GA
az iot hub module-identity renew-key	Obnovte cílové klíče modulu zařízení IoT Hubu s ověřováním SAS.	Rozšíření	GA
az iot hub module-identity show	Získejte podrobnosti o modulu zařízení IoT ve službě IoT Hub.	Rozšíření	GA
az iot hub module-identity update	Aktualizace modulu zařízení ioT Hubu	Rozšíření	GA

az iot hub module-identity create

Vytvořte modul na cílovém zařízení IoT ve službě IoT Hub.

Pokud používáte metodu ověřování shared_private_key (označovanou také jako symetrické klíče), služba je pro modul nevygeneruje.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

Povinné parametry

--device-id -d

ID cílového zařízení.

--module-id -m

ID cílového modulu.

Volitelné parametry

--am --auth-method

Metoda autorizace, se kterou se entita vytvoří.

přijímané hodnoty: shared_private_key, x509_ca, x509_thumbprint

výchozí hodnota: shared_private_key

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login

výchozí hodnota: key

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--od --output-dir

Vygenerujte certifikát podepsaný svým držitelem a použijte jeho kryptografický otisk. Výstup do zadaného cílového adresáře

--pk --primary-key

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

--primary-thumbprint --ptp

Kryptografický otisk certifikátu podepsaný svým držitelem, který se má použít pro primární kryptografický otisk.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--secondary-key --sk

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

--secondary-thumbprint --stp

Kryptografický otisk certifikátu podepsaný svým držitelem, který se má použít pro sekundární kryptografický otisk.

--valid-days --vd

Vygenerujte certifikát podepsaný svým držitelem a použijte jeho kryptografický otisk. Platné pro zadaný počet dní. Výchozí hodnota: 365.

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 hub module-identity delete

Odstranění zařízení ve službě IoT Hub

az iot hub module-identity delete --device-id
                                  --module-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Povinné parametry

--device-id -d

ID cílového zařízení.

--module-id -m

ID cílového modulu.

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login

výchozí hodnota: key

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

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

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 hub module-identity list

Výpis modulů umístěných na zařízení IoT ve službě IoT Hub

az iot hub module-identity list --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Povinné parametry

--device-id -d

ID cílového zařízení.

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login

výchozí hodnota: key

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--top

Maximální počet prvků, které se mají vrátit. Použijte -1 pro neomezenou dobu.

výchozí hodnota: 1000

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 hub module-identity renew-key

Obnovte cílové klíče modulu zařízení IoT Hubu s ověřováním SAS.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Příklady

Obnovte primární klíč.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

Prohození primárních a sekundárních klíčů

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

Povinné parametry

--device-id -d

ID cílového zařízení.

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--key-type --kt

Cílový typ klíče, který se má znovu vygenerovat.

přijímané hodnoty: primary, secondary, swap

--module-id -m

ID cílového modulu.

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login

výchozí hodnota: key

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

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

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 hub module-identity show

Získejte podrobnosti o modulu zařízení IoT ve službě IoT Hub.

az iot hub module-identity show --device-id
                                --module-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Povinné parametry

--device-id -d

ID cílového zařízení.

--module-id -m

ID cílového modulu.

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login

výchozí hodnota: key

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

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 hub module-identity update

Aktualizace modulu zařízení ioT Hubu

K aktualizaci modulu použijte parametr --set následovaný přiřazením vlastností. Využijte vlastnosti vrácené z modulu iot Hub – zobrazení identity.

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

Příklady

Opětovné generování symetrických ověřovacích klíčů modulu

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

Povinné parametry

--device-id -d

ID cílového zařízení.

--module-id -m

ID cílového modulu.

Volitelné parametry

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

výchozí hodnota: []

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login

výchozí hodnota: key

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

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

výchozí hodnota: False

--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

výchozí hodnota: []

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

výchozí hodnota: []

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.