Partager via

New-SqlAzureKeyVaultColumnMasterKeySettings

  • Référence
Module:
SQLServer

Crée un objet SqlColumnMasterKeySettings décrivant une clé asymétrique stockée dans Azure Key Vault.

Syntaxe

New-SqlAzureKeyVaultColumnMasterKeySettings
   [-KeyUrl] <String>
   [[-Signature] <String>]
   [-KeyVaultAccessToken <String>]
   [-ManagedHsmAccessToken <String>]
   [-AllowEnclaveComputations]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Crée un objet SqlColumnMasterKeySettings décrivant une clé principale de colonne stockée dans un coffre de clés ou dans un HSM managé dans Azure Key Vault.

Si vous utilisez l’applet de commande pour signer les métadonnées de clé, vous devez spécifier un jeton d’authentification valide pour les coffres de clés ou les HSM managés. Vous pouvez également vous authentifier auprès d’Azure avec Add-SqlAzureAuthenticationContext avant d’appeler cette applet de commande.

Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.

Exemples

Exemple 1 : Créer un objet SqlColumnMasterKeySettings simple

$CMKSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl 'https://myvault.vault.contoso.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700'

Cette commande crée un objet SqlColumnMasterKeySettings qui référence une clé dans Azure Key Vault et stocke le résultat dans la variable nommée $CMKSettings

Exemple 2 : Créer un SqlColumnMasterKeySettings avec des propriétés signées automatiquement autorisant les calculs d’enclave

# Obtain an access token for key vaults.
$keyVaultAccessToken = (Get-AzAccessToken -ResourceUrl https://vault.azure.net).Token

# Pass the token to the cmdlet. It will use the token to communicate with the key vault containing the column master key to sign the column master key metadata properties.
$cmkSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl 'https://myvault.vault.azure.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700' -AllowEnclaveComputations -keyVaultAccessToken $keyVaultAccessToken

Cette commande crée un objet SqlColumnMasterKeySettings qui référence une clé dans un coffre de clés et stocke le résultat dans la variable nommée $cmkSettings. La clé autorise les calculs d’enclave. Étant donné que le paramètre de signature n’est pas spécifié, l’applet de commande calcule automatiquement la signature et remplit la propriété Signature de l’objet SqlColumnMasterKeySettings.

Cet exemple illustre l’obtention d’un jeton d’authentification pour les coffres de clés dans Azure Key Vault et son passage à l’applet de commande.

Exemple 3 : Créer un objet SqlColumnMasterKeySettings autorisant les calculs d’enclave

# Note: actual signature truncated for brevity
$signature = "0x19BEB4F27F582F...89D5433CE9266C6F867334654BE12"
$cmkSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl 'https://myvault.vault.contoso.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700' -AllowEnclaveComputations -Signature $signature

Cette commande crée un objet SqlColumnMasterKeySettings qui référence une clé dans un coffre de clés et stocke le résultat dans la variable nommée $cmkSettings. La clé autorise les calculs d’enclave. La signature des propriétés de clé est spécifiée dans le paramètre signature .

Paramètres

-AllowEnclaveComputations

Spécifie si la clé principale de colonne autorise les calculs d’enclave. Si le paramètre est spécifié, les enclaves sécurisées côté serveur sont autorisées à effectuer des calculs sur les données protégées avec la clé principale de colonne. Non valide pour SQL Server 2017 et les versions antérieures.

Type:SwitchParameter
Position:1
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-KeyUrl

Spécifie le lien, en tant qu’URL, de la clé dans Azure Key Vault ou un HSM managé.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-KeyVaultAccessToken

Spécifie un jeton d’accès pour les coffres de clés dans Azure Key Vault. Utilisez ce paramètre si la clé principale de colonne spécifiée est stockée dans un coffre de clés dans Azure Key Vault et que l’applet de commande est censée signer les métadonnées de clé.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ManagedHsmAccessToken

Spécifie un jeton d’accès pour les HSM managés dans Azure Key Vault. Utilisez ce paramètre si la clé principale de colonne spécifiée est stockée dans un HSM managé dans Azure Key Vault et que l’applet de commande est censée signer les métadonnées de clé.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProgressAction

Détermine comment PowerShell répond aux mises à jour de progression générées par un script, une applet de commande ou un fournisseur, telles que les barres de progression générées par l’applet de commande Write-Progress. L’applet de commande Write-Progress crée des barres de progression qui affichent l’état d’une commande.

Type:ActionPreference
Alias:proga
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Signature

Spécifie une chaîne hexadécimale qui est une signature numérique des propriétés de clé principale de colonne. Un pilote client peut vérifier la signature pour vous assurer que les propriétés de clé principale de colonne n’ont pas été falsifiées.

Ce paramètre n’est autorisé que si AllowEnclaveComputations est spécifié. Si AllowEnclaveComputations est spécifié, mais signature n’est pas le cas, l’applet de commande calcule automatiquement la signature et remplit la propriété Signature du nouvel objet SqlColumnMasterKeySettings.

Type:String
Position:2
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Sorties

SqlColumnMasterKeySettings