az iot hub module-identity
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 hub module-identity command. Learn more about extensions.
Manage IoT device modules.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot hub module-identity connection-string |
Manage IoT device module's connection string. |
Extension | GA |
| az iot hub module-identity connection-string show |
Show a target IoT device module connection string. |
Extension | GA |
| az iot hub module-identity create |
Create a module on a target IoT device in an IoT Hub. |
Extension | GA |
| az iot hub module-identity delete |
Delete a device in an IoT Hub. |
Extension | GA |
| az iot hub module-identity list |
List modules located on an IoT device in an IoT Hub. |
Extension | GA |
| az iot hub module-identity renew-key |
Renew target keys of an IoT Hub device module with sas authentication. |
Extension | GA |
| az iot hub module-identity show |
Get the details of an IoT device module in an IoT Hub. |
Extension | GA |
| az iot hub module-identity update |
Update an IoT Hub device module. |
Extension | GA |
az iot hub module-identity create
Create a module on a target IoT device in an IoT Hub.
When using the auth method of shared_private_key (also known as symmetric keys), if no custom keys are provided the service will generate them for the module.
az iot hub module-identity create --device-id
--module-id
[--am {shared_private_key, x509_ca, x509_thumbprint}]
[--auth-type {key, login}]
[--hub-name]
[--login]
[--od]
[--pk]
[--primary-thumbprint]
[--resource-group]
[--secondary-key]
[--secondary-thumbprint]
[--valid-days]Required Parameters
Target Device Id.
Target Module Id.
Optional Parameters
The authorization method an entity is to be created with.
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.
IoT Hub name or hostname. Required if --login is not provided.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.
Generate self-signed cert and use its thumbprint. Output to specified target directory.
The primary symmetric shared access key stored in base64 format.
Self-signed certificate thumbprint to use for the primary thumbprint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The secondary symmetric shared access key stored in base64 format.
Self-signed certificate thumbprint to use for the secondary thumbprint.
Generate self-signed cert and use its thumbprint. Valid for specified number of days. Default: 365.
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 hub module-identity delete
Delete a device in an IoT Hub.
az iot hub module-identity delete --device-id
--module-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]Required Parameters
Target Device Id.
Target Module Id.
Optional Parameters
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.
Etag or entity tag corresponding to the last state of the resource. If no etag is provided the value '*' is used.
IoT Hub name or hostname. Required if --login is not provided.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 hub module-identity list
List modules located on an IoT device in an IoT Hub.
az iot hub module-identity list --device-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]Required Parameters
Target Device Id.
Optional Parameters
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.
IoT Hub name or hostname. Required if --login is not provided.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Maximum number of elements to return. Use -1 for unlimited.
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 hub module-identity renew-key
Renew target keys of an IoT Hub device module with sas authentication.
az iot hub module-identity renew-key --device-id
--hub-name
--key-type {primary, secondary, swap}
--module-id
[--auth-type {key, login}]
[--etag]
[--login]
[--resource-group]Examples
Renew the primary key.
az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primarySwap the primary and secondary keys.
az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swapRequired Parameters
Target Device Id.
IoT Hub name or hostname. Required if --login is not provided.
Target key type to regenerate.
Target Module Id.
Optional Parameters
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.
Etag or entity tag corresponding to the last state of the resource. If no etag is provided the value '*' is used.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 hub module-identity show
Get the details of an IoT device module in an IoT Hub.
az iot hub module-identity show --device-id
--module-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]Required Parameters
Target Device Id.
Target Module Id.
Optional Parameters
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.
IoT Hub name or hostname. Required if --login is not provided.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 hub module-identity update
Update an IoT Hub device module.
Use --set followed by property assignments for updating a module. Leverage properties returned from 'iot hub module-identity show'.
az iot hub module-identity update --device-id
--module-id
[--add]
[--auth-type {key, login}]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--remove]
[--resource-group]
[--set]Examples
Regenerate module symmetric authentication keys
az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""Required Parameters
Target Device Id.
Target Module Id.
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Indicates whether the operation should auto-derive a policy key or use the current Azure AD session. If the authentication type is login and the resource hostname is provided, resource lookup will be skipped unless needed.You can configure the default using az configure --defaults iothub-data-auth-type=<auth-type-value>.
Etag or entity tag corresponding to the last state of the resource. If no etag is provided the value '*' is used.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
IoT Hub name or hostname. Required if --login is not provided.
This command supports an entity connection string with rights to perform action. Use to avoid session login via "az login". If both an entity connection string and name are provided the connection string takes priority. Required if --hub-name is not provided.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
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