az iot hub module-identity
Manage IoT device modules.
Commands
| az iot hub module-identity create |
Create a module on a target IoT device in an IoT Hub. |
| az iot hub module-identity delete |
Delete a device in an IoT Hub. |
| az iot hub module-identity list |
List modules located on an IoT device in an IoT Hub. |
| az iot hub module-identity show |
Get the details of an IoT device module in an IoT Hub. |
| az iot hub module-identity show-connection-string |
Show a target IoT device module connection string. |
| az iot hub module-identity update |
Update an IoT Hub device module. |
az iot hub module-identity create
Create a module on a target IoT device in an IoT Hub.
az iot hub module-identity create --device-id
--module-id
[--am {shared_private_key, x509_ca, x509_thumbprint}]
[--hub-name]
[--login]
[--od]
[--primary-thumbprint]
[--resource-group]
[--secondary-thumbprint]
[--valid-days]Required Parameters
Target Device.
Target Module.
Optional Parameters
The authorization type an entity is to be created with.
IoT Hub name.
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.
Generate self-signed cert and use its thumbprint. Output to specified target directory.
Explicit self-signed certificate thumbprint to use for primary key.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Explicit self-signed certificate thumbprint to use for secondary key.
Generate self-signed cert and use its thumbprint. Valid for specified number of days. Default: 365.
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.
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
[--hub-name]
[--login]
[--resource-group]Required Parameters
Target Device.
Target Module.
Optional Parameters
IoT Hub name.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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.
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
[--hub-name]
[--login]
[--resource-group]
[--top]Required Parameters
Target Device.
Optional Parameters
IoT Hub name.
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.
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.
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.
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
[--hub-name]
[--login]
[--resource-group]Required Parameters
Target Device.
Target Module.
Optional Parameters
IoT Hub name.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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.
Increase logging verbosity. Use --debug for full debug logs.
az iot hub module-identity show-connection-string
Show a target IoT device module connection string.
az iot hub module-identity show-connection-string --device-id
--module-id
[--hub-name]
[--key-type {primary, secondary}]
[--login]
[--resource-group]Required Parameters
Target Device.
Target Module.
Optional Parameters
IoT Hub name.
Shared access policy key type for auth.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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.
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]
[--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.
Target Module.
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
IoT Hub name.
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.
Remove a property or an element from a list. Example: --remove property.list
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=
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.
Increase logging verbosity. Use --debug for full debug logs.