Functions/Platforms/Enable-PASPlatform.ps1
|
Function Enable-PASPlatform { <# .SYNOPSIS Activates a platform. .DESCRIPTION Enables, target, group or rotational group platform. .PARAMETER TargetPlatform Specify if ID relates to Target platform .PARAMETER GroupPlatform Specify if ID relates to Group platform .PARAMETER RotationalGroup Specify if ID relates to Rotational Group platform .PARAMETER ID The unique ID number of the platofrm to enable. .EXAMPLE Enable-PASPlatform -TargetPlatform -ID 53 Enables Target Platform with ID of 53 .EXAMPLE Enable-PASPlatform -GroupPlatform -id 64 Enables Group Platform with ID of 64 .EXAMPLE Enable-PASPlatform -RotationalGroup -id 65 Enables Rotational Group Platform with ID of 65 .NOTES PAS 11.4 minimum .LINK https://pspas.pspete.dev/commands/Enable-PASPlatform #> [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'TargetPlatform', Justification = "False Positive")] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'GroupPlatform', Justification = "False Positive")] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'RotationalGroup', Justification = "False Positive")] [CmdletBinding(SupportsShouldProcess)] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = "targets" )] [switch]$TargetPlatform, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = "groups" )] [switch]$GroupPlatform, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = "rotationalGroups" )] [switch]$RotationalGroup, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [int]$ID ) BEGIN { Assert-VersionRequirement -RequiredVersion 11.4 }#begin Process { #Create URL for request $URI = "$Script:BaseURI/api/platforms/$($PSCmdLet.ParameterSetName)/$ID/activate" if ($PSCmdlet.ShouldProcess($ID, "Activate $($PSCmdLet.ParameterSetName) Platform")) { #send request to web service Invoke-PASRestMethod -Uri $URI -Method POST -WebSession $Script:WebSession } } } |