AzureDevOpsDscNative

1.0.0-preview4

en-US/about_AzDoGroupMember.help.txt

.NAME
    AzDoGroupMember
 
.SYNOPSIS
    This class represents a DSC resource for managing Azure DevOps group members.
 
.DESCRIPTION
    The AzDoGroupMember class is a DSC resource that allows you to manage the members of an Azure DevOps group.
    It inherits from the AzDevOpsDscResourceBase class.
 
.PARAMETER GroupName
    Key - System.String
    The name of the Azure DevOps group.
 
.PARAMETER GroupMembers
    Required - System.String[]
    An array of strings representing the members of the Azure DevOps group.
 
.EXAMPLE 1
 
This example shows how to add groups to a membership.
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoGroupMember 'AddAzDoGroupMember'
        {
            Ensure = 'Present'
            GroupName = '[ProjectName|OrganizationName]\GroupName'
            GroupMembers = @(
                '[Project]\Readers'
                '[OrganizationName]\Project Collection Administrators'
            )
        }
    }
}
 
.EXAMPLE 2
 
TThis example shows how to update the group membership.
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoGroupMember 'UpdateAzDoGroupMember'
        {
            Ensure = 'Present'
            GroupName = '[ProjectName|OrganizationName]\GroupName'
            GroupMembers = @(
                '[Project]\New Group Name'
                '[OrganizationName]\Project Collection Administrators'
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove a group membership.
 
Configuration Example
{
 
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoGroupMember 'RemoveAzDoGroupMember'
        {
            Ensure = 'Present'
            GroupName = '[ProjectName|OrganizationName]\GroupName'
            # Ensure: Absent is not required. Zeroing out the membership is sufficent.
            GroupMembers = @()
        }
    }
}