Export (0) Print
Expand All

Certificate Class

The Certificate object represents a SQL Server certificate.

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

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

The Certificate type exposes the following members.

  NameDescription
Public methodCertificate()Initializes a new instance of the Certificate class.
Public methodCertificate(Database, String)Initializes a new instance of the Certificate class on the specified server and that has the specified name.
Top

  NameDescription
Public propertyActiveForServiceBrokerDialogGets or sets the Boolean property that specifies whether the certificate is active for use in the BEGIN DIALOG statement for Service Broker purposes.
Public propertyEventsGets the events that are associated with the certificate.
Public propertyExpirationDateGets or sets the date and time at which the certificate expires.
Public propertyIDGets the ID value that uniquely identifies the certificate.
Public propertyIssuerGets the issuer of the certificate.
Public propertyLastBackupDateGets or sets the date and time at which the certificate was last backed up.
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 certificate.
Public propertyParentGets or sets the Server object that owns the Certificate object.
Public propertyPrivateKeyEncryptionTypeGets the encryption type of the private key for the certificate.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySerialGets the serial number of the certificate.
Public propertySidGets the logon security identifier (SID) for the certificate.
Public propertyStartDateGets or sets the date and time from which the certificate is effective.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertySubjectGets or sets the subject of the certificate.
Public propertyThumbprintGets the globally unique SHA-1 hash thumbprint for the certificate.
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 methodAddPrivateKey(String, String)Adds a private key to the certificate with the specified decryption password.
Public methodAddPrivateKey(String, String, String)Adds a private key to the certificate with the specified decryption and encryption passwords.
Public methodAlterUpdates any Certificate 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 certificate.
Public methodCreate()Creates a certificate on the database.
Public methodCreate(String)Creates a certificate based on a certificate encryption algorithm or based on a certificate source type.
Public methodCreate(String, CertificateSourceType)Creates a certificate on the database that has the specified certificate source type.
Public methodCreate(String, CertificateSourceType, String, String)Creates a certificate on the database that has the specified certificate source type.
Public methodCreate(String, CertificateSourceType, String, String, String)Creates a certificate on the database that has the specified certificate source type.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the certificate.
Public methodDeny(ObjectPermissionSet, array<String>)Denies the specified set of permissions for the specified grantees on the certificate.
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 certificate.
Public methodDeny(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.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the certificate from the instance of SQL Server.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the certificate.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the certificate.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the certificate.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the certificate.
Public methodEquals (Inherited from Object.)
Public methodExport(String)Saves the certificate in the specified system path location.
Public methodExport(String, String, String)Saves the certificate in the specified system path location.
Public methodExport(String, String, String, String)Saves the certificate in the specified system path location.
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 the specified grantee on the certificate.
Public methodGrant(ObjectPermissionSet, array<String>)Grants the specified set of permissions to the specified grantees on the certificate.
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 certificate.
Public methodGrant(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.
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 certificate under an assumed role.
Public methodGrant(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.
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 certificate.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the certificate.
Public methodRevoke(ObjectPermissionSet, array<String>)Revokes a previously granted set of permissions from a list of grantees on the certificate.
Public methodRevoke(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.
Public methodRevoke(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.
Public methodRevoke(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.
Public methodRevoke(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.
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 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft