Share via

Microsoft.NetApp netAppAccounts/backupPolicies 2021-04-01

  • Article

Bicep resource definition

The netAppAccounts/backupPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetApp/netAppAccounts/backupPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NetApp/netAppAccounts/backupPolicies@2021-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    dailyBackupsToKeep: int
    enabled: bool
    monthlyBackupsToKeep: int
    volumeBackups: [
      {
        backupsCount: int
        policyEnabled: bool
        volumeName: 'string'
      }
    ]
    volumesAssigned: int
    weeklyBackupsToKeep: int
    yearlyBackupsToKeep: int
  }
}

Property values

netAppAccounts/backupPolicies

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-64

Valid characters:
Alphanumerics, underscores, and hyphens.

Start with alphanumeric.
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: netAppAccounts
properties Backup policy Properties BackupPolicyProperties (required)

BackupPolicyProperties

Name Description Value
dailyBackupsToKeep Daily backups count to keep int
enabled The property to decide policy is enabled or not bool
monthlyBackupsToKeep Monthly backups count to keep int
volumeBackups A list of volumes assigned to this policy VolumeBackups[]
volumesAssigned Volumes using current backup policy int
weeklyBackupsToKeep Weekly backups count to keep int
yearlyBackupsToKeep Yearly backups count to keep int

VolumeBackups

Name Description Value
backupsCount Total count of backups for volume int
policyEnabled Policy enabled bool
volumeName Volume name string

ARM template resource definition

The netAppAccounts/backupPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetApp/netAppAccounts/backupPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.NetApp/netAppAccounts/backupPolicies",
  "apiVersion": "2021-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "dailyBackupsToKeep": "int",
    "enabled": "bool",
    "monthlyBackupsToKeep": "int",
    "volumeBackups": [
      {
        "backupsCount": "int",
        "policyEnabled": "bool",
        "volumeName": "string"
      }
    ],
    "volumesAssigned": "int",
    "weeklyBackupsToKeep": "int",
    "yearlyBackupsToKeep": "int"
  }
}

Property values

netAppAccounts/backupPolicies

Name Description Value
type The resource type 'Microsoft.NetApp/netAppAccounts/backupPolicies'
apiVersion The resource api version '2021-04-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)

Character limit: 1-64

Valid characters:
Alphanumerics, underscores, and hyphens.

Start with alphanumeric.
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
properties Backup policy Properties BackupPolicyProperties (required)

BackupPolicyProperties

Name Description Value
dailyBackupsToKeep Daily backups count to keep int
enabled The property to decide policy is enabled or not bool
monthlyBackupsToKeep Monthly backups count to keep int
volumeBackups A list of volumes assigned to this policy VolumeBackups[]
volumesAssigned Volumes using current backup policy int
weeklyBackupsToKeep Weekly backups count to keep int
yearlyBackupsToKeep Yearly backups count to keep int

VolumeBackups

Name Description Value
backupsCount Total count of backups for volume int
policyEnabled Policy enabled bool
volumeName Volume name string

Terraform (AzAPI provider) resource definition

The netAppAccounts/backupPolicies resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetApp/netAppAccounts/backupPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/backupPolicies@2021-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dailyBackupsToKeep = int
      enabled = bool
      monthlyBackupsToKeep = int
      volumeBackups = [
        {
          backupsCount = int
          policyEnabled = bool
          volumeName = "string"
        }
      ]
      volumesAssigned = int
      weeklyBackupsToKeep = int
      yearlyBackupsToKeep = int
    }
  })
}

Property values

netAppAccounts/backupPolicies

Name Description Value
type The resource type "Microsoft.NetApp/netAppAccounts/backupPolicies@2021-04-01"
name The resource name string (required)

Character limit: 1-64

Valid characters:
Alphanumerics, underscores, and hyphens.

Start with alphanumeric.
location Resource location string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: netAppAccounts
tags Resource tags Dictionary of tag names and values.
properties Backup policy Properties BackupPolicyProperties (required)

BackupPolicyProperties

Name Description Value
dailyBackupsToKeep Daily backups count to keep int
enabled The property to decide policy is enabled or not bool
monthlyBackupsToKeep Monthly backups count to keep int
volumeBackups A list of volumes assigned to this policy VolumeBackups[]
volumesAssigned Volumes using current backup policy int
weeklyBackupsToKeep Weekly backups count to keep int
yearlyBackupsToKeep Yearly backups count to keep int

VolumeBackups

Name Description Value
backupsCount Total count of backups for volume int
policyEnabled Policy enabled bool
volumeName Volume name string