AzureDevOpsDscNative

1.0.0-preview02

en-US/about_AzDoGroupPermission.help.txt

.NAME
    AzDoGroupPermission
 
.SYNOPSIS
    This class represents a DSC resource for managing Azure DevOps project group permissions.
 
.DESCRIPTION
    The AzDoGroupPermission class is a DSC resource that allows you to manage permissions for a group in an Azure DevOps project.
 
.PARAMETER GroupName
    Key - System.String
    The name of the group for which the permissions are being managed.
 
.PARAMETER isInherited
    Write - System.Boolean
    Specifies whether the permissions are inherited from a parent group. Default value is $true.
 
.PARAMETER Permissions
    Write - HashTable[]
    Specifies the permissions to be assigned to the group. This should be an array of hashtables, where each hashtable represents a permission.
 
.EXAMPLE 1
 
This example shows how to grant permissions on an Azure DevOps group.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoGroupPermission 'AddAzDoGroupPermission'
        {
            Ensure = 'Present'
            GroupName = '[MyProject]\Readers'
            isInherited = $true
            Permissions = @(
                @{ Permission = 'GENERIC_READ'; Access = 'Allow' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update permissions on an Azure DevOps group.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoGroupPermission 'UpdateAzDoGroupPermission'
        {
            Ensure = 'Present'
            GroupName = '[MyProject]\Readers'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'GENERIC_READ'; Access = 'Allow' }
                @{ Permission = 'GENERIC_WRITE'; Access = 'Deny' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove permissions from an Azure DevOps group.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoGroupPermission 'RemoveAzDoGroupPermission'
        {
            Ensure = 'Absent'
            GroupName = '[MyProject]\Readers'
        }
    }
}