Get-AzsBackup
Returns a backup from a location based on name.
Syntax
Get-AzsBackup
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String[]>]
[-Skip <String>]
[-Top <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzsBackup
-Name <String>
[-Location <String>]
[-ResourceGroupName <String>]
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzsBackup
-INPUTOBJECT \<IBackupAdminIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Returns a backup from a location based on name.
Examples
Example 1: List Backups
PS C:\> Get-AzsBackupGet information sbout all Azure Stack backups.
Example 2: Get specific backup
PS C:\> Get-AzsBackup -Name 'backupName'Get information for the the specified Azure Stack backup.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | System.Management.Automation.PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.Models.IBackupAdminIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
Name of the backup location.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzLocation)[0].Location |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Name of the backup.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Name of the resource group.
| Type: | System.String |
| Position: | Named |
| Default value: | "system.$((Get-AzLocation)[0].Location)" |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
OData skip parameter.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | System.String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Top
OData top parameter.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.Models.IBackupAdminIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.BackupAdmin.Models.Api20180901.IBackup
Notes
ALIASES
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IBackupAdminIdentity>: Identity Parameter
[Backup <String>]: Name of the backup.[Id <String>]: Resource identity path[Location <String>]: Name of the backup location.[ResourceGroupName <String>]: Name of the resource group.[SubscriptionId <String>]: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.