AsymmetricKey Class

The AsymmetricKey object represents a SQL Server asymmetric key.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.AsymmetricKey

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
<StateChangeEventAttribute("CREATE_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")> _
<StateChangeEventAttribute("ALTER_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "ASYMMETRIC KEY")> _
Public NotInheritable Class AsymmetricKey _
    Inherits NamedSmoObject _
    Implements IAlterable, IDroppable, ISfcSupportsDesignMode, IObjectPermission
'Usage
Dim instance As AsymmetricKey

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

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

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
[<StateChangeEventAttribute("CREATE_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")>]
[<StateChangeEventAttribute("ALTER_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "ASYMMETRIC KEY")>]
type AsymmetricKey =  
    class 
        inherit NamedSmoObject 
        interface IAlterable 
        interface IDroppable 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
    end

public final class AsymmetricKey extends NamedSmoObject implements IAlterable, IDroppable, ISfcSupportsDesignMode, IObjectPermission

The AsymmetricKey type exposes the following members.

Constructors

	Name	Description
	AsymmetricKey()	Initializes a new instance of the AsymmetricKey class.
	AsymmetricKey(Database, String)	Initializes a new instance of the AsymmetricKey class on the specified database.

Top

Properties

	Name	Description
	ID	Gets the ID value that uniquely identifies the asymmetric key.
	KeyEncryptionAlgorithm	Gets the encryption algorithm used to encrypt the asymmetric key.
	KeyLength	Gets the length of the asymmetric key.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Owner	Gets or sets the name of the database principal that is the owner of the asymmetric key.
	Parent	Gets the Database object that is the parent of the AsymmetricKey object.
	PrivateKeyEncryptionType	Gets the encryption type for the private key for the asymmetric key.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ProviderName	Gets or sets an asymmetric security key provider name.
	PublicKey	Gets the public key for the asymmetric key.
	Sid	Gets the logon security identifier (SID) for the asymmetric key.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Thumbprint	Gets the globally unique SHA-1 hash thumbprint for the asymmetric key.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	AddPrivateKey	Adds a private key to the asymmetric key with the specified password.
	Alter	Updates any AsymmetricKey object property changes on the instance of SQL Server.
	ChangePrivateKeyPassword	Modifies the private key password that is used to secure the private key for the asymmetric key.
	Create(AsymmetricKeyEncryptionAlgorithm)	Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm.
	Create(String, AsymmetricKeySourceType)	Creates an asymmetric key on the instance of SQL Server by loading the asymmetric key from the specified source.
	Create(AsymmetricKeyEncryptionAlgorithm, String)	Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm and the specified password.
	Create(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.
	Create(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.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the asymmetric key.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the asymmetric key.
	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 asymmetric key.
	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 asymmetric key.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop()	Removes the asymmetric key from the instance of SQL Server.
	Drop(Boolean)	Removes an Extensible Key Management (EKM) key from an EKM device.
	EnumObjectPermissions()	Enumerates a list of object permissions for the asymmetric key.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the asymmetric key.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the asymmetric key.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the asymmetric key.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to a grantee on the asymmetric key.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the asymmetric key.
	Grant(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.
	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 asymmetric key.
	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 asymmetric key under an assumed role.
	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 asymmetric key under an assumed role.
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	RemovePrivateKey	Removes the private key from the asymmetric key.
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions for a grantee on the asymmetric key.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions for a list of grantees on the asymmetric key.
	Revoke(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.
	Revoke(ObjectPermissionSet, array<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.
	Revoke(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.
	Revoke(ObjectPermissionSet, array<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.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

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.

Examples

Granting, Revoking, and Denying Permissions

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 ASYMMETRIC KEY (Transact-SQL)