Compartir a través de

az iot du device deployment

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

Administración de la implementación de dispositivos.

Las implementaciones aplicarán una actualización compatible deseada en un grupo de dispositivos de destino que distribuya la actualización entre las clases de dispositivo dentro del grupo. La directiva de reversión iniciada por la nube se puede configurar opcionalmente.

Comandos

Nombre Description Tipo Estado
az iot du device deployment cancel

Cancelar una implementación de subgrupo de clase de dispositivo.

 Extensión GA
az iot du device deployment create

Cree una implementación para un grupo de dispositivos. La implementación será multiconversión en cada subgrupo de clases de dispositivo dentro del grupo de destino.

 Extensión GA
az iot du device deployment delete

Elimine una implementación por grupo de dispositivos o subgrupo de clase de dispositivo.

 Extensión GA
az iot du device deployment list

Enumera las implementaciones de un grupo de dispositivos o un subgrupo de clase de dispositivo.

 Extensión GA
az iot du device deployment list-devices

Enumere los dispositivos de una implementación de subgrupo de clase de dispositivo junto con su estado. Resulta útil para obtener una lista de dispositivos con errores.

 Extensión GA
az iot du device deployment retry

Vuelva a intentar una implementación de subgrupo de clase de dispositivo.

 Extensión GA
az iot du device deployment show

Mostrar una implementación para un grupo de dispositivos o un subgrupo de clase de dispositivo, incluido el estado, que detalla un desglose de cuántos dispositivos de la implementación están en curso, completados o con errores.

 Extensión GA

az iot du device deployment cancel

Cancelar una implementación de subgrupo de clase de dispositivo.

az iot du device deployment cancel --account
                                   --cid
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--resource-group]

Ejemplos

Cancele la implementación del subgrupo de clase de dispositivo de destino.

az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--cid --class-id

Identificador de clase de dispositivo. Esto se genera a partir del identificador de modelo y las propiedades de compatibilidad notificadas por el agente de device update en la interfaz PnP de Device Update en IoT Hub. Es un hash SHA1 codificado hexadecimal.

--deployment-id --did

Identificador de implementación proporcionado por el autor de la llamada. Esto no puede tener más de 73 caracteres, debe ser todo en minúsculas y no puede contener '&', '^', '[', ']', '{', '}', '|', '<', '', '>', barra diagonal, barra diagonal inversa o comillas dobles.

--gid --group-id

Identificador del grupo de dispositivos. Esto se crea a partir del valor de la etiqueta ADUGroup en el dispositivo o módulo gemelo de IoT Hub conectado o $default para dispositivos sin etiqueta.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_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 du device deployment create

Cree una implementación para un grupo de dispositivos. La implementación será multiconversión en cada subgrupo de clases de dispositivo dentro del grupo de destino.

az iot du device deployment create --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   --un
                                   --up
                                   --update-version
                                   [--failed-count]
                                   [--failed-percentage]
                                   [--rbun]
                                   [--rbup]
                                   [--rbuv]
                                   [--resource-group]
                                   [--start-time]

Ejemplos

Cree una implementación de grupo de dispositivos programada para iniciarse inmediatamente (con respecto a la hora UTC).

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}

Cree una implementación de grupo de dispositivos programada para iniciarse en una fecha y hora de fecha y hora compatibles con iso-8601 deseada.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"

Cree una implementación de grupo de dispositivos programada para empezar inmediatamente con una directiva de reversión iniciada por la nube definida. La reversión de la nube se inicia cuando se cumplen los objetivos de recuento de errores o porcentaje de errores.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--deployment-id --did

Identificador de implementación proporcionado por el autor de la llamada. Esto no puede tener más de 73 caracteres, debe ser todo en minúsculas y no puede contener '&', '^', '[', ']', '{', '}', '|', '<', '', '>', barra diagonal, barra diagonal inversa o comillas dobles.

--gid --group-id

Identificador del grupo de dispositivos. Esto se crea a partir del valor de la etiqueta ADUGroup en el dispositivo o módulo gemelo de IoT Hub conectado o $default para dispositivos sin etiqueta.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

--un --update-name

Nombre de la actualización.

--up --update-provider

Proveedor de actualizaciones.

--update-version --uv

La versión de actualización.

Parámetros opcionales

--failed-count --fc

Entero que representa el número de dispositivos con errores en una implementación antes de que se produzca una reversión initatada en la nube. Obligatorio al definir la directiva de reversión.

--failed-percentage --fp

Entero que representa el porcentaje de dispositivos con errores en una implementación antes de que se produzca una reversión initatada en la nube. Obligatorio al definir la directiva de reversión.

--rbun --rollback-update-name

Nombre de la actualización de reversión.

--rbup --rollback-update-provider

Proveedor de actualización de reversión.

--rbuv --rollback-update-version

Versión de actualización de reversión.

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_group=<name>.

--start-time

Hora de inicio compatible con iso-8601 para la implementación. Si no se proporciona ningún valor, se usará el valor correspondiente para UTC 'now'.

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 du device deployment delete

Elimine una implementación por grupo de dispositivos o subgrupo de clase de dispositivo.

az iot du device deployment delete --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--cid]
                                   [--resource-group]
                                   [--yes {false, true}]

Ejemplos

Elimine la implementación del grupo de dispositivos de destino.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id}

Elimine la implementación del subgrupo de clase de dispositivo de destino.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--deployment-id --did

Identificador de implementación proporcionado por el autor de la llamada. Esto no puede tener más de 73 caracteres, debe ser todo en minúsculas y no puede contener '&', '^', '[', ']', '{', '}', '|', '<', '', '>', barra diagonal, barra diagonal inversa o comillas dobles.

--gid --group-id

Identificador del grupo de dispositivos. Esto se crea a partir del valor de la etiqueta ADUGroup en el dispositivo o módulo gemelo de IoT Hub conectado o $default para dispositivos sin etiqueta.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--cid --class-id

Identificador de clase de dispositivo. Esto se genera a partir del identificador de modelo y las propiedades de compatibilidad notificadas por el agente de device update en la interfaz PnP de Device Update en IoT Hub. Es un hash SHA1 codificado hexadecimal.

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_group=<name>.

--yes -y

Omita las indicaciones del usuario. Indica la aceptación de la acción. Se usa principalmente para escenarios de automatización. Valor predeterminado: false.

Valores aceptados: false, true
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 du device deployment list

Enumera las implementaciones de un grupo de dispositivos o un subgrupo de clase de dispositivo.

az iot du device deployment list --account
                                 --gid
                                 --instance
                                 [--cid]
                                 [--order-by]
                                 [--resource-group]

Ejemplos

Enumera las implementaciones de un grupo de dispositivos.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id}

Enumera las implementaciones de un grupo de dispositivos ordenando los resultados por startDateTime descendente.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"

Enumera las implementaciones de un subgrupo de clase de dispositivo.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--gid --group-id

Identificador del grupo de dispositivos. Esto se crea a partir del valor de la etiqueta ADUGroup en el dispositivo o módulo gemelo de IoT Hub conectado o $default para dispositivos sin etiqueta.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--cid --class-id

Identificador de clase de dispositivo. Esto se genera a partir del identificador de modelo y las propiedades de compatibilidad notificadas por el agente de device update en la interfaz PnP de Device Update en IoT Hub. Es un hash SHA1 codificado hexadecimal.

--order-by

Ordena el conjunto de implementaciones devueltas. Puede solicitar por startDateTime [desc/asc].

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_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 du device deployment list-devices

Enumere los dispositivos de una implementación de subgrupo de clase de dispositivo junto con su estado. Resulta útil para obtener una lista de dispositivos con errores.

az iot du device deployment list-devices --account
                                         --cid
                                         --deployment-id
                                         --gid
                                         --instance
                                         [--filter]
                                         [--resource-group]

Ejemplos

Enumera los dispositivos de una implementación de subgrupo de clase de dispositivo.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Enumere los dispositivos de un filtrado de implementación de subgrupos de clase de dispositivo por deviceId y deviceState.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--cid --class-id

Identificador de clase de dispositivo. Esto se genera a partir del identificador de modelo y las propiedades de compatibilidad notificadas por el agente de device update en la interfaz PnP de Device Update en IoT Hub. Es un hash SHA1 codificado hexadecimal.

--deployment-id --did

Identificador de implementación proporcionado por el autor de la llamada. Esto no puede tener más de 73 caracteres, debe ser todo en minúsculas y no puede contener '&', '^', '[', ']', '{', '}', '|', '<', '', '>', barra diagonal, barra diagonal inversa o comillas dobles.

--gid --group-id

Identificador del grupo de dispositivos. Esto se crea a partir del valor de la etiqueta ADUGroup en el dispositivo o módulo gemelo de IoT Hub conectado o $default para dispositivos sin etiqueta.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--filter

Restringe el conjunto de estados de dispositivo de implementación devueltos. Puede filtrar por deviceId y moduleId o deviceState.

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_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 du device deployment retry

Vuelva a intentar una implementación de subgrupo de clase de dispositivo.

az iot du device deployment retry --account
                                  --cid
                                  --deployment-id
                                  --gid
                                  --instance
                                  [--resource-group]

Ejemplos

Vuelva a intentar la implementación del subgrupo de clase de dispositivo de destino.

az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--cid --class-id

Identificador de clase de dispositivo. Esto se genera a partir del identificador de modelo y las propiedades de compatibilidad notificadas por el agente de device update en la interfaz PnP de Device Update en IoT Hub. Es un hash SHA1 codificado hexadecimal.

--deployment-id --did

Identificador de implementación proporcionado por el autor de la llamada. Esto no puede tener más de 73 caracteres, debe ser todo en minúsculas y no puede contener '&', '^', '[', ']', '{', '}', '|', '<', '', '>', barra diagonal, barra diagonal inversa o comillas dobles.

--gid --group-id

Identificador del grupo de dispositivos. Esto se crea a partir del valor de la etiqueta ADUGroup en el dispositivo o módulo gemelo de IoT Hub conectado o $default para dispositivos sin etiqueta.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_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 du device deployment show

Mostrar una implementación para un grupo de dispositivos o un subgrupo de clase de dispositivo, incluido el estado, que detalla un desglose de cuántos dispositivos de la implementación están en curso, completados o con errores.

az iot du device deployment show --account
                                 --deployment-id
                                 --gid
                                 --instance
                                 [--cid]
                                 [--resource-group]
                                 [--status {false, true}]

Ejemplos

Mostrar una implementación para un grupo de dispositivos.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id}

Muestra el estado de una implementación de grupo de dispositivos.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --status

Mostrar una implementación para un subgrupo de clase de dispositivo.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Mostrar el estado de una implementación de subgrupo de clase de dispositivo.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status

Parámetros requeridos

--account -n

Nombre de la cuenta de Device Update. Puede configurar el nombre de cuenta predeterminado mediante az config set defaults.adu_account=<name>.

--deployment-id --did

Identificador de implementación proporcionado por el autor de la llamada. Esto no puede tener más de 73 caracteres, debe ser todo en minúsculas y no puede contener '&', '^', '[', ']', '{', '}', '|', '<', '', '>', barra diagonal, barra diagonal inversa o comillas dobles.

--gid --group-id

Identificador del grupo de dispositivos. Esto se crea a partir del valor de la etiqueta ADUGroup en el dispositivo o módulo gemelo de IoT Hub conectado o $default para dispositivos sin etiqueta.

--instance -i

Nombre de instancia de Device Update. Puede configurar el nombre de instancia predeterminado mediante az config set defaults.adu_instance=<name>.

Parámetros opcionales

--cid --class-id

Identificador de clase de dispositivo. Esto se genera a partir del identificador de modelo y las propiedades de compatibilidad notificadas por el agente de device update en la interfaz PnP de Device Update en IoT Hub. Es un hash SHA1 codificado hexadecimal.

--resource-group -g

Nombre del grupo de recursos de la cuenta de Device Update. Puede configurar el grupo predeterminado mediante az config set defaults.adu_group=<name>.

--status

Obtiene el estado de una implementación, incluido un desglose del número de dispositivos de la implementación en curso, completados o con errores.

Valores aceptados: false, true
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.