az iot hub module-twin

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 module-twin . Obtenga más información sobre las extensiones.

Administre la configuración de módulos gemelos de dispositivos IoT.

Comandos

Nombre	Description	Tipo	Estado
az iot hub module-twin replace	Reemplace una definición de módulo gemelo por json de destino.	Extensión	GA
az iot hub module-twin show	Mostrar una definición de módulo gemelo.	Extensión	GA
az iot hub module-twin update	Actualice las propiedades y etiquetas deseadas del módulo gemelo.	Extensión	GA

az iot hub module-twin replace

Reemplace una definición de módulo gemelo por json de destino.

Escriba json directamente o use una ruta de acceso de archivo.

az iot hub module-twin replace --device-id
                               --json
                               --module-id
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Ejemplos

Reemplace un módulo gemelo por el contenido del archivo.

az iot hub module-twin replace -d {device_id} -n {iothub_name} -m {module_name} -j ../mymodtwin.json

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

--json -j

Json para reemplazar el gemelo existente por. Proporcione la ruta de acceso del archivo o json sin formato.

--module-id -m

Id. del módulo de destino.

Parámetros opcionales

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

Valores aceptados: key, login

Valor predeterminado: key

--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.

az iot hub module-twin show

Mostrar una definición de módulo gemelo.

az iot hub module-twin show --device-id
                            --module-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

--module-id -m

Id. del módulo de destino.

Parámetros opcionales

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

Valores aceptados: key, login

Valor predeterminado: key

--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 module-twin update

Actualice las propiedades y etiquetas deseadas del módulo gemelo.

Proporcione argumentos --desired o --tags para el comportamiento PATCH. Ambos parámetros admiten json insertado o una ruta de acceso de archivo al contenido json. El uso de argumentos de actualización genéricos (es decir, --set) reflejará el comportamiento PUT y quedará en desuso.

az iot hub module-twin update --device-id
                              --module-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Ejemplos

Revisión de las propiedades deseadas del módulo gemelo.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Etiquetas de módulo gemelo de revisión.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags '{"country": "USA"}'

Aplique revisiones a etiquetas de módulo gemelo con contenido de archivo json.

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags /path/to/file

Eliminación de revisiones de la propiedad deseada "crítica" de la "temperatura" primaria

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Parámetros requeridos

--device-id -d

Id. de dispositivo de destino.

--module-id -m

Id. del módulo de destino.

Parámetros opcionales

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Valor predeterminado: []

--auth-type

Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iothub-data-auth-type=<auth-type-value>.

Valores aceptados: key, login

Valor predeterminado: key

--desired

Propiedades deseadas de gemelos.

--etag -e

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

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Valor predeterminado: False

--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.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Valor predeterminado: []

--resource-group -g

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

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Valor predeterminado: []

--tags

Etiquetas gemelas.

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.