Share via

Microsoft.NetApp netAppAccounts/snapshotPolicies 2022-03-01

Bicep resource definition

The netAppAccounts/snapshotPolicies 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/snapshotPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NetApp/netAppAccounts/snapshotPolicies@2022-03-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    dailySchedule: {
      hour: int
      minute: int
      snapshotsToKeep: int
      usedBytes: int
    }
    enabled: bool
    hourlySchedule: {
      minute: int
      snapshotsToKeep: int
      usedBytes: int
    }
    monthlySchedule: {
      daysOfMonth: 'string'
      hour: int
      minute: int
      snapshotsToKeep: int
      usedBytes: int
    }
    weeklySchedule: {
      day: 'string'
      hour: int
      minute: int
      snapshotsToKeep: int
      usedBytes: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/snapshotPolicies

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
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 Snapshot policy Properties SnapshotPolicyProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

DailySchedule

Name Description Value
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Daily snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

HourlySchedule

Name Description Value
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Hourly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

MonthlySchedule

Name Description Value
daysOfMonth Indicates which days of the month snapshot should be taken. A comma delimited string. string
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Monthly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

SnapshotPolicyProperties

Name Description Value
dailySchedule Schedule for daily snapshots DailySchedule
enabled The property to decide policy is enabled or not bool
hourlySchedule Schedule for hourly snapshots HourlySchedule
monthlySchedule Schedule for monthly snapshots MonthlySchedule
weeklySchedule Schedule for weekly snapshots WeeklySchedule

TrackedResourceTags

Name Description Value

WeeklySchedule

Name Description Value
day Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english string
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Weekly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

ARM template resource definition

The netAppAccounts/snapshotPolicies 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/snapshotPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies",
  "apiVersion": "2022-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "dailySchedule": {
      "hour": "int",
      "minute": "int",
      "snapshotsToKeep": "int",
      "usedBytes": "int"
    },
    "enabled": "bool",
    "hourlySchedule": {
      "minute": "int",
      "snapshotsToKeep": "int",
      "usedBytes": "int"
    },
    "monthlySchedule": {
      "daysOfMonth": "string",
      "hour": "int",
      "minute": "int",
      "snapshotsToKeep": "int",
      "usedBytes": "int"
    },
    "weeklySchedule": {
      "day": "string",
      "hour": "int",
      "minute": "int",
      "snapshotsToKeep": "int",
      "usedBytes": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/snapshotPolicies

Name Description Value
apiVersion The api version '2022-03-01'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Snapshot policy Properties SnapshotPolicyProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.NetApp/netAppAccounts/snapshotPolicies'

DailySchedule

Name Description Value
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Daily snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

HourlySchedule

Name Description Value
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Hourly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

MonthlySchedule

Name Description Value
daysOfMonth Indicates which days of the month snapshot should be taken. A comma delimited string. string
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Monthly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

SnapshotPolicyProperties

Name Description Value
dailySchedule Schedule for daily snapshots DailySchedule
enabled The property to decide policy is enabled or not bool
hourlySchedule Schedule for hourly snapshots HourlySchedule
monthlySchedule Schedule for monthly snapshots MonthlySchedule
weeklySchedule Schedule for weekly snapshots WeeklySchedule

TrackedResourceTags

Name Description Value

WeeklySchedule

Name Description Value
day Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english string
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Weekly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

Usage Examples

Terraform (AzAPI provider) resource definition

The netAppAccounts/snapshotPolicies 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/snapshotPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/snapshotPolicies@2022-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      dailySchedule = {
        hour = int
        minute = int
        snapshotsToKeep = int
        usedBytes = int
      }
      enabled = bool
      hourlySchedule = {
        minute = int
        snapshotsToKeep = int
        usedBytes = int
      }
      monthlySchedule = {
        daysOfMonth = "string"
        hour = int
        minute = int
        snapshotsToKeep = int
        usedBytes = int
      }
      weeklySchedule = {
        day = "string"
        hour = int
        minute = int
        snapshotsToKeep = int
        usedBytes = int
      }
    }
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/snapshotPolicies

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: netAppAccounts
properties Snapshot policy Properties SnapshotPolicyProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.NetApp/netAppAccounts/snapshotPolicies@2022-03-01"

DailySchedule

Name Description Value
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Daily snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

HourlySchedule

Name Description Value
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Hourly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

MonthlySchedule

Name Description Value
daysOfMonth Indicates which days of the month snapshot should be taken. A comma delimited string. string
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Monthly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

SnapshotPolicyProperties

Name Description Value
dailySchedule Schedule for daily snapshots DailySchedule
enabled The property to decide policy is enabled or not bool
hourlySchedule Schedule for hourly snapshots HourlySchedule
monthlySchedule Schedule for monthly snapshots MonthlySchedule
weeklySchedule Schedule for weekly snapshots WeeklySchedule

TrackedResourceTags

Name Description Value

WeeklySchedule

Name Description Value
day Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english string
hour Indicates which hour in UTC timezone a snapshot should be taken int
minute Indicates which minute snapshot should be taken int
snapshotsToKeep Weekly snapshot count to keep int
usedBytes Resource size in bytes, current storage usage for the volume in bytes int

Usage Examples

Terraform Samples

A basic example of deploying NetApp Snapshot Policy.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus2"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "netAppAccount" {
  type      = "Microsoft.NetApp/netAppAccounts@2022-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      activeDirectories = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "snapshotPolicy" {
  type      = "Microsoft.NetApp/netAppAccounts/snapshotPolicies@2022-05-01"
  parent_id = azapi_resource.netAppAccount.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      dailySchedule = {
        hour            = 22
        minute          = 15
        snapshotsToKeep = 1
      }
      enabled = true
      hourlySchedule = {
        minute          = 15
        snapshotsToKeep = 1
      }
      monthlySchedule = {
        daysOfMonth     = "30,15,1"
        hour            = 5
        minute          = 0
        snapshotsToKeep = 1
      }
      weeklySchedule = {
        day             = "Monday,Friday"
        hour            = 23
        minute          = 0
        snapshotsToKeep = 1
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on