We recommend using Azure Native.
Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
azure.portal.getDashboard
Explore with Pulumi AI
Use this data source to access information about an existing shared dashboard in the Azure Portal. This is the data source of the azure.portal.Dashboard
resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.portal.getDashboard({
name: "existing-dashboard",
resourceGroupName: "dashboard-rg",
});
export const id = exampleAzurermDashboard.id;
import pulumi
import pulumi_azure as azure
example = azure.portal.get_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/v5/go/azure/portal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := portal.LookupDashboard(ctx, &portal.LookupDashboardArgs{
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.GetDashboard.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.GetDashboardArgs;
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.getDashboard(GetDashboardArgs.builder()
.name("existing-dashboard")
.resourceGroupName("dashboard-rg")
.build());
ctx.export("id", exampleAzurermDashboard.id());
}
}
variables:
example:
fn::invoke:
Function: azure:portal:getDashboard
Arguments:
name: existing-dashboard
resourceGroupName: dashboard-rg
outputs:
id: ${exampleAzurermDashboard.id}
Using getDashboard
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 getDashboard(args: GetDashboardArgs, opts?: InvokeOptions): Promise<GetDashboardResult>
function getDashboardOutput(args: GetDashboardOutputArgs, opts?: InvokeOptions): Output<GetDashboardResult>
def get_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) -> GetDashboardResult
def get_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[GetDashboardResult]
func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput
> Note: This function is named LookupDashboard
in the Go SDK.
public static class GetDashboard
{
public static Task<GetDashboardResult> InvokeAsync(GetDashboardArgs args, InvokeOptions? opts = null)
public static Output<GetDashboardResult> Invoke(GetDashboardInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:portal/getDashboard:getDashboard
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- Dashboard
Properties string - JSON data representing dashboard body.
- Display
Name string - Specifies the display name of the shared Azure Portal Dashboard.
- Name string
- Specifies the name of the shared Azure Portal Dashboard.
- Resource
Group stringName - Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- Dashboard
Properties string - JSON data representing dashboard body.
- Display
Name string - Specifies the display name of the shared Azure Portal Dashboard.
- Name string
- Specifies the name of the shared Azure Portal Dashboard.
- resource
Group StringName - Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- dashboard
Properties String - JSON data representing dashboard body.
- display
Name String - Specifies the display name of the shared Azure Portal Dashboard.
- name String
- Specifies the name of the shared Azure Portal Dashboard.
- resource
Group stringName - Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- dashboard
Properties string - JSON data representing dashboard body.
- display
Name 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.
- resource
Group StringName - Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
- dashboard
Properties String - JSON data representing dashboard body.
- display
Name String - Specifies the display name of the shared Azure Portal Dashboard.
- name String
- Specifies the name of the shared Azure Portal Dashboard.
getDashboard Result
The following output properties are available:
- Dashboard
Properties 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.
- Resource
Group stringName - Dictionary<string, string>
- A mapping of tags assigned to the shared Azure Portal dashboard.
- Display
Name string - Name string
- Dashboard
Properties 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.
- Resource
Group stringName - map[string]string
- A mapping of tags assigned to the shared Azure Portal dashboard.
- Display
Name string - Name string
- dashboard
Properties 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.
- resource
Group StringName - Map<String,String>
- A mapping of tags assigned to the shared Azure Portal dashboard.
- display
Name String - name String
- dashboard
Properties 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.
- resource
Group stringName - {[key: string]: string}
- A mapping of tags assigned to the shared Azure Portal dashboard.
- display
Name 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
- dashboard
Properties 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.
- resource
Group StringName - Map<String>
- A mapping of tags assigned to the shared Azure Portal dashboard.
- display
Name String - name String
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.