azRecoveryServicesVault

+++ title = "azRecoveryServicesVault" description = "Azure Recovery Services Vault" weight = 10 alwaysopen = false +++

Use the resource azRecoveryServicesVault to deploy an Azure Recovery Services Vault to the relevant subscription. Recovery Service Vaults are storage entities in Azure which house data. Typically used to hold virtual machine backups and SQL server database backups from SQL Virtual Machines.

Attributes

Attribute	Type	Mandatory	Values	Default	Notes
Name	String	Yes
Location	String	Yes
ResourceGroupName	String	Yes
Diagnostic	Object	No
Identity	Object	No
Tag	Object	No
Lock	Object	No

Diagnostic

Attribute	Type	Mandatory	Values	Default	Notes
Name	String	Yes
Log	Object
Metric	Object
Target	Object

Diagnostic Log

Attribute	Type	Mandatory	Values	Default	Notes
Enabled	Boolean				Defaults to true if Category is not null
Category	Array		AzureBackupReport
			CoreAzureBackup
			AddonAzureBackupJobs
			AddonAzureBackupAlerts
			AddonAzureBackupPolicy
			AddonAzureBackupStorage
			AddonAzureBackupProtectedInstance
			AzureSiteRecoveryJobs
			AzureSiteRecoveryEvents
			AzureSiteRecoveryReplicatedItems
			AzureSiteRecoveryReplicationStats
			AzureSiteRecoveryRecoveryPoints
			AzureSiteRecoveryReplicationDataUploadRate
			AzureSiteRecoveryProtectedDiskDataChurn

Diagnostic Metric

Attribute	Type	Mandatory	Values	Default	Notes
Enabled	Boolean		True, False		Defaults to true if Category is not null
Category	Array		AllMetrics

Input by YAML

Object model for YAML deployment:

azRecoveryServicesVault:
    # Mandatory
  - Name: 'string'
    ResourceGroupName: 'string'
    Location: 'string'
    # Optional
    Identity:
      SystemIdentity: boolean                      # True, False (D)
      UserIdentity:
        - Name: 'string'
          ResourceGroupName: 'string'
    Diagnostic:
      - Name: 'string'
        Log:
          Enabled: boolean                          # True (D if Category not null), False
          Category: [array]                       # Defaults to all if enabled
        Metric:
          Enabled: boolean                          # True (D if MetricCategory not null), False
          Category: [array]                       # Defaults to all if enabled
        Target:
          Blob:
            StorageAccount: 'string' 
            ResourceGroupName: 'string'             # Defaults to RG of resource
            Subscription: 'string'                  # Defaults to Sub of resource
            StorageKeyType: 'string'                # Primary, Secondary
            RetentionInDays: number
          EventHub:
            Name: 'string'
            Namespace: 'string'
            ResourceGroupName: 'string'             # Defaults to RG of resource
            Subscription: 'string'                  # Defaults to Sub of resource
            SharedAccessPolicy: 'string'            # RootManageSharedAccessKey (D)
          LogAnalytics:
            Workspace: 'string'
            ResourceGroupName: 'string'             # Defaults to RG of resource
            Subscription: 'string'                  # Defaults to Sub of resource
    Tag:
      'keyvalue-pairs'
    Lock:
      - Name: 'string'
        Level: 'string'                             # CanNotDelete, ReadOnly
        Notes: 'string'

Input by JSON

Object model for JSON deployment:

{
  "azResourceGroup": [
    {
      "Name": "string",
      "ResourceGroupName": "string",
      "Location": "string",
      "Identity": {
        "SystemIdentity": boolean,
        "UserIdentity": [
          {
            "Name": "string",
            "ResourceGroupName": "string"
          }
        ]
      },
      "Diagnostic": [
        {
          "Name": "string",
          "Log": {
            "Enabled": boolean,
            "Category": [array]
          },
          "Metric": {
            "Enabled": boolean,
            "Category": [array]
          },
          "Target": {
            "Blob": {
              "StorageAccount": "string",
              "ResourceGroupName": "string",
              "Subscription": "string",
              "StorageKeyType": "string",
              "RetentionInDays": number
            },
            "EventHub": {
              "Name": "string",
              "Namespace": "string",
              "ResourceGroupName": "string",
              "Subscription": "string",
              "SharedAccessPolicy": "string"
            },
            "LogAnalytics": {
              "Workspace": "string",
              "ResourceGroupName": "string",
              "Subscription": "string"
            }
          }
        }
      ],
      "Tag": {
        "key": "value"
      },
      "Lock": [
        {
          "Name": "string",
          "Level": "string",
          "Notes": "string"
        }
      ]
    }
  ]
}