ServerRole Class
TOC
Collapse the table of content
Expand the table of content

ServerRole Class

 

The ServerRole object represents a Microsoft SQL Server security role.

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


[StateChangeEventAttribute("CREATE_SERVER_ROLE", "SERVER ROLE")]
[StateChangeEventAttribute("ALTER_SERVER_ROLE", "SERVER ROLE")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_SERVER", "SERVER ROLE")]
[SfcElementTypeAttribute("Role")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None | AutomatedPolicyEvaluationMode.Enforce | AutomatedPolicyEvaluationMode.CheckOnChanges | AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class ServerRole : ScriptNameObjectBase, IObjectPermission, 
	ICreatable, IDroppable, IAlterable, IRenamable, IScriptable

NameDescription
System_CAPS_pubmethodServerRole()

Initializes a new instance of the ServerRole class.

System_CAPS_pubmethodServerRole(Server, String)

Initializes a new instance of the ServerRole class.

NameDescription
System_CAPS_pubpropertyDateCreated

Gets a DateTime representing the date and time when the Server Role was created.

System_CAPS_pubpropertyDateModified

Gets a DateTime representing the date and time when the Server Role was modified.

System_CAPS_pubpropertyEvents

Gets the ServerRoleEvents object associated with this Server Role.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the server role.

System_CAPS_pubpropertyIsFixedRole

Gets a Boolean which indicates whether the server role is fixed.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyOwner

Gets the name of the owner of the ServerRole object.

System_CAPS_pubpropertyParent

Gets the Server object that is the parent of the ServerRole object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAddMember(String)

Adds a login to the fixed server role membership.

System_CAPS_pubmethodAddMembershipToRole(String)

Adds a role to the server role membership.

System_CAPS_pubmethodAlter()

Updates any ServerRole object property changes on the instance of Microsoft SQL Server. 

System_CAPS_pubmethodCreate()

Creates a Server Role on the instance of SQL Server as defined by the ServerRole object.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee(s) on the Server Role.

System_CAPS_pubmethodDeny(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 Server Role.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies the specified set of permissions for the specified grantees on the Server Role.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[], Boolean)

Denies the specified set of permissions for the specified grantees and other users that the grantees granted the specified set of permissions on the Server Role.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the Server Role from the instance of SQL Server.

System_CAPS_pubmethodDropMember(String)

Removes a login from the fixed server role membership.

System_CAPS_pubmethodDropMembershipFromRole(String)

Removes a role from the fixed server role membership.

System_CAPS_pubmethodEnumAgentProxyAccounts()

Enumerates a list of the SQL Server Agent proxy account to which the server role belongs.

System_CAPS_pubmethodEnumContainingRoleNames()

Gets a StringCollection which contains the names of all the ServerRole to which this ServerRole belongs.

System_CAPS_pubmethodEnumMemberNames()

Gets a StringCollection which contains the names of all the logins which belong to this role.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the Server Role.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the Server Role.

System_CAPS_pubmethodEnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the Server Role.

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the Server Role.

System_CAPS_pubmethodEnumServerRoleMembers()

Obsolete.Enumerates a list of members of the fixed server role. This method is deprecated. Use EnumMemberNames instead.

System_CAPS_pubmethodEnumServerRolePermissions()

Obsolete.Returns a list of server permissions assigned to the referenced server role.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet, String)

Grants the specified set of permissions to the specified grantee on the Server Role.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String, Boolean)

Grants access to the specified permission and the ability to grant access to other uses for the specified grantee on the Server Role.

System_CAPS_pubmethodGrant(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 Server Role under an assumed role.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants the specified set of permissions to the specified grantees on the Server Role.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[], Boolean)

Grants access to the specified permission to the grantees and the ability to grant access to other users on the Server Role.

System_CAPS_pubmethodGrant(ObjectPermissionSet, 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 Server Role under an assumed role.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRename(String)

Renames the Server Role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions from a grantee on the Server Role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String, Boolean, Boolean)

Revokes a previously granted set of permissions from a grantee from the Server Role, 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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String, Boolean, Boolean, String)

Revokes a previously granted set of permissions from a grantee from the Server Role 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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

Revokes a previously granted set of permissions from a set of grantees on the Server Role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[], Boolean, Boolean)

Revokes a previously granted set of permissions from a set of grantees from the Server Role, 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

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[], Boolean, Boolean, String)

Revokes the specified set of permissions to the grantees and the ability to revoke the set of permissions to other users on the Server Role under an assumed role.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the Server Role.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the Server Role.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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

To add or remove members from a fixed server role, users must have ALTER ANY LOGIN permission on the server or be a member of the sysadmin fixed server role.

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft