Jobs - Get Scheduled Job
Obtém detalhes de um trabalho agendado do Hub IoT. Consulte https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs para obter mais informações.
GET https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}?api-version=2021-04-12
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
id
|
path | True |
string |
O identificador exclusivo do trabalho. |
api-version
|
query | True |
string |
Versão da Api. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK. |
Definições
Name | Description |
---|---|
Cloud |
Os parâmetros para executar um método direto no dispositivo. |
Device |
O status dos recursos habilitados no dispositivo. |
Device |
As estatísticas do trabalho relativas ao estado de execução. |
Job |
|
Twin |
As informações de estado de um dispositivo ou módulo. Isso é implicitamente criado e excluído quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT. |
Twin |
As propriedades desejadas e relatadas do gêmeo. 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 (int32) |
|
methodName |
string |
O nome do método a ser executado. |
payload |
object |
A carga útil direta do método formatado em JSON, até 128kb de tamanho. |
responseTimeoutInSeconds |
integer (int32) |
DeviceCapabilities
O status dos recursos habilitados no dispositivo.
Name | Tipo | Description |
---|---|---|
iotEdge |
boolean |
A propriedade que determina se o dispositivo é um dispositivo de borda ou não. |
DeviceJobStatistics
As estatísticas do trabalho relativas ao estado de execução.
Name | Tipo | Description |
---|---|---|
deviceCount |
integer (int32) |
O número de dispositivos visados pelo trabalho. |
failedCount |
integer (int32) |
O número de trabalhos falhados. |
pendingCount |
integer (int32) |
O número de trabalhos pendentes (agendados). |
runningCount |
integer (int32) |
O número de trabalhos em execução. |
succeededCount |
integer (int32) |
O número de empregos sucedidos. |
JobResponse
Name | Tipo | Description |
---|---|---|
cloudToDeviceMethod |
O tipo de método e parâmetros. Isso é necessário se o tipo de trabalho for cloudToDeviceMethod. |
|
createdTime |
string (date-time) |
Sistema gerado. Ignorado na criação. A data e hora de criação do trabalho. |
deviceJobStatistics |
Os detalhes sobre o status de execução do trabalho. |
|
endTime |
string (date-time) |
Sistema gerado. Ignorado na criação. A data e hora de término do trabalho em UTC. |
failureReason |
string |
O motivo da falha, se ocorreu uma falha. |
jobId |
string |
Sistema gerado. Ignorado na criação. O identificador exclusivo do trabalho. |
maxExecutionTimeInSeconds |
integer (int64) |
O tempo máximo de execução em secounds. |
queryCondition |
string |
A condição de consulta do dispositivo. |
startTime |
string (date-time) |
A data e hora de início do trabalho agendado em UTC. |
status |
enum:
|
Sistema gerado. Ignorado na criação. O status do trabalho. |
statusMessage |
string |
A mensagem de status do trabalho. |
type |
enum:
|
O tipo de trabalho. |
updateTwin |
As informações de estado de um dispositivo ou módulo. Isso é implicitamente criado e excluído quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT. |
Twin
As informações de estado de um dispositivo ou módulo. Isso é implicitamente criado e excluído quando a identidade do dispositivo/módulo correspondente é criada ou excluída no Hub IoT.
Name | Tipo | Description |
---|---|---|
authenticationType |
enum:
|
O tipo de autenticação usado pelo dispositivo. |
capabilities |
O status dos recursos habilitados no dispositivo. |
|
cloudToDeviceMessageCount |
integer (int32) |
O número de mensagens da nuvem para o dispositivo enviadas. |
connectionState |
enum:
|
O estado de conexão do dispositivo. |
deviceEtag |
string |
A cadeia de caracteres que representa um ETag para o dispositivo, conforme RFC7232. |
deviceId |
string |
O identificador exclusivo do dispositivo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
deviceScope |
string |
O escopo do dispositivo. |
etag |
string |
A cadeia de caracteres que representa um ETag para o gêmeo do dispositivo, conforme RFC7232. |
lastActivityTime |
string (date-time) |
A data e a hora em que o dispositivo se conectou ou recebeu ou enviou uma mensagem pela última vez. A data e a hora são separadas no formato datetime ISO8601 em UTC, por exemplo, 2015-01-28T16:24:48.789Z. Esse valor não será atualizado se o dispositivo usar o protocolo HTTP/1 para executar operações de mensagens. |
moduleId |
string |
O identificador exclusivo do módulo no registro de identidade do Hub IoT. É uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits, e os seguintes caracteres especiais {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
parentScopes |
string[] |
Os escopos dos dispositivos de borda de nível superior, se aplicável. Disponível apenas para dispositivos de borda. |
properties |
As propriedades desejadas e relatadas do gêmeo. |
|
status |
enum:
|
O status ativado do dispositivo. Se desativado, o dispositivo não pode se conectar ao serviço. |
statusReason |
string |
A razão para o status atual do dispositivo, se houver. |
statusUpdateTime |
string (date-time) |
A data e a hora em que o status do dispositivo foi atualizado pela última vez. |
tags |
object |
A coleção de pares chave-valor lidos e gravados pelo back-end da solução. Eles não são visíveis para aplicativos de dispositivo. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e up-to 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores são objetos JSON, up-to de 4 KB de comprimento. |
version |
integer (int64) |
A versão para o dispositivo gêmeo, incluindo tags e propriedades desejadas |
x509Thumbprint |
A impressão digital X509 do dispositivo. |
TwinProperties
As propriedades desejadas e relatadas do gêmeo. A profundidade máxima do objeto é 10.
Name | Tipo | Description |
---|---|---|
desired |
object |
A coleção de pares chave-valor de propriedade desejados. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e up-to de 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores porperty desejados são objetos JSON, up-to 4KB de comprimento. |
reported |
object |
A coleção de pares chave-valor de propriedade relatados. As chaves são codificadas em UTF-8, diferenciam maiúsculas de minúsculas e up-to de 1 KB de comprimento. Os caracteres permitidos excluem caracteres de controle UNICODE (segmentos C0 e C1), '.', '$' e espaço. Os valores de propriedade relatados são objetos JSON up-to 4 KB de comprimento. |
X509Thumbprint
Name | Tipo | Description |
---|---|---|
primaryThumbprint |
string |
A impressão digital primária do certificado do cliente X509. |
secondaryThumbprint |
string |
A impressão digital secundária do certificado do cliente X509. |