Export (0) Print
Expand All

AsymmetricKey Class

The AsymmetricKey object represents a SQL Server asymmetric key.

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

[PhysicalFacetAttribute]
[StateChangeEventAttribute("CREATE_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")]
[StateChangeEventAttribute("ALTER_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "ASYMMETRIC KEY")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class AsymmetricKey : NamedSmoObject, 
	IAlterable, IDroppable, ISfcSupportsDesignMode, IObjectPermission

The AsymmetricKey type exposes the following members.

  NameDescription
Public methodAsymmetricKey()Initializes a new instance of the AsymmetricKey class.
Public methodAsymmetricKey(Database, String)Initializes a new instance of the AsymmetricKey class on the specified database.
Top

  NameDescription
Protected propertyExecuteForScalarGets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public propertyIDGets the ID value that uniquely identifies the asymmetric key.
Protected propertyIsTouchedGets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public propertyKeyEncryptionAlgorithmGets the encryption algorithm used to encrypt the asymmetric key.
Public propertyKeyLengthGets the length of the asymmetric key.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Protected propertyObjectInSpaceGets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public propertyOwnerGets or sets the name of the database principal that is the owner of the asymmetric key.
Public propertyParentGets the Database object that is the parent of the AsymmetricKey object.
Public propertyPrivateKeyEncryptionTypeGets the encryption type for the private key for the asymmetric key.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyProviderNameGets or sets an asymmetric security key provider name.
Public propertyPublicKeyGets the public key for the asymmetric key.
Protected propertyScalarResultGets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public propertySidGets the logon security identifier (SID) for the asymmetric key.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyThumbprintGets the globally unique SHA-1 hash thumbprint for the asymmetric key.
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
Protected methodAddDatabaseContext(StringCollection)Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Protected methodAddDatabaseContext(StringCollection, ScriptingOptions)Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.)
Public methodAddPrivateKeyAdds a private key to the asymmetric key with the specified password.
Public methodAlterUpdates any AsymmetricKey object property changes on the instance of SQL Server.
Protected methodAlterImplActivates the object altered event. (Inherited from SqlSmoObject.)
Protected methodAlterImplFinishMethod called when object altered event finishes. (Inherited from SqlSmoObject.)
Protected methodAlterImplInitMethod called when object-altered event is intialized. (Inherited from SqlSmoObject.)
Protected methodAlterImplWorkerCalls the Alter methods. (Inherited from SqlSmoObject.)
Protected methodBindDefaultImplBinds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected methodBindRuleImplBinds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Public methodChangePrivateKeyPasswordModifies the private key password that is used to secure the private key for the asymmetric key.
Protected methodCheckCollationChecks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.)
Protected methodCheckObjectState()Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected methodCheckObjectState(Boolean)Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
Protected methodCheckObjectStateImplChecks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodCheckVersion100Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected methodCheckVersion80Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected methodCheckVersion80SP3Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected methodCheckVersion90Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCheckVersionBelow90Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCleanObjectSets the object to unmodified state. (Inherited from SqlSmoObject.)
Public methodCreate(AsymmetricKeyEncryptionAlgorithm)Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm.
Public methodCreate(String, AsymmetricKeySourceType)Creates an asymmetric key on the instance of SQL Server by loading the asymmetric key from the specified source.
Public methodCreate(AsymmetricKeyEncryptionAlgorithm, String)Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm and the specified password.
Public methodCreate(String, AsymmetricKeySourceType, String)Creates an asymmetric key on the instance of SQL Server by loading the specified asymmetric key and by using the specified password.
Public methodCreate(String, String, CreateDispositionType, AsymmetricKeySourceType)Creates an asymmetric key on the instance of SQL Server by loading the specified asymmetric key and by using the specified password.
Protected methodCreateImplCreates an object with scripting options. (Inherited from SqlSmoObject.)
Protected methodCreateImplFinishMethod called when the create event finishes. (Inherited from SqlSmoObject.)
Protected methodCreateImplInitMethod called when the create event initializes. (Inherited from SqlSmoObject.)
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the asymmetric key.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the asymmetric 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 asymmetric 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 asymmetric key.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDrop()Removes the asymmetric key from the instance of SQL Server.
Public methodDrop(Boolean)Removes an Extensible Key Management (EKM) key from an EKM device.
Protected methodDropImplDrops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodDropImplWorkerCalls the drop methods. (Inherited from SqlSmoObject.)
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the asymmetric key.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the asymmetric key.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the asymmetric key.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the asymmetric key.
Protected methodEnumScriptImplEnumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected methodEnumScriptImplWorkerCalls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected methodEnumScriptImplWorkerSOChangedReturns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.)
Public methodEquals (Inherited from Object.)
Protected methodExecuteNonQueryExecutes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.)
Protected methodFinalize (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGenerateDataSpaceFileStreamScriptGenerates a script to create data file. (Inherited from SqlSmoObject.)
Protected methodGenerateDataSpaceScriptGenerates a script to allocate space in the data file. (Inherited from SqlSmoObject.)
Protected methodGetBindDefaultScriptGets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.)
Protected methodGetBindRuleScriptGets the script that specifies the binding rules. (Inherited from SqlSmoObject.)
Protected methodGetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetDateTimeParameterAssigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetDateTimeParameterAsIntAssigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Protected methodGetEnumParameterAssigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetFragOptionStringGets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Protected methodGetGuidParameterAssigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
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 methodGetRealValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetScriptingOptionsForCreateGets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerNameGets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetSqlServerVersionNameGets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetTimeSpanParameterAsIntAssigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Protected methodGetUrnRecursive(StringBuilder)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetUrnRecursive(StringBuilder, UrnIdOption)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to a grantee on the asymmetric key.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the asymmetric 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 asymmetric 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 asymmetric 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 asymmetric 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 asymmetric key under an assumed role.
Protected methodImplInitializeInitializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodInitialize()Initializes 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 methodIsObjectDirtyVerifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (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.)
Protected methodIsVersion80SP3Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected methodIsVersion90AndAboveDetermines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected methodMarkDroppedSets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected methodMarkForDropImplSets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodPostAlterMethod activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected methodPostCreateMethod activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected methodPostDropMethod activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRemovePrivateKeyRemoves the private key from the asymmetric key.
Protected methodRenameImplIdentified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Protected methodRenameImplWorkerIdentified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions for a grantee on the asymmetric key.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions for a list of grantees on the asymmetric key.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean)Revokes previously granted permissions for a grantee on the asymmetric 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 for grantees on the asymmetric 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 for a grantee on the asymmetric 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 for grantees on the asymmetric 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 methodScriptAlterAlters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected methodScriptChangeOwnerThis method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected methodScriptCreateAlters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected methodScriptDdlThrows InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected methodScriptDropThrows InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected methodScriptImpl()Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptImpl(ScriptingOptions)Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptImplWorkerGets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptOwnerAlters the script owner authorization. (Inherited from NamedSmoObject.)
Protected methodScriptRenameThis method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected methodSetSchemaOwnedSets the schema owned value. (Inherited from NamedSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected methodTouchImplNot implemented. (Inherited from SqlSmoObject.)
Protected methodUnbindDefaultImplUnbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodUnbindRuleImplUnbinds rules of the SqlSmoObject. (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
Protected fieldm_ExtendedPropertiesRepresents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected fieldsingletonParentRepresents the singleton parent. (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 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 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. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode.IsDesignModeGets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Top

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

To set any AsymmetricKey object properties and run the Alter method, users must have CONTROL permission on the database.

To create an AsymmetricKey object, users must have CREATE ASYMMETRIC KEY role permission on the parent database.

To drop an AsymmetricKey object, users must be the owner of the asymmetric key or have CONTROL permission on the asymmetric key.

To grant, deny, and revoke permission on the AsymmetricKey object, users must have CONROL permission on the asymmetric 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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft