AzureDevOpsDscNative

1.0.0-preview4

en-US/about_AzDoAreaNodes.help.txt

.NAME
    AzDoAreaNodes
 
.SYNOPSIS
    Defines a custom Desired State Configuration (DSC) resource for managing Azure DevOps area nodes.
 
.DESCRIPTION
    The AzDoAreaNodes class is a DSC resource that inherits from the AzDevOpsDscResourceBase class. It manages area paths 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 AreaPaths
    Write - System.String[]
    Specifies an array of area paths to be managed within the Azure DevOps project.
 
.EXAMPLE 1
 
This example shows how to ensure that Azure DevOps area nodes exist in a project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAreaNodes 'AddAzDoAreaNodes'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            AreaPaths = @(
                'MyProject\Team Alpha'
                'MyProject\Team Alpha\Frontend'
                'MyProject\Team Beta'
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update the area nodes in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAreaNodes 'UpdateAzDoAreaNodes'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            AreaPaths = @(
                'MyProject\Team Alpha'
                'MyProject\Team Alpha\Frontend'
                'MyProject\Team Alpha\Backend'
                'MyProject\Team Beta'
                'MyProject\Team Beta\QA'
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove area nodes from an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAreaNodes 'RemoveAzDoAreaNodes'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
        }
    }
}