SymmetricKey Members

The SymmetricKey object represents a Microsoft SQL Server symmetric key.

The following tables list the members exposed by the SymmetricKey type.

Public Constructors

  Name Description
SymmetricKey Overloaded. Initializes a new instance of the SymmetricKey class.

Top

Protected Fields

  Name Description
ms220480.protfield(en-US,SQL.90).gif m_ExtendedProperties  (inherited from SqlSmoObject )

Top

Public Properties

(see also Protected Properties )

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

Top

Protected Properties

  Name Description
ms220480.protproperty(en-US,SQL.90).gif ExecuteForScalar  Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject)
ms220480.protproperty(en-US,SQL.90).gif ObjectInSpace  Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject)
ms220480.protproperty(en-US,SQL.90).gif PresetProperties  Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject)
ms220480.protproperty(en-US,SQL.90).gif ScalarResult  Gets the scalar result for the referenced object. (inherited from SqlSmoObject)

Top

Public Methods

(see also Protected Methods )

  Name Description
ms220480.pubmethod(en-US,SQL.90).gif AddKeyEncryption Overloaded. Adds key encryption to the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif Alter Updates any SymmetricKey object property changes on the instance of Microsoft SQL Server.
ms220480.pubmethod(en-US,SQL.90).gif Close Closes the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif Create Overloaded. Creates a symmetric key on the database with the specified encryption type and method.
ms220480.pubmethod(en-US,SQL.90).gif Deny Overloaded. Denies the specified set of permissions for the specified grantees on the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif Drop Removes a symmetric key from the instance of SQL Server.
ms220480.pubmethod(en-US,SQL.90).gif DropKeyEncryption Overloaded. Removes key encryptions from the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif EnumKeyEncryptions Enumerates a list of key encryptions associated with the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif EnumObjectPermissions Overloaded. Enumerates a list of object permissions for the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms220480.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms220480.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms220480.pubmethod(en-US,SQL.90).gif Grant Overloaded. Grants the specified set of permissions to the specified grantees on the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif Initialize  Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject)
ms220480.pubmethod(en-US,SQL.90).gif Open Opens the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif OpenWithCertificate Overloaded. Opens the symmetric key with a certificate.
ms220480.pubmethod(en-US,SQL.90).gif OpenWithSymmetricKey Opens the symmetric key with another symmetric key.
ms220480.pubmethod(en-US,SQL.90).gifms220480.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms220480.pubmethod(en-US,SQL.90).gif Refresh  Refreshes the object and retrieves properties when the object is next accessed. (inherited from SqlSmoObject)
ms220480.pubmethod(en-US,SQL.90).gif Revoke Overloaded. Revokes a previously granted set of permissions from a grantee or grantees on the symmetric key.
ms220480.pubmethod(en-US,SQL.90).gif ToString  Returns a String that represents the referenced object. (inherited from SqlSmoObject)

Top

Protected Methods

  Name Description
ms220480.protmethod(en-US,SQL.90).gif AlterImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif AlterImplFinish  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif AlterImplInit  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif AlterImplWorker  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif BindDefaultImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif BindRuleImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif CheckCollation  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif CheckObjectState  Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif CheckObjectStateImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif CheckVersion80  Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif CheckVersion80SP3  Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif CheckVersion90  Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif CheckVersionBelow90  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif CleanObject  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif CreateImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif CreateImplFinish  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif CreateImplInit  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif DropImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif DropImplWorker  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms220480.protmethod(en-US,SQL.90).gif FormatSqlVariant  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GenerateDataSpaceScript  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetBindDefaultScript  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetBindRuleScript  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetBoolParameter  Overloaded. (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetDateTimeParameter  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetDateTimeParameterAsInt  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetDBName  Gets the database name associated with the object. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif GetEnumParameter  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetFragOptionString  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetGuidParameter  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetParameter  Overloaded. (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetPropValue  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetPropValueOptional  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetPropValueOptionalAllowNull  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetRealValue  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetScriptingOptionsForCreate  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetServerName  Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif GetSqlServerVersionName  Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif GetStringParameter  Overloaded. (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetTimeSpanParameterAsInt  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif GetUrnRecursive  Overloaded. (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ImplInitialize  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gifms220480.static(en-US,SQL.90).gif IsCollectionDirty  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif IsObjectDirty  Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif IsObjectInitialized  Verifies whether the object has been initialized. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif IsObjectInSpace  Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms220480.protmethod(en-US,SQL.90).gif IsVersion80SP3  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif MarkDropped  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif MarkForDropImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )
ms220480.protmethod(en-US,SQL.90).gif PostAlter  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif PostCreate  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif PostDrop  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif RenameImpl  (inherited from NamedSmoObject )
ms220480.protmethod(en-US,SQL.90).gif RenameImplWorker  (inherited from NamedSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptAlter  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptChangeOwner  (inherited from NamedSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptCreate  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptDdl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptDrop  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptImpl  Overloaded. (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptImplWorker  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif ScriptRename  (inherited from NamedSmoObject )
ms220480.protmethod(en-US,SQL.90).gif SetParentImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gifms220480.static(en-US,SQL.90).gif Trace  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif UnbindDefaultImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gif UnbindRuleImpl  (inherited from SqlSmoObject )
ms220480.protmethod(en-US,SQL.90).gifms220480.static(en-US,SQL.90).gif UpdateCollectionState2  (inherited from SqlSmoObject )

Top

See Also

Reference

SymmetricKey Class
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Using Encryption
Encryption Hierarchy
CREATE SYMMETRIC KEY (Transact-SQL)