Export (0) Print
Expand All

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)

public final class ServerRole extends ScriptNameObjectBase implements IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, IScriptable

The ServerRole type exposes the following members.

  NameDescription
Public methodServerRole()Initializes a new instance of the ServerRole class.
Public methodServerRole(Server, String)Initializes a new instance of the ServerRole class.
Top

  NameDescription
Public propertyDateCreatedGets a DateTime representing the date and time when the Server Role was created.
Public propertyDateModifiedGets a DateTime representing the date and time when the Server Role was modified.
Public propertyEventsGets the ServerRoleEvents object associated with this Server Role.
Public propertyIDGets the ID value that uniquely identifies the server role.
Public propertyIsFixedRoleGets a Boolean which indicates whether the server role is fixed.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyOwnerGets the name of the owner of the ServerRole object.
Public propertyParentGets the Server object that is the parent of the ServerRole object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
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 methodAddMemberAdds a login to the fixed server role membership.
Public methodAddMembershipToRoleAdds a role to the server role membership.
Public methodAlterUpdates any ServerRole object property changes on the instance of Microsoft SQL Server. 
Public methodCreateCreates a Server Role on the instance of SQL Server as defined by the ServerRole object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee(s) on the Server Role.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the Server Role.
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 Server Role.
Public methodDeny(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.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the Server Role from the instance of SQL Server.
Public methodDropMemberRemoves a login from the fixed server role membership.
Public methodDropMembershipFromRoleRemoves a role from the fixed server role membership.
Public methodEnumAgentProxyAccountsEnumerates a list of the SQL Server Agent proxy account to which the server role belongs.
Public methodEnumContainingRoleNamesGets a StringCollection which contains the names of all the ServerRole to which this ServerRole belongs.
Public methodEnumMemberNamesGets a StringCollection which contains the names of all the logins which belong to this role.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the Server Role.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the Server Role.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the Server Role.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the Server Role.
Public methodEnumServerRoleMembers Obsolete. Enumerates a list of members of the fixed server role. This method is deprecated. Use EnumMemberNames() instead.
Public methodEnumServerRolePermissions Obsolete. Returns a list of server permissions assigned to the referenced server role.
Public methodEquals (Inherited from Object.)
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 Server Role.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the Server Role.
Public methodGrant(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.
Public methodGrant(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.
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 Server Role under an assumed role.
Public methodGrant(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.
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 script name. (Inherited from ScriptNameObjectBase.)
Public methodRenameRenames the Server Role.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the Server Role.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions from a set of grantees on the Server Role.
Public methodRevoke(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.
Public methodRevoke(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
Public methodRevoke(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.
Public methodRevoke(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.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the Server Role.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the Server 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.)
Top

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.

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.

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