Dela via


Use-AipServiceKeyVaultKey

Instruerar Azure Information Protection att använda en kundhanterad klientnyckel i Azure Key Vault.

Syntax

Use-AipServiceKeyVaultKey
   -KeyVaultKeyUrl <String>
   [-FriendlyName <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Cmdleten Use-AipServiceKeyVaultKey instruerar Azure Information Protection att använda en kundhanterad nyckel (BYOK) i Azure Key Vault.

Du måste använda PowerShell för att konfigurera din klientnyckel. du kan inte göra den här konfigurationen med hjälp av en hanteringsportal.

Du kan köra den här cmdleten innan eller efter att skyddstjänsten (Azure Rights Management) har aktiverats.

Innan du kör den här cmdleten kontrollerar du att Azure Rights Management-tjänstens huvudnamn har beviljats behörigheter till nyckelvalvet som innehåller den nyckel som du vill använda för Azure Information Protection. Dessa behörigheter beviljas genom att köra Cmdleten Azure Key Vault, Set-AzKeyVaultAccessPolicy.

Av säkerhetsskäl tillåter cmdleten Use-AipServiceKeyVaultKey inte att du anger eller ändrar åtkomstkontrollen för nyckeln i Azure Key Vault. När åtkomsten har beviljats genom att köra Set-AzKeyVaultAccessPolicy kör du Use-AipServiceKeyVaultKey för att instruera Azure Information Protection att använda nyckeln och versionen som du anger med parametern KeyVaultKeyUrl.

Mer information finns i Metodtips för att välja din Azure-Key Vault plats.

Anteckning

Om du kör den här cmdleten innan behörigheterna beviljas till nyckelvalvet visas ett fel som visar att Rights Management-tjänsten inte kunde lägga till nyckeln.

Om du vill se mer detaljerad information kör du kommandot igen med -Verbose. Om behörigheterna inte beviljas visas VERBOSE: Failure to access Azure KeyVault (Utförligt: Det gick inte att komma åt Azure KeyVault).

När kommandot körs läggs nyckeln till som en arkiverad kundhanterad klientnyckel för Azure Information Protection för din organisation. Om du vill göra den till den aktiva klientnyckeln för Azure Information Protection måste du sedan köra cmdleten Set-AipServiceKeyProperties.

Använd Azure Key Vault för att centralt hantera och övervaka användningen av den nyckel som du har angett. Alla anrop till din klientnyckel görs till det nyckelvalv som din organisation äger. Du kan bekräfta vilken nyckel du använder i Key Vault med hjälp av cmdleten Get-AipServiceKeys.

Mer information om vilka typer av klientnycklar som Azure Information Protection stöder finns i Planera och implementera din Azure Information Protection-klientnyckel.

Mer information om Azure Key Vault finns i Vad är Azure Key Vault.

Exempel

Exempel 1: Konfigurera Azure Information Protection att använda en kundhanterad nyckel i Azure Key Vault

PS C:\>Use-AipServiceKeyVaultKey -KeyVaultKeyUrl "https://contoso.vault.azure.net/keys/contoso-aipservice-key/aaaabbbbcccc111122223333"

Det här kommandot instruerar Azure Information Protection att använda nyckeln med namnet contoso-aipservice-key, version aaaabbbbcccc11122223333 i nyckelvalvet med namnet contoso.

Den här nyckeln och versionen i Azure Key Vault blir sedan den kundhanterade klientnyckeln för Azure Information Protection.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Tvingar kommandot att köras utan att be om användarbekräftelse.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Anger det egna namnet på en betrodd publiceringsdomän (TPD) och den SLC-nyckel som du har importerat från AD RMS.

Om användarna kör Office 2016 eller Office 2013 anger du samma eget namnvärde som har angetts för AD RMS-klusteregenskaperna på fliken Servercertifikat .

Den här parametern är valfri. Om du inte använder det används nyckelidentifieraren i stället.

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

-KeyVaultKeyUrl

Anger URL:en för nyckeln och versionen i Azure Key Vault som du vill använda för din klientnyckel.

Den här nyckeln används av Azure Information Protection som rotnyckel för alla kryptografiska åtgärder för din klientorganisation.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False