Sdílet prostřednictvím

Devices - Claim

  • Reference
Služba:
Azure Sphere Public API
Verze rozhraní API:
v2

Spustí asynchronní operaci, která deklaruje zařízení do zadaného tenanta.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
deviceId
 path True

string

ID zařízení.
tenantId
 path True

string

uuid

ID tenanta Azure Sphere.

Odpovědi

Name Typ Description
202 Accepted

Operation

Operace byla úspěšně spuštěna.

Definice

Name Description
ErrorResponse
Operation

ErrorResponse

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

Získá kód.
Message

string

Získá chybovou zprávu, která je čitelná pro člověka.

Operation

Name Typ Description
CompletedDateUTC

string

Získá datum v UTC, že operace byla dokončena.
CreatedDateUTC

string

Získá datum vytvoření operace v UTC.
DetailsLocation

string

Získá umístění pro získání podrobností o operaci.
Error

ErrorResponse

OperationId

string

Získá jedinečný identifikátor operace.
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

Získá identifikátor typu operace.
ResourceLocation

string

Získá umístění prostředků vytvořených během provádění operace.
StartedDateUTC

string

Získá datum ve standardu UTC, kdy operace začala zpracovávat.
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Získá stav operace.
TenantId

string

Získá identifikátor tenanta.