Jobs - Get

Serviço:: IoT Central

Versão da API:: 2022-07-31

Obter um emprego por ID
Obtenha detalhes sobre um trabalho em execução ou concluído por ID do trabalho.

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 todas as solicitações de serviço do Azure IoT Central.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	ID exclusivo do trabalho.
subdomain	path	True	string	O subdomínio do aplicativo.
api-version	query	True	string	A versão da API que está sendo chamada.

Respostas

Name	Tipo	Description
200 OK	Job	Sucesso
Other Status Codes	Error	Uma resposta de erro recebida do Serviço Central da IoT. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

Job

Sucesso

Other Status Codes

Error

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

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get a job by ID

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "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 do trabalho da propriedade na nuvem.
CommandJobData	A definição de dados do trabalho de comando.
DeviceTemplateMigrationJobData	A definição de dados de trabalho de migração de modelo de dispositivo.
Error	A definição de erro de resposta.
ErrorDetails	As informações detalhadas do erro.
Job	A definição do trabalho.
JobBatch	A definição de lote de trabalho.
JobBatchType	Se o processamento em lote é feito em um número especificado de dispositivos ou em uma porcentagem do total de dispositivos.
JobCancellationThreshold	A definição do limite de cancelamento de trabalho.
JobCancellationThresholdType	Se o limite de cancelamento é por um número especificado de dispositivos ou uma porcentagem do total de dispositivos.
JobProgress	Resumo do progresso de um trabalho agendado.
PropertyJobData	A definição de dados de trabalho de propriedade.

CloudPropertyJobData

Object

Os dados do trabalho da propriedade na nuvem.

Name	Tipo	Description
path	string	O caminho para o recurso de destino dentro do modelo de dispositivo.
target	string minLength: 1	O modelo de dispositivo que define a capacidade de destino para o trabalho.
type	string: cloudProperty	Tipo de dados do trabalho.
value	AnyValue	O valor usado para atualizar a capacidade de destino, se houver.

CommandJobData

Object

A definição de dados do trabalho de comando.

Name	Tipo	Description
path	string	O caminho para o recurso de destino dentro do modelo de dispositivo.
target	string minLength: 1	O modelo de dispositivo que define a capacidade de destino para o trabalho.
type	string: command	Tipo de dados do trabalho.
value	AnyValue	O valor usado para atualizar a capacidade de destino, se houver.

DeviceTemplateMigrationJobData

Object

A definição de dados de trabalho de migração de modelo de dispositivo.

Name	Tipo	Description
template	string minLength: 1	O modelo de dispositivo de destino para o qual os dispositivos serão migrados.
type	string: deviceTemplateMigration	Tipo de dados do trabalho.

Error

Object

A definição de erro de resposta.

Name	Tipo	Description
error	ErrorDetails	Detalhes do erro para a solicitação atual.

ErrorDetails

Object

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 a solicitação atual.
time	string (date-time-rfc1123)	A hora em que a solicitação de erro falhou.

Job

Object

A definição do trabalho.

Name	Tipo	Description
batch	JobBatch	A configuração em lote para o trabalho.
cancellationThreshold	JobCancellationThreshold	O limite de cancelamento para o trabalho.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Os recursos que estão sendo atualizados pelo trabalho e os valores com os quais eles estão sendo atualizados.
description	string	Descrição detalhada do trabalho.
displayName	string	Nome para exibição do trabalho.
end	string (date-time)	A hora de fim do trabalho
group	string	A ID do grupo de dispositivos no qual executar o trabalho.
id	string	ID exclusivo do trabalho.
organizations	string[]	Lista de organizações do trabalho, apenas uma organização é suportada hoje, 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 trabalho agendado que criou esse trabalho.
start	string (date-time)	A hora de início do trabalho
status	string	Indica se o trabalho está começando, em execução, etc.

JobBatch

Object

A definição de lote de trabalho.

Name	Tipo	Description
type	JobBatchType	Se o processamento em lote é feito em um número especificado de dispositivos ou em uma porcentagem do total de dispositivos.
value	number	O número ou a porcentagem de dispositivos nos quais o processamento em lote é feito.

JobBatchType

Enumeração

Se o processamento em lote é feito em um número especificado de dispositivos ou em uma porcentagem do total de dispositivos.

Valor	Description
number	Trabalho em lote com base no número de dispositivos.
percentage	Percentagem baseada no Job Batching do total de dispositivos aplicados.

JobCancellationThreshold

Object

A definição do limite de cancelamento de trabalho.

Name	Tipo	Description
batch	boolean	Se o limite de cancelamento se aplica por lote ou ao trabalho geral.
type	JobCancellationThresholdType	Se o limite de cancelamento é por um número especificado de dispositivos ou uma porcentagem do total de dispositivos.
value	number	O número ou a percentagem de dispositivos aos quais o limiar de cancelamento é aplicado.

JobCancellationThresholdType

Enumeração

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

Valor	Description
number	Limite de cancelamento de trabalho com base no número especificado de dispositivos.
percentage	Limite de cancelamento de trabalho com base na porcentagem do total de dispositivos.

JobProgress

Object

Resumo do progresso de um trabalho agendado.

Name	Tipo	Description
completed	integer (int32)	O número de entidades para as quais o trabalho foi concluído.
failed	integer (int32)	O número de entidades para as quais o trabalho falhou.
pending	integer (int32)	O número de entidades para as quais o trabalho ainda não está em execução.
total	integer (int32)	O número total de entidades visadas pelo trabalho.

PropertyJobData

Object

A definição de dados de trabalho de propriedade.

Name	Tipo	Description
path	string	O caminho para o recurso de destino dentro do modelo de dispositivo.
target	string minLength: 1	O modelo de dispositivo que define a capacidade de destino para o trabalho.
type	string: property	Tipo de dados do trabalho.
value	AnyValue	O valor usado para atualizar a capacidade de destino, se houver.

Partilhar via

Jobs - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Get a job by ID

Pedido de amostra

Resposta da amostra

Definições

CloudPropertyJobData

CommandJobData

DeviceTemplateMigrationJobData

Error

ErrorDetails

Job

JobBatch

JobBatchType

JobCancellationThreshold

JobCancellationThresholdType

JobProgress

PropertyJobData