Share via


Pause or enable Legacy tenant access

This workflow shows how to pause or enable Azure Sphere (Legacy) access to an Azure Sphere tenant.

Important

On 27 September 2027, Azure Sphere will retire its Legacy service interfaces, Azure Sphere (Legacy) API (also known as PAPI), and Azure Sphere CLI (also known as azsphere). Users must Migrate from Azure Sphere (Legacy) to Azure Sphere (Integrated) before this date.

The Pause access and Enable access functions have the following impacts:

  • Pause access

    • Users with a Legacy user role for the tenant (Administrator, Contributor, or Reader) are unable to perform tenant operations using the Azure Sphere (Legacy) API or azsphere CLI.
    • Pausing access does not delete or alter Legacy user role assignments
    • If a tenant has been integrated into a catalog, then pausing Legacy tenant access does not affect Integrated user operations.
    • If a tenant has not been integrated, then no operation will be possible on this tenant. However, Legacy access can be re-enabled as below.
  • Enable access

    • All users with Legacy user roles for the tenant can perform Legacy tenant operations at their assigned privilege level (Administrator, Contributor, or Reader).
    • You can re-enable tenant access if needed, but we recommend that you leave tenant access paused for security reasons, unless you are still using Legacy while you migrate to Integrated.

Pause Legacy tenant access

  1. Sign in to the Azure Portal. To locate the Azure Sphere service, in the top search bar, enter and select Azure Sphere. The Azure Sphere page is displayed.
  2. On the Azure Sphere page, select Legacy tenants.
  3. The Manage Legacy tenants page displays the list of tenants for which you have a Legacy user role. You must have a Legacy Administrator role for the tenant to pause tenant access.
  4. Select the desired tenant and click the Pause access button.
  5. In the warning screen, type Pause to confirm your request.
  6. Once the process completes and you return to the Manage Legacy tenants screen, verify that the Legacy tenant access column shows status as Paused.

Enable Legacy tenant access

  1. Sign in to the Azure Portal. To locate the Azure Sphere service, in the top search bar, enter and select Azure Sphere. The Azure Sphere page is displayed.
  2. On the Azure Sphere page, select Legacy tenants.
  3. The Manage Legacy tenants page displays the list of tenants for which you have privileges. You must have a Legacy Administrator role for the tenant to enable tenant access.
  4. In the Manage Legacy tenants screen, select the desired tenant and click the Enable access button.
  5. In the warning screen, type Enable to confirm your request.
  6. Once the process completes and you return to the Manage Legacy tenants screen, verify that the Legacy tenant access column shows status as Enabled.