Jobs - Get

Referência

Serviço:: IoT Central

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

Obter um trabalho 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 de URI

Nome	Em	Obrigató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 exclusiva 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

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

Nome

Tipo

Description

200 OK

Job

Êxito

Other Status Codes

Error

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

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a job by ID

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
CloudPropertyJobData	Os dados do trabalho de propriedade de nuvem.
CommandJobData	A definição de dados do trabalho de comando.
DeviceTemplateMigrationJobData	A definição de dados do trabalho 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 do trabalho.
JobBatch	A definição do lote de trabalho.
JobBatchType	Se o envio em lote é feito em um número especificado de dispositivos ou 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 de progresso para um trabalho agendado.
PropertyJobData	A definição de dados do trabalho de propriedade.

CloudPropertyJobData

Objeto

Os dados do trabalho de propriedade de nuvem.

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

CommandJobData

Objeto

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

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

DeviceTemplateMigrationJobData

Objeto

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

Nome	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

Objeto

A definição de erro de resposta.

Nome	Tipo	Description
error	ErrorDetails	Detalhes do erro da solicitação atual.

ErrorDetails

Objeto

As informações detalhadas do erro.

Nome	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

Objeto

A definição do trabalho.

Nome	Tipo	Description
batch	JobBatch	A configuração de envio em lote para o trabalho.
cancellationThreshold	JobCancellationThreshold	O limite de cancelamento do 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 de exibição do trabalho.
end	string (date-time)	A hora de término do trabalho
group	string	A ID do grupo de dispositivos no qual executar o trabalho.
id	string	ID exclusiva do trabalho.
organizations	string[]	Lista de organizações do trabalho, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.
progress	JobProgress	As estatísticas de progresso do trabalho.
scheduledJobId	string	ID da definição de trabalho agendada que criou esse trabalho.
start	string (date-time)	A hora de início do trabalho
status	string	Indica se o trabalho está sendo iniciado, em execução etc.

JobBatch

Objeto

A definição do lote de trabalho.

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

JobBatchType

Enumeração

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

Valor	Description
number	Envio em lote de trabalho com base no número de dispositivos.
percentage	Porcentagem baseada em Lote de Trabalhos do total de dispositivos aplicados.

JobCancellationThreshold

Objeto

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

Nome	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 percentual de dispositivos nos quais o limite 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

Objeto

resumo de progresso para um trabalho agendado.

Nome	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 direcionadas pelo trabalho.

PropertyJobData

Objeto

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

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

Compartilhar via

Jobs - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get a job by ID

Solicitação de exemplo

Resposta de exemplo

Definições

CloudPropertyJobData

CommandJobData

DeviceTemplateMigrationJobData

Error

ErrorDetails

Job

JobBatch

JobBatchType

JobCancellationThreshold

JobCancellationThresholdType

JobProgress

PropertyJobData