az iot device c2d-message

Notitie

Deze referentie maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de opdracht az iot device c2d-message voor het eerst gebruikt. Meer informatie over extensies.

Berichtenopdrachten van cloud naar apparaat.

Opdracht

az iot device c2d-message abandon

Een cloud-naar-apparaat-bericht verlaten.

az iot device c2d-message complete

Voltooi een cloud-naar-apparaat-bericht.

az iot device c2d-message purge

De berichtenwachtrij van de cloud naar het apparaat opseensen voor een doelapparaat.

az iot device c2d-message receive

Een cloud-naar-apparaat-bericht ontvangen.

az iot device c2d-message reject

Een cloud-naar-apparaat-bericht afwijzen of in een impasse schrijven.

az iot device c2d-message send

Een cloud-naar-apparaat-bericht verzenden.

az iot device c2d-message abandon

Een cloud-naar-apparaat-bericht verlaten.

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

Vereiste parameters

--device-id -d

Doelapparaat.

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag is opgegeven, wordt de waarde * ' ' gebruikt.

Optionele parameters

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

az iot device c2d-message complete

Voltooi een cloud-naar-apparaat-bericht.

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

Vereiste parameters

--device-id -d

Doelapparaat.

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag is opgegeven, wordt de waarde * ' ' gebruikt.

Optionele parameters

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

az iot device c2d-message purge

De berichtenwachtrij van de cloud naar het apparaat opseensen voor een doelapparaat.

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

Vereiste parameters

--device-id -d

Doelapparaat.

Optionele parameters

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

az iot device c2d-message receive

Een cloud-naar-apparaat-bericht ontvangen.

Opmerking: slechts één ACK-berichtargument [--complete, --reject, --abandon] wordt geaccepteerd.

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

Voorbeelden

Basisgebruik

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

Een bericht ontvangen en een time-out voor vergrendeling instellen van 30 seconden voor dat bericht

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

Een bericht ontvangen en als 'voltooid' ontvangen

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

Een bericht ontvangen en afwijzen nadat het is ontvangen

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

Vereiste parameters

--device-id -d

Doelapparaat.

Optionele parameters

--abandon

Verlaat het cloud-naar-apparaat-bericht na ontvangst.

geaccepteerde waarden: false, true
--complete

Voltooi het cloud-naar-apparaat-bericht na ontvangst.

geaccepteerde waarden: false, true
--hub-name -n

IoT Hub naam.

--lock-timeout --lt

Hiermee geeft u de hoeveelheid tijd aan dat een bericht onzichtbaar is voor andere ontvangstoproepen.

standaardwaarde: 60
--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--reject

Weiger het cloud-naar-apparaat-bericht na ontvangst.

geaccepteerde waarden: false, true
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

az iot device c2d-message reject

Een cloud-naar-apparaat-bericht afwijzen of in een impasse schrijven.

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

Vereiste parameters

--device-id -d

Doelapparaat.

--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag is opgegeven, wordt de waarde * ' ' gebruikt.

Optionele parameters

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

az iot device c2d-message send

Een cloud-naar-apparaat-bericht verzenden.

EXPERIMENTAL vereist Python 3.4+ Deze opdracht is afhankelijk van en kan afhankelijk Cython-pakket (uamqp) installeren bij de eerste uitvoering. https://github.com/Azure/azure-uamqp-python.

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

Voorbeelden

Basisgebruik met standaardbericht

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

Cloud-naar-apparaat-bericht verzenden met aangepaste gegevens en eigenschappen.

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

Een C2D-bericht verzenden en wachten op bevestiging van het apparaat

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

Vereiste parameters

--device-id -d

Doelapparaat.

Optionele parameters

--ack

Vraag de levering van feedback per bericht aan met betrekking tot de uiteindelijke status van dat bericht. De beschrijving van ACK-waarden is als volgt. Positief: als het c2D-bericht de status Voltooid heeft, IoT Hub een feedbackbericht gegenereerd. Negatief: als het c2d-bericht de status Dead lettered bereikt, IoT Hub een feedbackbericht gegenereerd. Volledig: IoT Hub genereert in beide gevallen een feedbackbericht. Standaard wordt er geen ACK aangevraagd.

geaccepteerde waarden: full, negative, positive
--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--ce --content-encoding

De codering voor de C2D-bericht body.

standaardwaarde: utf-8
--cid --correlation-id

De correlatie-id die is gekoppeld aan het C2D-bericht.

--content-type --ct

Het inhoudstype voor de C2D-bericht body.

--da --data

Bericht.

standaardwaarde: Ping from Az CLI IoT Extension
--expiry --expiry-time-utc

Eenheden zijn milliseconden sinds unix-epoche. Als er geen tijd wordt aangegeven, wordt IoT Hub de TTL van het C2D-bericht gebruikt.

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--message-id --mid

De C2D-bericht-id. Als er geen bericht-id is opgegeven, wordt er een UUID gegenereerd.

--properties --props -p

Berichten in sleutel-waardeparen met de volgende indeling: a=b;c=d.

--repair -r

Uamqp-afhankelijkheid opnieuw installeren die compatibel is met de extensieversie. Standaard: onwaar.

geaccepteerde waarden: false, true
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .

--uid --user-id

Het C2D-bericht, de eigenschap gebruikers-id.

--wait -w

Als de c2d-verzendbewerking is ingesteld, wordt deze geblokkeerd totdat de feedback van het apparaat is ontvangen.

geaccepteerde waarden: false, true
--yes -y

Gebruikersprompts overslaan. Geeft aan dat de installatie van afhankelijkheden is geaccepteerd (indien nodig). Voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

geaccepteerde waarden: false, true