Remove-AzNetAppFilesBackup
Deletes an Azure NetApp Files (ANF) backup.
Syntax
Remove-AzNetAppFilesBackup
-ResourceGroupName <String>
[-AccountName <String>]
[-PoolName <String>]
[-VolumeName <String>]
-BackupVaultName <String>
-Name <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzNetAppFilesBackup
-ResourceGroupName <String>
-AccountName <String>
[-AccountBackupName <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzNetAppFilesBackup
-Name <String>
[-VolumeObject <PSNetAppFilesVolume>]
-BackupVaultObject <PSNetAppFilesBackupVault>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzNetAppFilesBackup
-ResourceId <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzNetAppFilesBackup
-InputObject <PSNetAppFilesBackup>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-AzNetAppFilesBackup cmdlet deletes an ANF account.
Examples
Example 1
Remove-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -Name "MyBackup"
This command deletes the new ANF backup with a the name "MyBackup" for volume "MyVolume".
Example 2
Remove-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -AccountBackupName "MyBackup"
This command deletes the new ANF backup with a the name "MyBackup" for account "MyAccount".
Parameters
-AccountBackupName
The name of the ANF backup
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
-InputObject
The snapshot object to remove
Type: | PSNetAppFilesBackup |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
-PassThru
Return whether the specified backup was successfully removed
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PoolName
The name of the ANF pool
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-ResourceId
The resource id of the ANF Backup
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VolumeName
The name of the ANF volume
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VolumeObject
The volume object containing the backup to return
Type: | PSNetAppFilesVolume |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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
Outputs
Related Links
- New-AzNetAppFilesBackup
- Get-AzNetAppFilesBackup
- Update-AzNetAppFilesBackup
- Get-AzNetAppFilesBackupPolicy
- New-AzNetAppFilesBackupPolicy
- Update-AzNetAppFilesBackupPolicy
- Remove-AzNetAppFilesBackupPolicy
- Get-AzNetAppFilesVolume
- New-AzNetAppFilesVolume
- Update-AzNetAppFilesVolume
- Remove-AzNetAppFilesVolume
Azure PowerShell