CryptographicProvider Class

The CryptographicProvider object represents a SQL Server cryptographic provider.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class CryptographicProvider _
    Inherits NamedSmoObject _
    Implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable,  _
    IScriptable
'Usage
Dim instance As CryptographicProvider

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class CryptographicProvider : NamedSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IScriptable

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class CryptographicProvider sealed : public NamedSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IScriptable

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type CryptographicProvider =  
    class 
        inherit NamedSmoObject 
        interface ISfcSupportsDesignMode 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IScriptable 
    end

public final class CryptographicProvider extends NamedSmoObject implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IScriptable

The CryptographicProvider type exposes the following members.

Constructors

	Name	Description
	CryptographicProvider()	Initializes a new default instance of the CryptographicProvider class.
	CryptographicProvider(Server, String)	Initializes a new instance of the CryptographicProvider class on the specified instance of SQL Server and with the specified name.

Top

Properties

	Name	Description
	AsymmetricKeyExportable	Gets the Boolean value that specifies whether the asymmetric key is exportable.
	AsymmetricKeyImportable	Gets the Boolean value that specifies whether the asymmetric key is importable.
	AsymmetricKeyPersistable	Gets the Boolean value that specifies whether the asymmetric key can be persisted.
	AsymmetricKeySupported	Gets the Boolean value that specifies whether the asymmetric key is supported.
	AuthenticationType	Gets the type of authentication that is used by the cryptographic provider.
	DllPath	Gets or sets the path to the physical file that contains the cryptographic provider.
	Enabled	Gets or sets the Boolean value that specifies whether the cryptographic provider is enabled.
	ID	Gets the ID value that uniquely identifies the cryptographic provider.
	Name	Gets or sets a String which contains the name of the object. (Overrides NamedSmoObject.Name.)
	Parent	Gets or sets the parent of the CryptographicProvider object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ProviderGuid	Gets the Guid value that uniquely identifies the cryptographic provider.
	SqlCryptographicVersion	Gets the version number of the SQL Server cryptographic provider assembly.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	SymmetricKeyExportable	Gets the Boolean value that specifies whether the symmetric key is exportable.
	SymmetricKeyImportable	Gets the Boolean value that specifies whether the symmetric key is importable.
	SymmetricKeyPersistable	Gets the Boolean value that specifies whether the symmetric key can be persisted.
	SymmetricKeySupported	Gets the Boolean value that specifies whether the symmetric key is supported.
	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.)
	Version	Gets the version of the cryptographic provider.

Top

Methods

	Name	Description
	Alter	Updates any CryptographicProvider object property changes on an instance of SQL Server.
	Create	Creates a new CryptographicProvider object on the connected server that has the specified name and DLL path.
	Disable	Disables the CryptographicProvider on the connected server.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the CryptographicProvider object and updates the connected server.
	Enable	Enables the cryptographic provider.
	EnumEncryptionAlgorithms	Enumerates a list of encryption algorithms that are supported by the cryptographic provider.
	EnumProviderKeys	Enumerates a list of encryption keys that are supported by the cryptographic provider.
	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.)
	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.)
	Script()	Generates a Transact-SQL script that can be executed to create or delete the CryptographicProvider object.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be executed to create or delete the CryptographicProvider object by using the specified scripting options.
	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.)
	Upgrade	Upgrades the cryptographic provider assembly to the DLL version at the specified path.
	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	A Boolean indicating whether the instance is in design mode.

Top

Remarks

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

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