Skip to content

AzDoGroupPermission

github-actions[bot] edited this page Aug 19, 2026 · 4 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
GroupName Key System.String The name of the group for which the permissions are being managed.
Ensure Write Ensure Present, Absent
isInherited Write System.Boolean Specifies whether the permissions are inherited from a parent group. Default value is $true.
Permissions Write System.Collections.Hashtable[] Specifies the permissions to be assigned to the group. This should be an array of hashtables, where each hashtable represents a permission.
LookupResult Read System.Collections.Hashtable

Description

The AzDoGroupPermission class is a DSC resource that allows you to manage permissions for a group in an Azure DevOps project.

Examples

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'
        }
    }
}

Commands

Resources

Clone this wiki locally