Edit

Get-AzRecoveryServicesBackupContainer

  • Reference
Module:
Az.RecoveryServices

Gets Backup containers.

Syntax

Get-AzRecoveryServicesBackupContainer
   [-ContainerType] <ContainerType>
   [[-BackupManagementType] <String>]
   [[-FriendlyName] <String>]
   [[-ResourceGroupName] <String>]
   [-VaultId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzRecoveryServicesBackupContainer cmdlet gets a backup container. A Backup container encapsulates data sources that are modelled as backup items. For Container type "Azure VM" , the output lists all the containers whose name exactly matches to the one passed as the value for Friendly Name parameter. For other container types, output gives a list of containers with name similar to the value passed for Friendly name parameter. Set the vault context by using the -VaultId parameter.

Examples

Example 1: Get a specific container

$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
Get-AzRecoveryServicesBackupContainer -ContainerType "AzureVM" -FriendlyName "V2VM" -VaultId $vault.ID

This command gets the container named V2VM of type AzureVM.

Example 2: Get all containers of a specific type

$vault = Get-AzRecoveryServicesVault -ResourceGroupName "resourceGroup" -Name "vaultName"
Get-AzRecoveryServicesBackupContainer -ContainerType Windows -BackupManagementType MAB -VaultId $vault.ID

This command gets all Windows containers that are protected by Azure Backup agent. The BackupManagementType parameter is only required for Windows containers.

Parameters

-BackupManagementType

The class of resources being protected. The acceptable values for this parameter are:

  • AzureVM
  • MAB
  • AzureWorkload
  • AzureStorage

This parameter is used to differentiate Windows machines that are backed up using MARS agent or other backup engines.

Type:String
Accepted values:AzureVM, AzureStorage, AzureWorkload, MAB
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContainerType

Specifies the backup container type. The acceptable values for this parameter are:

  • AzureVM
  • Windows
  • AzureStorage
  • AzureVMAppContainer
Type:ContainerType
Accepted values:AzureVM, Windows, AzureStorage, AzureVMAppContainer
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

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

-FriendlyName

Specifies the friendly name of the container to get.

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

-ResourceGroupName

Specifies the name of the resource group. This parameter is for Azure virtual machines only.

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

-VaultId

ARM ID of the Recovery Services Vault.

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

Inputs

String

Outputs

ContainerBase