az iot central device c2d-message

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 c2d-message command. Learn more about extensions.

Run device cloud-to-device messaging commands.

Commands

Name	Description	Type	Status
az iot central device c2d-message purge	Purges the cloud-to-device message queue for the target device.	Extension	GA

az iot central device c2d-message purge

Purges the cloud-to-device message queue for the target device.

az iot central device c2d-message purge --app-id
                                        --device-id
                                        [--central-api-uri]
                                        [--token]

Examples

Purges the cloud to device message queue for the target device.

az iot central device c2d-message purge --app-id {appid} --device-id {deviceid}

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.

Optional Parameters

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

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com

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