Remove-VBOEncryptionKey

Short Description

Removes encryption keys for object storage repositories.

Syntax

Remove-VBOEncryptionKey -EncryptionKey <VBOEncryptionKey> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet removes an encryption key for object storage repositories.

Remove-VBOEncryptionKey Note

You cannot remove an encryption key if it is in use by any of the extended backup repositories.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

EncryptionKey

Specifies an encryption key. The cmdlet will remove that key from Veeam Backup for Microsoft 365.

Accepts the VBOEncryptionKey object.

To get this object, run the Get-VBOEncryptionKey cmdlet.

True

Named

True (ByValue)

False

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

False

Confirm

Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue.

SwitchParameter

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

None.

Examples

Remove-VBOEncryptionKeyExample 1. Removing Encryption Key

This example shows how to remove an encryption key.

$key = Get-VBOEncryptionKey -Description "Veeam Admin Key"

Remove-VBOEncryptionKey -EncryptionKey $key

Perform the following steps:

  1. Run the Get-VBOEncryptionKey cmdlet. Specify the Description parameter value. Save the result to the $key variable.
  2. Run the Remove-VBOEncryptionKey cmdlet. Set the $key variable as the EncryptionKey parameter value.

Related Commands

Get-VBOEncryptionKey