en-US/about_AzDoTaskGroup.help.txt

.NAME
    AzDoTaskGroup
 
.SYNOPSIS
    DSC resource for managing Azure DevOps reusable task groups.
 
.DESCRIPTION
    This resource manages task groups in Azure DevOps, which are reusable collections of pipeline
    tasks that can be shared across multiple pipelines. Task groups help enforce consistent build
    and deployment processes.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource.
 
.PARAMETER TaskGroupName
    Required - System.String
    The name of the task group. This is a key property.
 
.PARAMETER Description
    Write - System.String
    An optional description for the task group.
 
.PARAMETER Category
    Write - System.String
    The category of the task group (e.g., Build, Deploy, Test).
 
.PARAMETER Tasks
    Write - HashTable[]
 
.PARAMETER Inputs
    Write - HashTable[]
 
.EXAMPLE 1
 
This example shows how to create a task group in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoTaskGroup 'AddAzDoTaskGroup'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            TaskGroupName = 'MyBuildTaskGroup'
            Description = 'Reusable build steps for .NET projects'
            Category = 'Build'
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a task group in an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoTaskGroup 'UpdateAzDoTaskGroup'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            TaskGroupName = 'MyBuildTaskGroup'
            Description = 'Reusable build steps for .NET and Node.js projects'
            Category = 'Build'
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a task group from an Azure DevOps project.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoTaskGroup 'RemoveAzDoTaskGroup'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            TaskGroupName = 'MyBuildTaskGroup'
        }
    }
}