Get GrafanaFolder

---

external help file: PSGrafana-help.xml Module Name: PSGrafana online version: schema: 2.0.0

Get-GrafanaFolder

SYNOPSIS

Retrieve folder information from Grafana via the API

SYNTAX

All (Default)

Get-GrafanaFolder [-All] [<CommonParameters>]

Uid

Get-GrafanaFolder [-Uid <String>] [<CommonParameters>]

Id

Get-GrafanaFolder [-Id <Int32>] [<CommonParameters>]

DESCRIPTION

You can search for Grafana folders via the API with this cmdlet. You may search via Uid,Id, or return All folders

EXAMPLES

EXAMPLE 1

Get-GrafanaFolder

Returns all folders which the user has access to in Grafana.

EXAMPLE 2

Get-GrafanaFolder -Uid Ax8x33

Returns the information for the folder with the Uid you entered

EXAMPLE 3

Get-GrafanaFolder -Id 3

Returns the information for the folder with the specified ID

PARAMETERS

-Uid

The UID value of a folder you wish to search for. This is an alphanumeric value

Type: String
Parameter Sets: Uid
Aliases:

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

-Id

This is the ID of the folder you wish to search for. This is an int value

Type: Int32
Parameter Sets: Id
Aliases:

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

-All

Return all folders which you have access too.

Type: SwitchParameter
Parameter Sets: All
Aliases:

Required: False
Position: Named
Default value: False
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

RELATED LINKS

New-GrafanaFolder