Functions/Public/Disable-AMObject.ps1
|
function Disable-AMObject { <# .SYNOPSIS Disables an Automate object. .DESCRIPTION Disable-AMObject receives Automate object(s) on the pipeline, or via the parameter $InputObject, and disables the object(s). .PARAMETER InputObject The object(s) to be disabled. .INPUTS The following objects can be disabled by this function: Workflow Task Condition Process TaskAgent ProcessAgent AgentGroup User UserGroup .OUTPUTS None .EXAMPLE Get-AMWorkflow "My Workflow" | Disable-AMObject .LINK https://github.com/AutomatePS/AutomatePS/blob/master/Docs/Disable-AMObject.md #> [CmdletBinding()] [Alias("Disable-AMAgent")] [Alias("Disable-AMAgentGroup")] [Alias("Disable-AMCondition")] [Alias("Disable-AMProcess")] [Alias("Disable-AMTask")] [Alias("Disable-AMUser")] [Alias("Disable-AMUserGroup")] [Alias("Disable-AMWorkflow")] param ( [Parameter(ValueFromPipeline = $true, Mandatory = $true)] [ValidateNotNullOrEmpty()] $InputObject ) PROCESS { # Loop through all objects on the pipeline foreach ($obj in $InputObject) { if ($obj.Type -notin @("Workflow","Task","Condition","Process","Agent","AgentGroup","User","UserGroup")) { Write-Error -Message "Unsupported input type '$($obj.Type)' encountered!" -TargetObject $obj } # If object isn't already disabled, disable it if ($obj.Enabled) { Write-Verbose "Disabling $($obj.Type) '$($obj.Name)'" Invoke-AMRestMethod -Resource "$([AMTypeDictionary]::($obj.Type).RestResource)/$($obj.ID)/disable" -RestMethod Post -Connection $obj.ConnectionAlias | Out-Null } else { Write-Verbose "$($obj.Type) '$($obj.Name)' already disabled" } } } } |