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

Administrar y configurar el trabajo de programación de IoT Central.

Comandos

Nombre	Description	Tipo	Estado
az iot central scheduled-job create	Cree un trabajo programado por identificador.	Extensión	GA
az iot central scheduled-job delete	Elimine un trabajo programado existente por identificador.	Extensión	GA
az iot central scheduled-job list	Obtenga la lista de definiciones de trabajo programadas en una aplicación.	Extensión	GA
az iot central scheduled-job list-runs	Obtenga la lista de instancias de trabajo para una definición de trabajo programada.	Extensión	GA
az iot central scheduled-job show	Obtenga detalles sobre un trabajo programado por identificador.	Extensión	GA
az iot central scheduled-job update	Actualice un trabajo programado por identificador.	Extensión	GA

az iot central scheduled-job create

Cree un trabajo programado por identificador.

--schedule y --content pueden ser json insertados o ruta de acceso de archivo.

az iot central scheduled-job create --app-id
                                    --content
                                    --group-id
                                    --id
                                    --schedule
                                    [--api-version {2022-06-30-preview, 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 de programación con el nombre

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule {jobScheduleJSONPatch} --content {jobDataJSONPath}

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

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

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

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --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. 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.

--id --job-id

Identificador único del trabajo programado.

--schedule

Programación en la que se va a ejecutar el trabajo. Proporcione la ruta de acceso al archivo JSON o json con cadena sin formato.

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

--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 scheduled-job delete

Elimine un trabajo programado existente por identificador.

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

Ejemplos

Eliminación de un trabajo programado existente por identificador

az iot central scheduled-job delete --app-id {appid} --id {scheduledJobId}

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.

--id --job-id

Identificador único del trabajo programado.

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 scheduled-job list

Obtenga la lista de definiciones de trabajo programadas en una aplicación.

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

Ejemplos

Obtener la lista de definiciones de trabajo programadas en una aplicación

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

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 scheduled-job list-runs

Obtenga la lista de instancias de trabajo para una definición de trabajo programada.

az iot central scheduled-job list-runs --app-id
                                       --id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Ejemplos

Obtener la lista de instancias de trabajos para una definición de trabajo programada

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

--id --job-id

Identificador único del trabajo programado.

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

Obtenga detalles sobre un trabajo programado por identificador.

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

Ejemplos

Obtención de detalles sobre un trabajo programado por identificador

az iot central scheduled-job show --app-id {appid} --id {scheduledJobId}

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.

--id --job-id

Identificador único del trabajo programado.

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 scheduled-job update

Actualice un trabajo programado por identificador.

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

Ejemplos

Actualización de un trabajo de programación con el nombre

az iot central scheduled-job update --app-id {appid} --job-id {jobId} --job-name {displayName}

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.

--id --job-id

Identificador único del trabajo programado.

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

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

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

--content -k

Definición de datos del trabajo. Proporcione la ruta de acceso al archivo JSON o json con cadena sin formato. El cuerpo de la solicitud debe contener una matriz de JobData.

--desc --description

Descripción detallada del trabajo.

--group-id -g

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

--job-name

Nombre para mostrar del trabajo.

--schedule

Programación en la que se va a ejecutar el trabajo. Proporcione la ruta de acceso al archivo JSON o json con cadena sin formato.

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