Complete-SqlColumnMasterKeyRotation

  • Référence
Module:
SQLServer

Termine la rotation d’une colonne master clé.

Syntax

Complete-SqlColumnMasterKeyRotation
        -SourceColumnMasterKeyName <String>
        [-InputObject] <Database>
        [-Script]
        [-AccessToken <PSObject>]
        [-TrustServerCertificate]
        [-HostNameInCertificate <String>]
        [-Encrypt <String>]
        [<CommonParameters>]
Complete-SqlColumnMasterKeyRotation
        -SourceColumnMasterKeyName <String>
        [[-Path] <String>]
        [-Script]
        [-AccessToken <PSObject>]
        [-TrustServerCertificate]
        [-HostNameInCertificate <String>]
        [-Encrypt <String>]
        [<CommonParameters>]

Description

L’applet de commande Complete-SqlColumnMasterKeyRotation termine le processus de remplacement d’une clé de colonne master existante par une nouvelle clé cible master de colonne pour la fonctionnalité Always Encrypted.

L’applet de commande obtient tous les objets de clé de chiffrement de colonne contenant des valeurs de clé chiffrées chiffrées avec la colonne source spécifiée master clé.

L’applet de commande met ensuite à jour chaque objet de clé de chiffrement de colonne pour supprimer l’entrée d’une valeur chiffrée qui a été produite à l’aide de la colonne master clé spécifiée.

Par conséquent, chaque objet de clé de chiffrement de colonne impacté n’aura qu’une seule entrée de valeur chiffrée, générée à l’aide de la colonne master clé qui est la cible de la rotation.

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

Exemples

Exemple 1 : Terminer le processus de rotation de la colonne master clé

PS C:\> Cleanup-SqlColumnMasterKey -SourceColumnMasterKeyName "CMK1"

Cette commande termine le processus de rotation de la colonne master clé nommée CMK1.

Paramètres

-AccessToken

Le jeton d’accès utilisé pour s’authentifier auprès de SQL Server, en guise d’alternative à l’authentification utilisateur/mot de passe ou à l’authentification Windows.

Cela peut être utilisé, par exemple, pour se connecter à et à SQL Azure DB l’aide d’un Service Principal ou d’un Managed Identity.SQL Azure Managed Instance

Le paramètre à utiliser peut être une chaîne représentant le jeton ou un PSAccessToken objet retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net.

Ce paramètre est nouveau dans v22 du module.

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

-Encrypt

Type de chiffrement à utiliser lors de la connexion à SQL Server.

Cette valeur est mappée à la Encrypt propriété SqlConnectionEncryptOption sur l’objet SqlConnection du pilote Microsoft.Data.SqlClient.

Dans la version 22 du module, la valeur par défaut est Optional (pour la compatibilité avec v21). Dans v23+ du module, la valeur par défaut est « Obligatoire », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat SQL Server TLS/SSL. Vous devez passer ce paramètre si votre SQL Server instance est activé pour Forcer le chiffrement et que vous souhaitez vous connecter à un instance à l’aide d’un nom d’hôte/nom court. Si ce paramètre est omis, le passage du nom de domaine complet (FQDN) à -ServerInstance est nécessaire pour se connecter à un SQL Server instance activé pour forcer le chiffrement.

Ce paramètre est nouveau dans v22 du module.

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

-InputObject

Spécifie l’objet de base de données SQL pour lequel cette applet de commande exécute l’opération.

Type:Database
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Spécifie le chemin d’accès à la base de données SQL pour laquelle cette applet de commande exécute l’opération. Si vous ne spécifiez pas de valeur pour le paramètre, l’applet de commande utilise l’emplacement de travail actuel.

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

-Script

Indique que cette applet de commande exécute un script pour effectuer la rotation d’une colonne master clé.

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

-SourceColumnMasterKeyName

Spécifie le nom de la colonne source master clé.

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

-TrustServerCertificate

Indique si le canal sera chiffré tout en contournant la chaîne de certificats pour valider l’approbation.

Dans la version 22 du module, la valeur par défaut est $true (pour la compatibilité avec v21). Dans v23+ du module, la valeur par défaut est « $false », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

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

Entrées

Microsoft.SqlServer.Management.Smo.Database

Sorties

System.Object