User Class

Makale
05/16/2012

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
	User()	Initializes a new instance of the User class.
	User(Database, String)	Initializes a new instance of the User class on the specified database with the specified name.

Top

Properties

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

Top

Methods

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

Fields

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

Aracılığıyla paylaş

User Class

Inheritance Hierarchy

Syntax

Constructors

Properties

Methods

Events

Fields

Explicit Interface Implementations

Remarks

Thread Safety

Examples

Thread Safety

See Also

Reference

Other Resources

Ek kaynaklar