Delen via

az iot central device command

Note

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

Voer apparaatopdrachten uit.

Opdracht

Name Description Type Status
az iot central device command history

Haal de details op voor de meest recente opdrachtaanvraag en het antwoord dat naar het apparaat is verzonden.

 Extension GA
az iot central device command run

Voer een opdracht uit op een apparaat en bekijk het bijbehorende antwoord. Controleert geen updates van eigenschappen die door de opdracht kunnen worden uitgevoerd.

 Extension GA

az iot central device command history

Haal de details op voor de meest recente opdrachtaanvraag en het antwoord dat naar het apparaat is verzonden.

Hier ziet u de meest recente opdrachtaanvraag en het antwoord dat vanuit IoT Central naar het apparaat is verzonden. Elke update die door het apparaat wordt uitgevoerd op de apparaateigenschappen als gevolg van de uitvoering van de opdracht, wordt niet opgenomen in het antwoord.

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

Voorbeelden

Opdrachtantwoord weergeven

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

Antwoord van onderdeelopdracht weergeven

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

Opdrachtantwoord van moduleonderdeel weergeven

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--cn --command-name

De opdrachtnaam zoals opgegeven in de apparaatsjabloon. De opdrachtnaam kan afwijken van de weergavenaam van de opdracht.

--device-id -d

De apparaat-id van het doelapparaat. U vindt de apparaat-id door op de knop Verbinding maken te klikken op de pagina Apparaatdetails.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

Eigenschap Waarde
Default value: 2022-07-31
Geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Eigenschap Waarde
Default value: azureiotcentral.com
--co --component-name

De naam van het apparaatonderdeel.

--interface-id -i

De naam van de interface/het onderdeel zoals opgegeven in de apparaatsjabloon. U vindt deze door naar apparaatsjabloon te navigeren en de interface-/onderdeelidentiteit weer te geven onder de bijbehorende apparaatmogelijkheid.

--mn --module-name

De naam van de apparaatmodule.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie vindt u op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az iot central device command run

Voer een opdracht uit op een apparaat en bekijk het bijbehorende antwoord. Controleert geen updates van eigenschappen die door de opdracht kunnen worden uitgevoerd.

--content kan inline json of bestandspad zijn.

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

Voorbeelden

Voer de opdracht uit met inline nettolading. Nettolading moet onder 'aanvraag' in json-tekenreeks staan

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

Opdracht voor korte uitvoering met json-nettoladingpad.

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

Voer de onderdeelopdracht uit.

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

Voer de moduleonderdeelopdracht uit.

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--cn --command-name

De opdrachtnaam zoals opgegeven in de apparaatsjabloon. De opdrachtnaam kan afwijken van de weergavenaam van de opdracht.

--content -k

Configuratie voor aanvraag. Geef het pad naar het JSON-bestand of onbewerkte JSON op. [Voorbeeld van bestandspad: ./path/to/file.json] [Tekenreeks-JSON-voorbeeld: {'a': 'b'}].

--device-id -d

De apparaat-id van het doelapparaat. U vindt de apparaat-id door op de knop Verbinding maken te klikken op de pagina Apparaatdetails.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-version --av
Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

Eigenschap Waarde
Default value: 2022-07-31
Geaccepteerde waarden: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

Eigenschap Waarde
Default value: azureiotcentral.com
--co --component-name

De naam van het apparaatonderdeel.

--interface-id -i

De naam van de interface/het onderdeel zoals opgegeven in de apparaatsjabloon. U vindt deze door naar apparaatsjabloon te navigeren en de interface-/onderdeelidentiteit weer te geven onder de bijbehorende apparaatmogelijkheid.

--mn --module-name

De naam van de apparaatmodule.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie vindt u op https://aka.ms/iotcentraldocsapi.

Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False