Get-AzureRmSnapshot

Reference

Module:: AzureRM.Compute

Gets the properties of a snapshot

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmSnapshot
   [[-ResourceGroupName] <String>]
   [[-SnapshotName] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmSnapshot cmdlet gets the properties of a snapshot.

Examples

Example 1

PS C:\> Get-AzureRmSnapshot

This command gets the properties of all snapshots of the subscription.

Example 2

PS C:\> Get-AzureRmSnapshot -ResourceGroupName "ResourceGroupName1"

This command gets the properties of all snapshots in the resource group named "ResourceGroupName1"

Example 3

PS C:\> Get-AzureRmSnapshot -ResourceGroupName "ResourceGroupName1" -SnapshotName "SnapshotName1"

This command gets the properties of the snapshot named "SnapshotName1" in the resource group named "ResourceGroupName1"

Parameters

-DefaultProfile

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

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

-ResourceGroupName

Specifies the name of a resource group.

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

-SnapshotName

Specifies the name of a snapshot.

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

Inputs

String

Outputs

PSSnapshot

Share via