az iot hub 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 hub job . Saiba mais sobre extensões.

Gerenciar trabalhos do Hub IoT (v2).

Comandos

Nome Description Tipo Status
az iot hub job cancel

Cancelar um trabalho do Hub IoT.

 Extensão GA
az iot hub job create

Crie e agende um trabalho do Hub IoT para execução.

 Extensão GA
az iot hub job list

Listar os trabalhos históricos de um Hub IoT.

 Extensão GA
az iot hub job show

Mostrar detalhes de um trabalho existente do Hub IoT.

 Extensão GA

az iot hub job cancel

Cancelar um trabalho do Hub IoT.

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

Exemplos

Cancelar um trabalho do Hub IoT.

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

Parâmetros Exigidos

--job-id

ID do trabalho do Hub IoT.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

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

Crie e agende um trabalho do Hub IoT para execução.

Ao agendar um trabalho de atualização gêmea, o patch gêmeo é um argumento necessário. Ao agendar um trabalho de método de dispositivo, o nome do método e a carga útil são argumentos obrigatórios. OBSERVAÇÃO: Usar uma hora de início personalizada que está no passado pode causar falha na operação.

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

Exemplos

Crie e agende um trabalho para atualizar as tags gêmeas de todos os dispositivos.

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

Agende o trabalho e bloqueie o resultado de "concluído", "falhou" ou "cancelado". Especifique o intervalo de sondagem em 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

Crie um trabalho para atualizar uma propriedade gêmea desejada em um subconjunto de dispositivos, agendado para ser executado em um momento futuro arbitrário.

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']"

Crie e agende um trabalho para invocar um método de dispositivo para um conjunto de dispositivos que atendam a uma condição 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"

Crie e agende um trabalho para invocar um método de dispositivo para todos os 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 Exigidos

--job-id

ID do trabalho do Hub IoT.

--job-type --jt

O tipo de trabalho agendado.

Valores aceitos: scheduleDeviceMethod, scheduleUpdateTwin

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--duration --poll-duration

Duração total em segundos, onde o status do trabalho será verificado se o sinalizador --wait for passado.

Valor padrão: 600
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--interval --poll-interval

Intervalo em segundos que o status do trabalho será verificado se o sinalizador --wait for passado.

Valor padrão: 10
--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--mct --method-connect-timeout

Número máximo de segundos a aguardar na conexão do dispositivo.

Valor padrão: 30
--method-name --mn

Método de destino para invocação.

--method-payload --mp

Json carga útil a ser passada para o método. Deve ser caminho do arquivo ou JSON bruto.

--method-response-timeout --mrt

Número máximo de segundos para aguardar o resultado do método do dispositivo.

Valor padrão: 30
--patch --twin-patch

O patch gêmeo desejado. Forneça o caminho do arquivo ou o JSON bruto.

--query-condition -q

Condição para que a consulta de dispositivo obtenha dispositivos para executar o trabalho. Necessário se o tipo de trabalho for scheduleDeviceMethod ou scheduleUpdateTwin. Nota: O serviço prefixará "SELECT * FROM devices WHERE " para a entrada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--start --start-time

O início agendado do trabalho no formato de data e hora ISO 8601. Se nenhuma hora de início for fornecida, o trabalho será enfileirado para execução o mais rápido possível. Usar uma hora de início personalizada que está no passado pode fazer com que a operação falhe.

--ttl

Tempo máximo de execução em segundos, antes que o trabalho seja encerrado.

Valor padrão: 3600
--wait -w

Bloquear até que o trabalho criado esteja em um estado concluído, com falha ou cancelado. Sondará regularmente o intervalo especificado por --poll-interval.

Valores aceitos: false, true
Valor padrão: False
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 hub job list

Listar os trabalhos históricos de um Hub IoT.

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

Exemplos

Liste todos os trabalhos arquivados dentro do período de retenção (máximo de 30 dias).

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

Listar todos os trabalhos arquivados projetando propriedades específicas

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

Listar somente atualizar trabalhos de tipo duplo

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

Listar trabalhos de método de dispositivo que têm status "agendado"

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

Listar trabalhos de exportação de dispositivos com status "concluído"

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

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--job-status --js

O status de um trabalho agendado.

Valores aceitos: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

O tipo de trabalho agendado.

Valores aceitos: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--top

Número máximo de elementos a serem retornados. Use -1 para ilimitado.

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

Mostrar detalhes de um trabalho existente do Hub IoT.

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

Exemplos

Mostrar os detalhes de um trabalho criado.

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

Parâmetros Exigidos

--job-id

ID do trabalho do Hub IoT.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

Valores aceitos: key, login
Valor padrão: key
--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

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.