Share via

Devices - Claim

  • Reference
Service:
Azure Sphere Public API
API Version:
v2

Starts an asynchronous operation to claim a device to the specified tenant.

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

URI Parameters

Name In Required Type Description
deviceId
 path True

string

The device's ID.
tenantId
 path True

string

uuid

The Azure Sphere tenant ID.

Responses

Name Type Description
202 Accepted

Operation

Successfully started the operation.

Definitions

Name Description
ErrorResponse
Operation

ErrorResponse

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

Gets the code.
Message

string

Gets the human readable error message.

Operation

Name Type Description
CompletedDateUTC

string

Gets the date in UTC that the operation completed.
CreatedDateUTC

string

Gets the operation creation date in UTC.
DetailsLocation

string

Gets the location for getting details of the operation.
Error

ErrorResponse

OperationId

string

Gets the unique operation identifier.
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

Gets the operation type identifier.
ResourceLocation

string

Gets the location of resources created during the execution of the operation.
StartedDateUTC

string

Gets the date in UTC that the operation started processing.
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Gets the state of the operation.
TenantId

string

Gets the tenant identifier.