Partilhar via


Jobs - Get

Obter um trabalho por ID
Obtenha detalhes sobre uma tarefa em execução ou concluída por ID da tarefa.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

Parâmetros do URI

Name Em Necessário Tipo Description
baseDomain
path True

string

O domínio base para todos os pedidos de serviço do Azure IoT Central.

jobId
path True

string

ID exclusivo da tarefa.

Padrão Regex: ^[a-zA-Z0-9_-]*$

subdomain
path True

string

O subdomínio da aplicação.

api-version
query True

string

A versão da API que está a ser chamada.

Respostas

Name Tipo Description
200 OK

Job

Com êxito

Other Status Codes

Error

Uma resposta de erro recebida do Serviço IoT Central.

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Get a job by ID

Pedido de amostra

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Resposta da amostra

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Definições

Name Description
CloudPropertyJobData

Os dados da tarefa de propriedade da cloud.

CommandJobData

A definição de dados da tarefa de comando.

DeviceTemplateMigrationJobData

A definição de dados da tarefa de migração do modelo de dispositivo.

Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

Job

A definição da tarefa.

JobBatch

A definição do lote de tarefas.

JobBatchType

Se o batching é feito num número especificado de dispositivos ou numa percentagem do total de dispositivos.

JobCancellationThreshold

A definição do limiar de cancelamento da tarefa.

JobCancellationThresholdType

Se o limiar de cancelamento é por um número especificado de dispositivos ou uma percentagem do total de dispositivos.

JobProgress

resumo do progresso de uma tarefa agendada.

PropertyJobData

A definição de dados da tarefa de propriedade.

CloudPropertyJobData

Os dados da tarefa de propriedade da cloud.

Name Tipo Description
path

string

O caminho para a capacidade de destino no modelo de dispositivo.

target

string

O modelo de dispositivo que define a capacidade de destino da tarefa.

type string:

cloudProperty

Tipo de dados da tarefa.

value

AnyValue

O valor utilizado para atualizar a capacidade de destino, se existir.

CommandJobData

A definição de dados da tarefa de comando.

Name Tipo Description
path

string

O caminho para a capacidade de destino no modelo de dispositivo.

target

string

O modelo de dispositivo que define a capacidade de destino da tarefa.

type string:

command

Tipo de dados da tarefa.

value

AnyValue

O valor utilizado para atualizar a capacidade de destino, se existir.

DeviceTemplateMigrationJobData

A definição de dados da tarefa de migração do modelo de dispositivo.

Name Tipo Description
template

string

O modelo de dispositivo de destino para o qual os dispositivos serão migrados.

type string:

deviceTemplateMigration

Tipo de dados da tarefa.

Error

A definição de erro de resposta.

Name Tipo Description
error

ErrorDetails

Detalhes do erro do pedido atual.

ErrorDetails

As informações detalhadas do erro.

Name Tipo Description
code

string

Código de erro.

message

string

Detalhes da mensagem de erro.

requestId

string

ID de Correlação para pedido atual.

time

string

A hora em que o pedido de erro falhou.

Job

A definição da tarefa.

Name Tipo Description
batch

JobBatch

A configuração de criação de lotes para a tarefa.

cancellationThreshold

JobCancellationThreshold

O limiar de cancelamento da tarefa.

data JobData[]:

As capacidades que estão a ser atualizadas pela tarefa e os valores com os quais estão a ser atualizados.

description

string

Descrição detalhada da tarefa.

displayName

string

Nome a apresentar da tarefa.

end

string

A hora de fim da tarefa

group

string

O ID do grupo de dispositivos no qual executar a tarefa.

id

string

ID exclusivo da tarefa.

organizations

string[]

Lista de organizações do trabalho, apenas uma organização é suportada atualmente, várias organizações serão suportadas em breve.

progress

JobProgress

As estatísticas de progresso do trabalho.

scheduledJobId

string

ID da definição de tarefa agendada que criou esta tarefa.

start

string

A hora de início da tarefa

status

string

Indica se a tarefa está a ser iniciada, em execução, etc.

JobBatch

A definição do lote de tarefas.

Name Tipo Description
type

JobBatchType

Se o batching é feito num número especificado de dispositivos ou numa percentagem do total de dispositivos.

value

number

O número ou percentagem de dispositivos em que o lote é feito.

JobBatchType

Se o batching é feito num número especificado de dispositivos ou numa percentagem do total de dispositivos.

Name Tipo Description
number

string

Criação de Batches de Tarefas com base no número de dispositivos.

percentage

string

Percentagem baseada em Batching de Tarefas do total de dispositivos aplicados.

JobCancellationThreshold

A definição do limiar de cancelamento da tarefa.

Name Tipo Description
batch

boolean

Se o limiar de cancelamento se aplica por lote ou à tarefa geral.

type

JobCancellationThresholdType

Se o limiar de cancelamento é por um número especificado de dispositivos ou uma percentagem do total de dispositivos.

value

number

O número ou percentagem de dispositivos em que o limiar de cancelamento é aplicado.

JobCancellationThresholdType

Se o limiar de cancelamento é por um número especificado de dispositivos ou uma percentagem do total de dispositivos.

Name Tipo Description
number

string

Limiar de cancelamento de tarefas com base no número especificado de dispositivos.

percentage

string

Limiar de cancelamento de tarefas com base na percentagem do total de dispositivos.

JobProgress

resumo do progresso de uma tarefa agendada.

Name Tipo Description
completed

integer

O número de entidades para as quais a tarefa foi concluída.

failed

integer

O número de entidades para as quais a tarefa falhou.

pending

integer

O número de entidades para as quais a tarefa ainda não está em execução.

total

integer

O número total de entidades visadas pela tarefa.

PropertyJobData

A definição de dados da tarefa de propriedade.

Name Tipo Description
path

string

O caminho para a capacidade de destino no modelo de dispositivo.

target

string

O modelo de dispositivo que define a capacidade de destino da tarefa.

type string:

property

Tipo de dados da tarefa.

value

AnyValue

O valor utilizado para atualizar a capacidade de destino, se existir.