Compartilhar via

az iot central scheduled-job

  • Referência

Observação

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot central scheduled-job . Saiba mais sobre extensões.

Gerenciar e configurar o trabalho de agendamento do IoT Central.

Comandos

Nome Description Tipo Status
az iot central scheduled-job create

Crie um trabalho agendado por ID.

 Extensão GA
az iot central scheduled-job delete

Exclua um trabalho agendado existente por ID.

 Extensão GA
az iot central scheduled-job list

Obtenha a lista de definições de trabalho agendadas em um aplicativo.

 Extensão GA
az iot central scheduled-job list-runs

Obtenha a lista de instâncias de trabalho para uma definição de trabalho agendada.

 Extensão GA
az iot central scheduled-job show

Obtenha detalhes sobre um trabalho agendado por ID.

 Extensão GA
az iot central scheduled-job update

Atualize um trabalho agendado por ID.

 Extensão GA

az iot central scheduled-job create

Crie um trabalho agendado por ID.

--schedule e --content podem ser JSON embutido ou caminho de arquivo.

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]

Exemplos

Criar um trabalho de agendamento com nome

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

Crie um trabalho agendado com nome e configuração de lote.

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}

Crie um trabalho agendado com configuração de nome e limite de cancelamento sem 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 Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--content -k

A definição de dados de trabalho. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. O corpo da solicitação deve conter a matriz de JobData.

--group-id -g

A ID do grupo de dispositivos no qual executar o trabalho.

--id --job-id

Identificador exclusivo para o trabalho agendado.

--schedule

O cronograma no qual executar o trabalho. Forneça caminho para o arquivo JSON ou JSON stringificado bruto.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31
Valor padrão: 2022-07-31
--batch -b

O número ou a porcentagem de dispositivos nos quais o processamento em lote é feito.

--batch-type --bt

Especifique se o processamento em lote é feito em vários dispositivos ou em uma porcentagem do total.

Valores aceitos: number, percentage
Valor padrão: number
--cancellation-threshold --cth

O número ou a porcentagem de dispositivos nos quais o limite de cancelamento é aplicado.

--cancellation-threshold-batch --ctb

Se o limite de cancelamento se aplica por lote ou ao trabalho geral.

Valor padrão: number
--cancellation-threshold-type --ctt

Especifique se o limite de cancelamento se aplica a vários dispositivos ou a uma porcentagem do total.

Valores aceitos: number, percentage
Valor padrão: number
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com
--desc --description

Descrição detalhada do trabalho.

--job-name

Nome para exibição do trabalho.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central scheduled-job delete

Exclua um trabalho agendado existente por ID.

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

Exemplos

Excluir um trabalho agendado existente por ID

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

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31
Valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central scheduled-job list

Obtenha a lista de definições de trabalho agendadas em um aplicativo.

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

Exemplos

Obter a lista de definições de trabalho agendadas em um aplicativo

az iot central scheduled-job list --app-id {appid}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31
Valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central scheduled-job list-runs

Obtenha a lista de instâncias de trabalho para uma definição de trabalho agendada.

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

Exemplos

Obter a lista de instâncias de trabalho para uma definição de trabalho agendada

az iot central scheduled-job list-runs --app-id {appid} --job-id {jobId}

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31
Valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central scheduled-job show

Obtenha detalhes sobre um trabalho agendado por ID.

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

Exemplos

Obter detalhes sobre um trabalho agendado por ID

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

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31
Valor padrão: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot central scheduled-job update

Atualize um trabalho agendado por ID.

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]

Exemplos

Atualizar um trabalho de agendamento com nome

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

Parâmetros Exigidos

--app-id -n

A ID do aplicativo do IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Esse parâmetro de comando foi preterido e será ignorado. Na versão futura, só daremos suporte às APIs do IoT Central da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceitos: 2022-06-30-preview, 2022-07-31
Valor padrão: 2022-07-31
--batch -b

O número ou a porcentagem de dispositivos nos quais o processamento em lote é feito.

--batch-type --bt

Especifique se o processamento em lote é feito em vários dispositivos ou em uma porcentagem do total.

Valores aceitos: number, percentage
Valor padrão: number
--cancellation-threshold --cth

O número ou a porcentagem de dispositivos nos quais o limite de cancelamento é aplicado.

--cancellation-threshold-batch --ctb

Se o limite de cancelamento se aplica por lote ou ao trabalho geral.

--cancellation-threshold-type --ctt

Especifique se o limite de cancelamento se aplica a vários dispositivos ou a uma porcentagem do total.

Valores aceitos: number, percentage
Valor padrão: number
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Valor padrão: azureiotcentral.com
--content -k

A definição de dados de trabalho. Forneça caminho para o arquivo JSON ou JSON stringificado bruto. O corpo da solicitação deve conter a matriz de JobData.

--desc --description

Descrição detalhada do trabalho.

--group-id -g

A ID do grupo de dispositivos no qual executar o trabalho.

--job-name

Nome para exibição do trabalho.

--schedule

O cronograma no qual executar o trabalho. Forneça caminho para o arquivo JSON ou JSON stringificado bruto.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você poderá especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.