AzDoIterationPermission

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
ProjectName	Key	System.String	Specifies the name of the Azure DevOps project. This is a mandatory key property.
Ensure	Write	Ensure		Present, Absent
isInherited	Write	System.Boolean	Indicates whether the permissions are inherited. Defaults to $true.
IterationPath	Write	System.String	Specifies the path of the iteration for which permissions are being managed. Defaults to $null.
Permissions	Write	System.Collections.Hashtable[]	Specifies a hashtable array of permissions to be applied to the iteration.
LookupResult	Read	System.Collections.Hashtable

Description

The AzDoIterationPermission class is a DSC resource that allows you to manage permissions for iterations in Azure DevOps projects. It inherits from the AzDevOpsDscResourceBase class and provides properties and methods to configure and retrieve the state of iteration permissions.

Examples

Example 1

This example shows how to add the Iteration permissions.

Configuration Example
{

    Import-DscResource -ModuleName 'AzureDevOpsDscNative'

    node localhost
    {
        AzDoPermission 'AddAzDoIterationPermission'
        {
            Ensure               = 'Present'
            ProjectName          = 'Test Project'
            IterationPath        = '\Test Iteration\Sub Iteration'
            isInherited          = $false
            Permissions          = @(
                @{
                    Identity   = '[Test Project]\Test Team'
                    Permission = @{
                        'WORK_ITEM_READ'  = 'Allow'
                        'GENERIC_WRITE'   = 'Allow'
                    }
                }
            )
        }
    }
}

Example 2

This example shows how to update Iteration permissions.

Configuration Example
{

    Import-DscResource -ModuleName 'AzureDevOpsDscNative'

    node localhost
    {
        AzDoIterationPermission 'UpdateAzDoIterationPermission'
        {
            Ensure               = 'Present'
            ProjectName          = 'Test Project'
            IterationPath        = '\Test Iteration\Sub Iteration'
            isInherited          = $false
            Permissions          = @(
                @{
                    Identity   = '[Test Project]\Test Team'
                    Permission = @{
                        'WORK_ITEM_READ'  = 'Allow'
                        'GENERIC_WRITE'   = 'Allow'
                    }
                }
            )
        }
    }
}

Example 3

This example shows how to remove Iteration permissions.

Configuration Example
{

    Import-DscResource -ModuleName 'AzureDevOpsDscNative'

    node localhost
    {
        AzDoIterationPermission 'DeleteIterationPathPermission'
        {
            Ensure               = 'Present'
            ProjectName          = 'Test Project'
            IterationPath             = '\Test Iteration\Sub Iteration'
            isInherited          = $false
            # Note: Permissions can be empty to remove all permissions
            # Ensure = 'Absent' is not required.
            # Please note that by setting isInherited to $true, the permissions will be inherited from the parent Iteration path.
            # If you want to remove all permissions, you can set isInherited to $false and provide an empty Permissions array.
            Permissions          = @()
        }
    }
}