Credential Class

  • Article

The Credential object represents a Microsoft SQL Server credential.

Inheritance Hierarchy

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

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

Syntax

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

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

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

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

public final class Credential extends NamedSmoObject implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable

The Credential type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property CreateDate Gets the date and time that the credential was created.
Public property DateLastModified Gets the date and time that the credential was last modified.
Public property ID Gets the database ID value that uniquely identifies the credential.
Public property Identity Gets or sets the identity associated with the credential.
Public property MappedClassType Gets or sets the class associated with the credential.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Parent Gets the Server object that is the parent of the Credential object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ProviderName Gets or sets the name of the provider.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
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

Methods

  Name Description
Public method Alter() Updates any Credential object property changes on instance of SQL Server.
Public method Alter(String) Updates any Credential object property changes on instance of SQL Server.
Public method Alter(String, SecureString) Updates any Credential object property changes on instance of SQL Server.
Public method Alter(String, String) Updates any Credential object property changes on instance of SQL Server.
Public method Create() Creates a credential on the instance of SQL Server as defined by the Credential object.
Public method Create(String) Creates a credential on the instance of SQL Server as defined by the Credential object.
Public method Create(String, SecureString) Creates a credential on the instance of SQL Server as defined by the Credential object.
Public method Create(String, String) Creates a credential on the instance of SQL Server as defined by the Credential object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the credential.
Public method EnumLogins Enumerates a list of logins associated with the credential.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
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 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.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property 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

Credentials provide SQL Server authenticated users with an identity outside of SQL Server, on the local machine or on the network domain.

Credentials can also be used when a SQL Server authenticated user needs access to a domain resource, such as a file location to store a backup.

To get Credential object properties, users can be a member of the public fixed server role.

To set Credential object properties and run the Alter method, users must have ALTER ANY CREDENTIAL permission on the parent server, or be a member of the sysadmin fixed server role.

To create a credential, users must have ALTER ANY CREDENTIAL permission on the parent server, or be a member of the sysadmin fixed server role.

To drop a credential, users must have ALTER ANY CREDENTIAL permission on the parent server, or be a member of the sysadmin fixed server role.

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

Other Resources

CREATE CREDENTIAL (Transact-SQL)

Credentials (Database Engine)