SymmetricKey Class
TOC
Collapse the table of content
Expand the table of content

SymmetricKey Class

 

The SymmetricKey object represents a SQL Server symmetric key.

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


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

NameDescription
System_CAPS_pubmethodSymmetricKey()

Initializes a new instance of the SymmetricKey class.

System_CAPS_pubmethodSymmetricKey(Database, String)

Initializes a new instance of the SymmetricKey class on the specified database and with the specified name.

NameDescription
System_CAPS_pubpropertyCreateDate

Gets the date and time when the symmetric key was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the symmetric key was last modified.

System_CAPS_pubpropertyEncryptionAlgorithm

Gets or sets the symmetric key encryption algorithm.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the symmetric key.

System_CAPS_pubpropertyIsOpen

Gets the Boolean property value that specifies whether the symmetric key is open.

System_CAPS_pubpropertyKeyGuid

Get the GUID value that uniquely identifies the symmetric key globally.

System_CAPS_pubpropertyKeyLength

Gets the length of the symmetric key in bits.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyOwner

Gets or sets the owner of the symmetric key.

System_CAPS_pubpropertyParent

Gets or sets the Database object that is the parent of the SymmetricKey object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyProviderName

Gets or sets the key provider's name.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAddKeyEncryption(SymmetricKeyEncryption)

Adds key encryption to the symmetric key.

System_CAPS_pubmethodAddKeyEncryption(SymmetricKeyEncryption[])

Adds key encryption to the symmetric key.

System_CAPS_pubmethodAlter()

Updates any SymmetricKey object property changes on the instance of Microsoft SQL Server.

System_CAPS_pubmethodClose()

Closes the symmetric key.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption, String, String, CreateDispositionType)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString, String)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String, String)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, SecureString)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, SecureString, String)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, String)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodCreate(SymmetricKeyEncryption[], SymmetricKeyEncryptionAlgorithm, String, String)

Creates a symmetric key on the database with the specified encryption type and method.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee on the symmetric key.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies the specified set of permissions for the specified grantees on the symmetric key.

System_CAPS_pubmethodDeny(ObjectPermissionSet, 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.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes a symmetric key from the instance of SQL Server.

System_CAPS_pubmethodDrop(Boolean)

Removes a symmetric key and the provider key associated with it from the instance of SQL Server.

System_CAPS_pubmethodDropKeyEncryption(SymmetricKeyEncryption)

Removes the specified key encryption from the symmetric key.

System_CAPS_pubmethodDropKeyEncryption(SymmetricKeyEncryption[])

Removes the specified key encryptions from the symmetric key.

System_CAPS_pubmethodEnumKeyEncryptions()

Enumerates a list of key encryptions associated with the symmetric key.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the symmetric key.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the symmetric key.

System_CAPS_pubmethodEnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the symmetric key.

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the symmetric key.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet, String)

Grants the specified set of permissions to the specified grantee on the symmetric key.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants the specified set of permissions to the specified grantees on the symmetric key.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[], Boolean)

Grants access to the specified permission to the grantees and the ability to grant access to other users on the symmetric key.

System_CAPS_pubmethodGrant(ObjectPermissionSet, 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.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodOpen(String)

Opens the symmetric key.

System_CAPS_pubmethodOpenWithCertificate(String)

Opens the symmetric key with a certificate.

System_CAPS_pubmethodOpenWithCertificate(String, String)

Opens the symmetric key with a certificate.

System_CAPS_pubmethodOpenWithSymmetricKey(String)

Opens the symmetric key with another symmetric key.

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions from a grantee on the symmetric key.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

Revokes a previously granted set of permissions from a list of grantees on the symmetric key.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

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

Return to top
Show:
© 2016 Microsoft