Remove-AzureRmSnapshot

Module:: AzureRM.Compute

Removes a snapshot.

Syntax

Remove-AzureRmSnapshot
      [-ResourceGroupName] <String>
      [-SnapshotName] <String>
      [-Force]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzureRmSnapshot cmdlet removes a snapshot.

Examples

Example 1

PS C:\> Remove-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Force;

This command removes the snapshot named 'Snapshot01' in the resource group 'ResourceGroup01'.

Parameters

-AsJob

Run cmdlet in the background and return a Job to track progress.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

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

Type:	Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Forces the command to run without asking for user confirmation.

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

-ResourceGroupName

Specifies the name of a resource group.

Type:	String
Position:	1
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-SnapshotName

Specifies the name of a snapshot.

Type:	String
Aliases:	Name
Position:	2
Default value:	None
Accept pipeline input:	True (ByPropertyName)
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSOperationStatusResponse