Public/Set-LMAccessGroup.ps1
|
<# .SYNOPSIS Sets the properties of a LogicMonitor access group. .DESCRIPTION The Set-LMAccessGroup function is used to set the properties of a LogicMonitor access group. It allows you to specify the access group either by its ID or by its name. You can set the new name, description, and tenant ID for the access group. .PARAMETER Id Specifies the ID of the access group. This parameter is used when you want to set the properties of the access group by its ID. .PARAMETER Name Specifies the name of the access group. This parameter is used when you want to set the properties of the access group by its name. .PARAMETER NewName Specifies the new name for the access group. .PARAMETER Description Specifies the new description for the access group. .PARAMETER Tenant Specifies the tenant ID for the access group. .EXAMPLE Set-LMAccessGroup -Id 123 -NewName "New Access Group" -Description "This is a new access group" -Tenant "abc123" Sets the properties of the access group with ID 123. The new name is set to "New Access Group", the description is set to "This is a new access group", and the tenant ID is set to "abc123". .EXAMPLE Set-LMAccessGroup -Name "Old Access Group" -NewName "New Access Group" -Description "This is a new access group" -Tenant "abc123" Sets the properties of the access group with name "Old Access Group". The new name is set to "New Access Group", the description is set to "This is a new access group", and the tenant ID is set to "abc123". .NOTES This function requires you to be logged in and have valid API credentials. Use the Connect-LMAccount function to log in before running this command. #> Function Set-LMAccessGroup { [CmdletBinding()] Param ( [Parameter(ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] [Int]$Id, [Parameter(ParameterSetName = 'Name')] [String]$Name, [String]$NewName, [String]$Description, [String]$Tenant ) #Check if we are logged in and have valid api creds Begin {} Process { If ($Script:LMAuth.Valid) { #Lookup Group Id If ($Name) { $LookupResult = (Get-LMAccessGroup -Name $Name).Id If (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } If($PSItem){ $Message = "Id: $Id | Name: $($PSItem.name) | Description: $($PSItem.description)" } ElseIf($Name){ $Message = "Id: $Id | Name: $Name)" } Else{ $Message = "Id: $Id" } #Build header and uri $ResourcePath = "/setting/accessgroup/$Id" Try { $Data = @{ description = $Description name = $NewName tenantId = $Tenant } #Remove empty keys so we dont overwrite them @($Data.keys) | ForEach-Object { if ([string]::IsNullOrEmpty($Data[$_]) -and ($_ -notin @($MyInvocation.BoundParameters.Keys))) { $Data.Remove($_) } } $Data = ($Data | ConvertTo-Json) If ($PSCmdlet.ShouldProcess($Message, "Set AccessGroup")) { $Headers = New-LMHeader -Auth $Script:LMAuth -Method "PATCH" -ResourcePath $ResourcePath -Data $Data $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation -Payload $Data #Issue request $Response = Invoke-RestMethod -Uri $Uri -Method "PATCH" -Headers $Headers[0] -WebSession $Headers[1] -Body $Data Return (Add-ObjectTypeInfo -InputObject $Response -TypeName "LogicMonitor.AccessGroup" ) } } Catch [Exception] { $Proceed = Resolve-LMException -LMException $PSItem If (!$Proceed) { Return } } } Else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } End {} } |