Compartir a través de

az iot central device twin

Note

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

Administrar dispositivos gemelos de IoT Central.

Comandos

Nombre Description Tipo Estado
az iot central device twin replace

Reemplace los valores de propiedad grabables de un dispositivo, un componente de dispositivo o un módulo de dispositivo o un componente de módulo de dispositivo.

 Extension GA
az iot central device twin show

Obtenga todos los valores de propiedad de un dispositivo, un componente de dispositivo, un módulo de dispositivo o un componente de módulo de dispositivo.

 Extension GA
az iot central device twin update

Actualice los valores de propiedad grabables de un dispositivo, un componente de dispositivo, un módulo de dispositivo o un componente de módulo de dispositivo.

 Extension GA

az iot central device twin replace

Reemplace los valores de propiedad grabables de un dispositivo, un componente de dispositivo o un módulo de dispositivo o un componente de módulo de dispositivo.

Proporcionar --component-name, --module-name o ambos para reemplazar las propiedades del componente de dispositivo, las propiedades del módulo de dispositivo o las propiedades del componente del módulo de dispositivo.

az iot central device twin replace --app-id
                                   --content
                                   --device-id
                                   [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri --central-dns-suffix]
                                   [--co --component-name]
                                   [--mn --module-name]
                                   [--token]

Ejemplos

Reemplazar las propiedades del dispositivo

az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}

Reemplazar las propiedades del componente de dispositivo

az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Reemplazar las propiedades del componente del módulo de dispositivo

az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--content -k

Configuración de solicitud. Proporcione la ruta de acceso al archivo JSON o json con cadena sin formato. [Ejemplo de ruta de acceso de archivo: ./path/to/file.json] [Ejemplo json con cadena: {'a': 'b'}].

--device-id -d

Identificador de dispositivo del dispositivo de destino. Para encontrar el identificador de dispositivo, haga clic en el botón Conectar de la página Detalles del dispositivo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Propiedad Valor
Valor predeterminado: 2022-07-31
Valores aceptados: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Propiedad Valor
Valor predeterminado: azureiotcentral.com
--co --component-name

Nombre del componente de dispositivo.

--mn --module-name

Nombre del módulo de dispositivo.

--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

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

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot central device twin show

Obtenga todos los valores de propiedad de un dispositivo, un componente de dispositivo, un módulo de dispositivo o un componente de módulo de dispositivo.

Proporcionar --component-name, --module-name o ambos para obtener las propiedades del componente de dispositivo, las propiedades del módulo de dispositivo o las propiedades del componente del módulo de dispositivo.

az iot central device twin show --app-id
                                --device-id
                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri --central-dns-suffix]
                                [--co --component-name]
                                [--mn --module-name]
                                [--token]

Ejemplos

Obtención de las propiedades del dispositivo

az iot central device twin show --app-id {appid} --device-id {deviceid}

Obtención de propiedades de componentes de dispositivo

az iot central device twin show --app-id {appid} --device-id {deviceid} --co {componentname}

Obtención de las propiedades del componente del módulo de dispositivo

az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--device-id -d

Identificador de dispositivo del dispositivo de destino. Para encontrar el identificador de dispositivo, haga clic en el botón Conectar de la página Detalles del dispositivo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Propiedad Valor
Valor predeterminado: 2022-07-31
Valores aceptados: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Propiedad Valor
Valor predeterminado: azureiotcentral.com
--co --component-name

Nombre del componente de dispositivo.

--mn --module-name

Nombre del módulo de dispositivo.

--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

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

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az iot central device twin update

Actualice los valores de propiedad grabables de un dispositivo, un componente de dispositivo, un módulo de dispositivo o un componente de módulo de dispositivo.

Proporcionar --component-name, --module-name o ambos para actualizar las propiedades del componente de dispositivo, las propiedades del módulo de dispositivo o las propiedades del componente del módulo de dispositivo.

az iot central device twin update --app-id
                                  --content
                                  --device-id
                                  [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri --central-dns-suffix]
                                  [--co --component-name]
                                  [--mn --module-name]
                                  [--token]

Ejemplos

Actualizar las propiedades del dispositivo

az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}

Actualización de las propiedades del componente de dispositivo

az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Actualización de las propiedades del componente del módulo de dispositivo

az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--content -k

Configuración de solicitud. Proporcione la ruta de acceso al archivo JSON o json con cadena sin formato. [Ejemplo de ruta de acceso de archivo: ./path/to/file.json] [Ejemplo json con cadena: {'a': 'b'}].

--device-id -d

Identificador de dispositivo del dispositivo de destino. Para encontrar el identificador de dispositivo, haga clic en el botón Conectar de la página Detalles del dispositivo.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

Propiedad Valor
Valor predeterminado: 2022-07-31
Valores aceptados: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

Propiedad Valor
Valor predeterminado: azureiotcentral.com
--co --component-name

Nombre del componente de dispositivo.

--mn --module-name

Nombre del módulo de dispositivo.

--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

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

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

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

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False