Server.Roles Property
Represents a collection of ServerRole objects. Each ServerRole object represents a role defined on the instance of SQL Server.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, _
GetType(ServerRole))> _
Public ReadOnly Property Roles As ServerRoleCollection
Get
'Usage
Dim instance As Server
Dim value As ServerRoleCollection
value = instance.Roles
[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,
typeof(ServerRole))]
public ServerRoleCollection Roles { get; }
[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny,
typeof(ServerRole))]
public:
property ServerRoleCollection^ Roles {
ServerRoleCollection^ get ();
}
[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,
typeof(ServerRole))>]
member Roles : ServerRoleCollection
function get Roles () : ServerRoleCollection
Property Value
Type: Microsoft.SqlServer.Management.Smo.ServerRoleCollection
A ServerRoleCollection object that represents all the roles defined on the instance of SQL Server.
Remarks
The Roles property points to the ServerRoleCollection object. You can use the collection to reference the fixed server roles the instance of SQL Server.
Examples
Visual Basic
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Display the fixed server roles.
Dim sr As ServerRole
For Each sr In srv.Roles
Console.WriteLine(sr.Name)
Next
PowerShell
$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
foreach ($sr in $srv.Roles)
{
Write-Host $sr.Name
}
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace