Microsoft.NetApp netAppAccounts/snapshotPolicies 2024-09-01-preview

• Latest
• 2025-01-01
• 2025-01-01-preview
• 2024-09-01
• 2024-09-01-preview
• 2024-07-01
• 2024-07-01-preview
• 2024-05-01
• 2024-05-01-preview
• 2024-03-01
• 2024-03-01-preview
• 2024-01-01
• 2023-11-01
• 2023-11-01-preview
• 2023-07-01
• 2023-07-01-preview
• 2023-05-01
• 2023-05-01-preview
• 2022-11-01
• 2022-11-01-preview
• 2022-09-01
• 2022-05-01
• 2022-03-01
• 2022-01-01
• 2021-10-01
• 2021-08-01
• 2021-06-01
• 2021-04-01
• 2021-04-01-preview
• 2021-02-01
• 2020-12-01
• 2020-11-01
• 2020-09-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2024-09-01-preview' = {
  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

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

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

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:

• Resource groups - See resource group deployment commands

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": "2024-09-01-preview",
  "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

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

Microsoft.NetApp/netAppAccounts/snapshotPolicies

Name	Description	Value
apiVersion	The api version	'2024-09-01-preview'
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'

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:

• 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@2024-09-01-preview"
  name = "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

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

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@2024-09-01-preview"

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