Skip to content

Remove GrafanaSnapshot

Stephen Valdinger edited this page Apr 8, 2019 · 1 revision

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

Remove-GrafanaSnapshot

SYNOPSIS

Remove a Grafana snapshot via the API

SYNTAX

Remove-GrafanaSnapshot [-SnapshotName] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Grafana exposes an endpoint to delete snapshots. This cmdlet leverages that endpoint to let you remove them programmatically

EXAMPLES

EXAMPLE 1

Remove-GrafanaSnapshot -SnapshotName SnappyMcSnapshoterson

PARAMETERS

-SnapshotName

The friendly name of the snapshot you wish to remove

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
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

New-GrafanaSnapshot, Get-GrafanaSnapshot

Clone this wiki locally