az iot device

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

Využijte simulaci zařízení a další operace zaměřené na zařízení, jako jsou funkce zasílání zpráv typu zařízení-cloud nebo cloud-zařízení.

Příkazy

Name	Description	Typ	Stav
az iot device c2d-message	Příkazy zasílání zpráv typu Cloud-zařízení	Extension	GA
az iot device c2d-message abandon	Opusťte zprávu typu cloud-zařízení.	Extension	GA
az iot device c2d-message complete	Dokončete zprávu typu cloud-zařízení.	Extension	GA
az iot device c2d-message purge	Vyprázdnění fronty zpráv typu cloud-zařízení pro cílové zařízení	Extension	GA
az iot device c2d-message receive	Obdrží zprávu typu cloud-zařízení.	Extension	GA
az iot device c2d-message reject	Odmítnutí nebo zablokování zprávy typu cloud-zařízení	Extension	GA
az iot device c2d-message send	Odeslání zprávy typu cloud-zařízení	Extension	GA
az iot device registration	Správa registrací zařízení IoT pro službu IoT Device Provisioning	Extension	Preview
az iot device registration create	Zaregistrujte zařízení IoT ve službě IoT Device Provisioning.	Extension	Preview
az iot device send-d2c-message	Odešlete zprávu mqtt device-to-cloud.	Extension	GA
az iot device simulate	Simulace zařízení v Azure IoT Hubu	Extension	Experimental
az iot device upload-file	Nahrajte místní soubor jako zařízení do předem nakonfigurovaného kontejneru úložiště objektů blob.	Extension	GA

az iot device send-d2c-message

Odešlete zprávu mqtt device-to-cloud.

Příkaz podporuje odesílání zpráv s vlastní datovou částí v řetězci unicode nebo binárním formátu. Pokud chcete odeslat binární soubor, data by měla pocházet ze souboru (prostřednictvím --data-file-path) a typ obsahu by měl být nastaven na application/octet-stream.

Poznámka: Příkaz funguje jenom pro zařízení založená na symetrických klíčích (SAS). Pokud chcete povolit dotazování na text zprávy při směrování zpráv, musí být systémová vlastnost typu obsahu application/JSON a vlastnost systému kódování obsahu musí být jednou z hodnot kódování UTF podporovaných danou systémovou vlastností (UTF-8, UTF-16 nebo UTF-32). Pokud se kódování obsahu nenastaví při použití služby Azure Storage jako koncový bod směrování, Služba IoT Hub zapíše zprávy ve formátu kódování base 64. Pokud používáte metody ověřování x509, musí být k dispozici soubory certifikátu a klíče (a v případě potřeby přístupové heslo).

az iot device send-d2c-message --device-id
                               [--certificate-file-path --cp]
                               [--da --data]
                               [--data-file-path --dfp]
                               [--dtmi --model-id]
                               [--hub-name]
                               [--key --symmetric-key]
                               [--key-file-path --kp]
                               [--login]
                               [--mc --msg-count]
                               [--pass --passphrase]
                               [--properties --props]
                               [--resource-group]

Příklady

Základní použití

az iot device send-d2c-message -n {iothub_name} -d {device_id}

Základní použití zařízení, které registruje ID modelu 'dtmi:com:example:Termostat; 1' po připojení

az iot device send-d2c-message -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Základní použití zařízení s ověřováním x509

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Základní použití zařízení s ověřováním x509, ve kterém má soubor klíče přístupové heslo

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Základní použití s vlastními daty

az iot device send-d2c-message -n {iothub_name} -d {device_id} --data {message_body}

Odeslat vlastnosti aplikace

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props 'key0=value0;key1=value1'

Odeslání systémových vlastností (ID zprávy a ID korelace)

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid={id};$.cid={id}'

Odeslání vlastních dat zadáním typu obsahu a kódování obsahu ve vlastnostech systému

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct={content-type};$.ce={content-encoding}' --data {message_body}

Odeslání vlastních dat v binárním formátu zadáním kódování obsahu ve vlastnostech systému

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/octet-stream' --data-file-path {file_path}

Odeslání vlastních dat ve formátu JSON zadáním typu obsahu a kódování obsahu ve vlastnostech systému

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/json;$.ce=utf-8' --data-file-path {file_path}

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.

--certificate-file-path --cp

Cesta k souboru certifikátu

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication Arguments

--da --data

Text zprávy Zadejte text nebo nezpracovaný json.

Vlastnost	Hodnota
Default value:	Ping from Az CLI IoT Extension

--data-file-path --dfp

Preview

Zadejte cestu k souboru pro datovou část textu zprávy. Upozorňujeme, že je potřeba datovou část odeslat v binárním formátu, nastavte typ obsahu na application/octet-stream.

--dtmi --model-id

ID modelu digitálního dvojčete, které bude zařízení při připojování k rozbočovači hlásit. Další podrobnosti najdete v https://learn.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play.

Vlastnost	Hodnota
Skupina parametrů:	Digital Twin Arguments

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

Symetrický klíč, který se má použít pro zařízení. Pokud jsou k dispozici symetrické klíče a další argumenty ověřování zařízení, má symetrický klíč prioritu.

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication Arguments

--key-file-path --kp

Cesta k souboru klíče.

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication 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

--mc --msg-count

Počet zpráv zařízení, které se mají odeslat do IoT Hubu

Vlastnost	Hodnota
Default value:	1

--pass --passphrase

Přístupové heslo pro soubor klíče

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication Arguments

--properties --props -p

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

Experimentální

Tento příkaz je experimentální a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Simulace zařízení v Azure IoT Hubu

Když je simulace zařízení spuštěná, zařízení automaticky přijme a potvrdí zprávy typu cloud-zařízení (c2d). U simulace mqtt budou všechny zprávy c2d potvrzeny dokončením. Potvrzení http simulace c2d je založeno na výběru uživatele, který lze dokončit, odmítnout nebo opustit. Simulace mqtt podporuje také přímé vyvolání metod, které lze potvrdit stavovým kódem odpovědi a datovou částí odpovědi. Poznámka: Příkaz ve výchozím nastavení nastaví typ obsahu na application/json a content-encoding na utf-8. To může být přepsáno. Poznámka: Pokud používáte metody ověřování x509, musí být k dispozici soubory certifikátu a klíče (a v případě potřeby přístupové heslo).

az iot device simulate --device-id
                       [--certificate-file-path --cp]
                       [--da --data]
                       [--dtmi --model-id]
                       [--hub-name]
                       [--init-reported-properties --irp]
                       [--key --symmetric-key]
                       [--key-file-path --kp]
                       [--login]
                       [--mc --msg-count]
                       [--method-response-code --mrc]
                       [--method-response-payload --mrp]
                       [--mi --msg-interval]
                       [--pass --passphrase]
                       [--properties --props]
                       [--proto --protocol {http, mqtt}]
                       [--receive-settle --rs {abandon, complete, reject}]
                       [--resource-group]

Příklady

Základní využití (mqtt)

az iot device simulate -n {iothub_name} -d {device_id}

Základní použití zařízení, které registruje ID modelu 'dtmi:com:example:Termostat; 1' při připojení (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Základní využití zařízení s ověřováním x509 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Základní použití zařízení s ověřováním x509 (mqtt), ve kterém má soubor klíče přístupové heslo

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Odesílání smíšených vlastností (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/json"

Odeslání stavový kód odpovědi přímé metody a datová část odpovědi přímé metody jako nezpracovaný json (pouze mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '{"result":"Direct method successful"}'

Odeslat stavový kód odpovědi přímé metody a datovou část odpovědi přímé metody jako cestu k místnímu souboru (pouze mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '../my_direct_method_payload.json'

Odeslání počátečního stavu ohlášených vlastností dvojčete zařízení jako nezpracovaného kódu JSON pro cílové zařízení (pouze mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '{"reported_prop_1":"val_1", "reported_prop_2":val_2}'

Odeslání počátečního stavu ohlášených vlastností dvojčete zařízení jako cesty k místnímu souboru cílového zařízení (pouze mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '../my_device_twin_reported_properties.json'

Základní využití (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http

Odesílání smíšených vlastností (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http --properties "iothub-app-myprop=myvalue;content-type=application/json;iothub-correlationid=12345"

Volba celkového počtu zpráv a intervalu mezi zprávami

az iot device simulate -n {iothub_name} -d {device_id} --msg-count 1000 --msg-interval 5

Odmítnutí zpráv c2d (pouze http)

az iot device simulate -n {iothub_name} -d {device_id} --rs reject --protocol http

Opuštění zpráv c2d (pouze http)

az iot device simulate -n {iothub_name} -d {device_id} --rs abandon --protocol http

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.

--certificate-file-path --cp

Cesta k souboru certifikátu

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication Arguments

--da --data

Text zprávy Zadejte text nebo nezpracovaný json.

Vlastnost	Hodnota
Default value:	Ping from Az CLI IoT Extension

--dtmi --model-id

Vlastnost	Hodnota
Skupina parametrů:	Digital Twin Arguments

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

--init-reported-properties --irp

Počáteční stav ohlášených vlastností dvojčete pro cílové zařízení při spuštění simulátoru Volitelný parametr, podporovaný pouze pro mqtt.

--key --symmetric-key

Symetrický klíč, který se má použít pro zařízení. Pokud jsou k dispozici symetrické klíče a další argumenty ověřování zařízení, má symetrický klíč prioritu.

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication Arguments

--key-file-path --kp

Cesta k souboru klíče.

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication Arguments

--login -l

Vlastnost	Hodnota
Skupina parametrů:	IoT Hub Identifier Arguments

--mc --msg-count

Počet zpráv zařízení, které se mají odeslat do IoT Hubu

Vlastnost	Hodnota
Default value:	100

--method-response-code --mrc

Stavový kód, který se má vrátit při spuštění přímé metody na zařízení. Volitelný parametr, podporovaný pouze pro mqtt.

--method-response-payload --mrp

Datová část, která se má vrátit při spuštění přímé metody na zařízení. Zadejte cestu k souboru nebo nezpracovaný kód JSON. Volitelný parametr, podporovaný pouze pro mqtt.

--mi --msg-interval

Zpoždění v sekundách mezi zprávami typu zařízení-cloud

Vlastnost	Hodnota
Default value:	3

--pass --passphrase

Přístupové heslo pro soubor klíče

Vlastnost	Hodnota
Skupina parametrů:	Device Authentication Arguments

--properties --props -p

Taška vlastností zprávy ve dvojicích klíč-hodnota s následujícím formátem: a=b; c=d. Pro zasílání zpráv mqtt – pomocí $můžete odesílat systémové vlastnosti. {name}=value. Například $.cid=12345 nastaví vlastnost ID korelace systému. Další příklady identifikátorů systémových vlastností zahrnují $.ct pro typ obsahu, $.mid pro ID zprávy a $.ce pro kódování obsahu. Pro zasílání zpráv HTTP – vlastnosti aplikace se odesílají pomocí iothub-app-{name}=value, například iothub-app-myprop=myvalue. Systémové vlastnosti jsou obecně předponou iothub-{name} jako iothub-correlationid, ale existují výjimky, jako je typ obsahu a kódování obsahu.

--proto --protocol

Označuje protokol zpráv typu zařízení-cloud.

Vlastnost	Hodnota
Default value:	mqtt
Přípustné hodnoty:	http, mqtt

--receive-settle --rs

Označuje, jak vyřešit přijaté zprávy typu cloud-zařízení. Podporuje se jenom s protokolem HTTP.

Vlastnost	Hodnota
Default value:	complete
Přípustné hodnoty:	abandon, complete, reject

--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 device upload-file

Nahrajte místní soubor jako zařízení do předem nakonfigurovaného kontejneru úložiště objektů blob.

az iot device upload-file --content-type --ct
                          --device-id
                          --file-path --fp
                          [--hub-name]
                          [--login]
                          [--resource-group]

Povinné parametry

--content-type --ct

Typ souboru MIME.

--device-id -d

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

--file-path --fp

Cesta k souboru pro nahrání

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.

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

Váš názor

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

Sdílet prostřednictvím

az iot device

Příkazy

az iot device send-d2c-message

Příklady

Povinné parametry

Volitelné parametry

az iot device simulate

Příklady

Povinné parametry

Volitelné parametry

az iot device upload-file

Povinné parametry

Volitelné parametry

Váš názor