Поделиться через

Devices - Claim

  • Ссылка
Служба:
Azure Sphere Public API
Версия API:
v2

Запускает асинхронную операцию для утверждения устройства указанному клиенту.

PUT https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devices/{deviceId}/claim

Параметры URI

Имя В Обязательно Тип Описание
deviceId
 path True

string

Идентификатор устройства.
tenantId
 path True

string

uuid

Идентификатор клиента Azure Sphere.

Ответы

Имя Тип Описание
202 Accepted

Operation

Успешно запущена операция.

Определения

Имя Описание
ErrorResponse
Operation

ErrorResponse

Имя Тип Описание
Code enum:
  • 0 - OperationFailed
  • 1 - TenantInMigration
  • 2 - TenantMigrationRequired
  • 3 - ClientUpdateRequired
  • 4 - InternalServerError
  • 5 - BadRequest
  • 6 - Forbidden
  • 7 - Conflict
  • 8 - NotFound

Возвращает код.
Message

string

Возвращает сообщение об ошибке, доступное для чтения пользователем.

Operation

Имя Тип Описание
CompletedDateUTC

string

Возвращает дату выполнения операции в формате UTC.
CreatedDateUTC

string

Возвращает дату создания операции в формате UTC.
DetailsLocation

string

Возвращает расположение для получения сведений об операции.
Error

ErrorResponse

OperationId

string

Возвращает уникальный идентификатор операции.
OperationType enum:
  • 0 - DeviceClaim
  • 1 - DeviceUnclaim
  • 10 - DeleteProduct
  • 11 - BulkDeviceClaim
  • 2 - DeviceUpdateDeviceGroup
  • 3 - MigrateTenant
  • 4 - CreateProduct
  • 5 - DeployToDeviceGroup
  • 6 - DeployToOSFeed
  • 7 - ImageUpload
  • 8 - TenantCreation
  • 9 - DeleteDeviceGroup

Возвращает идентификатор типа операции.
ResourceLocation

string

Возвращает расположение ресурсов, созданных во время выполнения операции.
StartedDateUTC

string

Возвращает дату в формате UTC, которую операция начала обработку.
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Возвращает состояние операции.
TenantId

string

Возвращает идентификатор клиента.