Use-AipServiceKeyVaultKey
Vertelt Azure Information Protection om een door de klant beheerde tenantsleutel te gebruiken in Azure Key Vault.
Syntaxis
Use-AipServiceKeyVaultKey
-KeyVaultKeyUrl <String>
[-FriendlyName <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
De cmdlet Use-AipServiceKeyVaultKey vertelt Azure Information Protection om een door de klant beheerde sleutel (BYOK) te gebruiken in Azure Key Vault.
U moet PowerShell gebruiken om uw tenantsleutel te configureren; U kunt deze configuratie niet uitvoeren met behulp van een beheerportal.
U kunt deze cmdlet uitvoeren voor of nadat de beveiligingsservice (Azure Rights Management) is geactiveerd.
Voordat u deze cmdlet uitvoert, moet u ervoor zorgen dat de Azure Rights Management-service-principal machtigingen heeft gekregen voor de sleutelkluis die de sleutel bevat die u wilt gebruiken voor Azure Information Protection. Deze machtigingen worden verleend door de Azure Key Vault-cmdlet uit te voeren Set-AzKeyVaultAccessPolicy.
Om veiligheidsredenen kunt u met de cmdlet Use-AipServiceKeyVaultKey het toegangsbeheer voor de sleutel in Azure Key Vault niet instellen of wijzigen. Nadat deze toegang is verleend door Set-AzKeyVaultAccessPolicyuit te voeren, voert u Use-AipServiceKeyVaultKey uit om Azure Information Protection te laten weten dat u de sleutel en versie wilt gebruiken die u opgeeft met de parameter KeyVaultKeyUrl.
Zie Aanbevolen procedures voor het kiezen van uw Azure Key Vault-locatievoor meer informatie.
Notitie
Als u deze cmdlet uitvoert voordat de machtigingen worden verleend aan de sleutelkluis, ziet u een fout met de foutmelding De Rights Management-service kan de sleutel niet toevoegen.
Als u meer gedetailleerde informatie wilt zien, voert u de opdracht opnieuw uit met -Uitgebreide. Als de machtigingen niet worden verleend, ziet u UITGEBREID: Toegang tot Azure KeyVault-is mislukt.
Wanneer uw opdracht is uitgevoerd, wordt de sleutel toegevoegd als een gearchiveerde door de klant beheerde tenantsleutel voor Azure Information Protection voor uw organisatie. Als u de actieve tenantsleutel voor Azure Information Protection wilt maken, moet u vervolgens de Set-AipServiceKeyProperties cmdlet uitvoeren.
Gebruik Azure Key Vault om het gebruik van de sleutel die u hebt opgegeven centraal te beheren en te bewaken. Alle aanroepen naar uw tenantsleutel worden uitgevoerd in de sleutelkluis die uw organisatie bezit. U kunt controleren welke sleutel u in Key Vault gebruikt met behulp van de cmdlet Get-AipServiceKeys.
Zie Uw Azure Information Protection-tenantsleutels plannen en implementerenvoor meer informatie over de typen tenantsleutels die Door Azure Information Protection worden ondersteund.
Zie Wat is Azure Key Vaultvoor meer informatie over Azure Key Vault.
Voorbeelden
Voorbeeld 1: Azure Information Protection configureren voor het gebruik van een door de klant beheerde sleutel in Azure Key Vault
PS C:\>Use-AipServiceKeyVaultKey -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"
Met deze opdracht geeft Azure Information Protection aan dat de sleutel met de naam contoso-aipservice-key, versie aaaabbbbcccc111122223333, in de sleutelkluis met de naam contoso.
Deze sleutel en versie in Azure Key Vault worden vervolgens de door de klant beheerde tenantsleutel voor Azure Information Protection.
Parameters
-Confirm
U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.
Type: | SwitchParameter |
Aliassen: | cf |
Position: | Named |
Default value: | False |
Vereist: | False |
Pijplijninvoer accepteren: | False |
Jokertekens accepteren: | False |
-Force
Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | False |
Jokertekens accepteren: | False |
-FriendlyName
Hiermee geeft u de beschrijvende naam van een trusted publishing domain (TPD) en de SLC-sleutel die u hebt geïmporteerd uit AD RMS.
Als gebruikers Office 2016 of Office 2013 uitvoeren, geeft u dezelfde beschrijvende naam op waarde die is ingesteld voor de eigenschappen van het AD RMS-cluster op het tabblad Servercertificaat.
Deze parameter is optioneel. Als u deze niet gebruikt, wordt in plaats daarvan de sleutel-id gebruikt.
Type: | String |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | True |
Jokertekens accepteren: | False |
-KeyVaultKeyUrl
Hiermee geeft u de URL op van de sleutel en versie in Azure Key Vault die u wilt gebruiken voor uw tenantsleutel.
Deze sleutel wordt door Azure Information Protection gebruikt als de hoofdsleutel voor alle cryptografische bewerkingen voor uw tenant.
Type: | String |
Position: | Named |
Default value: | None |
Vereist: | True |
Pijplijninvoer accepteren: | True |
Jokertekens accepteren: | False |
-WhatIf
Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.
Type: | SwitchParameter |
Aliassen: | wi |
Position: | Named |
Default value: | False |
Vereist: | False |
Pijplijninvoer accepteren: | False |
Jokertekens accepteren: | False |