1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. dashboard
  6. azurerm_portal_dashboard

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.dashboard.azurerm_portal_dashboard

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Use this data source to access information about an existing shared dashboard in the Azure Portal. This is the data source of the azure.dashboard.Dashboard resource.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Dashboard.Azurerm_portal_dashboard.InvokeAsync(new Azure.Dashboard.Azurerm_portal_dashboardArgs
        {
            Name = "existing-dashboard",
            ResourceGroupName = "dashboard-rg",
        }));
        this.Id = data.Azurerm_dashboard.Example.Id;
    }

    [Output("id")]
    public Output<string> Id { get; set; }
}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/dashboard"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dashboard.Azurerm_portal_dashboard(ctx, &dashboard.Azurerm_portal_dashboardArgs{
			Name:              "existing-dashboard",
			ResourceGroupName: "dashboard-rg",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", data.Azurerm_dashboard.Example.Id)
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.dashboard.azurerm_portal_dashboard({
    name: "existing-dashboard",
    resourceGroupName: "dashboard-rg",
});
export const id = data.azurerm_dashboard.example.id;

    import pulumi
import pulumi_azure as azure

example = azure.dashboard.azurerm_portal_dashboard(name="existing-dashboard",
    resource_group_name="dashboard-rg")
pulumi.export("id", data["azurerm_dashboard"]["example"]["id"])

    Example coming soon!

    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,
                             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,
                             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 dictionary

    The following arguments are supported:

    Name string
    Specifies the name of the shared Azure Portal Dashboard.
    ResourceGroupName string
    Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
    DashboardProperties string
    JSON data representing dashboard body.
    Name string
    Specifies the name of the shared Azure Portal Dashboard.
    ResourceGroupName string
    Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
    DashboardProperties string
    JSON data representing dashboard body.
    name String
    Specifies the name of the shared Azure Portal Dashboard.
    resourceGroupName String
    Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
    dashboardProperties String
    JSON data representing dashboard body.
    name string
    Specifies the name of the shared Azure Portal Dashboard.
    resourceGroupName string
    Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
    dashboardProperties string
    JSON data representing dashboard body.
    name str
    Specifies the name of the shared Azure Portal Dashboard.
    resource_group_name str
    Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
    dashboard_properties str
    JSON data representing dashboard body.
    name String
    Specifies the name of the shared Azure Portal Dashboard.
    resourceGroupName String
    Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
    dashboardProperties String
    JSON data representing dashboard body.

    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.
    Name string
    ResourceGroupName string
    Tags Dictionary<string, string>
    A mapping of tags assigned to the shared Azure Portal dashboard.
    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.
    Name string
    ResourceGroupName string
    Tags map[string]string
    A mapping of tags assigned to the shared Azure Portal dashboard.
    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.
    name String
    resourceGroupName String
    tags Map<String,String>
    A mapping of tags assigned to the shared Azure Portal dashboard.
    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.
    name string
    resourceGroupName string
    tags {[key: string]: string}
    A mapping of tags assigned to the shared Azure Portal dashboard.
    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.
    name str
    resource_group_name str
    tags Mapping[str, str]
    A mapping of tags assigned to the shared Azure Portal dashboard.
    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.
    name String
    resourceGroupName String
    tags Map<String>
    A mapping of tags assigned to the shared Azure Portal dashboard.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.