az iot central device telemetry

Reference

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.46.0 or higher). The extension will automatically install the first time you run an az iot central device telemetry command. Learn more about extensions.

Query IoT Central device last telemetry value.

Commands

Name	Description	Type	Status
az iot central device telemetry show	Get the last telemetry value from a device.	Extension	GA

az iot central device telemetry show

Get the last telemetry value from a device.

az iot central device telemetry show --app-id
                                     --device-id
                                     --telemetry-name--tn
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--co]
                                     [--mn]
                                     [--token]

Examples

Get device telemetry value.

az iot central device telemetry show --app-id {appid} --device-id {deviceid} --telemetry-name {telemetryname}

Get device component telemetry value.

az iot central device telemetry show --app-id {appid} --device-id {deviceid} --component-name {componentname} --telemetry-name {telemetryname}

Get device module component telemetry value.

az iot central device telemetry show --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --telemetry-name {telemetryname}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

--device-id -d

The device ID of the target device.You can find the device ID by, clicking on the Connect button on the Device Details page.

--telemetry-name--tn

The name of the device telemetry.

Optional Parameters

--api-version --av

Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.

Accepted values: 2022-06-30-preview, 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com

--co --component-name

The name of the device component.

--mn --module-name

The name of the device module.

--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Share via