New-AzPortalDashboard

• Preview

Module:

Az.Portal Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

create a Dashboard.

New-AzPortalDashboard
 -Name <String>
 -ResourceGroupName <String>
 -Location <String>
 [-SubscriptionId <String>]
 [-Lens <IDashboardLens[]>]
 [-Metadata <Hashtable>]
 [-Tag <Hashtable>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

New-AzPortalDashboard
 -Name <String>
 -ResourceGroupName <String>
 -Resource <IDashboard>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

New-AzPortalDashboard
 -Name <String>
 -ResourceGroupName <String>
 -JsonFilePath <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

New-AzPortalDashboard
 -Name <String>
 -ResourceGroupName <String>
 -JsonString <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

New-AzPortalDashboard
 -Name <String>
 -ResourceGroupName <String>
 -DashboardPath <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

create 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.

$SubscriptionId = (Get-AzContext).Subscription.Id
$ResourceGroupName = 'mydash-rg'
$DashboardName = 'my-dashboard03'
$DashboardPath = ".\resources\dash1.json"
$Location = "East US"
$ApiVersion = "2022-12-01-preview"
$Dashboard = Get-Content -Path $DashboardPath -Raw | ConvertFrom-Json
$Payload = @{
 properties = $Dashboard.properties
 location = $Location
} | ConvertTo-Json -Depth 10
Invoke-AzRestMethod -SubscriptionId $SubscriptionId -ResourceGroupName $ResourceGroupName -ResourceProviderName "Microsoft.Portal" -ResourceType "dashboards" -Name $DashboardName -ApiVersion $ApiVersion -Method PUT -Payload $Payload

StatusCode : 200
Content : {"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mydash-rg/providers/Microsoft.Portal/dashboards/my-dashboard03","name":"my-dashboard03","type":"Microsoft.Portal/dashboards","location":"East US","properties":{...}}
Headers : {[Content-Length, 1234], [Content-Type, application/json; charset=utf-8], [Date, Wed, 01 Jan 2025 00:00:00 GMT]}

Use this workaround when New-AzPortalDashboard succeeds but the dashboard fails to render with "Dashboard not found" error. This issue is with the underlying REST API and this method provides a reliable alternative.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.