Public/New-LMAccessGroup.ps1
|
<# .SYNOPSIS Creates a new LogicMonitor access group. .DESCRIPTION The New-LMAccessGroup function is used to create a new access group in LogicMonitor. An access group is a collection of users with similar permissions and access rights for managing modules in the LM exchange and my module toolbox. .PARAMETER Name The name of the access group. This parameter is mandatory. .PARAMETER Description The description of the access group. .PARAMETER Tenant The ID of the tenant to which the access group belongs. .EXAMPLE New-LMAccessGroup -Name "Group1" -Description "Access group for administrators" -Tenant "12345" This example creates a new access group named "Group1" with the description "Access group for administrators" and assigns it to the tenant with ID "12345". .NOTES For this function to work, you need to be logged in and have valid API credentials. Use the Connect-LMAccount function to log in before running any commands. #> Function New-LMAccessGroup { [CmdletBinding()] Param ( [Parameter(Mandatory)] [String]$Name, [String]$Description, [String]$Tenant ) #Check if we are logged in and have valid api creds Begin {} Process { If ($Script:LMAuth.Valid) { #Build header and uri $ResourcePath = "/setting/accessgroup/add" Try { $Data = @{ description = $Description name = $Name tenantId = $Tenant } #Remove empty keys so we dont overwrite them @($Data.keys) | ForEach-Object { if ([string]::IsNullOrEmpty($Data[$_])) { $Data.Remove($_) } } $Data = ($Data | ConvertTo-Json) $Headers = New-LMHeader -Auth $Script:LMAuth -Method "POST" -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 "POST" -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 {} } |