Unregister-AzRecoveryServicesBackupManagementServer
Unregisters a SCDPM server or Backup server from the vault.
Syntax
Unregister-AzRecoveryServicesBackupManagementServer
[-AzureRmBackupManagementServer] <BackupEngineBase>
[-PassThru]
[-VaultId <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Unregister-AzRecoveryServicesBackupManagementServer 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-AzRecoveryServicesVaultContext cmdlet before you use the current cmdlet.
Examples
Example 1: Unregister an SCDPM server from the vault
$BMS = Get-AzRecoveryServicesBackupManagementServer -Name "dpmserver01.contoso.com"
Unregister-AzRecoveryServicesBackupManagementServer -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.
Example 2
Unregisters a SCDPM server or Backup server from the vault. (autogenerated)
Unregister-AzRecoveryServicesBackupManagementServer -AzureRmBackupManagementServer <BackupEngineBase> -VaultId $vault.ID
Parameters
-AzureRmBackupManagementServer
The recovery services backup container.
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: | AzContext, 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.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |