Public/Set-MITFolder.ps1
|
function Set-MITFolder { <# .SYNOPSIS Change a MOVEit Transfer Folder .LINK Partial Folder update https://docs.ipswitch.com/MOVEit/Transfer2021/Api/Rest/#operation/PATCHapi/v1/folders/{Id}-1.0 #> [CmdletBinding()] param ( [Parameter(Mandatory=$true, Position=0, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('Id')] [string]$FolderId, [Parameter()] [ValidateNotNullOrEmpty()] [string]$Name, [Parameter()] [string]$Description, [Parameter()] [bool]$InheritAccess ) try { # Confirm the token, refreshing if necessary Confirm-MITToken # Set the Uri for this request $uri = "$script:BaseUri/folders/$FolderId" # Set the request headers $headers = @{ Accept = "application/json" Authorization = "Bearer $($script:Token.AccessToken)" } # Build the request body. $body = @{} switch ($PSBoundParameters.Keys) { Name { $body['name'] = $Name } Description { $body['description'] = $Description } InheritAccess { $body['inheritAccess'] = $InheritAccess } } # Setup the params to splat to IRM $irmParams = @{ Uri = $uri Method = 'Patch' Headers = $headers ContentType = 'application/json' Body = ($body | ConvertTo-Json) } # Send the request and output the response $response = Invoke-RestMethod @irmParams $response | Write-MITResponse -TypeName 'MITFolderSimple' } catch { $PSCmdlet.ThrowTerminatingError($PSItem) } } |