Skip to content

Remove GrafanaDashboard

Stephen Valdinger edited this page Apr 9, 2019 · 2 revisions

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

Remove-GrafanaDashboard

SYNOPSIS

Remove a Grafana Dashboard via the API

SYNTAX

Default (Default)

Remove-GrafanaDashboard [-Dashboard] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

Pipeline

Remove-GrafanaDashboard -InputObject <PSObject> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet exposes the API to delete a dashboard out of Grafana

EXAMPLES

EXAMPLE 1

Remove-GrafanaDashboard -Name FancyDash

EXAMPLE 2

Get-GrafanaDashboard -Name FancyDash | Remove-GrafanaDashboard

EXAMPLE 3

Remove-GrafanaDashbaord -Name WebFarmDev -Confirm:$false

PARAMETERS

-Dashboard

The friendly name of the Dashbaord to remove.

Type: String
Parameter Sets: Default
Aliases: Name

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

-InputObject

{{ Fill InputObject Description }}

Type: PSObject
Parameter Sets: Pipeline
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

RELATED LINKS

Get-GrafanaDashboard, Set-GrafanaDashboard

Clone this wiki locally