Share via

Microsoft.NetApp netAppAccounts/backupVaults/backups 2023-11-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.NetApp/netAppAccounts/backupVaults/backups@2023-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    label: 'string'
    snapshotName: 'string'
    useExistingSnapshot: bool
    volumeResourceId: 'string'
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/backupVaults/backups

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_.]{0,255}$ (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/backupVaults
properties Backup Properties BackupProperties (required)

BackupProperties

Name Description Value
label Label for backup string
snapshotName The name of the snapshot string
useExistingSnapshot Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups bool
volumeResourceId ResourceId used to identify the Volume string (required)

ARM template resource definition

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

{
  "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "properties": {
    "label": "string",
    "snapshotName": "string",
    "useExistingSnapshot": "bool",
    "volumeResourceId": "string"
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/backupVaults/backups

Name Description Value
apiVersion The api version '2023-11-01-preview'
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_.]{0,255}$ (required)
properties Backup Properties BackupProperties (required)
type The resource type 'Microsoft.NetApp/netAppAccounts/backupVaults/backups'

BackupProperties

Name Description Value
label Label for backup string
snapshotName The name of the snapshot string
useExistingSnapshot Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups bool
volumeResourceId ResourceId used to identify the Volume string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/backupVaults/backups@2023-11-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      label = "string"
      snapshotName = "string"
      useExistingSnapshot = bool
      volumeResourceId = "string"
    }
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/backupVaults/backups

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_.]{0,255}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: netAppAccounts/backupVaults
properties Backup Properties BackupProperties (required)
type The resource type "Microsoft.NetApp/netAppAccounts/backupVaults/backups@2023-11-01-preview"

BackupProperties

Name Description Value
label Label for backup string
snapshotName The name of the snapshot string
useExistingSnapshot Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups bool
volumeResourceId ResourceId used to identify the Volume string (required)