Skip to content

Data Source: azurermDataProtectionBackupVault

Use this data source to access information about an existing Backup Vault.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new cdktf.TerraformOutput(this, "azurerm_data_protection_backup_vault_id", {
  value: "${data.azurerm_vpn_gateway.example.id}",
});
const dataAzurermDataProtectionBackupVaultExample =
  new azurerm.dataAzurermDataProtectionBackupVault.DataAzurermDataProtectionBackupVault(
    this,
    "example",
    {
      name: "existing-backup-vault",
      resource_group_name: "existing-resource-group",
    }
  );
new cdktf.TerraformOutput(
  this,
  "azurerm_data_protection_backup_vault_principal_id",
  {
    value: `\${${dataAzurermDataProtectionBackupVaultExample.identity}.0.principal_id}`,
  }
);

Arguments Reference

  • name - (Required) Specifies the name of the Backup Vault.

  • resourceGroupName - (Required) The name of the Resource Group where the Backup Vault exists.

Attributes Reference

  • id - The ID of the Backup Vault.

  • location - The Azure Region where the Backup Vault exists.

  • datastoreType - Specifies the type of the data store.

  • redundancy - Specifies the backup storage redundancy.

  • identity - A identity block as defined below.

  • tags - A mapping of tags which are assigned to the Backup Vault.

An identity block exports the following:

  • type - The type of Managed Service Identity that is configured on this Backup Vault.

  • principalId - The Principal ID of the System Assigned Managed Service Identity that is configured on this Backup Vault.

  • tenantId - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Backup Vault.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Backup Vault.