AzureDevOpsDscNative

1.0.0-preview5

en-US/about_AzDoIterationNodes.help.txt

.NAME
    AzDoIterationNodes
 
.SYNOPSIS
    Defines a custom Desired State Configuration (DSC) resource for managing Azure DevOps iteration nodes.
 
.DESCRIPTION
    The AzDoIterationNodes class is a DSC resource that inherits from the AzDevOpsDscResourceBase class. It manages iteration paths and their attributes within a specified Azure DevOps project.
 
.PARAMETER ProjectName
    Key - System.String
    Specifies the name of the Azure DevOps project. This parameter is mandatory and serves as the key identifier for the resource.
 
.PARAMETER IterationAttributes
    Write - HashTable[]
    Specifies an array of hashtables, each representing attributes for iterations to be managed within the Azure DevOps project. This parameter is mandatory.
 
.EXAMPLE 1
 
This example shows how to ensure that Azure DevOps iteration nodes exist in a project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoIterationNodes 'AddAzDoIterationNodes'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            IterationAttributes = @(
                @{
                    Name = 'Sprint 1'
                    StartDate = '2024-01-01'
                    FinishDate = '2024-01-14'
                }
                @{
                    Name = 'Sprint 2'
                    StartDate = '2024-01-15'
                    FinishDate = '2024-01-28'
                }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update the iteration nodes in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoIterationNodes 'UpdateAzDoIterationNodes'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            IterationAttributes = @(
                @{
                    Name = 'Sprint 1'
                    StartDate = '2024-01-01'
                    FinishDate = '2024-01-14'
                }
                @{
                    Name = 'Sprint 2'
                    StartDate = '2024-01-15'
                    FinishDate = '2024-01-28'
                }
                @{
                    Name = 'Sprint 3'
                    StartDate = '2024-01-29'
                    FinishDate = '2024-02-11'
                }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove iteration nodes from an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoIterationNodes 'RemoveAzDoIterationNodes'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
        }
    }
}