Partilhar via

az iot hub 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 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

Name Description Tipo Status
az iot hub job cancel

Cancelar um trabalho do Hub IoT.

 Extension disponibilidade geral
az iot hub job create

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

 Extension disponibilidade geral
az iot hub job list

Liste os trabalhos históricos de um Hub IoT.

 Extension disponibilidade geral
az iot hub job show

Mostrar detalhes de um trabalho existente do Hub IoT.

 Extension disponibilidade geral

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 Obrigatórios

--job-id

ID do trabalho do Hub IoT.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--hub-name -n

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

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--resource-group -g

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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 necessários. ATENÇÃO: Usar uma hora de início personalizada que está no passado pode fazer com que a operação falhe.

az iot hub job create --job-id
                      --job-type --jt {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration --poll-duration]
                      [--hub-name]
                      [--interval --poll-interval]
                      [--login]
                      [--mct --method-connect-timeout]
                      [--method-name --mn]
                      [--method-payload --mp]
                      [--method-response-timeout --mrt]
                      [--patch --twin-patch]
                      [--query-condition]
                      [--resource-group]
                      [--start --start-time]
                      [--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"}}'

Agendar trabalho e bloquear o resultado de "concluído", "reprovado" 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 Obrigatórios

--job-id

ID do trabalho do Hub IoT.

--job-type --jt

O tipo de trabalho agendado.

Propriedade Valor
Valores aceites: scheduleDeviceMethod, scheduleUpdateTwin

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--duration --poll-duration

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

Propriedade Valor
Default value: 600
--hub-name -n

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

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--interval --poll-interval

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

Propriedade Valor
Default value: 10
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--mct --method-connect-timeout

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

Propriedade Valor
Default value: 30
--method-name --mn

Método de destino para invocação.

--method-payload --mp

Carga útil Json 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.

Propriedade Valor
Default value: 30
--patch --twin-patch

O adesivo gêmeo desejado. Forneça o caminho do arquivo ou json bruto.

--query-condition -q

Condição para consulta de dispositivo para obter dispositivos para executar o trabalho. Necessário se o tipo de trabalho for scheduleDeviceMethod ou scheduleUpdateTwin. Nota: O serviço irá 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.

Propriedade Valor
Default value: 3600
--wait -w

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

Propriedade Valor
Default value: False
Valores aceites: false, true
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot hub job list

Liste os trabalhos históricos de um Hub IoT.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status --js {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type --jt {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 apenas trabalhos de tipo gêmeo de atualização

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 dispositivo com status "concluído"

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--hub-name -n

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

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--job-status --js

O status de um trabalho agendado.

Propriedade Valor
Valores aceites: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

O tipo de trabalho agendado.

Propriedade Valor
Valores aceites: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--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 devolver. Use -1 para ilimitado.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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 Obrigatórios

--job-id

ID do trabalho do Hub IoT.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--hub-name -n

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

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--resource-group -g

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False