Edit

Share via


PipeSecurity.AuditRuleFactory Method

Definition

Initializes a new instance of the AuditRule class with the specified values.

public:
 override System::Security::AccessControl::AuditRule ^ AuditRuleFactory(System::Security::Principal::IdentityReference ^ identityReference, int accessMask, bool isInherited, System::Security::AccessControl::InheritanceFlags inheritanceFlags, System::Security::AccessControl::PropagationFlags propagationFlags, System::Security::AccessControl::AuditFlags flags);
public override sealed System.Security.AccessControl.AuditRule AuditRuleFactory (System.Security.Principal.IdentityReference identityReference, int accessMask, bool isInherited, System.Security.AccessControl.InheritanceFlags inheritanceFlags, System.Security.AccessControl.PropagationFlags propagationFlags, System.Security.AccessControl.AuditFlags flags);
override this.AuditRuleFactory : System.Security.Principal.IdentityReference * int * bool * System.Security.AccessControl.InheritanceFlags * System.Security.AccessControl.PropagationFlags * System.Security.AccessControl.AuditFlags -> System.Security.AccessControl.AuditRule
Public Overrides NotOverridable Function AuditRuleFactory (identityReference As IdentityReference, accessMask As Integer, isInherited As Boolean, inheritanceFlags As InheritanceFlags, propagationFlags As PropagationFlags, flags As AuditFlags) As AuditRule

Parameters

identityReference
IdentityReference

The identity that the access rule applies to. It must be an object that can be cast as a SecurityIdentifier object.

accessMask
Int32

The access mask of this rule. The access mask is a 32-bit collection of anonymous bits, the meaning of which is defined by the individual integrators.

isInherited
Boolean

true if this rule is inherited from a parent container; otherwise, false.

inheritanceFlags
InheritanceFlags

One of the InheritanceFlags values that specifies the inheritance properties of the access rule.

propagationFlags
PropagationFlags

One of the PropagationFlags values that specifies whether inherited access rules are automatically propagated. The propagation flags are ignored if inheritanceFlags is set to None.

flags
AuditFlags

One of the AuditFlags values that specifies the valid access control type.

Returns

The AuditRule object that this method creates.

Exceptions

The accessMask, inheritanceFlags, propagationFlags, or flags properties specify an invalid value.

The identityReference property is null.

-or-

The accessMask property is zero.

The identityReference property is neither of type SecurityIdentifier nor of a type, such as NTAccount, that can be converted to type SecurityIdentifier.

Remarks

The recommended way to create audit rules is to use the constructors of the PipeAuditRule class.

Applies to