az iot central job

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

Administrar y configurar trabajos para una aplicación de IoT Central.

Comandos

Nombre	Description	Tipo	Estado
az iot central job create	Cree y ejecute un trabajo a través de su definición de trabajo.	Extensión	GA
az iot central job get-devices	Obtiene los estados del dispositivo de trabajo.	Extensión	GA
az iot central job list	Obtenga la lista de trabajos de una aplicación de IoT Central.	Extensión	GA
az iot central job rerun	Vuelva a ejecutar un trabajo en todos los dispositivos con errores.	Extensión	GA
az iot central job resume	Reanude un trabajo detenido.	Extensión	GA
az iot central job show	Obtenga los detalles de un trabajo por identificador.	Extensión	GA
az iot central job stop	Detenga un trabajo en ejecución.	Extensión	GA

az iot central job create

Cree y ejecute un trabajo a través de su definición de trabajo.

az iot central job create --app-id
                          --content
                          --group-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--batch]
                          [--batch-type {number, percentage}]
                          [--cancellation-threshold]
                          [--cancellation-threshold-batch]
                          [--cancellation-threshold-type {number, percentage}]
                          [--central-api-uri]
                          [--desc]
                          [--job-name]
                          [--token]

Ejemplos

Creación de un trabajo con el nombre

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath}

Cree un trabajo con el nombre y la configuración por lotes.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

Cree un trabajo con configuración de umbral de nombre y cancelación sin lote.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --cancellation-threshold {jobCancellationThresholdValue} --cancellation-threshold-type {jobCancellationThresholdType} --description {jobDesc}

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 datos del trabajo. 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 una matriz de JobData.

--group-id -g

Identificador del grupo de dispositivos en el que se va a ejecutar el trabajo.

--job-id -j

Identificador único del trabajo.

Parámetros opcionales

--api-version --av

Obsoleto

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

Versión de la API para la operación solicitada.

Valores aceptados: 2022-07-31

Valor predeterminado: 2022-07-31

--batch -b

Número o porcentaje de dispositivos en los que se realiza el procesamiento por lotes.

--batch-type --bt

Especifique si el procesamiento por lotes se realiza en un número de dispositivos o un porcentaje del total.

Valores aceptados: number, percentage

Valor predeterminado: number

--cancellation-threshold --cth

Número o porcentaje de dispositivos en los que se aplica el umbral de cancelación.

--cancellation-threshold-batch --ctb

Si el umbral de cancelación se aplica por lote o al trabajo general.

Valor predeterminado: number

--cancellation-threshold-type --ctt

Especifique si se aplica el umbral de cancelación para un número de dispositivos o un porcentaje del total.

Valores aceptados: number, percentage

Valor predeterminado: number

--central-api-uri --central-dns-suffix

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

Valor predeterminado: azureiotcentral.com

--desc --description

Descripción detallada del trabajo.

--job-name

Nombre para mostrar del trabajo.

--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 job get-devices

Obtiene los estados del dispositivo de trabajo.

az iot central job get-devices --app-id
                               --job-id
                               [--api-version {2022-07-31}]
                               [--central-api-uri]
                               [--token]

Ejemplos

Obtención de la lista de estados de dispositivo individuales por identificador de trabajo

az iot central job get-devices --app-id {appid} --job-id {jobId}

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.

--job-id -j

Identificador único del trabajo.

Parámetros opcionales

--api-version --av

Obsoleto

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

Versión de la API para la operación solicitada.

Valores aceptados: 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 job list

Obtenga la lista de trabajos de una aplicación de IoT Central.

az iot central job list --app-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Ejemplos

Enumeración de trabajos en una aplicación

az iot central job 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.

Versión de la API para la operación solicitada.

Valores aceptados: 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 job rerun

Vuelva a ejecutar un trabajo en todos los dispositivos con errores.

az iot central job rerun --app-id
                         --job-id
                         --rerun-id
                         [--api-version {2022-07-31}]
                         [--central-api-uri]
                         [--token]

Ejemplos

Volver a ejecutar un trabajo

az iot central job rerun --app-id {appid} --job-id {jobId} --rerun-id {rerunId}

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.

--job-id -j

Identificador único del trabajo.

--rerun-id

Identificador único de la nueva ejecución.

Parámetros opcionales

--api-version --av

Obsoleto

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

Versión de la API para la operación solicitada.

Valores aceptados: 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 job resume

Reanude un trabajo detenido.

az iot central job resume --app-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--central-api-uri]
                          [--token]

Ejemplos

Reanudar un trabajo

az iot central job resume --app-id {appid} --job-id {jobId}

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.

--job-id -j

Identificador único del trabajo.

Parámetros opcionales

--api-version --av

Obsoleto

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

Versión de la API para la operación solicitada.

Valores aceptados: 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 job show

Obtenga los detalles de un trabajo por identificador.

az iot central job show --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Ejemplos

Obtención de detalles del trabajo

az iot central job show --app-id {appid} --job-id {jobId}

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.

--job-id -j

Identificador único del trabajo.

Parámetros opcionales

--api-version --av

Obsoleto

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

Versión de la API para la operación solicitada.

Valores aceptados: 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 job stop

Detenga un trabajo en ejecución.

az iot central job stop --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Ejemplos

Detener un trabajo

az iot central job stop --app-id {appid} --job-id {jobId}

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.

--job-id -j

Identificador único del trabajo.

Parámetros opcionales

--api-version --av

Obsoleto

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

Versión de la API para la operación solicitada.

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