Compartir a través de

az iot hub digital-twin

  • Referencia

Nota:

Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.46.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot hub digital-twin . Obtenga más información sobre las extensiones.

Manipule e interactúe con el gemelo digital de un dispositivo ioT Hub.

Comandos

Nombre Description Tipo Estado
az iot hub digital-twin invoke-command

Invoque un comando raíz o de nivel de componente de un dispositivo gemelo digital.

 Extensión GA
az iot hub digital-twin show

Mostrar el gemelo digital de un dispositivo ioT Hub.

 Extensión GA
az iot hub digital-twin update

Actualice las propiedades de lectura y escritura de un dispositivo gemelo digital mediante la especificación de revisión JSON.

 Extensión GA

az iot hub digital-twin invoke-command

Invoque un comando raíz o de nivel de componente de un dispositivo gemelo digital.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

Ejemplos

En general, invoque el comando que toma una carga que incluye cierta propiedad mediante JSON insertado.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

Invocación del comando de nivel raíz "reboot" que toma una carga denominada "delay" conforme al modelo DTDL https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

Invoque el comando "getMaxMinReport" en el componente "thermostat1" que no toma ninguna entrada.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

Parámetros requeridos

--cn --command-name

Nombre del comando gemelo digital.

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--component-path

Ruta de acceso del componente gemelo digital. Por ejemplo: thermostat1.

--connect-timeout --cto

Intervalo máximo de tiempo, en segundos, que IoT Hub intentará conectarse al dispositivo.

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--payload

Entrada de carga JSON para el comando. Proporcione la ruta de acceso del archivo o JSON insertado.

Valor predeterminado: {}
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--response-timeout --rto

Intervalo máximo de tiempo, en segundos, que el comando del gemelo digital esperará el resultado.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot hub digital-twin show

Mostrar el gemelo digital de un dispositivo ioT Hub.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

Ejemplos

Muestra el gemelo digital del dispositivo de destino.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

Parámetros opcionales

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot hub digital-twin update

Actualice las propiedades de lectura y escritura de un dispositivo gemelo digital mediante la especificación de revisión JSON.

Actualmente, las operaciones se limitan a agregar, reemplazar y quitar.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Ejemplos

Actualice un gemelo digital mediante la especificación de revisión JSON.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

Actualice un gemelo digital mediante la especificación de revisión JSON.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

Actualice una propiedad de gemelo digital mediante la especificación de revisión JSON definida en un archivo.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

--json-patch --patch

Especificación de actualización descrita por JSON-patch. Las operaciones se limitan a agregar, reemplazar y quitar. Proporcione la ruta de acceso del archivo o JSON insertado.

Parámetros opcionales

--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--hub-name -n

Nombre o nombre de host de IoT Hub. Obligatorio si no se proporciona --login.

--login -l

Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --hub-name.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.