Iot Hub Resource - List Jobs

Referência

Service:: IoT Hub

API Version:: 2018-04-01

Obtenha uma lista de todos os trabalhos em um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs?api-version=2018-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o hub IoT.
resourceName	path	True	string	O nome do hub IoT.
subscriptionId	path	True	string	O identificador da assinatura.
api-version	query	True	string	A versão da API.

Respostas

Nome	Tipo	Description
200 OK	JobResponseListResult	Esta é uma operação síncrona. A resposta contém uma matriz serializada por JSON de todos os trabalhos no Hub IoT.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

IotHubResource_ListJobs

Sample Request

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/jobs?api-version=2018-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "jobId": "test",
      "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
      "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
      "type": "unknown",
      "status": "unknown"
    }
  ]
}

Definições

Nome	Description
ErrorDetails	Detalhes do erro.
JobResponse	As propriedades do objeto Job Response.
JobResponseListResult	A matriz serializada por JSON de objetos JobResponse com um próximo link.
JobStatus	O status do trabalho.
JobType	O tipo do trabalho.

ErrorDetails

Detalhes do erro.

Nome	Tipo	Description
code	string	O código de erro.
details	string	Os detalhes do erro.
httpStatusCode	string	O código de status do HTTP.
message	string	A mensagem de erro.

JobResponse

As propriedades do objeto Job Response.

Nome	Tipo	Description
endTimeUtc	string	A hora em que o trabalho parou de ser processado.
failureReason	string	Se status == falhou, essa cadeia de caracteres que contém o motivo da falha.
jobId	string	O identificador do trabalho.
parentJobId	string	O identificador de trabalho do trabalho pai, se houver.
startTimeUtc	string	A hora de início do trabalho.
status	JobStatus	O status do trabalho.
statusMessage	string	A mensagem status para o trabalho.
type	JobType	O tipo do trabalho.

JobResponseListResult

A matriz serializada por JSON de objetos JobResponse com um próximo link.

Nome	Tipo	Description
nextLink	string	O próximo link.
value	JobResponse[]	A matriz de objetos JobResponse.

JobStatus

O status do trabalho.

Nome	Tipo	Description
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

O tipo do trabalho.

Nome	Tipo	Description
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string