Public/Remove-ArmorCompleteWorkload.ps1
|
function Remove-ArmorCompleteWorkload { <# .SYNOPSIS This cmdlet deletes Armor Complete workloads. .DESCRIPTION The specified workload in the Armor Complete account in context will be deleted if is empty. .INPUTS UInt16 PSCustomObject .NOTES Troy Lindsay Twitter: @troylindsay42 GitHub: tlindsay42 .EXAMPLE {required: show one or more examples using the function} .LINK http://armorpowershell.readthedocs.io/en/latest/cmd_remove.html#remove-armorcompleteworkload .LINK https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Remove-ArmorCompleteWorkload.ps1 .LINK https://docs.armor.com/display/KBSS/Delete+Workload .LINK https://developer.armor.com/#!/Infrastructure/App_DeleteApp #> [CmdletBinding( SupportsShouldProcess = $true, ConfirmImpact = 'High' )] [OutputType( [ArmorCompleteWorkload[]] )] [OutputType( [ArmorCompleteWorkload] )] param ( <# Specifies the ID of the Armor Complete workload. #> [Parameter( Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [ValidateRange( 1, 65535 )] [UInt16] $ID, <# Specifies the API version for this request. #> [Parameter( Position = 1 )] [ValidateSet( 'v1.0' )] [String] $ApiVersion = $Global:ArmorSession.ApiVersion ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message "Beginning: '${function}'." Test-ArmorSession } # End of begin process { [ArmorCompleteWorkload[]] $return = $null $resources = Get-ArmorApiData -FunctionName $function -ApiVersion $ApiVersion if ( $PSCmdlet.ShouldProcess( $ID, $resources.Description ) ) { $uri = New-ArmorApiUri -Endpoints $resources.Endpoints -IDs $ID $keys = ( $resources.Body | Get-Member -MemberType 'NoteProperty' ).Name $parameters = ( Get-Command -Name $function ).Parameters.Values $body = Format-ArmorApiRequestBody -Keys $keys -Parameters $parameters -Method $resources.Method $splat = @{ 'Uri' = $uri 'Method' = $resources.Method 'Body' = $body 'SuccessCode' = $resources.SuccessCode 'Description' = $resources.Description } $results = Submit-ArmorApiRequest @splat $return = $results } $return } # End of process end { Write-Verbose -Message "Ending: '${function}'." } # End of end } # End of function |