Certificate Class

The Certificate object represents a SQL Server certificate.

Inheritance Hierarchy

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

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

Syntax

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

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

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

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

public final class Certificate extends NamedSmoObject implements ICreatable, IDroppable, IAlterable, ISfcSupportsDesignMode, IObjectPermission

The Certificate type exposes the following members.

Constructors

	Name	Description
	Certificate()	Initializes a new instance of the Certificate class.
	Certificate(Database, String)	Initializes a new instance of the Certificate class on the specified server and that has the specified name.

Top

Properties

	Name	Description
	ActiveForServiceBrokerDialog	Gets or sets the Boolean property that specifies whether the certificate is active for use in the BEGIN DIALOG statement for Service Broker purposes.
	Events	Gets the events that are associated with the certificate.
	ExpirationDate	Gets or sets the date and time at which the certificate expires.
	ID	Gets the ID value that uniquely identifies the certificate.
	Issuer	Gets the issuer of the certificate.
	LastBackupDate	Gets or sets the date and time at which the certificate was last backed up.
	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 certificate.
	Parent	Gets or sets the Server object that owns the Certificate object.
	PrivateKeyEncryptionType	Gets the encryption type of the private key for the certificate.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	Serial	Gets the serial number of the certificate.
	Sid	Gets the logon security identifier (SID) for the certificate.
	StartDate	Gets or sets the date and time from which the certificate is effective.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Subject	Gets or sets the subject of the certificate.
	Thumbprint	Gets the globally unique SHA-1 hash thumbprint for the certificate.
	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(String, String)	Adds a private key to the certificate with the specified decryption password.
	AddPrivateKey(String, String, String)	Adds a private key to the certificate with the specified decryption and encryption passwords.
	Alter	Updates any Certificate 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 certificate.
	Create()	Creates a certificate on the database.
	Create(String)	Creates a certificate based on a certificate encryption algorithm or based on a certificate source type.
	Create(String, CertificateSourceType)	Creates a certificate on the database that has the specified certificate source type.
	Create(String, CertificateSourceType, String, String)	Creates a certificate on the database that has the specified certificate source type.
	Create(String, CertificateSourceType, String, String, String)	Creates a certificate on the database that has the specified certificate source type.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the certificate.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the certificate.
	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 certificate.
	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 certificate.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the certificate from the instance of SQL Server.
	EnumObjectPermissions()	Enumerates a list of object permissions for the certificate.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the certificate.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the certificate.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the certificate.
	Equals	(Inherited from Object.)
	Export(String)	Saves the certificate in the specified system path location.
	Export(String, String, String)	Saves the certificate in the specified system path location.
	Export(String, String, String, String)	Saves the certificate in the specified system path location.
	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 the specified grantee on the certificate.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the certificate.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission to the grantee and the ability to grant access to other users on the certificate.
	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 certificate.
	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 certificate 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 certificate 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 certificate.
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the certificate.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the certificate.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the certificate 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 from grantees on the certificate 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 from a grantee on the certificate 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 from grantees on the certificate 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 Certificate object properties, users can be a member of the public fixed server role.

To set the Certificate object properties and run the Alter method, users must have ALTER permission on the certificate.

To create a Certificate object, users must have CREATE CERTIFICATE permission on the parent database.

To drop a Certificate object, users must have CONTROL permission on the certificate.

To grant, deny, or revoke permission to other users on the Certificate object, users must have CONTROL permission on the certificate.

Examples

Using Encryption

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