en-US/about_AzDoAgentPool.help.txt
|
.NAME
AzDoAgentPool .SYNOPSIS DSC resource for managing Azure DevOps agent pools. .DESCRIPTION This resource manages Azure DevOps agent pools at the organization level. Agent pools provide the infrastructure for running pipeline jobs. Pools can be shared across multiple projects. .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 PoolType Write - System.String Allowed values: automation, deployment The type of agent pool. Valid values are automation and deployment. Defaults to automation. .PARAMETER AutoProvision Write - System.Boolean Whether to automatically provision the agent pool to new projects. Defaults to $false. .PARAMETER AutoUpdate Write - System.Boolean Whether to automatically update agents in the pool. Defaults to $true. .PARAMETER IsHosted Write - System.Boolean Whether the pool is a Microsoft-hosted pool. Microsoft-hosted pools cannot be created or removed through this resource, so this is only meaningful when reading existing pools. Defaults to $false. .EXAMPLE 1 Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoAgentPool 'AddAgentPool' { Ensure='Present'; PoolName='MyAgentPool'; PoolType='automation'; AutoProvision=$false; AutoUpdate=$true } } } .EXAMPLE 2 Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoAgentPool 'UpdateAgentPool' { Ensure='Present'; PoolName='MyAgentPool'; PoolType='automation'; AutoProvision=$true; AutoUpdate=$true } } } .EXAMPLE 3 Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoAgentPool 'RemoveAgentPool' { Ensure='Absent'; PoolName='MyAgentPool' } } } |