in azext_iot/central/_help.py [0:0]
def _load_central_devices_help():
helps[
"iot central device"
] = """
type: group
short-summary: Manage and configure IoT Central devices
"""
helps[
"iot central device list"
] = """
type: command
short-summary: Get the list of devices for an IoT Central application.
examples:
- name: List all devices in an application, sorted by device Id (default)
text: >
az iot central device list
--app-id {appid}
"""
helps[
"iot central device create"
] = """
type: command
short-summary: Create a device in IoT Central.
examples:
- name: Create a device
text: >
az iot central device create
--app-id {appid}
--device-id {deviceid}
- name: Create a simulated device
text: >
az iot central device create
--app-id {appid}
--device-id {deviceid}
--template {devicetemplateid}
--simulated
"""
helps[
"iot central device update"
] = """
type: command
short-summary: Update a device in IoT Central.
long-summary: |
Allows to change the following properties of a device:
"displayName", "template", "simulated", "enabled" and "organizations".
Device Id cannot be changed.
examples:
- name: Update a device display name
text: >
az iot central device update
--app-id {appid}
--device-id {deviceid}
--device-name {deviceName}
- name: Turn a simulated device to a real one
text: >
az iot central device update
--app-id {appid}
--device-id {deviceid}
--simulated false
- name: Update organizations for the device
text: >
az iot central device update
--app-id {appid}
--device-id {deviceid}
--organizations {organizations}
- name: Disable a device
text: >
az iot central device update
--app-id {appid}
--device-id {deviceid}
--enable false
"""
helps[
"iot central device show"
] = """
type: command
short-summary: Get a device from IoT Central.
examples:
- name: Get a device
text: >
az iot central device show
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device manual-failover"
] = """
type: command
short-summary: Execute a manual failover of device across multiple IoT Hubs to validate device firmware's ability to reconnect using DPS to a different IoT Hub.
long-summary: For more information about high availability and default value for ttl-minutes visit https://github.com/iot-for-all/iot-central-high-availability-clients#readme
examples:
- name: Execute a manual failover of device across multiple IoT Hubs to validate device firmware's ability to reconnect using DPS to a different IoT Hub.
text: >
az iot central device manual-failover
--app-id {appid}
--device-id {deviceid}
--ttl-minutes {ttl_minutes}
"""
helps[
"iot central device manual-failback"
] = """
type: command
short-summary: Reverts the previously executed failover command by moving the device back to it's original IoT Hub
long-summary: For more information about high availability visit https://github.com/iot-for-all/iot-central-high-availability-clients#readme
examples:
- name: Reverts the previously executed failover command by moving the device back to it's original IoT Hub
text: >
az iot central device manual-failback
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device delete"
] = """
type: command
short-summary: Delete a device from IoT Central.
examples:
- name: Delete a device
text: >
az iot central device delete
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device show-credentials"
] = """
type: command
short-summary: Get device credentials from IoT Central.
examples:
- name: Get device credentials for a device
text: >
az iot central device show-credentials
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device registration-info"
] = """
type: command
short-summary: Get registration info on device(s) from IoT Central.
long-summary: |
Note: This command can take a significant amount of time to return if no device id is specified and your app contains a lot of devices.
examples:
- name: Get registration info on specified device
text: >
az iot central device registration-info
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device attestation"
] = """
type: group
short-summary: Manage and configure IoT Central device attestation.
"""
helps[
"iot central device attestation show"
] = """
type: command
short-summary: Get device attestation.
examples:
- name: Get device attestation on specified device
text: >
az iot central device attestation show
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device attestation delete"
] = """
type: command
short-summary: Remove an individual device attestation.
examples:
- name: Remove an individual device attestation on specified device
text: >
az iot central device attestation delete
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device attestation update"
] = """
type: command
short-summary: Update an individual device attestation via patch.
examples:
- name: Update an individual device attestation via patch on specified device
text: >
az iot central device attestation update
--app-id {appid}
--device-id {deviceid}
--content {attestation}
"""
helps[
"iot central device attestation create"
] = """
type: command
short-summary: Create an individual device attestation.
examples:
- name: Create an individual device attestation on specified device
text: >
az iot central device attestation create
--app-id {appid}
--device-id {deviceid}
--content {attestation}
"""
helps[
"iot central device list-components"
] = """
type: command
short-summary: List the components present in a device.
examples:
- name: List the components present in a device
text: >
az iot central device list-components
--app-id {appid}
--device-id {deviceid}
- name: List the components present in a device module
text: >
az iot central device list-components
--app-id {appid}
--module-name {modulename}
--device-id {deviceid}
"""
helps[
"iot central device list-modules"
] = """
type: command
short-summary: List the modules present in a device.
examples:
- name: List the modules present in a device
text: >
az iot central device list-modules
--app-id {appid}
--device-id {deviceid}
"""
helps[
"iot central device telemetry"
] = """
type: group
short-summary: Query IoT Central device last telemetry value
"""
helps[
"iot central device telemetry show"
] = """