en-US/about_AzDoReleaseFolderPermission.help.txt

.NAME
    AzDoReleaseFolderPermission
 
.SYNOPSIS
    DSC resource for managing permissions on Azure DevOps classic Release folders.
 
.DESCRIPTION
    Manages the ACL on a Release folder, using the 'ReleaseManagement' security namespace.
    Release definitions beneath the folder inherit from it, which is how release permissions are
    normally administered.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project.
 
.PARAMETER FolderPath
    Write - System.String
    The full path of the Release folder, for example '\Platform'. Omit to target the project's
    release root.
 
.PARAMETER isInherited
    Write - System.Boolean
    Whether the ACL inherits permissions from its parent. Defaults to $true.
 
.PARAMETER Permissions
    Write - HashTable[]
    The access control entries, as an array of hashtables:
    @{ Identity = '[ProjectName]\GroupName'; Permission = @{ ViewReleases = 'Allow' } }
 
.EXAMPLE 1
 
This example grants a team permissions on a release folder. Release definitions inside
the folder inherit from it, which is how release-folder permissions are normally
administered.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoReleaseFolder 'AddPlatformReleaseFolder'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            Path = '\Platform'
        }
 
        AzDoReleaseFolderPermission 'PlatformReleaseFolderPermissions'
        {
            ProjectName = 'MyProject'
            FolderPath = '\Platform'
            isInherited = $true
            Permissions = @(
                @{
                    Identity = '[MyProject]\Platform Team'
                    Permission = @{
                        ViewReleaseDefinition = 'Allow'
                        ManageReleaseApprovers = 'Allow'
                    }
                }
            )
            DependsOn = '[AzDoReleaseFolder]AddPlatformReleaseFolder'
        }
    }
}