Aracılığıyla paylaş


User Class

The User object represents a SQL Server user.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.User

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

Syntax

'Bildirim
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class User _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IAlterable, IRenamable, IExtendedProperties, IScriptable, IUserOptions,  _
    IDmfFacet
'Kullanım
Dim instance As User
[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class User : ScriptNameObjectBase, ISfcSupportsDesignMode, 
    IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable, IUserOptions, IDmfFacet
[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class User sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IAlterable, 
    IRenamable, IExtendedProperties, IScriptable, IUserOptions, IDmfFacet
[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type User =  
    class
        inherit ScriptNameObjectBase
        interface ISfcSupportsDesignMode
        interface IObjectPermission
        interface ICreatable
        interface IDroppable
        interface IAlterable
        interface IRenamable
        interface IExtendedProperties
        interface IScriptable
        interface IUserOptions
        interface IDmfFacet
    end
public final class User extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, IExtendedProperties, IScriptable, IUserOptions, IDmfFacet

The User type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AsymmetricKey Gets or sets the asymmetric key for the user.
Public property AuthenticationType Gets a string value that describes the mechanism used to authenticate the user.
Public property Certificate Gets or sets the certificate for the user.
Public property CreateDate Gets the date and time when the database user was created.
Public property DateLastModified Gets the date and time when the database user was last modified.
Public property DefaultLanguage Gets or sets the default language for the user.
Public property DefaultSchema Gets the default schema for the database user.
Public property Events Gets the events that are associated with the database user.
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 ExtendedProperties Gets the extended properties of the database user.
Public property HasDBAccess Gets the Boolean property that specifies whether the database user has access to the database.
Public property ID Gets the ID value that uniquely identifies the database user.
Public property IsSystemObject Gets the Boolean property that specifies whether the database user is a system object.
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 Login Gets the login that is associated with the database user.
Public property LoginType Gets the type of login that is associated with the database user, such as whether it is a Windows group or a SQL Server standard login.
Public property Name Gets or sets a String value that specifies the name of the user. (Overrides NamedSmoObject.Name.)
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 Parent Gets the Database object that is the parent of the User object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public property Sid Gets the security identification number (SID) value of the database user.
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.)
Public property UserType Gets or sets the type of user.

Top

Methods

  Name Description
Protected method AddDatabaseContext Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Public method AddToRole Adds the database user to the specified role.
Public method Alter Updates any User object property changes on the instance of Microsoft SQL Server. 
Protected method AlterImpl Activates the object altered event. (Inherited from SqlSmoObject.)
Protected method AlterImplWorker Calls the Alter methods. (Inherited from SqlSmoObject.)
Protected method AppendCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithOption Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AutoGenerateName Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
Protected method BindDefaultImpl Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected method BindRuleImpl Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Public method ChangePassword(SecureString) Changes the user password.
Public method ChangePassword(String) Changes the user password.
Public method ChangePassword(SecureString, SecureString) Changes the user password.
Public method ChangePassword(String, String) Changes the user password.
Protected method CheckObjectDirty Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
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 Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method CheckTextCorectness Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
Protected method CheckTextModeSupport Checks mode of support. (Inherited from ScriptNameObjectBase.)
Protected method CheckVersion100 Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected method CheckVersion110() Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.)
Protected method CheckVersion110(String) Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (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 CheckVersionBelow110 Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90 Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CleanObject Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
Public method Create() Creates a database user on the instance of SQL Server as defined by the User object.
Public method Create(SecureString) Creates a database user on the instance of SQL Server as defined by the User object with specified password using a secure string.
Public method Create(String) Creates a database user on the instance of SQL Server as defined by the User object with specified password.
Protected method CreateImpl Creates an object with scripting options. (Inherited from SqlSmoObject.)
Public method Deny(ObjectPermissionSet, String) Denies access to the specified permission for the specified grantee on the database user.
Public method Deny(ObjectPermissionSet, array<String[]) Denies access to the specified permission for the specified grantees on the database user.
Public method Deny(ObjectPermissionSet, String, Boolean) Denies access to the specified permission for the specified grantee and other users whom the grantee granted access on the database user.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies access to the specified permission for the specified grantees on the database user.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the user from the database.
Protected method DropImpl Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method DropImplWorker Calls the drop methods. (Inherited from SqlSmoObject.)
Public method EnumObjectPermissions() Enumerates a list of object permissions for the database user.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the database user.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the database user.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the database user.
Public method EnumOwnedObjects Enumerates a list of object that the database user owns.
Public method EnumRoles Enumerates a list of roles of which the database user is a member.
Public method Equals (Inherited from Object.)
Protected method ExecuteNonQuery Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.)
Protected method ExecuteRenameQuery Executes the rename query for the object. (Inherited from NamedSmoObject.)
Protected method Finalize (Inherited from Object.)
Protected method ForceTextModeOnTextBody Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GenerateAlterEvent() Generates the alter event with the specified value. (Inherited from SqlSmoObject.)
Protected method GenerateAlterEvent(Urn, Object) Generates alter event with the specified URN and inner object value. (Inherited from SqlSmoObject.)
Protected method GetBraketNameForText Gets the bracket name for the text. (Inherited from ScriptNameObjectBase.)
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.)
Protected method GetFragOptionString Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetIsSystemNamed Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method GetIsTextDirty Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
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 GetRealValue Gets a property value of the SqlSmoObject object. (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 Gets the server of the SqlSmoObject object. (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 GetTextBody() Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextBody(Boolean) Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextHeader Returns the text header. (Inherited from ScriptNameObjectBase.)
Protected method GetTextMode Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty Gets the text of the object, if not available, throw appropriate exception based on the state of the object. (Inherited from ScriptNameObjectBase.)
Public method GetType (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method Grant(ObjectPermissionSet, String) Grants access to the specified permission for the specified grantee on the database user.
Public method Grant(ObjectPermissionSet, array<String[]) Grants access to the specified permission for the specified grantees on the database user.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the database user.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) Grants access to the specified permission and the ability to grant access to other users for the specified grantees on the database user.
Public method Grant(ObjectPermissionSet, String, Boolean, String) Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the database user.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the database user under an assumed role.
Protected method ImplInitialize Initializes the fields of the SqlSmoObject object. (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.)
Public method IsMember Verifies whether the database user is a member of the specified role.
Protected method IsObjectDirty Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
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 Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected method IsVersion90AndAbove Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Public method MakeContained Converts a login mapped user to a contained user with password using the sys.sp_copy_password_to_user stored procedure.
Protected method MarkDropped Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method PostAlter The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected method PostCreate The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected method PostDrop The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Rename Renames the database user.
Protected method RenameImpl This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Public method Revoke(ObjectPermissionSet, String) Revokes previously granted permissions from a grantee on the database user.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes previously granted permissions from a list of grantees on the database user.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the database user and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes previously granted permissions from the grantees on the database user and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke other users' access.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes previously granted permissions from a grantee on the database user and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes previously granted permissions from grantees on the database user and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke other users' access under an assumed role.
Public method Script() Generates a Transact-SQL script that can be used to re-create the database user.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the database user as specified by the script options.
Protected method ScriptImpl() Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method SetCollectionTextMode Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
Protected method SetIsSystemNamed Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected method SetSchemaOwned Sets the schema owned value. (Inherited from NamedSmoObject.)
Protected method SetTextBody Specifies the text body. (Inherited from ScriptNameObjectBase.)
Protected method SetTextHeader Specifies the text header. (Inherited from ScriptNameObjectBase.)
Protected method SetTextMode Specifies the text mode. (Inherited from ScriptNameObjectBase.)
Protected method SwitchTextMode Switches the text mode. (Inherited from ScriptNameObjectBase.)
Protected method ThrowIfTextIsDirtyForAlter Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl Not implemented. (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl Unbinds rules of the SqlSmoObject. (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

Fields

  Name Description
Protected field m_ExtendedProperties Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected field singletonParent Represents the singleton parent. (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 specifies whether the user supports design mode.

Top

Remarks

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

To set User object properties, uses must have ALTER ANY USER permission on the database or be a member of the db_owner fixed database role.

To change the default schema, users must have ALTER permission on the specified user or be the owner of the user.

To create or drop a user, users must have ALTER ANY USER permission on the fixed server role or be a member of the db_owner fixed database role.

To grant, deny, or revoke permission on the specified user to other users, users must have CONTROL permission on the specified user.

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.

Examples

Managing Users, Roles, and Logins

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