RAps

1.0.3

Functions/Groups/Edit-RAGroup.ps1

function Edit-RAGroup {
    [CmdletBinding(
        SupportsShouldProcess,
        ConfirmImpact = 'Low'
    )]
    [OutputType([string])]
    param (

        [Parameter(
            Mandatory,
            HelpMessage = 'The unique ID of the VendorLDAP group.'
        )]
        [string]$GroupId,

        [Parameter(
            Mandatory,
            HelpMessage = 'The description of the VendorLDAP group'
        )]
        [string]$Description
    )

    begin {

    }

    process {
        $restBody = @{
            'Uri'         = "https://$($Script:ApiURL)/v2-edge/groups/$GroupId"
            'Body'        = $Description
            'ContentType' = $Script:ContentType
            'Method'      = 'Put'
            'WebSession'  = $Script:WebSession
        }
        if ($PSCmdlet.ShouldProcess("GroupId: $GroupId", 'Change description')) {
            $result = Invoke-RestMethod @restBody
        }
    }

    end {
        Write-Output -InputObject $result
    }
}