az iot central device-template

  • 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 central device-template . Obtenga más información sobre las extensiones.

Administrar y configurar plantillas de dispositivo de IoT Central.

Comandos

Nombre Description Tipo Estado
az iot central device-template create

Cree una plantilla de dispositivo en IoT Central.

 Extensión GA
az iot central device-template delete

Elimine una plantilla de dispositivo de IoT Central.

 Extensión GA
az iot central device-template list

Obtenga la lista de plantillas de dispositivo para una aplicación de IoT Central.

 Extensión GA
az iot central device-template show

Obtenga una plantilla de dispositivo de IoT Central.

 Extensión GA
az iot central device-template update

Actualice una plantilla de dispositivo en IoT Central.

 Extensión GA

az iot central device-template create

Cree una plantilla de dispositivo en IoT Central.

az iot central device-template create --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Ejemplos

Creación de una plantilla de dispositivo con carga leída desde un archivo

az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Creación de una plantilla de dispositivo con carga leída desde json sin formato

az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}

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

Definición de la plantilla de dispositivo. 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 de JSON con cadena: {}]. El cuerpo de la solicitud debe contener CapabilityModel.

--device-template-id --dtid

Identificador de modelo de gemelo digital de la plantilla de dispositivo. Obtenga más información en https://aka.ms/iotcentraldtmi.

Parámetros opcionales

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

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

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

Valor predeterminado: azureiotcentral.com
--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 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 central device-template delete

Elimine una plantilla de dispositivo de IoT Central.

Nota: Se espera que se produzca un error si algún dispositivo todavía está asociado a esta plantilla.

az iot central device-template delete --app-id
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Ejemplos

Eliminación de una plantilla de dispositivo de IoT Central

az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}

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-template-id --dtid

Identificador de la plantilla de dispositivo de destino. Ejemplo: somedevicetemplate.

Parámetros opcionales

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

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

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

Valor predeterminado: azureiotcentral.com
--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 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 central device-template list

Obtenga la lista de plantillas de dispositivo para una aplicación de IoT Central.

az iot central device-template list --app-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--compact]
                                    [--token]

Ejemplos

Enumerar todas las plantillas de dispositivo de una aplicación, ordenadas por identificador de plantilla (valor predeterminado)

az iot central device-template list --app-id {appid}

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.

Parámetros opcionales

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

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

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

Valor predeterminado: azureiotcentral.com
--compact -c

Mostrar plantillas en modo compacto. Para cada plantilla solo se mostrarán los tipos id, name y model.

Valor predeterminado: False
--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 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 central device-template show

Obtenga una plantilla de dispositivo de IoT Central.

az iot central device-template show --app-id
                                    --device-template-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--token]

Ejemplos

Obtención de una plantilla de dispositivo

az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}

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-template-id --dtid

Identificador de la plantilla de dispositivo de destino. Ejemplo: somedevicetemplate.

Parámetros opcionales

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

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

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

Valor predeterminado: azureiotcentral.com
--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 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 central device-template update

Actualice una plantilla de dispositivo en IoT Central.

az iot central device-template update --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Ejemplos

Actualización de una plantilla de dispositivo con carga leída desde un archivo

az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Actualización de una plantilla de dispositivo con carga leída desde json sin formato

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

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

Definición de la plantilla de dispositivo. 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 de JSON con cadena: {}]. El cuerpo de la solicitud debe contener CapabilityModel.

--device-template-id --dtid

Identificador de la plantilla de dispositivo de destino. Ejemplo: somedevicetemplate.

Parámetros opcionales

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

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

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

Valor predeterminado: azureiotcentral.com
--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 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.