az iot device

  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.37.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot-enhetskommando . Läs mer om tillägg.

Utnyttja enhetssimulering och andra enhetscentrerade åtgärder, till exempel meddelandefunktioner från enhet till moln eller meddelandefunktioner från moln till enhet.

Kommandon

Name Description Typ Status
az iot device c2d-message

Meddelandekommandon från moln till enhet.

 Anknytning Allmän tillgänglighet
az iot device c2d-message abandon

Överge ett meddelande från moln till enhet.

 Anknytning Allmän tillgänglighet
az iot device c2d-message complete

Slutför ett meddelande från moln till enhet.

 Anknytning Allmän tillgänglighet
az iot device c2d-message purge

Rensa meddelandekön från moln till enhet för en målenhet.

 Anknytning Allmän tillgänglighet
az iot device c2d-message receive

Ta emot ett meddelande från moln till enhet.

 Anknytning Allmän tillgänglighet
az iot device c2d-message reject

Avvisa eller deadletter ett meddelande från molnet till enheten.

 Anknytning Allmän tillgänglighet
az iot device c2d-message send

Skicka ett meddelande från moln till enhet.

 Anknytning Allmän tillgänglighet
az iot device registration

Hantera IoT-enhetsregistreringar för IoT Device Provisioning Service.

 Anknytning Förhandsgranska
az iot device registration create

Registrera en IoT-enhet med IoT Device Provisioning Service.

 Anknytning Förhandsgranska
az iot device send-d2c-message

Skicka ett mqtt-meddelande från enhet till moln.

 Anknytning Allmän tillgänglighet
az iot device simulate

Simulera en enhet i en Azure IoT Hub.

 Anknytning Experimentell
az iot device upload-file

Ladda upp en lokal fil som en enhet till en förkonfigurerad bloblagringscontainer.

 Anknytning Allmän tillgänglighet

az iot device send-d2c-message

Skicka ett mqtt-meddelande från enhet till moln.

Kommandot har stöd för att skicka meddelanden med anpassad nyttolast i unicode-sträng eller binärt format. När du tänker skicka binärt bör data komma från en fil (via --data-file-path) och innehållstypen ska vara inställd på application/octet-stream.

Obs! Kommandot fungerar bara för sas-baserade enheter (symmetrisk nyckelautentisering). Om du vill aktivera frågor i en meddelandetext i meddelanderoutning måste systemegenskapen contentType vara application/JSON och egenskapen contentEncoding system måste vara ett av UTF-kodningsvärdena som stöds av den systemegenskapen (UTF-8, UTF-16 eller UTF-32). Om innehållskodningen inte anges när Azure Storage används som routningsslutpunkt skriver IoT Hub meddelandena i bas 64-kodat format. Om du använder x509-autentiseringsmetoder måste certifikat- och nyckelfilerna (och lösenfrasen om det behövs) anges.

az iot device send-d2c-message --device-id
                               [--certificate-file-path]
                               [--da]
                               [--data-file-path]
                               [--dtmi]
                               [--hub-name]
                               [--key]
                               [--key-file-path]
                               [--login]
                               [--mc]
                               [--pass]
                               [--properties]
                               [--resource-group]

Exempel

Grundläggande användning

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

Grundläggande användning för enhet som registrerar modell-ID:t för 'dtmi:com:example:Thermostat; 1' vid anslutning

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

Grundläggande användning för enhet med x509-autentisering

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

Grundläggande användning för enhet med x509-autentisering där nyckelfilen har en lösenfras

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

Grundläggande användning med anpassade data

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

Skicka programegenskaper

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

Skicka systemegenskaper (meddelande-ID och korrelations-ID)

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

Skicka anpassade data genom att ange innehållstyp och innehållskodning i systemegenskaper

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

Skicka anpassade data i binärt format genom att ange innehållskodning i systemegenskaper

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

Skicka anpassade data i JSON-format genom att ange innehållstyp och innehållskodning i systemegenskaper

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--certificate-file-path --cp

Sökväg till certifikatfilen.

--da --data

Meddelandetext. Ange text eller rå json.

standardvärde: Ping from Az CLI IoT Extension
--data-file-path --dfp
Förhandsgranskning

Ange sökvägen till filen för meddelandetextnyttolasten. Observera att när nyttolasten måste skickas i binärt format anger du innehållstypen till program/oktettström.

--dtmi --model-id

Digital Twin-modell-ID:t som enheten rapporterar när den ansluter till hubben. Mer https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play information finns i.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--key --symmetric-key

Symmetrisk nyckel som ska användas för enheten. Om den symmetriska nyckeln och andra argument för enhetsautentisering tillhandahålls prioriteras symmetrisk nyckel.

--key-file-path --kp

Sökväg till nyckelfil.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--mc --msg-count

Antal enhetsmeddelanden som ska skickas till IoT Hub.

standardvärde: 1
--pass --passphrase

Lösenfras för nyckelfil.

--properties --props -p

Meddelandeegenskapspåse i nyckel/värde-par med följande format: a=b; c=d. För mqtt-meddelanden kan du skicka systemegenskaper med hjälp av $.=value. Till exempel anger $.cid=12345 egenskapen systemkorrelations-ID. Andra exempel på systemegenskapsidentifierare är $.ct för innehållstyp, $.mid för meddelande-ID och $.ce för innehållskodning.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot device simulate

Experimentell

Det här kommandot är experimentellt och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Simulera en enhet i en Azure IoT Hub.

Medan enhetssimuleringen körs tar enheten automatiskt emot och bekräftar meddelanden från moln till enhet (c2d). För mqtt-simulering bekräftas alla c2d-meddelanden när de har slutförts. För http-simulering baseras c2d-bekräftelse på användarval som kan slutföras, avvisas eller överges. Mqtt-simuleringen stöder också direkt metodanrop som kan bekräftas av en svarsstatuskod och svarsnyttolast. Obs! Kommandot anger som standard innehållstyp till application/json och content-encoding till utf-8. Detta kan åsidosättas. Obs! Om du använder x509-autentiseringsmetoder måste certifikat- och nyckelfilerna (och lösenfrasen om det behövs) anges.

az iot device simulate --device-id
                       [--certificate-file-path]
                       [--da]
                       [--dtmi]
                       [--hub-name]
                       [--init-reported-properties]
                       [--key]
                       [--key-file-path]
                       [--login]
                       [--mc]
                       [--method-response-code]
                       [--method-response-payload]
                       [--mi]
                       [--pass]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

Exempel

Grundläggande användning (mqtt)

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

Grundläggande användning för enhet som registrerar modell-ID:t för 'dtmi:com:example:Thermostat; 1' vid anslutning (mqtt)

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

Grundläggande användning för enhet med x509-autentisering (mqtt)

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

Grundläggande användning för enhet med x509-autentisering (mqtt) där nyckelfilen har en lösenfras

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

Skicka blandade egenskaper (mqtt)

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

Skicka statuskod för direktmetodsvar och direktmetodsvarsnyttolast som rå json (endast mqtt)

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

Skicka statuskod för direktmetodsvar och direktmetodsvarsnyttolast som sökväg till lokal fil (endast mqtt)

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

Skicka det initiala tillståndet för enhetstvillingens rapporterade egenskaper som rå json för målenheten (endast mqtt)

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

Skicka det initiala tillståndet för enhetstvillingens rapporterade egenskaper som sökväg till den lokala filen för målenheten (endast mqtt)

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

Grundläggande användning (http)

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

Skicka blandade egenskaper (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"

Välj totalt antal meddelanden och intervall mellan meddelanden

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

Avvisa c2d-meddelanden (endast http)

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

Överge c2d-meddelanden (endast http)

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

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--certificate-file-path --cp

Sökväg till certifikatfilen.

--da --data

Meddelandetext. Ange text eller rå json.

standardvärde: Ping from Az CLI IoT Extension
--dtmi --model-id

Digital Twin-modell-ID:t som enheten rapporterar när den ansluter till hubben. Mer https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play information finns i.

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--init-reported-properties --irp

Initialt tillstånd för tvillingrapporterade egenskaper för målenheten när simulatorn körs. Valfri param, som endast stöds för mqtt.

--key --symmetric-key

Symmetrisk nyckel som ska användas för enheten. Om den symmetriska nyckeln och andra argument för enhetsautentisering tillhandahålls prioriteras symmetrisk nyckel.

--key-file-path --kp

Sökväg till nyckelfil.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--mc --msg-count

Antal enhetsmeddelanden som ska skickas till IoT Hub.

standardvärde: 100
--method-response-code --mrc

Statuskod som ska returneras när direktmetoden körs på enheten. Valfri param, som endast stöds för mqtt.

--method-response-payload --mrp

Nyttolast som ska returneras när direktmetoden körs på enheten. Ange filsökväg eller rå json. Valfri param, som endast stöds för mqtt.

--mi --msg-interval

Fördröjning i sekunder mellan meddelanden från enhet till moln.

standardvärde: 3
--pass --passphrase

Lösenfras för nyckelfil.

--properties --props -p

Meddelandeegenskapspåse i nyckel/värde-par med följande format: a=b; c=d. För mqtt-meddelanden kan du skicka systemegenskaper med hjälp av $.=value. Till exempel anger $.cid=12345 egenskapen systemkorrelations-ID. Andra exempel på systemegenskapsidentifierare är $.ct för innehållstyp, $.mid för meddelande-ID och $.ce för innehållskodning. För http messaging – programegenskaper skickas med iothub-app-=value, till exempel iothub-app-myprop=myvalue. Systemegenskaper är vanligtvis prefix med iothub, som iothub-correlationid, men det finns undantag som innehållstyp och innehållskodning.

--proto --protocol

Anger meddelandeprotokoll från enhet till moln.

accepterade värden: http, mqtt
standardvärde: mqtt
--receive-settle --rs

Anger hur du kvittar mottagna meddelanden från molnet till enheten. Stöds endast med HTTP.

accepterade värden: abandon, complete, reject
standardvärde: complete
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot device upload-file

Ladda upp en lokal fil som en enhet till en förkonfigurerad bloblagringscontainer.

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

Obligatoriska parametrar

--content-type --ct

MIME-typ av fil.

--device-id -d

Målenhets-ID.

--file-path --fp

Sökväg till fil för uppladdning.

Valfria parametrar

--hub-name -n

IoT Hub-namn eller värdnamn. Krävs om --login inte har angetts.

--login -l

Det här kommandot stöder en entitet anslutningssträng med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet anslutningssträng och namn anges prioriteras anslutningssträng. Krävs om --hub-name inte anges.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.