Edit

Share via

Create Azure Backup vault using REST API

  • Article

Azure Backup's new Data Protection platform provides enhanced capabilities for backup and restore for newer workloads such as blobs in storage accounts, managed disk and PostgreSQL server's PaaS platform. It aims to minimize management overhead while making it easy for organizing backups. A 'Backup vault' is the cornerstone of the Data protection platform and this is different from the 'Recovery Services' vault.

The steps to create an Azure Backup vault using REST API are outlined in create vault REST API documentation. Let's use this document as a reference to create a vault called "testBkpVault" in "West US" and under 'TestBkpVaultRG' resource group.

To create or update an Azure Backup vault, use the following PUT operation.

HTTP 
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/testBkpVault?api-version=2021-01-01

Create a request

To create the PUT request, the {subscription-id} parameter is required. If you have multiple subscriptions, see Working with multiple subscriptions. You define a {resourceGroupName} and {vaultName} for your resources, along with the api-version parameter. This article uses api-version=2021-01-01.

The following headers are required:

Request header Description
Content-Type: Required. Set to application/json.
Authorization: Required. Set to a valid Bearer access token.

For more information about how to create the request, see Components of a REST API request/response.

Create the request body

The following common definitions are used to build a request body:

Name Required Type Description
eTag String Optional eTag
location true String Resource location
properties true BackupVault Properties of the vault
Identity DPPIdentityDetails Identifies the unique system identifier for each Azure resource
tags Object Resource tags

Note that vault name and resource group name are provided in the PUT URI. The request body defines the location.

Example request body

The following example body is used to create a vault in "West US". Specify the location.

JSON 
{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "identity": {
    "type": "None"
  },
  "properties": {
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

If you want to create a backup vault and also generate a system assigned identity, then the following request body should be given.

JSON 
{
  "location": "WestUS",
  "tags": {
    "key1": "val1"
  },
  "identity": {
    "type": "systemAssigned"
  },
  "properties": {
    "storageSettings": [
      {
        "datastoreType": "VaultStore",
        "type": "LocallyRedundant"
      }
    ]
  }
}

Responses

Creation of a backup vault is an asynchronous operation. It means this operation creates another operation that needs to be tracked separately. There are two successful responses for the operation to create or update a Backup vault:

Name Type Description
200 OK BackupVaultResource OK
201 Created BackupVaultResource Created
Other status codes CloudError

For more information about REST API responses, see Process the response message.

Example response

A condensed 201 Created response from the previous example request body shows an id has been assigned and the provisioningState is Succeeded:

JSON 
{
    "eTag": null,
    "id": "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/TestBkpVaultRG/providers/Microsoft.DataProtection/BackupVaults/testBkpVault",
    "identity": {
      "principalId": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "tenantId": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "SystemAssigned"
    },
    "location": "westUS",
    "name": "testBkpVault",
    "properties": {
      "provisioningState": "Succeeded",
      "storageSettings": [
        {
          "datastoreType": "VaultStore",
          "type": "GeoRedundant"
        }
      ]
    },
    "resourceGroup": "TestBkpVaultRG",
    "systemData": null,
    "tags": {},
    "type": "Microsoft.DataProtection/backupVaults"
  }

Next steps

Create a backup policy for backing up blobs in this vault.

For more information on the Azure REST APIs, see the following documents: