Top / Microsoft Azure / Azure DataProtection / Backup Vault

Azure DataProtection Backup Vault

This page shows how to write Terraform and Azure Resource Manager for DataProtection Backup Vault and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_data_protection_backup_vault (Terraform)

The Backup Vault in DataProtection can be configured in Terraform with the resource name azurerm_data_protection_backup_vault. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) Specifies the name of the Backup Vault. Changing this forces a new Backup Vault to be created.

  • resource_group_name - (Required) The name of the Resource Group where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.

  • location - (Required) The Azure Region where the Backup Vault should exist. Changing this forces a new Backup Vault to be created.

  • datastore_type - (Required) Specifies the type of the data store. Possible values are ArchiveStore, SnapshotStore and VaultStore.

  • redundancy - (Required) Specifies the backup storage redundancy. Possible values are GeoRedundant and LocallyRedundant. Changing this forces a new Backup Vault to be created.

  • identity - (Optional) An identity block as defined below.

  • tags - (Optional) A mapping of tags which should be assigned to the Backup Vault.

A identity block supports the following:

  • type - (Required) Specifies the identity type of the Backup Vault. Possible value is SystemAssigned.

The assigned principal_id and tenant_id can be retrieved after the identity type has been set to SystemAssigned and Backup Vault has been created. More details are available below.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Backup Vault.

  • identity - An identity block as defined below, which contains the Identity information for this Backup Vault.

identity exports the following:

  • principal_id - The Principal ID for the Service Principal associated with the Identity of this Backup Vault.

  • tenant_id - The Tenant ID for the Service Principal associated with the Identity of this Backup Vault.

-> You can access the Principal ID via $[azurerm_data_protection_backup_vault.example.identity.0.principal_id] and the Tenant ID via $[azurerm_data_protection_backup_vault.example.identity.0.tenant_id]

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Backup Vault.

>> from Terraform Registry

Microsoft.DataProtection/backupVaults (Azure Resource Manager)

The backupVaults in Microsoft.DataProtection can be configured in Azure Resource Manager with the resource name Microsoft.DataProtection/backupVaults. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • eTag optional - string

    Optional ETag.

  • identity optional
      • type optional - string

        The identityType which can be either SystemAssigned or None

  • location optional - string

    Resource location.

  • name required - string

    The name of the backup vault.

  • properties required
      • storageSettings required array
          • datastoreType optional - string

            Gets or sets the type of the datastore.

          • type optional - string

            Gets or sets the type.

  • systemData optional
      • createdAt optional - string

        The timestamp of resource creation (UTC).

      • createdBy optional - string

        The identity that created the resource.

      • createdByType optional - string

        The type of identity that created the resource.

      • lastModifiedAt optional - string

        The type of identity that last modified the resource.

      • lastModifiedBy optional - string

        The identity that last modified the resource.

      • lastModifiedByType optional - string

        The type of identity that last modified the resource.

  • tags optional - string

    Resource tags.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure DataProtection Resources

Frequently asked questions

What is Azure DataProtection Backup Vault?

Azure DataProtection Backup Vault is a resource for DataProtection of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents