Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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)
[<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

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
Public propertyIDGets the ID value that uniquely identifies the asymmetric key.
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.)
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.
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
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.
Public methodChangePrivateKeyPasswordModifies the private key password that is used to secure the private key for the asymmetric key.
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.
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.
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.
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 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.
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 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 methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRemovePrivateKeyRemoves the private key from the asymmetric key.
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 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.)
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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.