Partilhar via

Devices - Claim

  • Referência
Service:
Azure Sphere Public API
API Version:
v2

Inicia uma operação assíncronea para reclamar um dispositivo ao inquilino especificado.

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

Parâmetros do URI

Name Em Necessário Tipo Description
deviceId
 path True

string

A identificação do dispositivo.
tenantId
 path True

string

uuid

A identificação do inquilino da Esfera azul.

Respostas

Name Tipo Description
202 Accepted

Operation

Com sucesso, iniciou a operação.

Definições

Name Description
ErrorResponse
Operation

ErrorResponse

Name Tipo Description
Code enum:
  • 0 - OperationFailed
  • 1 - TenantInMigration
  • 2 - TenantMigrationRequired
  • 3 - ClientUpdateRequired
  • 4 - InternalServerError
  • 5 - BadRequest
  • 6 - Forbidden
  • 7 - Conflict
  • 8 - NotFound

Fica com o código.
Message

string

Recebe a mensagem de erro legível humana.

Operation

Name Tipo Description
CompletedDateUTC

string

Obtém a data na UTC que a operação terminou.
CreatedDateUTC

string

Obtém a data de criação da operação na UTC.
DetailsLocation

string

Obtém a localização para obter detalhes da operação.
Error

ErrorResponse

OperationId

string

Obtém o identificador de operação único.
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

Obtém o identificador do tipo de operação.
ResourceLocation

string

Obtém a localização dos recursos criados durante a execução da operação.
StartedDateUTC

string

Obtém a data na UTC que a operação começou a ser processada.
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Fica com o estado da operação.
TenantId

string

Fica com o identificador do inquilino.