Adding a Cosmos DB Table API Instance Using a New Azure Account

When you add a Cosmos DB Table API instance, you can do that by creating a new Azure account.

Before You Begin

  • For Azure Resource Manager, the cloud account represents an application, and there are two methods of deployment:

    • The traditional method with Azure Active Directory where you must set up the application and tenant. With this option, when you configure the cloud account, you must provide the following information:

      • Subscription ID

      • Tenant ID

      • Application ID and password

      To complete this type of deployment, refer to Setting Up an Application and Tenant for Azure Resource Manager.

    • Managed identity authentication with Azure Active Directory. This is a more secure method of deployment. Using this method ensures that your Azure subscription is accessed only from authorized managed identity-enabled virtual machines. In addition, the process of adding an Azure cloud account is more simplified, because you need only the Subscription ID, not the Tenant ID, Application ID, or Application Password.

      To complete this type of deployment, refer to Setting Up Managed Identity Authentication for Azure Resource Manager.

  • Verify that the Cosmos DB application has the contributor role enabled on the Azure account. For restricted access, create a custom role using cosmos_tableapi.json at the resource group level and assign it to the Cosmos DB application.


  1. From the navigation pane, go to Protect > Databases.

    The Instances page appears.

  2. Click Add Instance, and then click Cloud DB.

    The Add Cloud DB instance page appears.

  3. From the Select vendor list, select Microsoft Azure.

  4. From the Database service list, select Cosmos DB.

  5. From the API list, select Table API.

  6. In the Instance box, enter a name for the cloud instance.

  7. In the Table group box, enter a name for the default table group.

  8. Beside the Cloud account list, click Add.

    The Add cloud account dialog box appears.

  9. Enter information about the subscription:

    • For the traditional authentication method of deployment, enter the following information:

      • Subscription ID: Enter the subscription ID for the Azure account.

      • Credentials: If you have already configured the credentials entity, select the credentials from the list. To define a new credential, click + beside the list. For more information, see Adding Credentials.

    • For the managed identity authentication method of deployment, configure the following settings:

      • Connect using managed identities for Azure resources: Move the toggle key to the right.

      • Subscription ID: Enter the subscription ID for the Azure account.

  10. From the Access node list, select an access node that has both the Virtual Server and Cloud Apps packages installed.


    If you configure this cloud account to use managed identity authentication, select only Azure access nodes that use managed identity authentication so that backups and restores will be successful. The access node must be an Azure virtual machine in the same subscription that contains the Cosmos DB account that you want to back up.

  11. Click Save.

  12. From the Access nodes list, select the access node that you selected in the Add cloud account dialog box for the new account.

  13. From the Plan list, select the server plan to use for instance.

  14. To filter the content that that is backed up, for Backup content, click Edit, and then select or clear the tables that you want to include or exclude.

  15. Click Add.

What to Do Next

A table group is created for the instance. You can create more table groups to meet different backup requirements.