AuthorizationRule.Roles Property

Definition

Namespace:

System.Web.Configuration

Assembly:

System.Web.dll

Gets the roles associated with the resource.

public:
 property System::Collections::Specialized::StringCollection ^ Roles { System::Collections::Specialized::StringCollection ^ get(); };

[System.ComponentModel.TypeConverter(typeof(System.Configuration.CommaDelimitedStringCollectionConverter))]
[System.Configuration.ConfigurationProperty("roles")]
public System.Collections.Specialized.StringCollection Roles { get; }

[<System.ComponentModel.TypeConverter(typeof(System.Configuration.CommaDelimitedStringCollectionConverter))>]
[<System.Configuration.ConfigurationProperty("roles")>]
member this.Roles : System.Collections.Specialized.StringCollection

Public ReadOnly Property Roles As StringCollection

Property Value

StringCollection

A StringCollection collection containing the roles whose authorization must be verified.

Attributes

TypeConverterAttribute ConfigurationPropertyAttribute

Examples

The following code example shows how to use this property.

 // Using the AuthorizationRuleCollection Add method.

 // Set the action property.
 authorizationRule.Action = 
    AuthorizationRuleAction.Allow;
 // Define the new rule to add to the collection.
 authorizationRule.Users.Add("userName");
 authorizationRule.Roles.Add("admin");
 authorizationRule.Verbs.Add("POST");

 // Add the new rule to the collection.
 authorizationSection.Rules.Add(authorizationRule);

' Using the AuthorizationRuleCollection Add method.
' Set the action property.
  authorizationRule.Action = _
  AuthorizationRuleAction.Allow
' Define the new rule to add to the collection.
authorizationRule.Users.Add("userName")
authorizationRule.Roles.Add("admin")
authorizationRule.Verbs.Add("POST")

' Add the new rule to the collection.
authorizationSection.Rules.Add(authorizationRule)

Remarks

The Roles property is a list of roles that are granted or denied access to the resource. There must be at least one value in either the Users property collection or the Roles property collection, or both.