AzureDevOpsDscNative

1.1.0-preview2

en-US/about_AzDoAgentQueue.help.txt

.NAME
    AzDoAgentQueue
 
.SYNOPSIS
    DSC resource for managing Azure DevOps agent queues.
 
.DESCRIPTION
    This resource manages agent queues within Azure DevOps projects. An agent queue is the project-
    level reference to an organization-level agent pool, allowing pipelines in the project to use
    that pool.
 
.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 QueueName
    Required - System.String
    The name of the agent queue within the project. This is a key property.
 
.PARAMETER PoolName
    Required - System.String
    The name of the agent pool that backs this queue. This is a mandatory property.
 
.PARAMETER AuthorizeAllPipelines
    Write - System.Boolean
    Whether every pipeline in the project is granted access to the queue without an explicit
    authorization prompt. Defaults to $false.
 
.EXAMPLE 1
 
 
Configuration Example {
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
    node localhost {
        AzDoAgentQueue 'AddAgentQueue' { Ensure='Present'; ProjectName='MyProject'; QueueName='MyQueue'; PoolName='MyAgentPool' }
    }
}
 
.EXAMPLE 2
 
 
Configuration Example {
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
    node localhost {
        AzDoAgentQueue 'UpdateAgentQueue' { Ensure='Present'; ProjectName='MyProject'; QueueName='MyQueue'; PoolName='MyAgentPool'; AuthorizeAllPipelines=$true }
    }
}
 
.EXAMPLE 3
 
 
Configuration Example {
    Import-DscResource -ModuleName 'AzureDevOpsDscNative'
    node localhost {
        AzDoAgentQueue 'RemoveAgentQueue' { Ensure='Absent'; ProjectName='MyProject'; QueueName='MyQueue'; PoolName='MyAgentPool' }
    }
}