< Back
Get-AzureRmRecoveryServicesBackupContainer
Post
NAME Get-AzureRmRecoveryServicesBackupContainer
SYNOPSIS
Gets Backup containers.
SYNTAX
Get-AzureRmRecoveryServicesBackupContainer [-ContainerType] {AzureVM | Windows | AzureSQL} [[-BackupManagementType] {AzureVM | MARS | AzureSQL}]
[[-FriendlyName] <String>] [[-Name] <String>] [[-ResourceGroupName] <String>] [[-Status] {Registered}] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmRecoveryServicesBackupContainer cmdlet gets a backup container. A Backup container encapsulates data sources that are modelled as
backup items.
Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet.
PARAMETERS
-BackupManagementType <String>
Specifies the backup management type. The acceptable values for this parameter are:
- AzureVM
- MARS
- AzureSQL
This parameter is used to differentiate Windows machines that are backed up using MARS agent or other backup engines.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContainerType <ContainerType>
Specifies the backup container type. The acceptable values for this parameter are:
- AzureVM
- Windows
- AzureSQL
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FriendlyName <String>
Specifies the friendly name of the container to get.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the container to get.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group. This parameter is for Azure virtual machines only.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Status <ContainerRegistrationStatus>
Specifies the container registration status. The acceptable values for this parameter are:
- Registered
Required? false
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase
System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase]
NOTES
Example 1: Get a specific container
PS C:\\>Get-AzureRmRecoveryServicesContainer -ContainerType "AzureVM" -Status "Registered" -Name "V2VM";
This command gets the container named V2VM of type AzureVM.
Example 2: Get all containers of a specific type
PS C:\\>Get-AzureRmRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MARS
This command gets all Windows containers that are protected by Azure Backup agent. The BackupManagementType parameter is only required for Windows
containers.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... pcontainer
Get-AzureRmRecoveryServicesBackupItem
Get-AzureRmRecoveryServicesBackupManagementServer
Unregister-AzureRmRecoveryServicesBackupContainer
SYNOPSIS
Gets Backup containers.
SYNTAX
Get-AzureRmRecoveryServicesBackupContainer [-ContainerType] {AzureVM | Windows | AzureSQL} [[-BackupManagementType] {AzureVM | MARS | AzureSQL}]
[[-FriendlyName] <String>] [[-Name] <String>] [[-ResourceGroupName] <String>] [[-Status] {Registered}] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmRecoveryServicesBackupContainer cmdlet gets a backup container. A Backup container encapsulates data sources that are modelled as
backup items.
Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet.
PARAMETERS
-BackupManagementType <String>
Specifies the backup management type. The acceptable values for this parameter are:
- AzureVM
- MARS
- AzureSQL
This parameter is used to differentiate Windows machines that are backed up using MARS agent or other backup engines.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContainerType <ContainerType>
Specifies the backup container type. The acceptable values for this parameter are:
- AzureVM
- Windows
- AzureSQL
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FriendlyName <String>
Specifies the friendly name of the container to get.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the container to get.
Required? false
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group. This parameter is for Azure virtual machines only.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Status <ContainerRegistrationStatus>
Specifies the container registration status. The acceptable values for this parameter are:
- Registered
Required? false
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase
System.Collections.Generic.IList`1[Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.ContainerBase]
NOTES
Example 1: Get a specific container
PS C:\\>Get-AzureRmRecoveryServicesContainer -ContainerType "AzureVM" -Status "Registered" -Name "V2VM";
This command gets the container named V2VM of type AzureVM.
Example 2: Get all containers of a specific type
PS C:\\>Get-AzureRmRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MARS
This command gets all Windows containers that are protected by Azure Backup agent. The BackupManagementType parameter is only required for Windows
containers.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... pcontainer
Get-AzureRmRecoveryServicesBackupItem
Get-AzureRmRecoveryServicesBackupManagementServer
Unregister-AzureRmRecoveryServicesBackupContainer