az iot device

  • 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 az iot-apparaatopdracht uitvoert. Meer informatie over extensies.

Maak gebruik van apparaatsimulatie en andere apparaatgerichte bewerkingen, zoals mogelijkheden voor apparaat-naar-cloud- of cloud-naar-apparaatberichten.

Opdracht

Name Description Type Status
az iot device c2d-message

Cloud-naar-apparaat-berichtenopdrachten.

 Toestel GA
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 registration

IoT-apparaatregistraties beheren voor de IoT Device Provisioning Service.

 Toestel Preview uitvoeren
az iot device registration create

Registreer een IoT-apparaat bij de IoT Device Provisioning Service.

 Toestel Preview uitvoeren
az iot device send-d2c-message

Een mqtt-apparaat-naar-cloudbericht verzenden.

 Toestel GA
az iot device simulate

Een apparaat simuleren in een Azure IoT Hub.

 Toestel Experimenteel
az iot device upload-file

Upload een lokaal bestand als een apparaat naar een vooraf geconfigureerde blobopslagcontainer.

 Toestel GA

az iot device send-d2c-message

Een mqtt-apparaat-naar-cloudbericht verzenden.

De opdracht ondersteunt het verzenden van berichten met aangepaste nettolading in unicode-tekenreeks of binaire indeling. Wanneer u een binair bestand wilt verzenden, moeten de gegevens afkomstig zijn van een bestand (via --data-file-path) en het inhoudstype moet worden ingesteld op application/octet-stream.

Opmerking: de opdracht werkt alleen voor apparaten op basis van symmetrische sleutels (SAS). Als u query's wilt inschakelen voor een berichttekst in berichtroutering, moet de eigenschap contentType-systeem toepassing/JSON zijn en moet de eigenschap contentEncoding-systeem een van de UTF-coderingswaarden zijn die worden ondersteund door die systeemeigenschap (UTF-8, UTF-16 of UTF-32). Als de inhoudscodering niet is ingesteld wanneer Azure Storage wordt gebruikt als routeringseindpunt, schrijft IoT Hub de berichten in basis 64 gecodeerde indeling. Als u x509-verificatiemethoden gebruikt, moeten het certificaat- en sleutelbestanden (en de wachtwoordzin indien nodig) worden opgegeven.

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]

Voorbeelden

Basaal gebruik

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

Basisgebruik voor apparaat dat de model-id van 'dtmi:com:example:Thermostat; 1' bij verbinding

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

Basisgebruik voor apparaat met x509-verificatie

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

Basisgebruik voor apparaat met x509-verificatie waarbij het sleutelbestand een wachtwoordzin heeft

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

Basisgebruik met aangepaste gegevens

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

Toepassingseigenschappen verzenden

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

Systeemeigenschappen verzenden (bericht-id en correlatie-id)

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

Aangepaste gegevens verzenden door inhoudstype en inhoudscodering op te geven in systeemeigenschappen

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

Aangepaste gegevens verzenden in binaire indeling door inhoudscodering op te geven in systeemeigenschappen

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

Aangepaste gegevens verzenden in JSON-indeling door inhoudstype en inhoudscodering op te geven in systeemeigenschappen

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

--certificate-file-path --cp

Pad naar certificaatbestand.

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

--dtmi --model-id

De Digital Twin-model-id die het apparaat rapporteert wanneer u verbinding maakt met de hub. Zie https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play voor meer informatie.

--hub-name -n

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

--key --symmetric-key

Symmetrische sleutel die moet worden gebruikt voor het apparaat. Als de symmetrische sleutel en andere argumenten voor apparaatverificatie worden opgegeven, heeft symmetrische sleutel prioriteit.

--key-file-path --kp

Pad naar sleutelbestand.

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

--mc --msg-count

Aantal apparaatberichten dat moet worden verzonden naar IoT Hub.

standaardwaarde: 1
--pass --passphrase

Wachtwoordzin voor sleutelbestand.

--properties --props -p

Berichteneigenschapsverzameling in sleutel-waardeparen met de volgende indeling: a=b; c=d. Voor mqtt-berichten kunt u systeemeigenschappen verzenden met behulp van $.=value. Bijvoorbeeld $.cid=12345 stelt de eigenschap van de systeemcorrelatie-id in. Andere voorbeelden van systeemeigenschaps-id's zijn $.ct voor inhoudstype, $.mid voor bericht-id en $.ce voor inhoudscodering.

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

Experimenteel

Deze opdracht is experimenteel en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Een apparaat simuleren in een Azure IoT Hub.

Terwijl de apparaatsimulatie wordt uitgevoerd, ontvangt en bevestigt het apparaat automatisch cloud-naar-apparaat-berichten (c2d). Voor mqtt-simulatie worden alle c2d-berichten met voltooiing bevestigd. Voor http-simulatie c2d-bevestiging is gebaseerd op gebruikersselectie die kan worden voltooid, geweigerd of afgebroken. De mqtt-simulatie biedt ook ondersteuning voor directe methode-aanroep, die kan worden bevestigd door een antwoordstatuscode en nettolading van de reactie. Opmerking: met de opdracht wordt standaard het inhoudstype ingesteld op application/json en content-codering op utf-8. Dit kan worden overschreven. Opmerking: als u x509-verificatiemethoden gebruikt, moeten de certificaat- en sleutelbestanden (en wachtwoordzin indien nodig) worden opgegeven.

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]

Voorbeelden

Basisgebruik (mqtt)

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

Basisgebruik voor apparaat dat de model-id van 'dtmi:com:example:Thermostat; 1' bij verbinding (mqtt)

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

Basisgebruik voor apparaat met x509-verificatie (mqtt)

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

Basisgebruik voor apparaat met x509-verificatie (mqtt) waarin het sleutelbestand een wachtwoordzin heeft

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

Gemengde eigenschappen verzenden (mqtt)

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

Statuscode voor antwoord van directe methode en nettolading voor directe methoden verzenden als onbewerkte json (alleen mqtt)

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

Statuscode voor antwoord van directe methode en nettolading van directe methodeantwoord verzenden als pad naar lokaal bestand (alleen mqtt)

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

De initiële status van gerapporteerde eigenschappen van apparaatdubbel verzenden als onbewerkte json voor het doelapparaat (alleen mqtt)

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

De initiële status van gerapporteerde eigenschappen van apparaatdubbel verzenden als pad naar het lokale bestand voor het doelapparaat (alleen mqtt)

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

Basisgebruik (http)

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

Gemengde eigenschappen verzenden (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"

Het totale aantal berichten en het interval tussen berichten kiezen

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

C2d-berichten weigeren (alleen http)

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

C2d-berichten afbreken (alleen http)

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

Vereiste parameters

--device-id -d

Doelapparaat-id.

Optionele parameters

--certificate-file-path --cp

Pad naar certificaatbestand.

--da --data

Berichttekst. Geef tekst of onbewerkte json op.

standaardwaarde: Ping from Az CLI IoT Extension
--dtmi --model-id

De Digital Twin-model-id die het apparaat rapporteert wanneer u verbinding maakt met de hub. Zie https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play voor meer informatie.

--hub-name -n

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

--init-reported-properties --irp

Initiële status van gerapporteerde eigenschappen van dubbels voor het doelapparaat wanneer de simulator wordt uitgevoerd. Optionele param, alleen ondersteund voor mqtt.

--key --symmetric-key

Symmetrische sleutel die moet worden gebruikt voor het apparaat. Als de symmetrische sleutel en andere argumenten voor apparaatverificatie worden opgegeven, heeft symmetrische sleutel prioriteit.

--key-file-path --kp

Pad naar sleutelbestand.

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

--mc --msg-count

Aantal apparaatberichten dat moet worden verzonden naar IoT Hub.

standaardwaarde: 100
--method-response-code --mrc

Statuscode die moet worden geretourneerd wanneer de directe methode wordt uitgevoerd op het apparaat. Optionele param, alleen ondersteund voor mqtt.

--method-response-payload --mrp

Nettolading die moet worden geretourneerd wanneer de directe methode wordt uitgevoerd op het apparaat. Geef bestandspad of onbewerkte json op. Optionele param, alleen ondersteund voor mqtt.

--mi --msg-interval

Vertraging in seconden tussen apparaat-naar-cloud-berichten.

standaardwaarde: 3
--pass --passphrase

Wachtwoordzin voor sleutelbestand.

--properties --props -p

Berichteneigenschapsverzameling in sleutel-waardeparen met de volgende indeling: a=b; c=d. Voor mqtt-berichten kunt u systeemeigenschappen verzenden met behulp van $.=value. Bijvoorbeeld $.cid=12345 stelt de eigenschap van de systeemcorrelatie-id in. Andere voorbeelden van systeemeigenschaps-id's zijn $.ct voor inhoudstype, $.mid voor bericht-id en $.ce voor inhoudscodering. Voor http-berichten: toepassingseigenschappen worden verzonden met behulp van iothub-app-=value, bijvoorbeeld iothub-app-myprop=myvalue. Systeemeigenschappen worden over het algemeen voorafgegaan door iothub, zoals iothub-correlationid, maar er zijn uitzonderingen zoals inhoudstype en inhoudscodering.

--proto --protocol

Geeft het protocol voor apparaat-naar-cloud-berichten aan.

geaccepteerde waarden: http, mqtt
standaardwaarde: mqtt
--receive-settle --rs

Geeft aan hoe u ontvangen cloud-naar-apparaat-berichten vereffent. Alleen ondersteund met HTTP.

geaccepteerde waarden: abandon, complete, reject
standaardwaarde: complete
--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 upload-file

Upload een lokaal bestand als een apparaat naar een vooraf geconfigureerde blobopslagcontainer.

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

Vereiste parameters

--content-type --ct

MIME-type bestand.

--device-id -d

Doelapparaat-id.

--file-path --fp

Pad naar bestand voor uploaden.

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.