DatabaseEncryptionKey Class

Creates a database encryption key.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.DatabaseEncryptionKey

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class DatabaseEncryptionKey _
    Inherits SqlSmoObject _
    Implements ICreatable, IAlterable, IDroppable, IScriptable
'Usage
Dim instance As DatabaseEncryptionKey

public sealed class DatabaseEncryptionKey : SqlSmoObject, 
    ICreatable, IAlterable, IDroppable, IScriptable

public ref class DatabaseEncryptionKey sealed : public SqlSmoObject, 
    ICreatable, IAlterable, IDroppable, IScriptable

[<SealedAttribute>]
type DatabaseEncryptionKey =  
    class 
        inherit SqlSmoObject 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IScriptable 
    end

public final class DatabaseEncryptionKey extends SqlSmoObject implements ICreatable, IAlterable, IDroppable, IScriptable

The DatabaseEncryptionKey type exposes the following members.

Constructors

	Name	Description
	DatabaseEncryptionKey	Creates a database encryption key.

Top

Properties

	Name	Description
	CreateDate	Gets the date and time when the encryption key was created.
	EncryptionAlgorithm	Gets or sets the encryption key algorithm.
	EncryptionState	Gets or sets the encryption key state.
	EncryptionType	Specifies the encryption type used to encrypt the database encryption key.
	EncryptorName	Gets or sets the name of the server certificate that was used to encrypt the database.
	ModifyDate	Gets the date and time of the last encryption key modification.
	OpenedDate	Shows the date and time when the database encryption key was last opened.
	Parent	Gets or sets the database parent of the key.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	RegenerateDate	Shows the date and time when the database encryption key was regenerated.
	SetDate	Gets the last date and time when the database encryption key was set.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Thumbprint	Gets a database encryption key thumbprint.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Alters the database encryption key.
	Create	Creates a new database encryption key.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops a database encryption key.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Reencrypt	Re-encrypts a database encryption key.
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	Regenerate	Regenerates a database encryption key.
	Script()	Generates a script for a database encryption key object with the default values.
	Script(ScriptingOptions)	Generates a script for a database encryption key object with the specific scripting options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Transparent Data Encryption (TDE)

Manage Database Encryption (Properties Page)