AzureDevOpsDscNative

1.1.0-preview2

en-US/about_AzDoAgentPoolPermission.help.txt

.NAME
    AzDoAgentPoolPermission
 
.SYNOPSIS
    DSC resource for managing Azure DevOps agent pool permissions.
 
.DESCRIPTION
    This resource manages security permissions on Azure DevOps agent pools, controlling which
    groups or users can use or administer the pool.
 
.PARAMETER PoolName
    Key - System.String
    The name of the agent pool. This property is mandatory and serves as the 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. Defaults to $true.
 
.PARAMETER Permissions
    Write - HashTable[]
 
.EXAMPLE 1
 
This example shows how to grant permissions on an agent pool.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAgentPoolPermission 'AddAgentPoolPermission'
        {
            Ensure = 'Present'
            PoolName = 'MyPool'
            GroupName = 'MyGroup'
            isInherited = $true
            Permissions = @(
                @{ Permission = 'Use'; Access = 'Allow' }
            )
        }
    }
}
 
.EXAMPLE 2
 
This example shows how to update permissions on an agent pool.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAgentPoolPermission 'UpdateAgentPoolPermission'
        {
            Ensure = 'Present'
            PoolName = 'MyPool'
            GroupName = 'MyGroup'
            isInherited = $false
            Permissions = @(
                @{ Permission = 'Use'; Access = 'Allow' }
                @{ Permission = 'Administer'; Access = 'Deny' }
            )
        }
    }
}
 
.EXAMPLE 3
 
This example shows how to remove permissions on an agent pool.
 
Configuration Example
{
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
 
    node localhost
    {
        AzDoAgentPoolPermission 'RemoveAgentPoolPermission'
        {
            Ensure = 'Absent'
            PoolName = 'MyPool'
            GroupName = 'MyGroup'
            isInherited = $true
        }
    }
}