Remove-VBOEncryptionKey

Short Description

Removes encryption keys.

Syntax

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

[-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes an encryption key for object storage repositories.

Note

You cannot remove an encryption key if it is in use by any of object storage repositories.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
EncryptionKey	Specifies an encryption key. The cmdlet will remove this key from Veeam Backup for Microsoft 365. Accepts the `VBOEncryptionKey` object. To get this object, run the `Get-VBOEncryptionKey` cmdlet.	`VBOEncryptionKey`	True	Named	True (ByValue)
Confirm	Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue. Default: True	`SwitchParameter`	False	Named	False
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action. Default: False	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Examples

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:

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

Get-VBOEncryptionKey