en-US/about_AzDoPipelineFolder.help.txt
|
.NAME
AzDoPipelineFolder .SYNOPSIS DSC resource for managing Azure DevOps pipeline (build) folders. .DESCRIPTION Manages a folder in a project's pipeline tree. Pipeline folders are configuration in their own right: they carry ACLs that the definitions beneath them inherit, which is how pipeline security is normally administered. .PARAMETER ProjectName Required - System.String The name of the Azure DevOps project. .PARAMETER Path Key - System.String The full path of the folder, for example '\Platform\Release'. .PARAMETER Description Write - System.String An optional description shown in the Azure DevOps UI. .PARAMETER AllowRecursiveDelete Write - System.Boolean Deleting a pipeline folder deletes every pipeline definition beneath it. Removal of a folder that still has contents is refused unless this is set to $true. .EXAMPLE 1 This example creates a pipeline folder. Pipeline folder paths are backslash-delimited, unlike work item query paths. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoPipelineFolder 'AddPlatformFolder' { Ensure = 'Present' ProjectName = 'MyProject' Path = '\Platform' Description = 'Platform team pipelines' } } } .EXAMPLE 2 This example removes a pipeline folder and every pipeline beneath it. Deleting a pipeline folder deletes its pipeline definitions, so the resource refuses unless AllowRecursiveDelete is set. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoPipelineFolder 'RemovePlatformFolder' { Ensure = 'Absent' ProjectName = 'MyProject' Path = '\Platform' AllowRecursiveDelete = $true } } } |