Get-VBOEncryptionKey

Short Description

Returns encryption keys for object storage.

Syntax

Get-VBOEncryptionKey [-Id <Guid>][-Description <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of encryption keys for object storage.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Id

Specifies an ID of the encryption key. The cmdlet will return the encryption key with this ID.

Guid

False

Named

False

Description

Specifies a description of the encryption key. The cmdlet will return the encryption key with this description.

Sring

False

Named

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

The cmdlet returns the VBOEncryptionKey object that contains settings of an encryption key.

Examples

Get-VBOEncryptionKeyExample 1. Getting All Encryption Keys

This command returns all encryption keys managed by Veeam Backup for Microsoft 365.

Get-VBOEncryptionKey

Get-VBOEncryptionKeyExample 2. Getting Encryption Keys with Specified ID

This command returns the 8657138e-ca49-4f91-a8ec-a17818eb818e encryption key.

Get-VBOEncryptionKey -Id 8657138e-ca49-4f91-a8ec-a17818eb818e

Get-VBOEncryptionKeyExample 3. Getting Encryption Keys with Specified Description

This command returns all encryption keys with the specified description.

Get-VBOEncryptionKey -Description "Veeam Admin Key"

Page updated 4/26/2024

Page content applies to build 8.0.4.29