Share via

Microsoft.NetApp netAppAccounts/snapshotPolicies 2023-11-01-preview

  • Article

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@2023-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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

netAppAccounts/snapshotPolicies

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 The geo-location where the resource lives 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 Snapshot policy Properties SnapshotPolicyProperties (required)

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

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

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": "2023-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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

netAppAccounts/snapshotPolicies

Name Description Value
type The resource type 'Microsoft.NetApp/netAppAccounts/snapshotPolicies'
apiVersion The resource api version '2023-11-01-preview'
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 The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Snapshot policy Properties SnapshotPolicyProperties (required)

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

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

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

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/snapshotPolicies@2023-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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

netAppAccounts/snapshotPolicies

Name Description Value
type The resource type "Microsoft.NetApp/netAppAccounts/snapshotPolicies@2023-11-01-preview"
name The resource name string (required)

Character limit: 1-64

Valid characters:
Alphanumerics, underscores, and hyphens.

Start with alphanumeric.
location The geo-location where the resource lives 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 Snapshot policy Properties SnapshotPolicyProperties (required)

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

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

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