Unregister-AzureRmRecoveryServicesBackupManagementServer

Reference

Module:: AzureRM.RecoveryServices.Backup

Unregisters a SCDPM server or Backup server from the vault.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Unregister-AzureRmRecoveryServicesBackupManagementServer
          [-AzureRmBackupManagementServer] <BackupEngineBase>
          [-PassThru]
          [-VaultId <String>]
          [-DefaultProfile <IAzureContextContainer>]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

Description

The Unregister-AzureRmRecoveryServicesBackupManagementServer cmdlet unregisters a System Center Data Protection Manager (SCDPM) server or an Azure Backup server from the vault. This cmdlet removes references to the servers that are unregistered from the vault. Before you can unregister a container, you must delete any protected data associated with that container. Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet.

Examples

Example 1: Unregister an SCDPM server from the vault

PS C:\>$BMS = Get-AzureRmRecoveryServicesBackupManagementServer -Name "dpmserver01.contoso.com"
PS C:\> Unregister-AzureRmRecoveryServicesBackupManagementServer -AzureRmBackupManagementServer $BMS

The first command gets the Backup management server named dpmserver01.contoso.com, and then stores it in the $BMS variable. The second command unregisters the SCDPM server from the vault.

Parameters

-AzureRmBackupManagementServer

Specifies an SCDPM server object to unregister. To obtain an BackupManagementServer object, use the Get-AzureRmRecoveryServicesBackupManagementServer cmdlet.

Type:	BackupEngineBase
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

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

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

-PassThru

Return the Backup Management Server to be deleted.

Type:	SwitchParameter
Position:	Named
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

-WhatIf

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

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

Inputs

String

Parameters: VaultId (ByValue)

Outputs

BackupEngineBase

Get-AzureRmRecoveryServicesBackupManagementServer