AzureDevOpsDscNative

1.1.0-preview2

en-US/about_AzDoProjectPermission.help.txt

.NAME
    AzDoProjectPermission
 
.SYNOPSIS
    DSC resource for managing project-level ACL permissions.
 
.DESCRIPTION
    This resource manages project-level permissions in Azure DevOps, controlling what actions
    groups or users can perform within a specific project.
 
.PARAMETER ProjectName
    Key - System.String
    The name of the Azure DevOps project. This property is mandatory and serves as a key property for the resource.
 
.PARAMETER GroupName
    Required - System.String
    The name of the group to grant permissions to. This is a key property. Use the format [ProjectName]\GroupName or [TEAM FOUNDATION]\GroupName for organization-level groups.
 
.PARAMETER isInherited
    Write - System.Boolean
    Whether permissions are inherited from parent objects. Defaults to $true.
 
.PARAMETER Permissions
    Write - HashTable[]
 
.EXAMPLE 1
 
This example shows how to grant project-level permissions to a group in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProjectPermission 'AddAzDoProjectPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            GroupName = '[MyProject]\Contributors'
            isInherited = $true
            Permissions = @(
                @{ Permission = 'GENERIC_READ'; Access = 'Allow' }
                @{ Permission = 'GENERIC_WRITE'; Access = 'Allow' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update project-level permissions for a group in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProjectPermission 'UpdateAzDoProjectPermission'
        {
            Ensure = 'Present'
            ProjectName = 'MyProject'
            GroupName = '[MyProject]\Contributors'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'GENERIC_READ'; Access = 'Allow' }
                @{ Permission = 'GENERIC_WRITE'; Access = 'Allow' }
                @{ Permission = 'DELETE'; Access = 'Deny' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove project-level permissions from a group in Azure DevOps.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoProjectPermission 'RemoveAzDoProjectPermission'
        {
            Ensure = 'Absent'
            ProjectName = 'MyProject'
            GroupName = '[MyProject]\Contributors'
        }
    }
}