Share via

Deployments - List

Service:
Azure Sphere Public API
API Version:
v2

Gets the Deployments for the specified DeviceGroup.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/{deviceGroupId}/deployments
With optional parameters: 
GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/{deviceGroupId}/deployments?maxPageSize={maxPageSize}

URI Parameters

Name In Required Type Description
deviceGroupId
 path True

string (uuid)

The DeviceGroup ID.
tenantId
 path True

string (uuid)

The Azure Sphere tenant ID.
maxPageSize
 query

integer (int32)

The maximum number of results that should be included in the response.

Request Header

Name Required Type Description
Sphere-Continuation

string

A continuation token used to continue from a previous page of results.

Responses

Name Type Description
200 OK

DeploymentItemCollectionResponse

Success.

Definitions

Name Description
Deployment
DeploymentItemCollectionResponse

Deployment

Object
Name Type Description
DeployedImages

string[]

The IDs of images that are currently in this deployment.
DeploymentDateUtc

string

The DateTime that the deployment was created.
Id

string

The unique ID of the deployment.
TenantId

string

The unique ID of the tenant that owns the deployment.

DeploymentItemCollectionResponse

Object
Name Type Description
ContinuationToken

string

Continuation token that can be used to get next set of items.
Items

Deployment[]

List of items.