Dela via

az iot device c2d-message

  • Referens

Kommentar

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

Meddelandekommandon från moln till enhet.

Kommandon

Name Description Typ Status
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 c2d-message abandon

Överge ett meddelande från moln till enhet.

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--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 niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. 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.

Godkända 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 c2d-message complete

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

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--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 niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. 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.

Godkända 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 c2d-message purge

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

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

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 niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. 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.

Godkända 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 c2d-message receive

Ta emot ett meddelande från moln till enhet.

Den mottagna meddelandetexten avkodas endast när dess innehållskodning är inställd på "utf-8", "utf-16" eller "utf-32". Meddelandets nyttolast visas som {{icke-avkodbar nyttolast}} när innehållskodning inte har angetts till något av ovanstående, eller misslyckas med att avkoda även när innehållskodning har angetts till något av ovanstående.

Obs! Endast ett meddelandes ack-argument [--complete, --reject, --abandon] accepteras.

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Exempel

Grundläggande användning

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Ta emot ett meddelande och ange en tidsgräns på 30 sekunder för det meddelandet

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Ta emot ett meddelande och ack det som "slutfört" när det har tagits emot

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Ta emot ett meddelande och avvisa det när det har tagits emot

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--abandon

Överge meddelandet från moln till enhet efter mottagandet.

Godkända värden: false, true
Standardvärde: False
--complete

Slutför meddelandet från moln till enhet efter mottagandet.

Godkända värden: false, true
Standardvärde: False
--hub-name -n

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

--lock-timeout --lt

Anger hur lång tid ett meddelande ska vara osynligt för andra mottagningsanrop.

Standardvärde: 60
--login -l

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

--reject

Avvisa meddelandet från moln till enhet efter mottagandet.

Godkända värden: false, true
Standardvärde: False
--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.

Godkända 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 c2d-message reject

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

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--etag -e

Etag eller entitetstagg som motsvarar resursens sista tillstånd. Om ingen etag anges används värdet *.

--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 niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. 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.

Godkända 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 c2d-message send

Skicka ett meddelande från moln till enhet.

Det här kommandot förlitar sig på och kan installera beroende Cython-paket (uamqp) vid första körningen. https://github.com/Azure/azure-uamqp-python

Obs! Innehållskodning är som standard utf-8. Kommandot skickar meddelandetexten med kodningsåtgärden när egenskapen content-encoding antingen är utf-8, utf-16 eller utf-32. Om värdet för innehållskodning inte är något av dessa skickas egenskapen fortfarande utan att någon kodningsåtgärd vidtas.

När du skickar en binär meddelandetext måste innehållet anges från en fil (via --data-file-path) och innehållstypen måste vara inställd på application/octet-stream.

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Exempel

Grundläggande användning med standardmeddelandetext

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

Skicka meddelande från moln till enhet med anpassade data och egenskaper.

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

Skicka ett C2D-meddelande och vänta på att enheten bekräftas

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Skicka ett C2D-meddelande i binärt format från en fil.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Skicka ett C2D-meddelande i JSON-format från en fil.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Obligatoriska parametrar

--device-id -d

Målenhets-ID.

Valfria parametrar

--ack

Begär leverans av feedback per meddelande om meddelandets slutliga tillstånd. Beskrivningen av ack-värden är följande. Positivt: Om c2d-meddelandet når tillståndet Slutfört genererar IoT Hub ett feedbackmeddelande. Negativ: Om c2d-meddelandet når tillståndet Död bokstav genererar IoT Hub ett feedbackmeddelande. Fullständig: IoT Hub genererar ett feedbackmeddelande i båda fallen. Som standard begärs inget ack.

Godkända värden: full, negative, positive
--auth-type

Anger om åtgärden ska automatiskt härleda en principnyckel eller använda den aktuella Azure AD-sessionen. Om autentiseringstypen är inloggning och resursens värdnamn anges hoppas resurssökningen över om det inte behövs. Du kan konfigurera standardinställningen med .az configure --defaults iothub-data-auth-type=<auth-type-value>

Godkända värden: key, login
Standardvärde: key
--ce --content-encoding

Kodningen för C2D-meddelandetexten.

Standardvärde: utf-8
--cid --correlation-id

Korrelations-ID:t som är associerat med C2D-meddelandet.

--content-type --ct

Innehållstypen för C2D-meddelandetexten.

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

--expiry --expiry-time-utc

Enheterna är millisekunder sedan unix-epoken. Om ingen tid anges används standard-IoT Hub C2D-meddelandet TTL.

--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 niska veze med behörighet att utföra åtgärder. Använd för att undvika sessionsinloggning via "az login". Om både en entitet niska veze och namn anges prioriteras niska veze. Krävs om --hub-name inte anges.

--message-id --mid

C2D-meddelande-ID:t. Om inget meddelande-ID anges genereras ett UUID.

--properties --props -p

Meddelandeegenskapspåse i nyckel/värde-par med följande format: a=b; c=d.

--repair -r

Installera om uamqp-beroende som är kompatibelt med tilläggsversionen. Standard: falskt.

Godkända värden: false, true
Standardvärde: False
--resource-group -g

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

--uid --user-id

C2D-meddelandet, användar-ID-egenskapen.

--wait -w

Om du anger c2d-sändningsåtgärden blockeras tills enhetens feedback har tagits emot.

Godkända värden: false, true
Standardvärde: False
--yes -y

Hoppa över användarprompter. Anger godkännande av åtgärd. Används främst för automatiseringsscenarier. Standard: falskt.

Godkända värden: false, true
Standardvärde: False
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.

Godkända 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.