az iot central device-template
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.37.0 or higher). The extension will automatically install the first time you run an az iot central device-template command. Learn more about extensions.
Manage and configure IoT Central device templates.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot central device-template create |
Create a device template in IoT Central. |
Extension | GA |
| az iot central device-template delete |
Delete a device template from IoT Central. |
Extension | GA |
| az iot central device-template list |
Get the list of device templates for an IoT Central application. |
Extension | GA |
| az iot central device-template show |
Get a device template from IoT Central. |
Extension | GA |
| az iot central device-template update |
Update a device template in IoT Central. |
Extension | GA |
az iot central device-template create
Create a device template in IoT Central.
az iot central device-template create --app-id
--content
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Create a device template with payload read from a file
az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}Create a device template with payload read from raw json
az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}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 template definition. Provide path to JSON file or raw stringified JSON. [File Path Example: ./path/to/file.json] [Example of stringified JSON: {}]. The request body must contain CapabilityModel.
Digital Twin Model Identifier of the device template. Learn more at https://aka.ms/iotcentraldtmi.
Optional Parameters
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.
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-template delete
Delete a device template from IoT Central.
Note: this is expected to fail if any devices are still associated to this template.
az iot central device-template delete --app-id
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Delete a device template from IoT Central
az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}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 ID of the target device template. Example: somedevicetemplate.
Optional Parameters
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.
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-template list
Get the list of device templates for an IoT Central application.
az iot central device-template list --app-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--compact]
[--token]Examples
List all device templates in an application, sorted by template Id (default)
az iot central device-template list --app-id {appid}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.
Optional Parameters
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.
The IoT Central DNS suffix associated with your application.
Show templates in compact mode. For each template will only display id, name and model types.
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-template show
Get a device template from IoT Central.
az iot central device-template show --app-id
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Get a device template
az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}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 ID of the target device template. Example: somedevicetemplate.
Optional Parameters
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.
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-template update
Update a device template in IoT Central.
az iot central device-template update --app-id
--content
--device-template-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--token]Examples
Update a device template with payload read from a file
az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}Update a device template with payload read from raw json
az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}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 template definition. Provide path to JSON file or raw stringified JSON. [File Path Example: ./path/to/file.json] [Example of stringified JSON: {}]. The request body must contain CapabilityModel.
The ID of the target device template. Example: somedevicetemplate.
Optional Parameters
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.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for