Edit

Share via

New-AzNetAppFilesBackup

  • Reference
Module:
Az.NetAppFiles

Creates a new Azure NetApp Files (ANF) backup.

Syntax

New-AzNetAppFilesBackup
   -ResourceGroupName <String>
   -AccountName <String>
   -BackupVaultName <String>
   -Name <String>
   -VolumeResourceId <String>
   [-Label <String>]
   [-UseExistingSnapshot]
   [-SnapshotName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzNetAppFilesBackup
   -Name <String>
   -VolumeResourceId <String>
   [-Label <String>]
   [-UseExistingSnapshot]
   [-SnapshotName <String>]
   -BackupVaultObject <PSNetAppFilesBackupVault>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzNetAppFilesBackup cmdlet creates a backup for an ANF volume.

Examples

Example 1

$volumeResourceId = "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/MyAccount/capacityPools/MyPool/volumes/MyVolume"
New-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -BackupVaultName "MyVault" -Name "MyVolumeBackup" -Label "ALabel" -VolumeResourceId $volumeResourceId

This command creates the new ANF backup in vault MyVault for volume with resource Id $volumeResourceId.

Parameters

-AccountName

The name of the ANF account

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-BackupVaultName

The name of the ANF BackupVault

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-BackupVaultObject

The BackupVault object containing the backup to return

Type:PSNetAppFilesBackupVault
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Label

Label for backup

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name of the ANF backup

Type:String
Aliases:BackupName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The resource group of the ANF account

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SnapshotName

The name of the snapshot, use with UseExistingSnapshot

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseExistingSnapshot

Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VolumeResourceId

ResourceId used to identify the Volume

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSNetAppFilesBackupVault

Outputs

PSNetAppFilesBackup