Share via

SymmetricKey Class

  • Article

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
Public method SymmetricKey() Initializes a new instance of the SymmetricKey class.
Public method SymmetricKey(Database, String) Initializes a new instance of the SymmetricKey class on the specified database and with the specified name.

Top

Properties

  Name Description
Public property CreateDate Gets the date and time when the symmetric key was created.
Public property DateLastModified Gets the date and time when the symmetric key was last modified.
Public property EncryptionAlgorithm Gets or sets the symmetric key encryption algorithm.
Public property ID Gets the ID value that uniquely identifies the symmetric key.
Public property IsOpen Gets the Boolean property value that specifies whether the symmetric key is open.
Public property KeyGuid Get the GUID value that uniquely identifies the symmetric key globally.
Public property KeyLength Gets the length of the symmetric key in bits.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Owner Gets or sets the owner of the symmetric key.
Public property Parent Gets or sets the Database object that is the parent of the SymmetricKey object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ProviderName Gets or sets the key provider's name.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method AddKeyEncryption(SymmetricKeyEncryption) Adds key encryption to the symmetric key.
Public method AddKeyEncryption(array<SymmetricKeyEncryption[]) Adds key encryption to the symmetric key.
Public method Alter Updates any SymmetricKey object property changes on the instance of Microsoft SQL Server.
Public method Close Closes the symmetric key.
Public method Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, SecureString) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, String) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString, String) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String, String) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(SymmetricKeyEncryption, String, String, CreateDispositionType) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, SecureString, String) Creates a symmetric key on the database with the specified encryption type and method.
Public method Create(array<SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, String, String) Creates a symmetric key on the database with the specified encryption type and method.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the symmetric key.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the symmetric key.
Public method 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.
Public method 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.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop() Removes a symmetric key from the instance of SQL Server.
Public method Drop(Boolean) Removes a symmetric key and the provider key associated with it from the instance of SQL Server.
Public method DropKeyEncryption(SymmetricKeyEncryption) Removes the specified key encryption from the symmetric key.
Public method DropKeyEncryption(array<SymmetricKeyEncryption[]) Removes the specified key encryptions from the symmetric key.
Public method EnumKeyEncryptions Enumerates a list of key encryptions associated with the symmetric key.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the symmetric key.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the symmetric key.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the symmetric key.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the symmetric key.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the symmetric key.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the symmetric key.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Open Opens the symmetric key.
Public method OpenWithCertificate(String) Opens the symmetric key with a certificate.
Public method OpenWithCertificate(String, String) Opens the symmetric key with a certificate.
Public method OpenWithSymmetricKey Opens the symmetric key with another symmetric key.
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the symmetric key.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the symmetric key.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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)