en-US/about_AzDoProject.help.txt
|
.NAME
AzDoProject .SYNOPSIS This class represents an Azure DevOps project. .DESCRIPTION The AzDoProject class is used to define and manage Azure DevOps projects. It inherits from the AzDevOpsDscResourceBase class. .PARAMETER ProjectName Key - System.String The name of the Azure DevOps project. .PARAMETER ProjectDescription Write - System.String The description of the Azure DevOps project. .PARAMETER SourceControlType Write - System.String Allowed values: Git, Tfvc The type of source control for the project. Valid values are 'Git' and 'Tfvc'. .PARAMETER ProcessTemplate Write - System.String The process template for the project. Accepts any process name available in the organization, including the built-in system processes ('Agile', 'Scrum', 'CMMI', 'Basic') and any inherited process created from them. Unknown names are rejected at apply time against the live process list. Changing this on an existing project (via Set) is only permitted when the current and desired processes share the same system-process ancestor (for example, moving between a system process and one of its inherited children, or between two inherited children of the same parent) - Azure DevOps does not allow migrating a project across unrelated process families. .PARAMETER Visibility Write - System.String Allowed values: Public, Private The visibility of the project. Valid values are 'Public' and 'Private'. .EXAMPLE 1 This example shows how to ensure that the Azure DevOps project called 'Test Project' exists (or is added if it does not exist). Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoProject 'AddProject' { Ensure = 'Present' ProjectName = 'Test Project' ProjectDescription = 'A Test Project' SourceControlType = 'Git' } } } .EXAMPLE 2 This example shows how to ensure that an Azure DevOps project with a ProjectName of 'Test Project' can have it's description updated to 'A Test Project with a new description'. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoProject 'UpdateProject' { Ensure = 'Present' ProjectName = 'Test Project' ProjectDescription = 'A Test Project with a new description' # Updated property #SourceControlType = 'Git' # Note: Update of this property is not supported } } } .EXAMPLE 3 This example shows how to delete a project called 'Test Project'. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoProject 'DeleteProject' { Ensure = 'Absent' # 'Absent' ensures this will be removed/deleted ProjectName = 'Test Project' # Identifies the name of the project to be deleted } } } |