Dela via

az iot central device command

  • 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 central device. Läs mer om tillägg.

Kör enhetskommandon.

Kommandon

Name Description Typ Status
az iot central device command history

Hämta information om den senaste kommandobegäran och det senaste svaret som skickats till enheten.

 Anknytning Allmän tillgänglighet
az iot central device command run

Kör ett kommando på en enhet och visa tillhörande svar. Övervakar INTE egenskapsuppdateringar som kommandot kan utföra.

 Anknytning Allmän tillgänglighet

az iot central device command history

Hämta information om den senaste kommandobegäran och det senaste svaret som skickats till enheten.

Visar den senaste kommandobegäran och det svar som skickades till enheten från IoT Central. Alla uppdateringar som enheten utför till enhetsegenskaperna som ett resultat av kommandokörningen ingår inte i svaret.

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

Exempel

Visa kommandosvar

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Visa komponentkommandosvar

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Visa modulkomponentkommandosvar

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--cn --command-name

Kommandonamnet som anges i enhetsmallen. Kommandonamnet kan skilja sig från kommandots visningsnamn.

--device-id -d

Målenhetens enhets-ID. Du hittar enhets-ID:t genom att klicka på knappen Anslut på sidan Enhetsinformation.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--co --component-name

Namnet på enhetskomponenten.

--interface-id -i

Namnet på gränssnittet/komponenten som anges i enhetsmallen. Du hittar den genom att gå till Enhetsmall och visa gränssnitts-/komponentidentiteten under motsvarande enhetsfunktion.

--mn --module-name

Namnet på enhetsmodulen.

--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

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 central device command run

Kör ett kommando på en enhet och visa tillhörande svar. Övervakar INTE egenskapsuppdateringar som kommandot kan utföra.

--content kan vara infogad json eller filsökväg.

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

Exempel

Kör kommandot med infogad nyttolast. Nyttolasten ska vara under "begäran" i json-strängen

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Kortkörningskommando med json-nyttolastsökväg.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Kör komponentkommandot.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Kör modulkomponentkommandot.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--cn --command-name

Kommandonamnet som anges i enhetsmallen. Kommandonamnet kan skilja sig från kommandots visningsnamn.

--content -k

Konfiguration för begäran. Ange sökväg till JSON-fil eller råsträngad JSON. [Exempel på filsökväg: ./path/to/file.json] [Strängifierad JSON-exempel: {'a': 'b'}].

--device-id -d

Målenhetens enhets-ID. Du hittar enhets-ID:t genom att klicka på knappen Anslut på sidan Enhetsinformation.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--co --component-name

Namnet på enhetskomponenten.

--interface-id -i

Namnet på gränssnittet/komponenten som anges i enhetsmallen. Du hittar den genom att gå till Enhetsmall och visa gränssnitts-/komponentidentiteten under motsvarande enhetsfunktion.

--mn --module-name

Namnet på enhetsmodulen.

--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

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.