We recommend using Azure Native.
Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
azure.dashboard.azurerm_portal_dashboard
Explore with Pulumi AI
Deprecated: azure.dashboard/azurerm_portal_dashboard.azurerm_portal_dashboard has been deprecated in favor of azure.portal/azurerm_portal_dashboard.azurerm_portal_dashboard
Use this data source to access information about an existing shared dashboard in the Azure Portal. This is the data source of the azurerm_dashboard resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.portal.azurerm_portal_dashboard({
    name: "existing-dashboard",
    resourceGroupName: "dashboard-rg",
});
export const id = exampleAzurermDashboard.id;
import pulumi
import pulumi_azure as azure
example = azure.portal.azurerm_portal_dashboard(name="existing-dashboard",
    resource_group_name="dashboard-rg")
pulumi.export("id", example_azurerm_dashboard["id"])
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/portal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := portal.Azurerm_portal_dashboard(ctx, &portal.Azurerm_portal_dashboardArgs{
			Name:              pulumi.StringRef("existing-dashboard"),
			ResourceGroupName: "dashboard-rg",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", exampleAzurermDashboard.Id)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = Azure.Portal.Azurerm_portal_dashboard.Invoke(new()
    {
        Name = "existing-dashboard",
        ResourceGroupName = "dashboard-rg",
    });
    return new Dictionary<string, object?>
    {
        ["id"] = exampleAzurermDashboard.Id,
    };
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.portal.PortalFunctions;
import com.pulumi.azure.portal.inputs.Azurerm_portal_dashboardArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = PortalFunctions.azurerm_portal_dashboard(Azurerm_portal_dashboardArgs.builder()
            .name("existing-dashboard")
            .resourceGroupName("dashboard-rg")
            .build());
        ctx.export("id", exampleAzurermDashboard.id());
    }
}
variables:
  example:
    fn::invoke:
      function: azure:portal:azurerm_portal_dashboard
      arguments:
        name: existing-dashboard
        resourceGroupName: dashboard-rg
outputs:
  id: ${exampleAzurermDashboard.id}
Using azurerm_portal_dashboard
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function azurerm_portal_dashboard(args: Azurerm_portal_dashboardArgs, opts?: InvokeOptions): Promise<Azurerm_portal_dashboardResult>
function azurerm_portal_dashboardOutput(args: Azurerm_portal_dashboardOutputArgs, opts?: InvokeOptions): Output<Azurerm_portal_dashboardResult>def azurerm_portal_dashboard(dashboard_properties: Optional[str] = None,
                             display_name: Optional[str] = None,
                             name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> Azurerm_portal_dashboardResult
def azurerm_portal_dashboard_output(dashboard_properties: Optional[pulumi.Input[str]] = None,
                             display_name: Optional[pulumi.Input[str]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[Azurerm_portal_dashboardResult]func Azurerm_portal_dashboard(ctx *Context, args *Azurerm_portal_dashboardArgs, opts ...InvokeOption) (*Azurerm_portal_dashboardResult, error)
func Azurerm_portal_dashboardOutput(ctx *Context, args *Azurerm_portal_dashboardOutputArgs, opts ...InvokeOption) Azurerm_portal_dashboardResultOutput> Note: This function is named Azurerm_portal_dashboard in the Go SDK.
public static class Azurerm_portal_dashboard 
{
    public static Task<Azurerm_portal_dashboardResult> InvokeAsync(Azurerm_portal_dashboardArgs args, InvokeOptions? opts = null)
    public static Output<Azurerm_portal_dashboardResult> Invoke(Azurerm_portal_dashboardInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<Azurerm_portal_dashboardResult> azurerm_portal_dashboard(Azurerm_portal_dashboardArgs args, InvokeOptions options)
public static Output<Azurerm_portal_dashboardResult> azurerm_portal_dashboard(Azurerm_portal_dashboardArgs args, InvokeOptions options)
fn::invoke:
  function: azure:dashboard/azurerm_portal_dashboard:azurerm_portal_dashboard
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ResourceGroup stringName 
- Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- DashboardProperties string
- JSON data representing dashboard body.
- DisplayName string
- Specifies the display name of the shared Azure Portal Dashboard.
- Name string
- Specifies the name of the shared Azure Portal Dashboard.
- ResourceGroup stringName 
- Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- DashboardProperties string
- JSON data representing dashboard body.
- DisplayName string
- Specifies the display name of the shared Azure Portal Dashboard.
- Name string
- Specifies the name of the shared Azure Portal Dashboard.
- resourceGroup StringName 
- Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- dashboardProperties String
- JSON data representing dashboard body.
- displayName String
- Specifies the display name of the shared Azure Portal Dashboard.
- name String
- Specifies the name of the shared Azure Portal Dashboard.
- resourceGroup stringName 
- Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- dashboardProperties string
- JSON data representing dashboard body.
- displayName string
- Specifies the display name of the shared Azure Portal Dashboard.
- name string
- Specifies the name of the shared Azure Portal Dashboard.
- resource_group_ strname 
- Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- dashboard_properties str
- JSON data representing dashboard body.
- display_name str
- Specifies the display name of the shared Azure Portal Dashboard.
- name str
- Specifies the name of the shared Azure Portal Dashboard.
- resourceGroup StringName 
- Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- dashboardProperties String
- JSON data representing dashboard body.
- displayName String
- Specifies the display name of the shared Azure Portal Dashboard.
- name String
- Specifies the name of the shared Azure Portal Dashboard.
azurerm_portal_dashboard Result
The following output properties are available:
- DashboardProperties string
- JSON data representing dashboard body.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The Azure Region where the shared Azure Portal dashboard exists.
- ResourceGroup stringName 
- Dictionary<string, string>
- A mapping of tags assigned to the shared Azure Portal dashboard.
- DisplayName string
- Name string
- DashboardProperties string
- JSON data representing dashboard body.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The Azure Region where the shared Azure Portal dashboard exists.
- ResourceGroup stringName 
- map[string]string
- A mapping of tags assigned to the shared Azure Portal dashboard.
- DisplayName string
- Name string
- dashboardProperties String
- JSON data representing dashboard body.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The Azure Region where the shared Azure Portal dashboard exists.
- resourceGroup StringName 
- Map<String,String>
- A mapping of tags assigned to the shared Azure Portal dashboard.
- displayName String
- name String
- dashboardProperties string
- JSON data representing dashboard body.
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- The Azure Region where the shared Azure Portal dashboard exists.
- resourceGroup stringName 
- {[key: string]: string}
- A mapping of tags assigned to the shared Azure Portal dashboard.
- displayName string
- name string
- dashboard_properties str
- JSON data representing dashboard body.
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- The Azure Region where the shared Azure Portal dashboard exists.
- resource_group_ strname 
- Mapping[str, str]
- A mapping of tags assigned to the shared Azure Portal dashboard.
- display_name str
- name str
- dashboardProperties String
- JSON data representing dashboard body.
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The Azure Region where the shared Azure Portal dashboard exists.
- resourceGroup StringName 
- Map<String>
- A mapping of tags assigned to the shared Azure Portal dashboard.
- displayName String
- name String
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.