en-US/about_WindowsAccessControlNtfsAccessRule.help.txt

.NAME
    WindowsAccessControlNtfsAccessRule
 
.SYNOPSIS
    Ensures one exact explicit NTFS access rule is present or absent.
 
.DESCRIPTION
    The composite key identifies exactly one explicit access control entry
    by path, account, rights, qualifier, and inheritance scope. Absent
    removes every duplicate of that exact entry without purging unrelated
    rights or the opposite qualifier. For an allow rule the comparison
    includes the Synchronize bit that .NET adds when it materializes the
    entry. Windows can merge entries that share account, qualifier, and
    scope, so a narrower exact rule cannot coexist with a broader superset
    entry and will stay noncompliant; model the superset explicitly or
    manage the whole list with WindowsAccessControlNtfsSecurityDescriptor.
 
.PARAMETER Path
    Key - string
    The file or directory the rule applies to.
 
.PARAMETER Account
    Key - string
    The principal the rule applies to. An alias is normalized by security
    identifier, so any spelling that resolves to the same principal matches.
 
.PARAMETER AccessRights
    Key - System.Security.AccessControl.FileSystemRights
    The exact file system rights the entry grants or denies.
 
.PARAMETER AccessControlType
    Key - System.Security.AccessControl.AccessControlType
    Whether the entry is an allow or a deny entry.
 
.PARAMETER AppliesTo
    Key - string
    Allowed values: ThisFolderOnly, ThisFolderSubfoldersAndFiles, ThisFolderAndSubfolders, ThisFolderAndFiles, SubfoldersAndFilesOnly, SubfoldersOnly, FilesOnly, ThisFolderSubfoldersAndFilesOneLevel, ThisFolderAndSubfoldersOneLevel, ThisFolderAndFilesOneLevel, SubfoldersAndFilesOnlyOneLevel, SubfoldersOnlyOneLevel, FilesOnlyOneLevel
    The inheritance scope of the entry, expressed the way the Windows
    security editor expresses it.
 
.PARAMETER Ensure
    Write - WindowsAccessControlDscEnsure
    Whether the exact entry must be present or absent. Defaults to Present.
 
.PARAMETER Reasons
    Read - WindowsAccessControlDscReason[]
    Returns why the resource is not in the desired state. Not configurable.