AzureDevOpsDscNative

1.0.0-preview4

en-US/about_AzDoAgentPoolPermission.help.txt

.NAME
    AzDoAgentPoolPermission
 
.SYNOPSIS
    DSC resource for managing Azure DevOps agent pool permissions.
 
.DESCRIPTION
 
 
.PARAMETER PoolName
    Key - System.String
 
.PARAMETER GroupName
    Required - System.String
 
.PARAMETER isInherited
    Write - System.Boolean
 
.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
        }
    }
}