functions/generated/TaskAgent/Remove-AdsDistributedtaskPoolAgent.ps1
|
function Remove-AdsDistributedtaskPoolAgent { <# .SYNOPSIS .DESCRIPTION Delete an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove an agent from your organization. .PARAMETER Organization The name of the Azure DevOps organization. .PARAMETER PoolId The pool ID to remove the agent from .PARAMETER AgentId The agent ID to remove .PARAMETER ApiVersion Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api. .EXAMPLE PS C:\> Remove-AdsDistributedtaskPoolAgent -Organization $organization -PoolId $poolid -AgentId $agentid -ApiVersion $apiversion Delete an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove an agent from your organization. .LINK <unknown> #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Organization, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $PoolId, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $AgentId, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $ApiVersion ) process { $__mapping = @{ 'ApiVersion' = 'api-version' } $__body = $PSBoundParameters | ConvertTo-Hashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-Hashtable -Include @('ApiVersion') -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-Hashtable -Include @() -Mapping $__mapping $__path = 'https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId}' -Replace '{organization}',$Organization -Replace '{poolId}',$PoolId -Replace '{agentId}',$AgentId Invoke-RestRequest -Path $__path -Method delete -Body $__body -Query $__query -Header $__header } } |