Compartir a través de

az iot hub job

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

Administración de trabajos de IoT Hub (v2).

Comandos

Nombre Description Tipo Estado
az iot hub job cancel

Cancelar un trabajo de IoT Hub.

 Extension GA
az iot hub job create

Cree y programe un trabajo de IoT Hub para su ejecución.

 Extension GA
az iot hub job list

Enumerar los trabajos históricos de una instancia de IoT Hub.

 Extension GA
az iot hub job show

Mostrar detalles de un trabajo de IoT Hub existente.

 Extension GA

az iot hub job cancel

Cancelar un trabajo de IoT Hub.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Ejemplos

Cancelar un trabajo de IoT Hub.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

Parámetros requeridos

--job-id

Identificador de trabajo de IoT Hub.

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.

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

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--hub-name -n

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

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--login -l

Este comando admite una cadena de conexión de entidad 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.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--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 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 hub job create

Cree y programe un trabajo de IoT Hub para su ejecución.

Al programar un trabajo de actualización de gemelos, la revisión del gemelo es un argumento obligatorio. Al programar un trabajo de método de dispositivo, el nombre del método y la carga son argumentos necesarios. NOTA: El uso de una hora de inicio personalizada que está en el pasado puede provocar un error en la operación.

az iot hub job create --job-id
                      --job-type --jt {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration --poll-duration]
                      [--hub-name]
                      [--interval --poll-interval]
                      [--login]
                      [--mct --method-connect-timeout]
                      [--method-name --mn]
                      [--method-payload --mp]
                      [--method-response-timeout --mrt]
                      [--patch --twin-patch]
                      [--query-condition]
                      [--resource-group]
                      [--start --start-time]
                      [--ttl]
                      [--wait {false, true}]

Ejemplos

Cree y programe un trabajo para actualizar las etiquetas gemelas de todos los dispositivos.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

Programe el trabajo y bloquee el resultado de "completed", "failed" o "cancelled". Especifique el intervalo de sondeo en segundos.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

Cree un trabajo para actualizar una propiedad de gemelo deseada en un subconjunto de dispositivos, programado para ejecutarse en un tiempo futuro arbitrario.

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

Cree y programe un trabajo para invocar un método de dispositivo para un conjunto de dispositivos que cumplen una condición de consulta.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

Cree y programe un trabajo para invocar un método de dispositivo para todos los dispositivos.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

Parámetros requeridos

--job-id

Identificador de trabajo de IoT Hub.

--job-type --jt

Tipo de trabajo programado.

Propiedad Valor
Valores aceptados: scheduleDeviceMethod, scheduleUpdateTwin

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.

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

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--duration --poll-duration

Duración total en segundos donde se comprobará el estado del trabajo si se pasa la marca --wait.

Propiedad Valor
Valor predeterminado: 600
--hub-name -n

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

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--interval --poll-interval

Intervalo en segundos en que se comprobará el estado del trabajo si se pasa la marca --wait.

Propiedad Valor
Valor predeterminado: 10
--login -l

Este comando admite una cadena de conexión de entidad 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.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--mct --method-connect-timeout

Número máximo de segundos para esperar en la conexión del dispositivo.

Propiedad Valor
Valor predeterminado: 30
--method-name --mn

Método de destino para la invocación.

--method-payload --mp

Carga json que se va a pasar al método . Debe ser la ruta de acceso del archivo o json sin formato.

--method-response-timeout --mrt

Número máximo de segundos para esperar el resultado del método del dispositivo.

Propiedad Valor
Valor predeterminado: 30
--patch --twin-patch

Revisión de gemelo deseada. Proporcione la ruta de acceso del archivo o json sin formato.

--query-condition -q

Condición para que la consulta de dispositivo obtenga dispositivos en los que se ejecute el trabajo. Obligatorio si el tipo de trabajo es scheduleDeviceMethod o scheduleUpdateTwin. Nota: El servicio prefijo "SELECT * FROM devices WHERE" (SELECT * FROM devices WHERE) en la entrada.

--resource-group -g

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

--start --start-time

Inicio programado del trabajo en formato de fecha y hora ISO 8601. Si no se proporciona ninguna hora de inicio, el trabajo se pone en cola para la ejecución del montón. El uso de una hora de inicio personalizada que está en el pasado puede provocar un error en la operación.

--ttl

Tiempo máximo de ejecución en segundos, antes de que finalice el trabajo.

Propiedad Valor
Valor predeterminado: 3600
--wait -w

Bloquee hasta que el trabajo creado esté en estado completado, con error o cancelado. Sondeará periódicamente el intervalo especificado por --poll-interval.

Propiedad Valor
Valor predeterminado: False
Valores aceptados: false, true
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 hub job list

Enumerar los trabajos históricos de una instancia de IoT Hub.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status --js {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type --jt {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

Ejemplos

Enumere todos los trabajos archivados dentro del período de retención (máximo de 30 días).

az iot hub job list --hub-name {iothub_name}

Enumerar todos los trabajos archivados que proyectan propiedades específicas

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

Enumerar solo los trabajos de tipo gemelo

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

Enumeración de los trabajos del método de dispositivo que tienen el estado "programado"

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

Enumeración de trabajos de exportación de dispositivos que tienen el estado "completado"

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

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.

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

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--hub-name -n

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

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--job-status --js

Estado de un trabajo programado.

Propiedad Valor
Valores aceptados: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Tipo de trabajo programado.

Propiedad Valor
Valores aceptados: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Este comando admite una cadena de conexión de entidad 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.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--resource-group -g

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

--top

Número máximo de elementos que se van a devolver. Use -1 para un límite ilimitado.

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 hub job show

Mostrar detalles de un trabajo de IoT Hub existente.

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

Ejemplos

Muestra los detalles de un trabajo creado.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

Parámetros requeridos

--job-id

Identificador de trabajo de IoT Hub.

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.

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

Propiedad Valor
Grupo de parámetros: Access Control Arguments
Valor predeterminado: key
Valores aceptados: key, login
--hub-name -n

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

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--login -l

Este comando admite una cadena de conexión de entidad 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.

Propiedad Valor
Grupo de parámetros: IoT Hub Identifier Arguments
--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 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