AsymmetricKey Members

Include Protected Members
Include Inherited Members

The AsymmetricKey object represents a SQL Server asymmetric key.

The AsymmetricKey type exposes the following members.

Constructors

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

Top

Methods

  Name Description
Protected method AddDatabaseContext(StringCollection) (Inherited from SqlSmoObject.)
Public method AddPrivateKey(String) Adds a private key to the asymmetric key with the specified password.
Public method Alter() Updates any AsymmetricKey object property changes on the instance of SQL Server.
Protected method AlterImpl() (Inherited from SqlSmoObject.)
Protected method AlterImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method AlterImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Protected method AlterImplWorker() (Inherited from SqlSmoObject.)
Protected method BindDefaultImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method BindRuleImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Public method ChangePrivateKeyPassword(String, String) Modifies the private key password that is used to secure the private key for the asymmetric key.
Protected method CheckCollation(String, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method CheckObjectState(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 method CheckObjectStateImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method CheckVersion100() (Inherited from SqlSmoObject.)
Protected method CheckVersion80() Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3() Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90() Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90() (Inherited from SqlSmoObject.)
Protected method CleanObject() (Inherited from SqlSmoObject.)
Public method Create(AsymmetricKeyEncryptionAlgorithm) Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm.
Public method Create(String, AsymmetricKeySourceType) Creates an asymmetric key on the instance of SQL Server by loading the asymmetric key from the specified source.
Public method Create(AsymmetricKeyEncryptionAlgorithm, String) Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm and the specified password.
Public method 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.
Public method 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.
Protected method CreateImpl() (Inherited from SqlSmoObject.)
Protected method CreateImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CreateImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the asymmetric key.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the asymmetric key.
Public method 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.
Public method 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.
Public method Discover() (Inherited from SqlSmoObject.)
Public method Drop() Removes the asymmetric key from the instance of SQL Server.
Public method Drop(Boolean) Removes an Extensible Key Management (EKM) key from an EKM device.
Protected method DropImpl() (Inherited from SqlSmoObject.)
Protected method DropImplWorker(Urn%) (Inherited from SqlSmoObject.)
Public method EnumObjectPermissions() Enumerates a list of object permissions for the asymmetric key.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the asymmetric key.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the asymmetric key.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the asymmetric key.
Protected method EnumScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Protected method FormatSqlVariant(Object) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceScript(StringBuilder, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method GetBindDefaultScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBindRuleScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDBName() Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Protected method GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%) (Inherited from SqlSmoObject.)
Protected method GetFragOptionString(FragmentationOption) (Inherited from SqlSmoObject.)
Protected method GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetHashCode() (Inherited from Object.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetPropValue(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull(String) (Inherited from SqlSmoObject.)
Protected method GetRealValue(Property, Object) (Inherited from SqlSmoObject.)
Protected method GetScriptingOptionsForCreate() (Inherited from SqlSmoObject.)
Protected method GetServerName() Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject() (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName() Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetType() (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) (Inherited from SqlSmoObject.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to a grantee on the asymmetric key.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the asymmetric key.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Protected method ImplInitialize(array<String[], array<OrderBy[]) (Inherited from SqlSmoObject.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectDirty() Verifies 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 method IsObjectInitialized() Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace() Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected method IsVersion80SP3() (Inherited from SqlSmoObject.)
Protected method MarkDropped() (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method PostAlter() (Inherited from SqlSmoObject.)
Protected method PostCreate() (Inherited from SqlSmoObject.)
Protected method PostDrop() (Inherited from SqlSmoObject.)
Public method Refresh() Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method RemovePrivateKey() Removes the private key from the asymmetric key.
Protected method RenameImpl(String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker(String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions for a grantee on the asymmetric key.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions for a list of grantees on the asymmetric key.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Protected method ScriptAlter(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptChangeOwner(StringCollection, ScriptingOptions) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method ScriptCreate(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDdl(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDrop(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImpl() (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptRename(StringCollection, ScriptingOptions, String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method SetParentImpl(SqlSmoObject) (Inherited from SqlSmoObject.)
Public method ToString() Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl() (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl(Boolean) (Inherited from SqlSmoObject.)
Public method Validate(String, array<Object[]) (Inherited from SmoObjectBase.)

Top

Fields

  Name Description
Protected field m_ExtendedProperties (Inherited from SqlSmoObject.)

Top

Properties

  Name Description
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public property ID Gets the ID value that uniquely identifies the asymmetric key.
Protected property IsTouched Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public property KeyEncryptionAlgorithm Gets the encryption algorithm used to encrypt the asymmetric key.
Public property KeyLength Gets the length of the asymmetric key.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Protected property ObjectInSpace Gets 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 property Owner Gets or sets the name of the database principal that is the owner of the asymmetric key.
Public property Parent Gets the Database object that is the parent of the AsymmetricKey object.
Public property PrivateKeyEncryptionType Gets the encryption type for the private key for the asymmetric key.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ProviderName Gets or sets an asymmetric security key provider name.
Public property PublicKey Gets the public key for the asymmetric key.
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public property Sid Gets the logon security identifier (SID) for the asymmetric key.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Thumbprint Gets the globally unique SHA-1 hash thumbprint for the asymmetric key.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObjectDiscover() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetParent() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetProperty(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProviderGetPropertySet() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetUrn() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectResolve(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectSetProperty(Object, Object) (Inherited from SqlSmoObject.)

Top