Partilhar via

Jobs - Cancel Scheduled Job

  • Referência
Serviço:
IoT Hub
Versão da API:
2021-04-12

Cancela uma tarefa agendada no Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}/cancel?api-version=2021-04-12

Parâmetros do URI

Name Em Necessário Tipo Description
id
 path True

string

O identificador exclusivo da tarefa.
api-version
 query True

string

Versão da API.

Respostas

Name Tipo Description
200 OK

JobResponse

OK.

Definições

Name Description
CloudToDeviceMethod

Os parâmetros para executar um método direto no dispositivo.
DeviceCapabilities

O estado das capacidades ativadas no dispositivo.
DeviceJobStatistics

As estatísticas das tarefas relativas ao estado de execução.
JobResponse
Twin

As informações de estado de um dispositivo ou módulo. Isto é criado e eliminado implicitamente quando a identidade do módulo/dispositivo correspondente é criada ou eliminada no Hub IoT.
TwinProperties

As propriedades pretendidas e comunicadas do duplo. A profundidade máxima do objeto é 10.
X509Thumbprint

CloudToDeviceMethod

Os parâmetros para executar um método direto no dispositivo.

Name Tipo Description
connectTimeoutInSeconds

integer

methodName

string

O nome do método a executar.
payload

object

O payload do método direto formatado em JSON, com um tamanho máximo de 128 kb.
responseTimeoutInSeconds

integer

DeviceCapabilities

O estado das capacidades ativadas no dispositivo.

Name Tipo Description
iotEdge

boolean

A propriedade que determina se o dispositivo é ou não um dispositivo edge.

DeviceJobStatistics

As estatísticas das tarefas relativas ao estado de execução.

Name Tipo Description
deviceCount

integer

O número de dispositivos visados pela tarefa.
failedCount

integer

O número de tarefas falhadas.
pendingCount

integer

O número de tarefas pendentes (agendadas).
runningCount

integer

O número de tarefas em execução.
succeededCount

integer

O número de tarefas bem-sucedidas.

JobResponse

Name Tipo Description
cloudToDeviceMethod

CloudToDeviceMethod

O tipo de método e os parâmetros. Isto é necessário se o tipo de tarefa for cloudToDeviceMethod.
createdTime

string

Sistema gerado. Ignorado na criação. A data e hora de criação da tarefa.
deviceJobStatistics

DeviceJobStatistics

Os detalhes relativos ao estado de execução da tarefa.
endTime

string

Sistema gerado. Ignorado na criação. A data e hora de fim da tarefa em UTC.
failureReason

string

O motivo da falha, se tiver ocorrido uma falha.
jobId

string

Sistema gerado. Ignorado na criação. O identificador exclusivo da tarefa.
maxExecutionTimeInSeconds

integer

O tempo máximo de execução em secounds.
queryCondition

string

A condição de consulta do dispositivo.
startTime

string

A data e hora de início da tarefa agendada em UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Sistema gerado. Ignorado na criação. O estado da tarefa.
statusMessage

string

A mensagem de estado da tarefa.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

O tipo de tarefa.
updateTwin

Twin

As informações de estado de um dispositivo ou módulo. Isto é criado e eliminado implicitamente quando a identidade do módulo/dispositivo correspondente é criada ou eliminada no Hub IoT.

Twin

As informações de estado de um dispositivo ou módulo. Isto é criado e eliminado implicitamente quando a identidade do módulo/dispositivo correspondente é criada ou eliminada no Hub IoT.

Name Tipo Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

O tipo de autenticação utilizado pelo dispositivo.
capabilities

DeviceCapabilities

O estado das capacidades ativadas no dispositivo.
cloudToDeviceMessageCount

integer

O número de mensagens da cloud para o dispositivo enviadas.
connectionState enum:
  • Connected
  • Disconnected

O estado de ligação do dispositivo.
deviceEtag

string

A cadeia que representa uma ETag para o dispositivo, de acordo com RFC7232.
deviceId

string

O identificador exclusivo do dispositivo no registo de identidade do Hub IoT. É uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos ASCII de 7 bits, e os seguintes carateres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}.
deviceScope

string

O âmbito do dispositivo.
etag

string

A cadeia que representa uma ETag para o dispositivo duplo, de acordo com RFC7232.
lastActivityTime

string

A data e hora em que o dispositivo ligou ou recebeu ou enviou uma mensagem pela última vez. A data e hora são específicas no formato datetime ISO8601 em UTC, por exemplo, 2015-01-28T16:24:48.789Z. Este valor não é atualizado se o dispositivo utilizar o protocolo HTTP/1 para realizar operações de mensagens.
moduleId

string

O identificador exclusivo do módulo no registo de identidade do Hub IoT. É uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos ASCII de 7 bits, e os seguintes carateres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', '', '=', '@', ';', '$', '''}.
parentScopes

string[]

Os âmbitos dos dispositivos edge de nível superior, se aplicável. Apenas disponível para dispositivos edge.
properties

TwinProperties

As propriedades pretendidas e comunicadas do duplo.
status enum:
  • disabled
  • enabled

O estado ativado do dispositivo. Se estiver desativado, o dispositivo não consegue ligar ao serviço.
statusReason

string

O motivo do estado atual do dispositivo, se existir.
statusUpdateTime

string

A data e hora em que o estado do dispositivo foi atualizado pela última vez.
tags

object

A coleção de pares chave-valor lida e escrita pelo back-end da solução. Não estão visíveis para as aplicações do dispositivo. As chaves são codificadas com UTF-8, sensíveis a maiúsculas e minúsculas e até 1 KB de comprimento. Os carateres permitidos excluem carateres de controlo UNICODE (segmentos C0 e C1), ".", "$" e espaço. Os valores são objetos JSON, com um comprimento máximo de 4 KB.
version

integer

A versão do dispositivo duplo, incluindo etiquetas e propriedades pretendidas
x509Thumbprint

X509Thumbprint

O thumbprint X509 do dispositivo.

TwinProperties

As propriedades pretendidas e comunicadas do duplo. A profundidade máxima do objeto é 10.

Name Tipo Description
desired

object

A coleção de pares chave-valor de propriedade pretendidos. As chaves têm codificação UTF-8, sensíveis a maiúsculas e minúsculas e até 1 KB de comprimento. Os carateres permitidos excluem carateres de controlo UNICODE (segmentos C0 e C1), ".", "$" e espaço. Os valores de porperty pretendidos são objetos JSON, com um comprimento máximo de 4 KB.
reported

object

A coleção de pares chave-valor da propriedade reportada. As chaves têm codificação UTF-8, sensíveis a maiúsculas e minúsculas e até 1 KB de comprimento. Os carateres permitidos excluem carateres de controlo UNICODE (segmentos C0 e C1), ".", "$" e espaço. Os valores de propriedade comunicados são objetos JSON, com um comprimento máximo de 4 KB.

X509Thumbprint

Name Tipo Description
primaryThumbprint

string

O thumbprint primário do certificado de cliente X509.
secondaryThumbprint

string

O thumbprint secundário do certificado de cliente X509.