Devices - Claim

  • Riferimento
Servizio:
Azure Sphere Public API
Versione API:
v2

Avvia un'operazione asincrona per richiedere un dispositivo al tenant specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
deviceId
 path True

string

ID del dispositivo.
tenantId
 path True

string

uuid

ID tenant di Azure Sphere.

Risposte

Nome Tipo Descrizione
202 Accepted

Operation

L'operazione è stata avviata correttamente.

Definizioni

Nome Descrizione
ErrorResponse
Operation

ErrorResponse

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

Ottiene il codice.
Message

string

Ottiene il messaggio di errore leggibile.

Operation

Nome Tipo Descrizione
CompletedDateUTC

string

Ottiene la data in formato UTC completata dall'operazione.
CreatedDateUTC

string

Ottiene la data di creazione dell'operazione in formato UTC.
DetailsLocation

string

Ottiene il percorso per ottenere i dettagli dell'operazione.
Error

ErrorResponse

OperationId

string

Ottiene l'identificatore univoco dell'operazione.
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

Ottiene l'identificatore del tipo di operazione.
ResourceLocation

string

Ottiene la posizione delle risorse create durante l'esecuzione dell'operazione.
StartedDateUTC

string

Ottiene la data in formato UTC in cui l'operazione ha iniziato l'elaborazione.
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Ottiene lo stato dell'operazione.
TenantId

string

Ottiene l'identificatore del tenant.