Skip to content

Latest commit

 

History

History
154 lines (121 loc) · 3.44 KB

Get-LMAccessGroup.md

File metadata and controls

154 lines (121 loc) · 3.44 KB
external help file Module Name online version schema
Logic.Monitor-help.xml
Logic.Monitor
2.0.0

Get-LMAccessGroup

SYNOPSIS

Retrieves LogicMonitor access groups based on specified parameters.

SYNTAX

All (Default)

Get-LMAccessGroup [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id

Get-LMAccessGroup [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name

Get-LMAccessGroup [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Filter

Get-LMAccessGroup [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

The Get-LMAccessGroup function retrieves LogicMonitor access groups based on the specified parameters. It supports retrieving access groups by ID, name, or using a filter. The function uses the LogicMonitor REST API to make the requests.

EXAMPLES

EXAMPLE 1

Get-LMAccessGroup -Id 123
Retrieves the access group with the specified ID.

EXAMPLE 2

Get-LMAccessGroup -Name "MyAccessGroup"
Retrieves the access group with the specified name.

EXAMPLE 3

Get-LMAccessGroup -Filter "tenantId -eq 'Value'"
Retrieves access groups based on the specified filter criteria.

PARAMETERS

-Id

Specifies the ID of the access group to retrieve. This parameter is mutually exclusive with the Name and Filter parameters.

Type: Int32
Parameter Sets: Id
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the access group to retrieve. This parameter is mutually exclusive with the Id and Filter parameters.

Type: String
Parameter Sets: Name
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Specifies a filter object to retrieve access groups based on custom filter criteria. This parameter is mutually exclusive with the Id and Name parameters.

Type: Object
Parameter Sets: Filter
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BatchSize

Specifies the number of access groups to retrieve per request. The default value is 1000.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

This function requires a valid LogicMonitor API authentication. Use Connect-LMAccount to authenticate before running this function.

RELATED LINKS