SymmetricKey Class

The SymmetricKey object represents a SQL Server symmetric key.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.SymmetricKey

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class SymmetricKey _
    Inherits NamedSmoObject _
    Implements IAlterable, IDroppable, IObjectPermission
'Usage
Dim instance As SymmetricKey

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class SymmetricKey : NamedSmoObject, 
    IAlterable, IDroppable, IObjectPermission

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class SymmetricKey sealed : public NamedSmoObject, 
    IAlterable, IDroppable, IObjectPermission

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type SymmetricKey =  
    class 
        inherit NamedSmoObject 
        interface IAlterable 
        interface IDroppable 
        interface IObjectPermission 
    end

public final class SymmetricKey extends NamedSmoObject implements IAlterable, IDroppable, IObjectPermission

The SymmetricKey type exposes the following members.

Constructors

	Name	Description
	SymmetricKey()	Initializes a new instance of the SymmetricKey class.
	SymmetricKey(Database, String)	Initializes a new instance of the SymmetricKey class on the specified database and with the specified name.

Top

Properties

	Name	Description
	CreateDate	Gets the date and time when the symmetric key was created.
	DateLastModified	Gets the date and time when the symmetric key was last modified.
	EncryptionAlgorithm	Gets or sets the symmetric key encryption algorithm.
	ID	Gets the ID value that uniquely identifies the symmetric key.
	IsOpen	Gets the Boolean property value that specifies whether the symmetric key is open.
	KeyGuid	Get the GUID value that uniquely identifies the symmetric key globally.
	KeyLength	Gets the length of the symmetric key in bits.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Owner	Gets or sets the owner of the symmetric key.
	Parent	Gets or sets the Database object that is the parent of the SymmetricKey object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ProviderName	Gets or sets the key provider's name.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	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
	AddKeyEncryption(SymmetricKeyEncryption)	Adds key encryption to the symmetric key.
	AddKeyEncryption(array<SymmetricKeyEncryption[])	Adds key encryption to the symmetric key.
	Alter	Updates any SymmetricKey object property changes on the instance of Microsoft SQL Server.
	Close	Closes the symmetric key.
	Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, SecureString)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, String)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString, String)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String, String)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(SymmetricKeyEncryption, String, String, CreateDispositionType)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, SecureString, String)	Creates a symmetric key on the database with the specified encryption type and method.
	Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, String, String)	Creates a symmetric key on the database with the specified encryption type and method.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the symmetric key.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the symmetric key.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the symmetric key.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the symmetric key.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop()	Removes a symmetric key from the instance of SQL Server.
	Drop(Boolean)	Removes a symmetric key and the provider key associated with it from the instance of SQL Server.
	DropKeyEncryption(SymmetricKeyEncryption)	Removes the specified key encryption from the symmetric key.
	DropKeyEncryption(array<SymmetricKeyEncryption[])	Removes the specified key encryptions from the symmetric key.
	EnumKeyEncryptions	Enumerates a list of key encryptions associated with the symmetric key.
	EnumObjectPermissions()	Enumerates a list of object permissions for the symmetric key.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the symmetric key.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the symmetric key.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the symmetric 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.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the symmetric key.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the symmetric key.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission to the grantee and the ability to grant access to other users on the symmetric key.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission to the grantees and the ability to grant access to other users on the symmetric key.
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the symmetric key under an assumed role.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the symmetric key under an assumed role.
	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.)
	Open	Opens the symmetric key.
	OpenWithCertificate(String)	Opens the symmetric key with a certificate.
	OpenWithCertificate(String, String)	Opens the symmetric key with a certificate.
	OpenWithSymmetricKey	Opens the symmetric key with another symmetric key.
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the symmetric key.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the symmetric key.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the symmetric key and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes previously granted permissions from grantees on the symmetric key and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes previously granted permissions from a grantee on the symmetric key and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes previously granted permissions from grantees on the symmetric key and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	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

Remarks

To get SymmetricKey object properties, users can be a member of the public fixed server role.

To set SymmetricKey object properties, users must have ALTER permission on the symmetric key.

To create a symmetric key, users must have ALTER ANY SYMMETRIC KEY permissions on the parent database.

To drop a symmetric key, users must have CONTROL permissions on the symmetric key.

To open the symmetric key, users must know the password used to encrypt the symmetric key. CONTROL permission is also required on the certificate or other symmetric key when used to open the specified symmetric key.

To grant, deny, or revoke permissions on the symmetric key to other users, users must have CONTROL permissions on the symmetric key.

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

Encryption Hierarchy

CREATE SYMMETRIC KEY (Transact-SQL)