external help file | Module Name | online version | schema |
---|---|---|---|
Az.Portal-help.xml |
Az.Portal |
2.0.0 |
Creates or updates a Dashboard.
New-AzPortalDashboard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>] -Location <String>
[-Lens <Hashtable>] [-Metadata <Hashtable>] [-Tag <Hashtable>] [-DefaultProfile <PSObject>]
[-WhatIf] [-Confirm] [<CommonParameters>]
New-AzPortalDashboard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>]
-Dashboard <IDashboard> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-AzPortalDashboard -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>]
-DashboardPath <String> [-DefaultProfile <PSObject>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Creates or updates a Dashboard.
New-AzPortalDashboard -DashboardPath .\resources\dash1.json -ResourceGroupName mydash-rg -DashboardName my-dashboard03
Location Name Type
-------- ---- ----
eastasia my-dashboard03 Microsoft.Portal/dashboards
Create a new dashboard using the provided dashboard template file.
The shared dashboard resource definition. To construct, see NOTES section for DASHBOARD properties and create a hash table.
Type: Microsoft.Azure.PowerShell.Cmdlets.Portal.Models.Api201901Preview.IDashboard
Parameter Sets: Create
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
The Path to an existing dashboard template. Dashboard templates may be downloaded from the portal.
Type: System.String
Parameter Sets: CreateByFile
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The dashboard lenses.
Type: System.Collections.Hashtable
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Resource location
Type: System.String
Parameter Sets: CreateExpanded
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The dashboard metadata.
Type: System.Collections.Hashtable
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The name of the dashboard.
Type: System.String
Parameter Sets: (All)
Aliases: DashboardName
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The name of the resource group.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False
Resource tags
Type: System.Collections.Hashtable
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.