en-US/about_AzDoReleaseFolder.help.txt
|
.NAME
AzDoReleaseFolder .SYNOPSIS DSC resource for managing classic Release Management folders. .DESCRIPTION Manages a folder in a project's classic Release (Release Management) folder tree. Release folders carry ACLs that the release definitions beneath them inherit, which is how release security is normally administered - see AzDoReleaseFolderPermission. .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 release folder deletes every release 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 classic Release Management folder. Release folder paths are backslash-delimited, the same convention used by pipeline folders, but the folder lives on the vsrm.dev.azure.com host. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoReleaseFolder 'AddPlatformReleaseFolder' { Ensure = 'Present' ProjectName = 'MyProject' Path = '\Platform' Description = 'Platform team releases' } } } .EXAMPLE 2 This example removes a classic Release Management folder. Removal is refused unless AllowRecursiveDelete is set, because deleting a folder deletes every sub-folder and release definition beneath it. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoReleaseFolder 'RemovePlatformReleaseFolder' { Ensure = 'Absent' ProjectName = 'MyProject' Path = '\Platform' AllowRecursiveDelete = $true } } } |