Share via

Start-OBRegistration

  • Reference
Module:
MSOnlineBackup

Registers the current computer to Microsoft Azure Backup.

Syntax

Start-OBRegistration
     [-RecoveryService] <CBServiceResource>
     [-Confirm]
     [-WhatIf]

Description

The Start-OBRegistration cmdlet registers the server to Microsoft Azure Backup. The cmdlet registers the server by uploading a backup certificate to the vault. You can use the Get-OBCertificateListFromLocalStore cmdlet to get the list of certificates from the local computer certificate store.

This cmdlet supports the WhatIf and the Confirm parameters. The cmdlet prompts the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Specify -Confirm:$FALSE to override the prompt.

To use Microsoft Azure Backup cmdlets, the user needs to be an administrator on the protected machine.

Examples

Example 1: Registers a server

The first command gets the list of certificates from the local computer certificate store, and stores the result in the **$Cert** variable.
$Cert = Get-OBCertificateListFromLocalStore

The second command gets the list of backup vaults that can you use to register the current computer for the fifth certificate stored in **$Cert**. The command stores the result in the **$Item** variable.
$Item = Get-OBRecoveryService -Certificate $Cert[4]


The third command registers the current computer by using the first certificate stored in **$Item**.
Start-OBRegistration -RecoveryService $Item[0]

This example starts a computer registration.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-RecoveryService

Specifies a Microsoft Azure Backup recovery agent.

Type:CBServiceResource
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

None

Outputs

None