AzDoProject

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
ProjectName	Key	System.String	The name of the Azure DevOps project.
Ensure	Write	Ensure		Present, Absent
ProcessTemplate	Write	System.String	The process template for the project. Valid values are 'Agile', 'Scrum', 'CMMI', and 'Basic'.	Agile, Scrum, CMMI, Basic
ProjectDescription	Write	System.String	The description of the Azure DevOps project.
SourceControlType	Write	System.String	The type of source control for the project. Valid values are 'Git' and 'Tfvc'.	Git, Tfvc
Visibility	Write	System.String	The visibility of the project. Valid values are 'Public' and 'Private'.	Public, Private
LookupResult	Read	System.Collections.Hashtable

Description

The AzDoProject class is used to define and manage Azure DevOps projects. It inherits from the AzDevOpsDscResourceBase class.

Examples

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
        }

    }
}