az iot central scheduled-job

Note

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

Gerencie e configure o trabalho de agendamento do IoT Central.

Comandos

Nome	Description	Tipo	Status
az iot central scheduled-job create	Crie um trabalho agendado por ID.	Extension	GA
az iot central scheduled-job delete	Exclua um trabalho agendado existente por ID.	Extension	GA
az iot central scheduled-job list	Obtenha a lista de definições de trabalho agendadas em um aplicativo.	Extension	GA
az iot central scheduled-job list-runs	Obtenha a lista de instâncias de trabalho para uma definição de trabalho agendada.	Extension	GA
az iot central scheduled-job show	Obtenha detalhes sobre um trabalho agendado por ID.	Extension	GA
az iot central scheduled-job update	Atualize um trabalho agendado por ID.	Extension	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 --job-id
                                    --schedule
                                    [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                    [--batch]
                                    [--batch-type --bt {number, percentage}]
                                    [--cancellation-threshold --cth]
                                    [--cancellation-threshold-batch --ctb]
                                    [--cancellation-threshold-type --ctt {number, percentage}]
                                    [--central-api-uri --central-dns-suffix]
                                    [--desc --description]
                                    [--job-name]
                                    [--token]

Exemplos

Criar um trabalho de agendamento com o 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 o nome e a configuração do 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 limite de nome e 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

--content -k

A definição de dados do trabalho. Forneça o caminho para o arquivo JSON ou JSON em cadeia de caracteres bruto. O corpo da solicitação deve conter uma 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

A agenda na qual executar o trabalho. Forneça o caminho para o arquivo JSON ou JSON em cadeia de caracteres bruto.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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ó ofereceremos suporte a APIs do IoT Central da versão mais recente da GA. Se alguma API ainda não for GA, chamaremos a versão prévia mais recente.

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

--batch -b

O número ou percentual de dispositivos nos quais o envio em lote é feito.

--batch-type --bt

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

Propriedade	Valor
Valor padrão:	number
Valores aceitos:	number, percentage

--cancellation-threshold --cth

O número ou percentual 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.

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

Propriedade	Valor
Valor padrão:	number
Valores aceitos:	number, percentage

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--desc --description

Descrição detalhada do trabalho.

--job-name

Nome de exibição do trabalho.

--token

Se preferir enviar sua solicitação sem se 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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az iot central scheduled-job delete

Exclua um trabalho agendado existente por ID.

az iot central scheduled-job delete --app-id
                                    --id --job-id
                                    [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri --central-dns-suffix]
                                    [--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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--api-version --av

Preterido

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

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

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

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 --av {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri --central-dns-suffix]
                                  [--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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--api-version --av

Preterido

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

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

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

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 --job-id
                                       [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri --central-dns-suffix]
                                       [--token]

Exemplos

Obter a lista de instâncias de trabalhos 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--api-version --av

Preterido

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

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

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az iot central scheduled-job show

Obtenha detalhes sobre um trabalho agendado por ID.

az iot central scheduled-job show --app-id
                                  --id --job-id
                                  [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri --central-dns-suffix]
                                  [--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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--api-version --av

Preterido

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

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

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--token

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az iot central scheduled-job update

Atualize um trabalho agendado por ID.

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

Exemplos

Atualizar um trabalho de agendamento com o 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 a ID do aplicativo na página "Sobre" para seu aplicativo no menu de ajuda.

--id --job-id

Identificador exclusivo para o trabalho agendado.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--api-version --av

Preterido

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

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

--batch -b

O número ou percentual de dispositivos nos quais o envio em lote é feito.

--batch-type --bt

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

Propriedade	Valor
Valor padrão:	number
Valores aceitos:	number, percentage

--cancellation-threshold --cth

O número ou percentual 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.

Propriedade	Valor
Valor padrão:	number
Valores aceitos:	number, percentage

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

O sufixo DNS do IoT Central associado ao seu aplicativo.

Propriedade	Valor
Valor padrão:	azureiotcentral.com

--content -k

A definição de dados do trabalho. Forneça o caminho para o arquivo JSON ou JSON em cadeia de caracteres bruto. O corpo da solicitação deve conter uma 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 de exibição do trabalho.

--schedule

A agenda na qual executar o trabalho. Forneça o caminho para o arquivo JSON ou JSON em cadeia de caracteres bruto.

--token

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

Comentários

Esta página foi útil?

Compartilhar via

az iot central scheduled-job

Comandos

az iot central scheduled-job create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central scheduled-job delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central scheduled-job list

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central scheduled-job list-runs

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central scheduled-job show

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az iot central scheduled-job update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários