Share via

Image - Upload

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

Starts an asynchronous operation to upload the provided image.

POST https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/images

URI Parameters

Name In Required Type Description
tenantId
 path True

string

uuid

The Azure Sphere tenant ID.

Request Body

Media Types: "application/octet-stream"

Name Type Description
body

byte[]

The image data, in the form of a byte array.

Responses

Name Type Description
200 OK

Operation

An object with operation details.
400 Bad Request

PublicApiErrorDetails[]

A collection of error details.
404 Not Found

PublicApiErrorDetails[]

A collection of error details.
500 Internal Server Error

PublicApiErrorDetails[]

A collection of error details.

Definitions

Name Description
ErrorResponse
Operation
PublicApiErrorDetails

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.

PublicApiErrorDetails

Name Type Description
Detail

string

A human-readable explanation specific to this occurrence of the problem.
ErrorCode

string

A string representation of PublicApiErrorCode defining the error.
Extensions

Gets the Dictionary for extension members.Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as other members of a problem type.
Instance

string

A URI reference that identifies the specific occurrence of the problem.It mayor may not yield further information if dereferenced.
Status

integer

The HTTP status code([RFC7231], Section 6) generated by the origin server forthis occurrence of the problem.
Title

string

A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g.,using proactive content negotiation; see[RFC7231], Section 3.4).
Type

string

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be blank.