Integrate Azure Sphere (Legacy) tenants into Azure Sphere (Integrated) catalogs

Azure Sphere (Integrated) is native to the Azure platform, and provides a like-for-like replacement of the Azure Sphere (Legacy) interface. For more information see, Azure Sphere (Integrated) and Azure Sphere (Legacy).

In Azure portal, the Azure Sphere > Legacy tenants > Azure Sphere Tenants screen displays the legacy tenants for which you have a Legacy user role (Administrator, Contributor, or Reader). In this view, users with legacy administrator privileges can perform actions related to migrating tenants from Azure Sphere (Legacy) to Azure Sphere (Integrated).

• Integrate a tenant to a catalog at the start of the migration process to enable the tenant resources to be managed using the Azure Sphere (Integrated).
• Pause access to the tenant at the end of the migration process to ensure that your users, as well as the scripts and automated processes in your environment, no longer rely on Legacy tenant operations, and to disable further Legacy user access for security. For more information see, Pause or enable Legacy tenant access.

Note

The Integrate, Pause access, and Enable access options are available only in the Azure portal. They are not supported in Azure CLI or in Azure Sphere (Legacy) CLI.

Integrate a Legacy tenant to an Azure Sphere catalog

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. This page will be empty if no catalogs or tenants exist, or if you do not have the required permissions to view them. You can view the following information about legacy tenants:
   • Azure Sphere Tenant ID: The ID of the legacy tenant.
   • Azure Sphere Tenant Name: The name of the legacy tenant.
   • Legacy Tenant Access:
     • Enabled: Indicates that the legacy tenant operations can be conducted using the legacy Public API or CLI.
     • Paused: Indicates that all legacy operations are blocked, preventing management of the tenant using the Legacy Public API or CLI.
   • Azure Sphere Catalog: If integrated, displays the name of the corresponding Azure Sphere catalog. If this column is empty, it indicates that the tenant was created in Azure Sphere (Legacy) and is not yet integrated.
3. Select the checkbox next to the tenant you want to integrate, and click Integrate.
4. On the Integration page enter the following:
   • Subscription: [Required] Select your Azure subscription. An error message is displayed if the service is not registered for the subscription. For more information, see Errors.
   • Resource group: [Required] Select or create a resource group. An error message is displayed if you don't have sufficient permissions to create a resource on the resource group level. For more information, see Errors.
   • Resource Group Location: Set to global by default.
   • Catalog name: [Required] A name for the catalog. Catalog names can contain only alphanumeric characters, underscores, and hyphens, and cannot exceed 30 characters.
5. Select Integrate to proceed.
6. The status is displayed when the action is complete.
7. When the deployment is complete, click Go to Resource in the Deployment details dropdown, to view the integrated catalog.

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.