AzureDevOpsDscNative

1.0.0-preview5

en-US/about_AzDoProjectGroup.help.txt

.NAME
    AzDoProjectGroup
 
.SYNOPSIS
    This class represents an Azure DevOps project group.
 
.DESCRIPTION
    The AzDoProjectGroup class is a DSC resource that allows you to manage Azure DevOps project groups.
 
.PARAMETER GroupName
    Key - System.String
    The name of the project group.
 
.PARAMETER ProjectName
    Required - System.String
    The name of the Azure DevOps project associated with the project group.
 
.PARAMETER GroupDescription
    Write - System.String
    The description of the project group.
 
.EXAMPLE 1
 
This example shows how to add a Project Group
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProjectGroup 'AddProjectGroup' {
            Ensure = 'Present'
            GroupName = 'SampleProjectGroup'
            ProjectName = 'SampleProject'
            GroupDescription = 'This is a sample project group!'
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a Project Group
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProjectGroup 'UpdateProjectGroup' {
            Ensure = 'Present'
            GroupName = 'SampleProjectGroup'
            ProjectName = 'SampleProject'
            GroupDescription = 'New project group description'
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a Project Group
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProjectGroup 'RemoveProjectGroup' {
            Ensure = 'Absent'
            GroupName = 'SampleProjectGroup'
            ProjectName = 'SampleProject'
        }
    }
}