BackupToAAD-BitLockerKeyProtector

Module:

BitLocker

Saves a key protector for a BitLocker volume in Microsoft Entra ID.

Syntax

BackupToAAD-BitLockerKeyProtector
                [-MountPoint] <String[]>
                [-KeyProtectorId] <String>
                [-WhatIf]
                [-Confirm]
                [<CommonParameters>]

Description

The BackupToAAD-BitLockerKeyProtector cmdlet saves a recovery password key protector for a volume protected by BitLocker Drive Encryption to Microsoft Entra ID. Specify a key to be saved by ID.

Examples

Example 1

PS C:\> $BLV = Get-BitLockerVolume -MountPoint "C:"
PS C:\> BackupToAAD-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId $BLV.KeyProtector[1].KeyProtectorId

This example saves a key protector for a specified BitLocker volume.

The first command uses Get-BitLockerVolume to obtain a BitLocker volume and store it in the $BLV variable.

The second command backs up the key protector for the BitLocker volume specified by the MountPoint parameter. The command specifies the key protector by using its ID, contained in the BitLocker object stored in $BLV.

Example 2

PS C:\> BackupToAAD-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId "{E2611001E-6AD0-4A08-BAAA-C9c031DB2AA6}"

This command saves a key protector for a specified BitLocker volume to Microsoft Entra ID. The command specifies the key protector by using its ID.

Parameters

-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

-KeyProtectorId

The KeyProtector attribute contains an array of key protectors associated to the volume. This command uses standard array syntax to index the KeyProtector object. The key protector that corresponds to the recovery password key protector can be identified by using the KeyProtectorType attribute in the KeyProtector object.

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

-MountPoint

The volume to be used by KeyProtector.

Type:	String[]
Position:	0
Default value:	None
Required:	True
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[]

String

Outputs

Object