Export (0) Print
Expand All

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)

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

The SymmetricKey type exposes the following members.

  NameDescription
Public methodSymmetricKeyInitializes a new instance of the SymmetricKey class.
Public methodSymmetricKey(Database, String)Initializes a new instance of the SymmetricKey class on the specified database and with the specified name.
Top

  NameDescription
Public propertyCreateDateGets the date and time when the symmetric key was created.
Public propertyDateLastModifiedGets the date and time when the symmetric key was last modified.
Public propertyEncryptionAlgorithmGets or sets the symmetric key encryption algorithm.
Public propertyIDGets the ID value that uniquely identifies the symmetric key.
Public propertyIsOpenGets the Boolean property value that specifies whether the symmetric key is open.
Public propertyKeyGuidGet the GUID value that uniquely identifies the symmetric key globally.
Public propertyKeyLengthGets the length of the symmetric key in bits.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyOwnerGets or sets the owner of the symmetric key.
Public propertyParentGets or sets the Database object that is the parent of the SymmetricKey object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyProviderNameGets or sets the key provider's name.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAddKeyEncryption(SymmetricKeyEncryption)Adds key encryption to the symmetric key.
Public methodAddKeyEncryption(SymmetricKeyEncryption())Adds key encryption to the symmetric key.
Public methodAlterUpdates any SymmetricKey object property changes on the instance of Microsoft SQL Server.
Public methodCloseCloses the symmetric key.
Public methodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption(), SymmetricKeyEncryptionAlgorithm)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption(), SymmetricKeyEncryptionAlgorithm, SecureString)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption(), SymmetricKeyEncryptionAlgorithm, String)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, SecureString, String)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption, SymmetricKeyEncryptionAlgorithm, String, String)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption, String, String, CreateDispositionType)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption(), SymmetricKeyEncryptionAlgorithm, SecureString, String)Creates a symmetric key on the database with the specified encryption type and method.
Public methodCreate(SymmetricKeyEncryption(), SymmetricKeyEncryptionAlgorithm, String, String)Creates a symmetric key on the database with the specified encryption type and method.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the symmetric key.
Public methodDeny(ObjectPermissionSet, String())Denies the specified set of permissions for the specified grantees on the symmetric key.
Public methodDeny(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 methodDeny(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.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves a symmetric key from the instance of SQL Server.
Public methodDrop(Boolean)Removes a symmetric key and the provider key associated with it from the instance of SQL Server.
Public methodDropKeyEncryption(SymmetricKeyEncryption)Removes the specified key encryption from the symmetric key.
Public methodDropKeyEncryption(SymmetricKeyEncryption())Removes the specified key encryptions from the symmetric key.
Public methodEnumKeyEncryptionsEnumerates a list of key encryptions associated with the symmetric key.
Public methodEnumObjectPermissionsEnumerates a list of object permissions for the symmetric key.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the symmetric key.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the symmetric key.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the symmetric key.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the symmetric key.
Public methodGrant(ObjectPermissionSet, String())Grants the specified set of permissions to the specified grantees on the symmetric key.
Public methodGrant(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 methodGrant(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.
Public methodGrant(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 methodGrant(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.
Public methodInitializeInitializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodOpenOpens the symmetric key.
Public methodOpenWithCertificate(String)Opens the symmetric key with a certificate.
Public methodOpenWithCertificate(String, String)Opens the symmetric key with a certificate.
Public methodOpenWithSymmetricKeyOpens the symmetric key with another symmetric key.
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the symmetric key.
Public methodRevoke(ObjectPermissionSet, String())Revokes a previously granted set of permissions from a list of grantees on the symmetric key.
Public methodRevoke(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 methodRevoke(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.
Public methodRevoke(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 methodRevoke(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.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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.

Community Additions

ADD
Show:
© 2014 Microsoft