Invoke-AzKeyVaultKeyOperation

Effectue une opération telle que « Encrypt », « Decrypt », « Wrap » ou « Unwrap » à l’aide d’une clé spécifiée stockée dans un coffre de clés ou un hsm managé.

Syntax

Invoke-AzKeyVaultKeyOperation
      [-Version <String>]
      -Operation <String>
      -Algorithm <String>
      [-Value <SecureString>]
      [-ByteArrayValue <Byte[]>]
      [-Name] <String>
      [-VaultName] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzKeyVaultKeyOperation
      [-Version <String>]
      -Operation <String>
      -Algorithm <String>
      [-Value <SecureString>]
      [-ByteArrayValue <Byte[]>]
      [-HsmName] <String>
      [-Name] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzKeyVaultKeyOperation
      [-Version <String>]
      -Operation <String>
      -Algorithm <String>
      [-Value <SecureString>]
      [-ByteArrayValue <Byte[]>]
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

L’applet de commande Invoke-AzKeyVaultKeyOperation prend en charge

  1. Chiffrement d’une séquence arbitraire d’octets à l’aide d’une clé de chiffrement.
  2. Déchiffrement d’un bloc unique de données chiffrées.
  3. Encapsuler une clé symétrique à l’aide d’une clé spécifiée.
  4. Décompressez une clé symétrique à l’aide de la clé spécifiée qui a été initialement utilisée pour encapsuler cette clé.

Exemples

Exemple 1 : Chiffre le tableau d’octets à l’aide d’une clé de chiffrement

$byteArray = [Byte[]]@(58, 219)
$encryptedData = Invoke-AzKeyVaultKeyOperation -Operation Encrypt -Algorithm RSA1_5 -VaultName test-kv -Name test-key -ByteArrayValue $byteArray
$encryptedData

KeyId     : https://bez-kv.vault.azure.net/keys/bez-key/c96ce0fb18de446c9f4b911b686988af
RawResult : {21, 39, 82, 56…}
Algorithm : RSA1_5

Chiffre à $byteArray l’aide de la clé de test stockée dans test-kv.

Exemple 2 : Déchiffre le tableau d’octets à l’aide d’une clé de chiffrement

$decryptedData = Invoke-AzKeyVaultKeyOperation -Operation Decrypt -Algorithm RSA1_5 -VaultName test-kv -Name test-key -ByteArrayValue $encryptedData.RawResult
$decryptedData

KeyId     : https://bez-kv.vault.azure.net/keys/bez-key/c96ce0fb18de446c9f4b911b686988af
RawResult : {58, 219}
Algorithm : RSA1_5

Déchiffre à $encryptedData.RawResult l’aide de la clé de test stockée dans test-kv. Il $decryptedData.RawResult en est de même avec $byteArrayles données d’origine.

Exemple 3 : Chiffre le texte brut à l’aide d’une clé de chiffrement

$encryptedData = Invoke-AzKeyVaultKeyOperation -Operation Encrypt -Algorithm RSA1_5 -VaultName test-kv -Name test-key -Value (ConvertTo-SecureString -String "test" -AsPlainText -Force)
$encryptedData

KeyId     : https://test-kv.vault.azure.net/keys/test-key/bd8b77352a2443d4983bd70e9f660bc6
RawResult : {58, 219, 6, 236…}
Algorithm : RSA1_5

Chiffre la chaîne « test » à l’aide de la clé de test stockée dans test-kv. Il RawResult s’agit du résultat chiffré au format de tableau d’octets, où [System.Convert] ::ToBase64String($encryptedData.RawResult) est égal à $encryptedData.Result.

Exemple 4 : Déchiffrer les données chiffrées en texte brut

$decryptedData = Invoke-AzKeyVaultKeyOperation -Operation Decrypt -Algorithm RSA1_5 -VaultName test-kv -Name test-key -ByteArrayValue $encryptedData.RawResult
$decryptedData

KeyId     : https://bez-kv.vault.azure.net/keys/bez-key/c96ce0fb18de446c9f4b911b686988af
RawResult : $byteArray
Algorithm : RSA1_5

Déchiffre les données chiffrées chiffrées à l’aide de la clé de test stockée dans test-kv. Le $decryptedData.Result est test. Il RawResult s’agit du résultat déchiffré au format de tableau d’octets, où [System.Text.UTF8Encoding] ::UTF8. GetString($decryptedData.RawResult) est égal à $decryptedData.Result.

Exemple 5 : encapsule une clé symétrique à l’aide d’une clé spécifiée

$wrappedResult = Invoke-AzKeyVaultKeyOperation -Operation Wrap -Algorithm RSA1_5 -VaultName test-kv -Name test-key -Value (ConvertTo-SecureString -String "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" -AsPlainText -Force) 

$wrappedResult | Format-List

KeyId     : https://test-kv.vault.azure.net/keys/test-key/375cdf20252043b79c8ca0c57b6c7679
RawResult : {58, 219, 6, 236…}
Algorithm : RSA1_5

Encapsule une clé symétrique à l’aide de la clé nommée test-key stockée dans test-kv. Le Result résultat est encapsulé au format de chaîne Base64.

Exemple 6 : Désinscrit une clé symétrique à l’aide d’une clé spécifiée

Invoke-AzKeyVaultKeyOperation -Operation Unwrap -Algorithm RSA1_5 -VaultName test-kv -Name test-key -Value (ConvertTo-SecureString -String $result.Result -AsPlainText -Force)

KeyId     : https://test-kv.vault.azure.net/keys/test-key/375cdf20252043b79c8ca0c57b6c7679
RawResult : {58, 219, 6, 236…}
Algorithm : RSA1_5

Annule une clé symétrique à l’aide d’une clé de test de clé spécifiée stockée dans test-kv. Il Result s’agit d’une chaîne simple.

Paramètres

-Algorithm

Identificateur d’algorithme

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

-ByteArrayValue

Valeur à utiliser au format de tableau d’octets.

Type:Byte[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

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

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HsmName

Nom du module HSM.

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

-InputObject

Objet Clé

Type:PSKeyVaultKeyIdentityItem
Aliases:Key
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Nom de clé.

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

-Operation

Identificateur d’algorithme

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

-Value

Valeur à utiliser. Ce paramètre est converti en tableau d’octets de manière d’encodage UTF-8. Si votre valeur ne peut pas être encodée par UTF-8, utilisez le paramètre ByteArrayValue comme alternative.

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

-VaultName

Nom du coffre.

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

-Version

Version de clé.

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

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

Entrées

PSKeyVaultKeyIdentityItem

Sorties

PSKeyOperationResult