Overview of the Azure Sphere Security Service (AS3) REST API

The Azure Sphere REST API is a set of service endpoints that support HTTP operations for creating and managing Azure Sphere resources such as catalogs, products, deployments, and device groups. The Azure Sphere REST API uses the REST (REpresentational State Transfer) HTTP protocol to send operation requests and responses. The data returned in the operation response is formatted in JSON (JavaScript Object Notation). The available operations are documented in the Azure Sphere REST API reference.

Customers may prefer to use the Azure command-line interface (CLI) instead of the REST API to perform resource-management tasks. The CLI simplifies the sending and receiving of operation requests and responses by abstracting much of the programmatic complexity of the REST API. The CLI commands use the Azure Sphere REST API to perform tasks, but the simple syntax of the CLI commands make them much easier to use.

Some customers may want to build their own user interface (UI) to perform resource-management tasks. The Azure Sphere REST API can be used to build a custom UI. It is not possible to build a custom UI with the Azure CLI.