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
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
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.
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
The IoT Central DNS suffix associated with your application.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central device edge module restart
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
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.
The device ID of the target device.You can find the device ID by, clicking on the Connect button on the Device Details page.
The module ID of the target module.
Optional Parameters
The IoT Central DNS suffix associated with your application.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central device edge module show
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
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.
The device ID of the target device.You can find the device ID by, clicking on the Connect button on the Device Details page.
The module ID of the target module.
Optional Parameters
The IoT Central DNS suffix associated with your application.
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
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
