en-US/about_AzDoReleaseDefinitionPermission.help.txt

.NAME
    AzDoReleaseDefinitionPermission
 
.SYNOPSIS
    DSC resource for managing permissions on an Azure DevOps classic Release definition.
 
.DESCRIPTION
    Manages the ACL on a single Release definition, using the 'ReleaseManagement' security
    namespace. The definition is resolved by name (optionally disambiguated by the folder it
    lives in) rather than by its numeric id, since the id is an implementation detail the
    configuration author does not see.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project.
 
.PARAMETER DefinitionName
    Required - System.String
    The name of the Release definition.
 
.PARAMETER FolderPath
    Write - System.String
    The Release folder the definition lives in, for example '\Platform'. Omit when the definition
    lives at the release root, or when its name is unique across the project.
 
.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 = @{ ViewReleaseDefinition = 'Allow' } }
 
.EXAMPLE 1
 
This example grants a team permissions on a specific classic release definition,
resolved by name (and, when given, by folder).
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoReleaseDefinitionPermission 'PlatformReleaseDefinitionPermissions'
        {
            ProjectName = 'MyProject'
            DefinitionName = 'Platform Release'
            FolderPath = '\Platform'
            isInherited = $true
            Permissions = @(
                @{
                    Identity = '[MyProject]\Platform Team'
                    Permission = @{
                        ViewReleaseDefinition = 'Allow'
                        ManageReleaseApprovers = 'Allow'
                    }
                }
            )
        }
    }
}