en-US/about_AzDoPipelineFolderPermission.help.txt
|
.NAME
AzDoPipelineFolderPermission .SYNOPSIS DSC resource for managing permissions on Azure DevOps pipeline (build) folders. .DESCRIPTION Manages the ACL on a pipeline folder, using the 'Build' security namespace. Definitions beneath the folder inherit from it, which is how pipeline 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 pipeline folder, for example '\Platform'. Omit to target the project's build 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 = @{ ViewBuilds = 'Allow' } } .EXAMPLE 1 This example grants a team permissions on a pipeline folder. Definitions inside the folder inherit from it, which is how pipeline permissions are normally administered. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoPipelineFolder 'AddPlatformFolder' { Ensure = 'Present' ProjectName = 'MyProject' Path = '\Platform' } AzDoPipelineFolderPermission 'PlatformFolderPermissions' { ProjectName = 'MyProject' FolderPath = '\Platform' isInherited = $true Permissions = @( @{ Identity = '[MyProject]\Platform Team' Permission = @{ ViewBuilds = 'Allow' QueueBuilds = 'Allow' } } ) DependsOn = '[AzDoPipelineFolder]AddPlatformFolder' } } } |