az iot hub module-identity

Note

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.67.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	Extension	GA
az iot hub module-identity connection-string show	Zobrazení cílového modulu zařízení IoT připojovací řetězec	Extension	GA
az iot hub module-identity create	Vytvořte modul na cílovém zařízení IoT ve službě IoT Hub.	Extension	GA
az iot hub module-identity delete	Odstranění zařízení ve službě IoT Hub	Extension	GA
az iot hub module-identity list	Výpis modulů umístěných na zařízení IoT ve službě IoT Hub	Extension	GA
az iot hub module-identity renew-key	Obnovte cílové klíče modulů zařízení IoT Hubu s ověřováním SAS.	Extension	GA
az iot hub module-identity show	Získejte podrobnosti o modulu zařízení IoT ve službě IoT Hub.	Extension	GA
az iot hub module-identity update	Aktualizace modulu zařízení ioT Hubu	Extension	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 --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od --output-dir]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--valid-days --vd]

Povinné parametry

--device-id -d

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

--module-id -m

ID cílového modulu.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--am --auth-method

Metoda autorizace, se kterou se entita vytvoří.

Vlastnost	Hodnota
Default value:	shared_private_key
Přípustné hodnoty:	shared_private_key, x509_ca, x509_thumbprint

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

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--hub-name -n

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

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Tento příkaz podporuje připojovací řetězec entity 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 je zadaný připojovací řetězec i název entity, má připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

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

Vlastnost	Hodnota
Skupina parametrů:	X.509 Arguments

--pk --primary-key

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

Vlastnost	Hodnota
Skupina parametrů:	Symmetric Key Arguments

--primary-thumbprint --ptp

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

Vlastnost	Hodnota
Skupina parametrů:	X.509 Arguments

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

Vlastnost	Hodnota
Skupina parametrů:	Symmetric Key Arguments

--secondary-thumbprint --stp

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

Vlastnost	Hodnota
Skupina parametrů:	X.509 Arguments

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

Vlastnost	Hodnota
Skupina parametrů:	X.509 Arguments

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

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

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

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

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

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

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--hub-name -n

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

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

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

Vlastnost	Hodnota
Default value:	1000

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

az iot hub module-identity renew-key

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

V současné době nejsou značky etag a typ klíče swap podporovány pro hromadnou regeneraci klíčů. Hromadná regenerace klíčů se zhoršuje jiný výstupní formát od regenerace klíčů jednoho modulu.

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--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

Obnovte sekundární klíč pro dva moduly.

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

Obnovte oba klíče pro všechny moduly v zařízení.

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

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.

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--key-type --kt

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

Vlastnost	Hodnota
Přípustné hodnoty:	both, primary, secondary, swap

--module-id -m

Seznam ID cílového modulu s hodnocením prostoru Pro všechny moduly použijte *.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--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 *. Tento argument platí pouze pro swap.

--login -l

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--no-progress

Skryjte indikátor průběhu pro regeneraci hromadných klíčů.

Vlastnost	Hodnota
Přípustné hodnoty:	false, true

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

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

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--auth-type

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

--hub-name -n

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

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

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

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	[]

--auth-type

Vlastnost	Hodnota
Skupina parametrů:	Access Control Arguments
Default value:	key
Přípustné hodnoty:	key, login

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	False

--hub-name -n

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

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--login -l

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--remove

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	[]

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	[]

Globální parametry

--debug

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

Vlastnost	Hodnota
Default value:	False

--help -h

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

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost	Hodnota
Default value:	False

--output -o

Výstupní formát

Vlastnost	Hodnota
Default value:	json
Přípustné hodnoty:	json, jsonc, none, table, tsv, yaml, yamlc

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

Vlastnost	Hodnota
Default value:	False

Váš názor

Byla tato stránka užitečná?

Sdílet prostřednictvím

az iot hub module-identity

Příkazy

az iot hub module-identity create

Povinné parametry

Volitelné parametry

az iot hub module-identity delete

Povinné parametry

Volitelné parametry

az iot hub module-identity list

Povinné parametry

Volitelné parametry

az iot hub module-identity renew-key

Příklady

Povinné parametry

Volitelné parametry

az iot hub module-identity show

Povinné parametry

Volitelné parametry

az iot hub module-identity update

Příklady

Povinné parametry

Volitelné parametry

Váš názor