Edit

Remove-AzPortalDashboard

  • Reference
Module:
Az.Portal

Deletes the Dashboard.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Remove-AzPortalDashboard
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Remove-AzPortalDashboard
      -InputObject <IPortalIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Deletes the Dashboard.

Examples

Example 1: Remove a Dashboard

Remove-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02

Remove a Dashbaord using resource group name and dashboard name.

Example 2: Remove a Dashboard using the pipeline

Get-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02 | Remove-AzPortalDashboard

Remove the dashboard returned from a Get-AzDashboard call.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IPortalIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

The name of the dashboard.

Type:String
Aliases:DashboardName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

The name of the resource group.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IPortalIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IPortalIdentity>: Identity Parameter

  • [DashboardName <String>]: The name of the dashboard.
  • [Id <String>]: Resource identity path
  • [ResourceGroupName <String>]: The name of the resource group.
  • [SubscriptionId <String>]: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)