Iot Hub Resource - Get Job

Служба:: IoT Hub

Версия API:: 2023-06-30

Получение сведений о задании из Центра Интернета вещей. Дополнительные сведения см. в статье 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/{jobId}?api-version=2023-06-30

Параметры URI

Имя	В	Обязательно	Тип	Описание
jobId	path	True	string	Идентификатор задания.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей Центр Интернета вещей.
resourceName	path	True	string	Имя Центра Интернета вещей.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Ответы

Имя	Тип	Описание
200 OK	JobResponse	Это синхронная операция. Ответ содержит сериализованное в ФОРМАТЕ JSON описание задания в Центре Интернета вещей.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

IotHubResource_GetJob

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
ErrorDetails	Сведения об ошибке.
JobResponse	Свойства объекта Job Response.
JobStatus	Состояние задания.
JobType	Тип задания.

ErrorDetails

Object

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

JobResponse

Object

Свойства объекта Job Response.

Имя	Тип	Описание
endTimeUtc	string (date-time-rfc1123)	Время остановки обработки задания.
failureReason	string	Если состояние == завершилось ошибкой, эта строка содержит причину сбоя.
jobId	string	Идентификатор задания.
parentJobId	string	Идентификатор задания родительского задания, если таковой есть.
startTimeUtc	string (date-time-rfc1123)	Время начала задания.
status	JobStatus	Состояние задания.
statusMessage	string	Сообщение о состоянии задания.
type	JobType	Тип задания.

JobStatus

Перечисление

Состояние задания.

Значение	Описание
unknown
enqueued
running
completed
failed
cancelled

JobType