|
| 1 | +--- |
| 2 | +external help file: BitLocker-help.xml |
| 3 | +Module Name: bitlocker |
| 4 | +online version: |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# BackupToAAD-BitLockerKeyProtector |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Saves a key protector for a BitLocker volume in Azure Active Directory. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +``` |
| 16 | +BackupToAAD-BitLockerKeyProtector [-MountPoint] <String[]> [-KeyProtectorId] <String> [-WhatIf] [-Confirm] |
| 17 | + [<CommonParameters>] |
| 18 | +``` |
| 19 | + |
| 20 | +## DESCRIPTION |
| 21 | +The **BackupToAAD-BitLockerKeyProtector** cmdlet saves a recovery password key protector for a volume protected by BitLocker Drive Encryption to Azure Active Directory (AAD). Specify a key to be saved by ID. |
| 22 | + |
| 23 | +## EXAMPLES |
| 24 | + |
| 25 | +### Example 1 |
| 26 | +```powershell |
| 27 | +PS C:\> $BLV = Get-BitLockerVolume -MountPoint "C:" |
| 28 | +PS C:\> BackupToAAD-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId $BLV.KeyProtector[1].KeyProtectorId |
| 29 | +
|
| 30 | +``` |
| 31 | + |
| 32 | +This example saves a key protector for a specified BitLocker volume. |
| 33 | + |
| 34 | +The first command uses **Get-BitLockerVolume** to obtain a BitLocker volume and store it in the $BLV variable. |
| 35 | + |
| 36 | +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. |
| 37 | + |
| 38 | +### Example 2 |
| 39 | +```powershell |
| 40 | +PS C:\> BackupToAAD-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId "{E2611001E-6AD0-4A08-BAAA-C9c031DB2AA6}" |
| 41 | +``` |
| 42 | +This command saves a key protector for a specified BitLocker volume to Azure AD. The command specifies the key protector by using its ID. |
| 43 | + |
| 44 | +## PARAMETERS |
| 45 | + |
| 46 | +### -KeyProtectorId |
| 47 | +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. |
| 48 | + |
| 49 | + |
| 50 | +```yaml |
| 51 | +Type: String |
| 52 | +Parameter Sets: (All) |
| 53 | +Aliases: |
| 54 | + |
| 55 | +Required: True |
| 56 | +Position: 1 |
| 57 | +Default value: None |
| 58 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 59 | +Accept wildcard characters: False |
| 60 | +``` |
| 61 | +
|
| 62 | +### -MountPoint |
| 63 | +The volume to be used by **KeyProtector**. |
| 64 | +
|
| 65 | +```yaml |
| 66 | +Type: String[] |
| 67 | +Parameter Sets: (All) |
| 68 | +Aliases: |
| 69 | + |
| 70 | +Required: True |
| 71 | +Position: 0 |
| 72 | +Default value: None |
| 73 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 74 | +Accept wildcard characters: False |
| 75 | +``` |
| 76 | +
|
| 77 | +### -Confirm |
| 78 | +Prompts you for confirmation before running the cmdlet. |
| 79 | +
|
| 80 | +```yaml |
| 81 | +Type: SwitchParameter |
| 82 | +Parameter Sets: (All) |
| 83 | +Aliases: cf |
| 84 | + |
| 85 | +Required: False |
| 86 | +Position: Named |
| 87 | +Default value: None |
| 88 | +Accept pipeline input: False |
| 89 | +Accept wildcard characters: False |
| 90 | +``` |
| 91 | +
|
| 92 | +### -WhatIf |
| 93 | +Shows what would happen if the cmdlet runs. |
| 94 | +The cmdlet is not run. |
| 95 | +
|
| 96 | +```yaml |
| 97 | +Type: SwitchParameter |
| 98 | +Parameter Sets: (All) |
| 99 | +Aliases: wi |
| 100 | + |
| 101 | +Required: False |
| 102 | +Position: Named |
| 103 | +Default value: None |
| 104 | +Accept pipeline input: False |
| 105 | +Accept wildcard characters: False |
| 106 | +``` |
| 107 | +
|
| 108 | +### CommonParameters |
| 109 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). |
| 110 | +
|
| 111 | +## INPUTS |
| 112 | +
|
| 113 | +### System.String[] |
| 114 | +
|
| 115 | +### System.String |
| 116 | +
|
| 117 | +## OUTPUTS |
| 118 | +
|
| 119 | +### System.Object |
| 120 | +## NOTES |
| 121 | +
|
| 122 | +## RELATED LINKS |
0 commit comments