Microsoft.AzureSphere (preview:2022-09-01)

2025/10/13 • 44 deleted methods

Operations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureSphere/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_ListBySubscription (removed)
Description :  List Catalog resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureSphere/catalogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Catalog items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_ListByResourceGroup (removed)
Description :  List Catalog resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Catalog items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_Get (removed)
Description :  Get a Catalog
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_CreateOrUpdate (removed)
Description :  Create a Catalog
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An Azure Sphere catalog ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_Update (removed)
Description :  Update a Catalog
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_Delete (removed)
Description :  Delete a Catalog
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificates_ListByCatalog (removed)
Description :  List Certificate resources by Catalog
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates
{
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Certificate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
certificate:
{
Description: The certificate as a UTF-8 encoded base 64 string. ,
Required: False ,
}
string ,
status:
{
Description: The certificate status. ,
Enum:
{
Active: Certificate is active ,
Inactive: Certificate is inactive ,
Expired: Certificate has expired ,
Revoked: Certificate has been revoked ,
}
,
Required: False ,
}
enum ,
subject:
{
Description: The certificate subject. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate thumbprint. ,
Required: False ,
}
string ,
expiryUtc:
{
Description: The certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeUtc:
{
Description: The certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificates_Get (removed)
Description :  Get a Certificate
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial number of the certificate. Use '.default' to get current active certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
certificate:
{
Description: The certificate as a UTF-8 encoded base 64 string. ,
Required: False ,
}
string ,
status:
{
Description: The certificate status. ,
Enum:
{
Active: Certificate is active ,
Inactive: Certificate is inactive ,
Expired: Certificate has expired ,
Revoked: Certificate has been revoked ,
}
,
Required: False ,
}
enum ,
subject:
{
Description: The certificate subject. ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate thumbprint. ,
Required: False ,
}
string ,
expiryUtc:
{
Description: The certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeUtc:
{
Description: The certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificates_RetrieveCertChain (removed)
Description :  Retrieves cert chain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveCertChain
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial number of the certificate. Use '.default' to get current active certificate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
certificateChain:
{
Description: The certificate chain. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Certificates_RetrieveProofOfPossessionNonce (removed)
Description :  Gets the proof of possession nonce.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveProofOfPossessionNonce
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial number of the certificate. Use '.default' to get current active certificate. ,
Required: True ,
}
string ,
proofOfPossessionNonceRequest:
{
Description: Proof of possession nonce request body ,
Required: True ,
}
{
proofOfPossessionNonce:
{
Description: The proof of possession nonce ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Result of the action to generate a proof of possession nonce ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_CountDevices (removed)
Description :  Counts devices in catalog.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/countDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Response to the action call for count devices in a catalog (preview API). ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_ListByCatalog (removed)
Description :  List Image resources by Catalog
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images
{
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Image items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_Get (removed)
Description :  Get a Image
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
imageName:
{
Description: Image name. Use an image GUID for GA versions of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_CreateOrUpdate (removed)
Description :  Create a Image
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
imageName:
{
Description: Image name. Use an image GUID for GA versions of the API. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An image resource belonging to a catalog resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Images_Delete (removed)
Description :  Delete a Image
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
imageName:
{
Description: Image name. Use an image GUID for GA versions of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_ListDeployments (removed)
Description :  Lists deployments for catalog.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Deployment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment ID ,
Required: False ,
}
string ,
deployedImages:
{
Description: Images deployed ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
deploymentDateUtc:
{
Description: Deployment date UTC ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_ListDeviceGroups (removed)
Description :  List the device groups for the catalog.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
listDeviceGroupsRequest:
{
Description: List device groups for catalog. ,
Required: True ,
}
{
deviceGroupName:
{
Description: Device Group name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The DeviceGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_ListDeviceInsights (removed)
Description :  Lists device insights for catalog.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceInsights
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DeviceInsight items on this page ,
Required: True ,
}
[
{
deviceId:
{
Description: Device ID ,
Required: True ,
}
string ,
description:
{
Description: Event description ,
Required: True ,
}
string ,
startTimestampUtc:
{
Description: Event start timestamp ,
Format: date-time ,
Required: True ,
}
string ,
endTimestampUtc:
{
Description: Event end timestamp ,
Format: date-time ,
Required: True ,
}
string ,
eventCategory:
{
Description: Event category ,
Required: True ,
}
string ,
eventClass:
{
Description: Event class ,
Required: True ,
}
string ,
eventType:
{
Description: Event type ,
Required: True ,
}
string ,
eventCount:
{
Description: Event count ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Catalogs_ListDevices (removed)
Description :  Lists devices for catalog.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Device items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceId:
{
Description: Device ID ,
Required: False ,
}
string ,
chipSku:
{
Description: SKU of the chip ,
Required: False ,
}
string ,
lastAvailableOsVersion:
{
Description: OS version available for installation when update requested ,
Required: False ,
}
string ,
lastInstalledOsVersion:
{
Description: OS version running on device when update requested ,
Required: False ,
}
string ,
lastOsUpdateUtc:
{
Description: Time when update requested and new OS version available ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateRequestUtc:
{
Description: Time when update was last requested ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_ListByCatalog (removed)
Description :  List Product resources by Catalog
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Product items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the product ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_Get (removed)
Description :  Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the product ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_CreateOrUpdate (removed)
Description :  Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the product ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the product ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An product resource belonging to a catalog resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the product ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_Update (removed)
Description :  Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the Product. ,
Required: False ,
}
{
description:
{
Description: Description of the product ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the product ,
Required: True ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_Delete (removed)
Description :  Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_CountDevices (removed)
Description :  Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/countDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Response to the action call for count devices in a catalog (preview API). ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeviceGroups_ListByProduct (removed)
Description :  List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups
{
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DeviceGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeviceGroups_Get (removed)
Description :  Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeviceGroups_CreateOrUpdate (removed)
Description :  Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An device group resource belonging to a product resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeviceGroups_Update (removed)
Description :  Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the DeviceGroup. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeviceGroups_Delete (removed)
Description :  Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeviceGroups_ClaimDevices (removed)
Description :  Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/claimDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
claimDevicesRequest:
{
Description: Bulk claim devices request body. ,
Required: True ,
}
{
deviceIdentifiers:
{
Description: Device identifiers of the devices to be claimed. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeviceGroups_CountDevices (removed)
Description :  Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/countDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Response to the action call for count devices in a catalog (preview API). ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ListByDeviceGroup (removed)
Description :  List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments
{
$filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
$top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Deployment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment ID ,
Required: False ,
}
string ,
deployedImages:
{
Description: Images deployed ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
deploymentDateUtc:
{
Description: Deployment date UTC ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Get (removed)
Description :  Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment ID ,
Required: False ,
}
string ,
deployedImages:
{
Description: Images deployed ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
deploymentDateUtc:
{
Description: Deployment date UTC ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdate (removed)
Description :  Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment ID ,
Required: False ,
}
string ,
deployedImages:
{
Description: Images deployed ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
deploymentDateUtc:
{
Description: Deployment date UTC ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment ID ,
Required: False ,
}
string ,
deployedImages:
{
Description: Images deployed ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
deploymentDateUtc:
{
Description: Deployment date UTC ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An deployment resource belonging to a device group resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deploymentId:
{
Description: Deployment ID ,
Required: False ,
}
string ,
deployedImages:
{
Description: Images deployed ,
Required: False ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
image:
{
Description: Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. ,
Required: False ,
}
string ,
imageId:
{
Description: Image ID ,
Required: False ,
}
string ,
imageName:
{
Description: Image name ,
Required: False ,
}
string ,
regionalDataBoundary:
{
Description: Regional data boundary for an image ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: Location the image ,
Required: False ,
}
string ,
description:
{
Description: The image description. ,
Required: False ,
}
string ,
componentId:
{
Description: The image component id. ,
Required: False ,
}
string ,
imageType:
{
Description: The image type. ,
Enum:
{
InvalidImageType: Invalid image. ,
OneBl: One Bl image type ,
PlutonRuntime: Pluton image type ,
WifiFirmware: Wifi firmware image type ,
SecurityMonitor: Security monitor image type ,
NormalWorldLoader: Normal world loader image type ,
NormalWorldDtb: Normal world dtb image type ,
NormalWorldKernel: Normal world kernel image type ,
RootFs: Root FS image type ,
Services: Services image type ,
Applications: Applications image type ,
FwConfig: FW config image type ,
BootManifest: Boot manifest image type ,
Nwfs: Nwfs image type ,
TrustedKeystore: Trusted key store image type ,
Policy: Policy image type ,
CustomerBoardConfig: Customer board config image type ,
UpdateCertStore: Update certificate store image type ,
BaseSystemUpdateManifest: Base system update manifest image type ,
FirmwareUpdateManifest: Firmware update manifest image type ,
CustomerUpdateManifest: Customer update manifest image type ,
RecoveryManifest: Recovery manifest image type ,
ManifestSet: manifest set image type ,
Other: Other image type ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
deploymentDateUtc:
{
Description: Deployment date UTC ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Delete (removed)
Description :  Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Devices_ListByDeviceGroup (removed)
Description :  List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Device items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceId:
{
Description: Device ID ,
Required: False ,
}
string ,
chipSku:
{
Description: SKU of the chip ,
Required: False ,
}
string ,
lastAvailableOsVersion:
{
Description: OS version available for installation when update requested ,
Required: False ,
}
string ,
lastInstalledOsVersion:
{
Description: OS version running on device when update requested ,
Required: False ,
}
string ,
lastOsUpdateUtc:
{
Description: Time when update requested and new OS version available ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateRequestUtc:
{
Description: Time when update was last requested ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Devices_Get (removed)
Description :  Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deviceName:
{
Description: Device name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceId:
{
Description: Device ID ,
Required: False ,
}
string ,
chipSku:
{
Description: SKU of the chip ,
Required: False ,
}
string ,
lastAvailableOsVersion:
{
Description: OS version available for installation when update requested ,
Required: False ,
}
string ,
lastInstalledOsVersion:
{
Description: OS version running on device when update requested ,
Required: False ,
}
string ,
lastOsUpdateUtc:
{
Description: Time when update requested and new OS version available ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateRequestUtc:
{
Description: Time when update was last requested ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Devices_CreateOrUpdate (removed)
Description :  Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deviceName:
{
Description: Device name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceId:
{
Description: Device ID ,
Required: False ,
}
string ,
chipSku:
{
Description: SKU of the chip ,
Required: False ,
}
string ,
lastAvailableOsVersion:
{
Description: OS version available for installation when update requested ,
Required: False ,
}
string ,
lastInstalledOsVersion:
{
Description: OS version running on device when update requested ,
Required: False ,
}
string ,
lastOsUpdateUtc:
{
Description: Time when update requested and new OS version available ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateRequestUtc:
{
Description: Time when update was last requested ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceId:
{
Description: Device ID ,
Required: False ,
}
string ,
chipSku:
{
Description: SKU of the chip ,
Required: False ,
}
string ,
lastAvailableOsVersion:
{
Description: OS version available for installation when update requested ,
Required: False ,
}
string ,
lastInstalledOsVersion:
{
Description: OS version running on device when update requested ,
Required: False ,
}
string ,
lastOsUpdateUtc:
{
Description: Time when update requested and new OS version available ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateRequestUtc:
{
Description: Time when update was last requested ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An device resource belonging to a device group resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceId:
{
Description: Device ID ,
Required: False ,
}
string ,
chipSku:
{
Description: SKU of the chip ,
Required: False ,
}
string ,
lastAvailableOsVersion:
{
Description: OS version available for installation when update requested ,
Required: False ,
}
string ,
lastInstalledOsVersion:
{
Description: OS version running on device when update requested ,
Required: False ,
}
string ,
lastOsUpdateUtc:
{
Description: Time when update requested and new OS version available ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateRequestUtc:
{
Description: Time when update was last requested ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Devices_Update (removed)
Description :  Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deviceName:
{
Description: Device name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The updatable properties of the Device. ,
Required: False ,
}
{
deviceGroupId:
{
Description: Device group id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceId:
{
Description: Device ID ,
Required: False ,
}
string ,
chipSku:
{
Description: SKU of the chip ,
Required: False ,
}
string ,
lastAvailableOsVersion:
{
Description: OS version available for installation when update requested ,
Required: False ,
}
string ,
lastInstalledOsVersion:
{
Description: OS version running on device when update requested ,
Required: False ,
}
string ,
lastOsUpdateUtc:
{
Description: Time when update requested and new OS version available ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdateRequestUtc:
{
Description: Time when update was last requested ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Devices_Delete (removed)
Description :  Delete a Device
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deviceName:
{
Description: Device name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Devices_GenerateCapabilityImage (removed)
Description :  Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
deviceGroupName:
{
Description: Name of device group. ,
Required: True ,
}
string ,
deviceName:
{
Description: Device name ,
Required: True ,
}
string ,
generateDeviceCapabilityRequest:
{
Description: Generate capability image request body. ,
Required: True ,
}
{
capabilities:
{
Description: List of capabilities to create ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
image:
{
Description: The signed device capability image as a UTF-8 encoded base 64 string. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_GenerateDefaultDeviceGroups (removed)
Description :  Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/generateDefaultDeviceGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
catalogName:
{
Description: Name of catalog ,
Required: True ,
}
string ,
productName:
{
Description: Name of product. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DeviceGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Description of the device group. ,
Required: False ,
}
string ,
osFeedType:
{
Description: Operating system feed type of the device group. ,
Enum:
{
Retail: Retail OS feed type. ,
RetailEval: Retail evaluation OS feed type. ,
}
,
Required: False ,
}
enum ,
updatePolicy:
{
Description: Update policy of the device group. ,
Enum:
{
UpdateAll: Update all policy. ,
No3rdPartyAppUpdates: No update for 3rd party app policy. ,
}
,
Required: False ,
}
enum ,
allowCrashDumpsCollection:
{
Description: Flag to define if the user allows for crash dump collection. ,
Enum:
{
Enabled: Crash dump collection enabled ,
Disabled: Crash dump collection disabled ,
}
,
Required: False ,
}
enum ,
regionalDataBoundary:
{
Description: Regional data boundary for the device group. ,
Enum:
{
None: No data boundary ,
EU: EU data boundary ,
}
,
Required: False ,
}
enum ,
hasDeployment:
{
Description: Deployment status for the device group. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is being updated ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}