Azure Sphere
Azure Sphere resource management API.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Azure Sphere resource management API.
Endpoints 45
Operations
- GETOperations_List
/providers/Microsoft.AzureSphere/operationsList the operations for the provider
Catalogs
- GETCatalogs_ListBySubscription
/subscriptions/:subscriptionId/providers/Microsoft.AzureSphere/catalogsList Catalog resources by subscription ID - GETCatalogs_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogsList Catalog resources by resource group - GETCatalogs_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogNameGet a Catalog - PUTCatalogs_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogNameCreate a Catalog - DELETECatalogs_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogNameDelete a Catalog - PATCHCatalogs_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogNameUpdate a Catalog - POSTCatalogs_CountDevices
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/countDevicesCounts devices in catalog. - POSTCatalogs_ListDeployments
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/listDeployments?$filter=string&$top=0&$skip=0&$maxpagesize=0Lists deployments for catalog. - POSTCatalogs_ListDeviceGroups
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/listDeviceGroups?$filter=string&$top=0&$skip=0&$maxpagesize=0List the device groups for the catalog. - POSTCatalogs_ListDeviceInsights
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/listDeviceInsights?$filter=string&$top=0&$skip=0&$maxpagesize=0Lists device insights for catalog. - POSTCatalogs_ListDevices
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/listDevices?$filter=string&$top=0&$skip=0&$maxpagesize=0Lists devices for catalog. - POSTCatalogs_UploadImage
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/uploadImageCreates an image. Use this action when the image ID is unknown.
Certificates
- GETCertificates_ListByCatalog
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates?$filter=string&$top=0&$skip=0&$maxpagesize=0List Certificate resources by Catalog - GETCertificates_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates/:serialNumberGet a Certificate - POSTCertificates_RetrieveCertChain
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates/:serialNumber/retrieveCertChainRetrieves cert chain. - POSTCertificates_RetrieveProofOfPossessionNonce
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates/:serialNumber/retrieveProofOfPossessionNonceGets the proof of possession nonce.
Images
- GETImages_ListByCatalog
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/images?$filter=string&$top=0&$skip=0&$maxpagesize=0List Image resources by Catalog - GETImages_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/images/:imageNameGet a Image - PUTImages_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/images/:imageNameCreate a Image - DELETEImages_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/images/:imageNameDelete a Image
Products
- GETProducts_ListByCatalog
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/productsList Product resources by Catalog - GETProducts_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productNameGet a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. - PUTProducts_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productNameCreate a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. - DELETEProducts_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productNameDelete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name' - PATCHProducts_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productNameUpdate a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. - POSTProducts_CountDevices
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/countDevicesCounts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name. - POSTProducts_GenerateDefaultDeviceGroups
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/generateDefaultDeviceGroupsGenerates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
DeviceGroups
- GETDeviceGroups_ListByProduct
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups?$filter=string&$top=0&$skip=0&$maxpagesize=0List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. - GETDeviceGroups_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupNameGet a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - PUTDeviceGroups_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupNameCreate a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - DELETEDeviceGroups_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupNameDelete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - PATCHDeviceGroups_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupNameUpdate a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - POSTDeviceGroups_ClaimDevices
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/claimDevicesBulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only. - POSTDeviceGroups_CountDevices
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/countDevicesCounts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Deployments
- GETDeployments_ListByDeviceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/deployments?$filter=string&$top=0&$skip=0&$maxpagesize=0List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - GETDeployments_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/deployments/:deploymentNameGet a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - PUTDeployments_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/deployments/:deploymentNameCreate a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - DELETEDeployments_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/deployments/:deploymentNameDelete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
Devices
- GETDevices_ListByDeviceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devicesList Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. - GETDevices_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceNameGet 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. - PUTDevices_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceNameCreate a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only. - DELETEDevices_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceNameDelete a Device - PATCHDevices_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceNameUpdate a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level. - POSTDevices_GenerateCapabilityImage
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceName/generateCapabilityImageGenerates 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…
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 45 operations on 29 pathsGET 16POST 13PUT 6DELETE 6PATCH 4
- Main resources
- Catalogs 12DeviceGroups 7Products 7Devices 6Certificates 4Deployments 4Images 4Operations 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2024-04-01 - Links
- OpenAPI document
How to test the Azure Sphere in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Sphere collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.AzureSphere/operations), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Sphere?
Azure Sphere resource management API. It is listed under Developer tools and has 45 endpoints.
Who publishes the Azure Sphere?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Sphere?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Sphere?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Sphere have?
45 operations on 29 paths (16 GET, 13 POST, 6 PUT, 6 DELETE, 4 PATCH). The largest groups are Catalogs, DeviceGroups, Products, Devices.
Is forking the Azure Sphere free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.