< Back
Register-AzureRmBackupContainer
Post
NAME Register-AzureRmBackupContainer
SYNOPSIS
Registers the container with a Backup vault.
SYNTAX
Register-AzureRmBackupContainer [-Vault] <AzureRMBackupVault> [-DefaultProfile <IAzureContextContainer>] -Name <String> -ResourceGroupName
<String> [<CommonParameters>]
Register-AzureRmBackupContainer [-Vault] <AzureRMBackupVault> [-DefaultProfile <IAzureContextContainer>] -Name <String> -ServiceName <String>
[<CommonParameters>]
DESCRIPTION
The Register-AzureRmBackupContainer cmdlet registers the container with an Azure Backup vault. To configure backup by using Azure Backup, first
register your server or virtual machine with a Backup vault. This cmdlet registers an infrastructure as a service (IaaS) virtual machine with the
specified vault. The register operation associates the Azure virtual machine with the backup vault and tracks the virtual machine through the
backup life cycle.
PARAMETERS
-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
-Name <String>
Specifies the name of the virtual machine that this cmdlet registers.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group for the virtual machine.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceName <String>
Specifies the service name of the virtual machine that this cmdlet registers.
Typically, a cloud service name has a suffix .cloudapp.net. Do not include the suffix when you specify this parameter.
To obtain information about a virtual machine, use the Get-AzureRMVM cmdlet. The service name is the DeploymentName property of the virtual
machine object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Vault <AzureRMBackupVault>
Specifies the Backup vault to which this cmdlet registers virtual machine. To obtain an AzureRmBackupVault object, use the
Get-AzureRmBackupVault cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
AzureRmBackupVault
OUTPUTS
AzureRmBackupJob
NOTES
Example 1: Register a virtual machine to a Backup vault
PS C:\\>$Vault = Get-AzureRmBackupVault -Name "Vault03"
PS C:\\> Register-AzureRmBackupContainer -Vault $Vault -Name "Contoso03Vm" -ServiceName "ContosoService27"
The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores the vault in the $Vault variable.
The second command registers the virtual machine named Contoso03Vm with the vault in $Vault. That virtual machine belongs to the service named
ContosoService27.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... pcontainer
Get-AzureRmBackupVault
SYNOPSIS
Registers the container with a Backup vault.
SYNTAX
Register-AzureRmBackupContainer [-Vault] <AzureRMBackupVault> [-DefaultProfile <IAzureContextContainer>] -Name <String> -ResourceGroupName
<String> [<CommonParameters>]
Register-AzureRmBackupContainer [-Vault] <AzureRMBackupVault> [-DefaultProfile <IAzureContextContainer>] -Name <String> -ServiceName <String>
[<CommonParameters>]
DESCRIPTION
The Register-AzureRmBackupContainer cmdlet registers the container with an Azure Backup vault. To configure backup by using Azure Backup, first
register your server or virtual machine with a Backup vault. This cmdlet registers an infrastructure as a service (IaaS) virtual machine with the
specified vault. The register operation associates the Azure virtual machine with the backup vault and tracks the virtual machine through the
backup life cycle.
PARAMETERS
-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
-Name <String>
Specifies the name of the virtual machine that this cmdlet registers.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group for the virtual machine.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceName <String>
Specifies the service name of the virtual machine that this cmdlet registers.
Typically, a cloud service name has a suffix .cloudapp.net. Do not include the suffix when you specify this parameter.
To obtain information about a virtual machine, use the Get-AzureRMVM cmdlet. The service name is the DeploymentName property of the virtual
machine object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Vault <AzureRMBackupVault>
Specifies the Backup vault to which this cmdlet registers virtual machine. To obtain an AzureRmBackupVault object, use the
Get-AzureRmBackupVault cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
AzureRmBackupVault
OUTPUTS
AzureRmBackupJob
NOTES
Example 1: Register a virtual machine to a Backup vault
PS C:\\>$Vault = Get-AzureRmBackupVault -Name "Vault03"
PS C:\\> Register-AzureRmBackupContainer -Vault $Vault -Name "Contoso03Vm" -ServiceName "ContosoService27"
The first command gets the vault named Vault03 by using the Get-AzureRmBackupVault cmdlet. The command stores the vault in the $Vault variable.
The second command registers the virtual machine named Contoso03Vm with the vault in $Vault. That virtual machine belongs to the service named
ContosoService27.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... pcontainer
Get-AzureRmBackupVault