AzureDevOpsDscNative

1.0.0-preview5

en-US/about_AzDoOrganizationGroup.help.txt

.NAME
    AzDoOrganizationGroup
 
.SYNOPSIS
    This class represents an Azure DevOps organization group.
 
.DESCRIPTION
    The AzDoOrganizationGroup class is a DSC resource that allows you to manage Azure DevOps organization groups.
    It provides properties to specify the group name, display name, and description.
 
.PARAMETER GroupName
    Key - System.String
    The name of the organization group.
    This property is mandatory and serves as the key property for the resource.
 
.PARAMETER GroupDescription
    Write - System.String
    The description of the organization group.
 
.EXAMPLE 1
 
This example shows how to add a Orgnaization Group
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoOrganizationGroup 'AddAzDoOrganizationGroup'
        {
            Ensure = 'Present'
            GroupName = 'Initial Group Name'
            GroupDescription = 'Initial Description'
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update a Orgnaization Group
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoOrganizationGroup 'UpdateAzDoOrganizationGroup'
        {
            Ensure = 'Present'
            GroupName = 'Updated Group Name'
            GroupDescription = 'Initial Description'
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a Orgnaization Group
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoOrganizationGroup 'DeleteAzDoOrganizationGroup'
        {
            Ensure = 'Absent'
            GroupName = 'Updated Group Name'
        }
    }
}