Share via

Get-AzsBackup

  • Reference
Module:
Azs.Backup.Admin

Returns a backup from a location based on name.

Syntax

Get-AzsBackup
   [-Location <String>]
   [-ResourceGroupName <String>]
   [-Top <Int32>]
   [-Skip <Int32>]
   [<CommonParameters>]
Get-AzsBackup
   -Name <String>
   [-Location <String>]
   [-ResourceGroupName <String>]
   [<CommonParameters>]
Get-AzsBackup
   -ResourceId <String>
   [<CommonParameters>]
Get-AzsBackup
   -ParentResource <BackupLocation>
   [-Top <Int32>]
   [-Skip <Int32>]
   [<CommonParameters>]

Description

Returns a backup from a location based on name.

Examples

-------------------------- EXAMPLE 1 --------------------------

Get-AzsBackup

Get information sbout all Azure Stack backups.

-------------------------- EXAMPLE 2 --------------------------

Get-AzsBackup -Name 'backupName'

Get information for the the specified Azure Stack backup.

Parameters

-Location

Location backed up.

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

-Name

Name of the backup.

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

-ParentResource

Passing a backup location will return the list of all backups at that backup location.

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

-ResourceGroupName

Name of the resource group.

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

-ResourceId

The resource id.

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

-Skip

{{Fill Skip Description}}

Type:Int32
Position:Named
Default value:-1
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

{{Fill Top Description}}

Type:Int32
Position:Named
Default value:-1
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.AzureStack.Management.Backup.Admin.Models.Backup