Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

AuthorizationRuleCollection Class

Represents a collection of AuthorizationRule objects. This class cannot be inherited.

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)
[ConfigurationCollectionAttribute(typeof(AuthorizationRule), AddItemName = "allow,deny", 
	CollectionType = ConfigurationElementCollectionType.BasicMapAlternate)]
public sealed class AuthorizationRuleCollection : ConfigurationElementCollection

The AuthorizationRuleCollection type exposes the following members.

  NameDescription
Public methodAuthorizationRuleCollectionInfrastructure. Initializes a new instance of the AuthorizationRuleCollection class.
Top
  NameDescription
Protected propertyAddElementNameGets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected propertyClearElementNameGets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public propertyCollectionTypeInfrastructure. Gets the type of this AuthorizationRuleCollection. (Overrides ConfigurationElementCollection.CollectionType.)
Public propertyCountGets the number of elements in the collection. (Inherited from ConfigurationElementCollection.)
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Public propertyEmitClearGets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection.)
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Public propertyItem[Int32]Infrastructure. Gets or sets an item in this collection.
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Protected propertyRemoveElementNameGets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public propertySyncRootGets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Top
  NameDescription
Public methodAddAdds a AuthorizationRule object to the collection.
Protected methodBaseAdd(ConfigurationElement, Boolean)Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseClearRemoves all configuration element objects from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Int32)Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Object)Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetAllKeysReturns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetKeyGets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseIsRemovedIndicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveRemoves a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveAtRemoves the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Public methodClearRemoves all AuthorizationRule objects from the collection.
Public methodCopyToCopies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.)
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection.)
Public methodGetGets the AuthorizationRule at the specified index.
Public methodGetEnumeratorInfrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public methodGetHashCodeGets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfGets the collection index of the specified AuthorizationRule object.
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsModifiedIndicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public methodIsReadOnlyIndicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection.)
Public methodRemoveRemoves a AuthorizationRule object from the collection.
Public methodRemoveAtRemoves a AuthorizationRule object from the collection at the specified index.
Protected methodResetResets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodResetModifiedResets the value of the IsModified property to false when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodSerializeElementWrites the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodSetAdds the specified AuthorizationRule object to the collection at the specified index.
Protected methodSetReadOnlyInfrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeInfrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.)
Top

The AuthorizationRuleCollection type allows access to the elements of the authorization section collection.

The following code example shows how to obtain the AuthorizationRuleCollection object from the configuration file of an existing Web application. You use this object to access its members as shown in the following topics. The configuration file will contain a setup similar to the following.

<authorization>
  <allow users="userName" roles="admin" verbs="post" />
  <deny users="*" verbs="post"/>
</authorization>
// Get the Web application configuration.
System.Configuration.Configuration configuration = 
    WebConfigurationManager.OpenWebConfiguration(
    "/aspnetTest");
// Get the section.
AuthorizationSection authorizationSection = 
    (AuthorizationSection)configuration.GetSection(
    "system.web/authorization");
// Get the authorization rule collection.
AuthorizationRuleCollection authorizationRuleCollection = 
    authorizationSection.Rules;

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.