az iot central device edge module

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 edge module command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage IoT Edge device modules.

Commands

Name	Description	Type	Status
az iot central device edge module list	Get the list of modules in an IoT Edge device.	Extension	Preview
az iot central device edge module restart	Restart a module in an IoT Edge device.	Extension	Preview
az iot central device edge module show	Get a module in an IoT Edge device.	Extension	Preview

az iot central device edge module list

Preview

Command group 'iot central device edge module' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the list of modules in an IoT Edge device.

az iot central device edge module list --app-id
                                       --device-id
                                       [--central-api-uri]
                                       [--token]

Examples

List all modules in a device. (default)

az iot central device edge module list --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.

az iot central device edge module restart

Preview

Command group 'iot central device edge module' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Restart a module in an IoT Edge device.

az iot central device edge module restart --app-id
                                          --device-id
                                          --module-id
                                          [--central-api-uri]
                                          [--token]

Examples

Restart a module in a device.

az iot central device edge module restart --app-id {appid} --device-id {deviceId} --module-id {moduleId}

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.

--module-id -m

The module ID of the target module.

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.

az iot central device edge module show

Preview

Command group 'iot central device edge module' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a module in an IoT Edge device.

az iot central device edge module show --app-id
                                       --device-id
                                       --module-id
                                       [--central-api-uri]
                                       [--token]

Examples

Get a module in a device.

az iot central device edge module show --app-id {appid} --device-id {deviceId} --module-id {moduleId}

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.

--module-id -m

The module ID of the target module.

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.