az iot device c2d-message

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.37.0 of hoger). De extensie installeert automatisch de eerste keer dat u een opdracht az iot device c2d-message uitvoert. Meer informatie over extensies.

Cloud-naar-apparaat-berichtenopdrachten.

Opdracht

Name Description Type Status
az iot device c2d-message abandon

Een cloud-naar-apparaat-bericht verlaten.

 Toestel GA
az iot device c2d-message complete

Voltooi een cloud-naar-apparaat-bericht.

 Toestel GA
az iot device c2d-message purge

Cloud-naar-apparaat-berichtenwachtrij leegmaken voor een doelapparaat.

 Toestel GA
az iot device c2d-message receive

Een cloud-naar-apparaat-bericht ontvangen.

 Toestel GA
az iot device c2d-message reject

Een cloud-naar-apparaat-bericht weigeren of in een deadletter schrijven.

 Toestel GA
az iot device c2d-message send

Een cloud-naar-apparaat-bericht verzenden.

 Toestel GA

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

Optionele parameters

--etag -e

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

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

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

Optionele parameters

--etag -e

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

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot device c2d-message purge

Cloud-naar-apparaat-berichtenwachtrij leegmaken voor een doelapparaat.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot device c2d-message receive

Een cloud-naar-apparaat-bericht ontvangen.

De ontvangen berichttekst wordt alleen gedecodeerd wanneer de inhoudscodering is ingesteld op 'utf-8', 'utf-16' of 'utf-32'. De nettolading van het bericht wordt weergegeven als {{niet-ontsleutelbare nettolading}} wanneer inhoudscodering niet is ingesteld op een van de bovenstaande, of als inhoudscodering niet kan worden gedecodeerd, zelfs niet wanneer inhoudscodering is ingesteld op een van de bovenstaande opties.

Opmerking: er wordt slechts één bericht met het argument [--complete, --reject, --abandon] 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

Basaal gebruik

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

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

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

Een bericht ontvangen en het bericht 'voltooid' instellen nadat het is ontvangen

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

Een bericht ontvangen en weigeren 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-id.

Optionele parameters

--abandon

Verlaat het cloud-naar-apparaatbericht na ontvangstbevestiging.

geaccepteerde waarden: false, true
standaardwaarde: False
--complete

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

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

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--lock-timeout --lt

Hiermee geeft u op hoe lang een bericht onzichtbaar is voor andere oproepen.

standaardwaarde: 60
--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--reject

Negeer het cloud-naar-apparaat-bericht na ontvangstbevestiging.

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

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot device c2d-message reject

Een cloud-naar-apparaat-bericht weigeren of in een deadletter schrijven.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

--etag -e

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

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

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

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot device c2d-message send

Een cloud-naar-apparaat-bericht verzenden.

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

Opmerking: inhoudscodering is standaard ingesteld op utf-8. Met de opdracht wordt de berichttekst met coderingsactie verzonden wanneer de eigenschap inhoudscodering utf-8, utf-16 of utf-32 is. Als de waarde voor inhoudscodering niet een van deze is, wordt de eigenschap nog steeds verzonden zonder coderingsactie.

Wanneer u een binaire berichttekst verzendt, moet de inhoud worden opgegeven uit een bestand (via --data-file-path) en moet het inhoudstype worden ingesteld op 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}]

Voorbeelden

Basisgebruik met standaardtekst van bericht

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 apparaat

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

Verzend een C2D-bericht in binaire indeling vanuit een bestand.

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

Verzend een C2D-bericht in JSON-indeling vanuit een bestand.

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

--ack

Vraag de bezorging van feedback per bericht 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 bereikt, genereert IoT Hub een feedbackbericht. Negatief: Als het c2d-bericht de status Dead lettered bereikt, genereert IoT Hub een feedbackbericht. Volledig: IoT Hub genereert in beide gevallen een feedbackbericht. Standaard wordt er geen ack aangevraagd.

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

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

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

De codering voor de hoofdtekst van het C2D-bericht.

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

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

--content-type --ct

Het inhoudstype voor de hoofdtekst van het C2D-bericht.

--da --data

Berichttekst. Geef tekst of onbewerkte json op.

standaardwaarde: Ping from Az CLI IoT Extension
--data-file-path --dfp
Preview

Geef het pad naar het bestand op voor de nettolading van de berichttekst. Let op wanneer de nettolading moet worden verzonden in binaire indeling, stelt u het inhoudstype in op toepassing/octet-stream.

--expiry --expiry-time-utc

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

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--message-id --mid

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

--properties --props -p

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

--repair -r

Installeer de uamqp-afhankelijkheid opnieuw die compatibel is met de extensieversie. Standaard: onwaar.

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

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

--uid --user-id

Het C2D-bericht, eigenschap gebruikers-id.

--wait -w

Als de c2d-verzendbewerking is ingesteld, wordt deze geblokkeerd totdat apparaatfeedback is ontvangen.

geaccepteerde waarden: false, true
standaardwaarde: False
--yes -y

Gebruikersprompts overslaan. Geeft de acceptatie van de actie aan. Wordt voornamelijk gebruikt voor automatiseringsscenario's. Standaard: onwaar.

geaccepteerde waarden: false, true
standaardwaarde: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.