Azure Native

v1.87.0 published on Tuesday, Nov 22, 2022 by Pulumi

Dashboard

The shared dashboard resource definition. API Version: 2020-09-01-preview.

Example Usage

Create or update a Dashboard

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var dashboard = new AzureNative.Portal.Dashboard("dashboard", new()
    {
        DashboardName = "testDashboard",
        Lenses = new[]
        {
            new AzureNative.Portal.Inputs.DashboardLensArgs
            {
                Order = 1,
                Parts = new[]
                {
                    new AzureNative.Portal.Inputs.DashboardPartsArgs
                    {
                        Position = new AzureNative.Portal.Inputs.DashboardPartsPositionArgs
                        {
                            ColSpan = 3,
                            RowSpan = 4,
                            X = 1,
                            Y = 2,
                        },
                    },
                    new AzureNative.Portal.Inputs.DashboardPartsArgs
                    {
                        Position = new AzureNative.Portal.Inputs.DashboardPartsPositionArgs
                        {
                            ColSpan = 6,
                            RowSpan = 6,
                            X = 5,
                            Y = 5,
                        },
                    },
                },
            },
            new AzureNative.Portal.Inputs.DashboardLensArgs
            {
                Order = 2,
                Parts = new[] {},
            },
        },
        Location = "eastus",
        Metadata = 
        {
            { "metadata", 
            {
                { "ColSpan", 2 },
                { "RowSpan", 1 },
                { "X", 4 },
                { "Y", 3 },
            } },
        },
        ResourceGroupName = "testRG",
        Tags = 
        {
            { "aKey", "aValue" },
            { "anotherKey", "anotherValue" },
        },
    });

});

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.portal.Dashboard;
import com.pulumi.azurenative.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) {
        var dashboard = new Dashboard("dashboard", DashboardArgs.builder()        
            .dashboardName("testDashboard")
            .lenses(            
                Map.ofEntries(
                    Map.entry("order", 1),
                    Map.entry("parts",                     
                        Map.of("position", Map.ofEntries(
                            Map.entry("colSpan", 3),
                            Map.entry("rowSpan", 4),
                            Map.entry("x", 1),
                            Map.entry("y", 2)
                        )),
                        Map.of("position", Map.ofEntries(
                            Map.entry("colSpan", 6),
                            Map.entry("rowSpan", 6),
                            Map.entry("x", 5),
                            Map.entry("y", 5)
                        )))
                ),
                Map.ofEntries(
                    Map.entry("order", 2),
                    Map.entry("parts", )
                ))
            .location("eastus")
            .metadata(Map.of("metadata", Map.ofEntries(
                Map.entry("ColSpan", 2),
                Map.entry("RowSpan", 1),
                Map.entry("X", 4),
                Map.entry("Y", 3)
            )))
            .resourceGroupName("testRG")
            .tags(Map.ofEntries(
                Map.entry("aKey", "aValue"),
                Map.entry("anotherKey", "anotherValue")
            ))
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

dashboard = azure_native.portal.Dashboard("dashboard",
    dashboard_name="testDashboard",
    lenses=[
        {
            "order": 1,
            "parts": [
                {
                    "position": {
                        "colSpan": 3,
                        "rowSpan": 4,
                        "x": 1,
                        "y": 2,
                    },
                },
                {
                    "position": {
                        "colSpan": 6,
                        "rowSpan": 6,
                        "x": 5,
                        "y": 5,
                    },
                },
            ],
        },
        {
            "order": 2,
            "parts": [],
        },
    ],
    location="eastus",
    metadata={
        "metadata": {
            "ColSpan": 2,
            "RowSpan": 1,
            "X": 4,
            "Y": 3,
        },
    },
    resource_group_name="testRG",
    tags={
        "aKey": "aValue",
        "anotherKey": "anotherValue",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const dashboard = new azure_native.portal.Dashboard("dashboard", {
    dashboardName: "testDashboard",
    lenses: [
        {
            order: 1,
            parts: [
                {
                    position: {
                        colSpan: 3,
                        rowSpan: 4,
                        x: 1,
                        y: 2,
                    },
                },
                {
                    position: {
                        colSpan: 6,
                        rowSpan: 6,
                        x: 5,
                        y: 5,
                    },
                },
            ],
        },
        {
            order: 2,
            parts: [],
        },
    ],
    location: "eastus",
    metadata: {
        metadata: {
            ColSpan: 2,
            RowSpan: 1,
            X: 4,
            Y: 3,
        },
    },
    resourceGroupName: "testRG",
    tags: {
        aKey: "aValue",
        anotherKey: "anotherValue",
    },
});
resources:
  dashboard:
    type: azure-native:portal:Dashboard
    properties:
      dashboardName: testDashboard
      lenses:
        - order: 1
          parts:
            - position:
                colSpan: 3
                rowSpan: 4
                x: 1
                y: 2
            - position:
                colSpan: 6
                rowSpan: 6
                x: 5
                y: 5
        - order: 2
          parts: []
      location: eastus
      metadata:
        metadata:
          ColSpan: 2
          RowSpan: 1
          X: 4
          Y: 3
      resourceGroupName: testRG
      tags:
        aKey: aValue
        anotherKey: anotherValue

Create Dashboard Resource

new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              dashboard_name: Optional[str] = None,
              lenses: Optional[Sequence[DashboardLensArgs]] = None,
              location: Optional[str] = None,
              metadata: Optional[Mapping[str, Any]] = None,
              resource_group_name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
@overload
def Dashboard(resource_name: str,
              args: DashboardArgs,
              opts: Optional[ResourceOptions] = None)
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
type: azure-native:portal:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Dashboard Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Dashboard resource accepts the following input properties:

ResourceGroupName string

The name of the resource group.

DashboardName string

The name of the dashboard.

Lenses List<Pulumi.AzureNative.Portal.Inputs.DashboardLensArgs>

The dashboard lenses.

Location string

Resource location

Metadata Dictionary<string, object>

The dashboard metadata.

Tags Dictionary<string, string>

Resource tags

ResourceGroupName string

The name of the resource group.

DashboardName string

The name of the dashboard.

Lenses []DashboardLensArgs

The dashboard lenses.

Location string

Resource location

Metadata map[string]interface{}

The dashboard metadata.

Tags map[string]string

Resource tags

resourceGroupName String

The name of the resource group.

dashboardName String

The name of the dashboard.

lenses List<DashboardLensArgs>

The dashboard lenses.

location String

Resource location

metadata Map<String,Object>

The dashboard metadata.

tags Map<String,String>

Resource tags

resourceGroupName string

The name of the resource group.

dashboardName string

The name of the dashboard.

lenses DashboardLensArgs[]

The dashboard lenses.

location string

Resource location

metadata {[key: string]: any}

The dashboard metadata.

tags {[key: string]: string}

Resource tags

resource_group_name str

The name of the resource group.

dashboard_name str

The name of the dashboard.

lenses Sequence[DashboardLensArgs]

The dashboard lenses.

location str

Resource location

metadata Mapping[str, Any]

The dashboard metadata.

tags Mapping[str, str]

Resource tags

resourceGroupName String

The name of the resource group.

dashboardName String

The name of the dashboard.

lenses List<Property Map>

The dashboard lenses.

location String

Resource location

metadata Map<Any>

The dashboard metadata.

tags Map<String>

Resource tags

Outputs

All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name

Type string

Resource type

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name

Type string

Resource type

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name

type String

Resource type

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name

type string

Resource type

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name

type str

Resource type

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name

type String

Resource type

Supporting Types

DashboardLens

Order int

The lens order.

Parts List<Pulumi.AzureNative.Portal.Inputs.DashboardParts>

The dashboard parts.

Metadata Dictionary<string, object>

The dashboard len's metadata.

Order int

The lens order.

Parts []DashboardParts

The dashboard parts.

Metadata map[string]interface{}

The dashboard len's metadata.

order Integer

The lens order.

parts List<DashboardParts>

The dashboard parts.

metadata Map<String,Object>

The dashboard len's metadata.

order number

The lens order.

parts DashboardParts[]

The dashboard parts.

metadata {[key: string]: any}

The dashboard len's metadata.

order int

The lens order.

parts Sequence[DashboardParts]

The dashboard parts.

metadata Mapping[str, Any]

The dashboard len's metadata.

order Number

The lens order.

parts List<Property Map>

The dashboard parts.

metadata Map<Any>

The dashboard len's metadata.

DashboardLensResponse

Order int

The lens order.

Parts List<Pulumi.AzureNative.Portal.Inputs.DashboardPartsResponse>

The dashboard parts.

Metadata Dictionary<string, object>

The dashboard len's metadata.

Order int

The lens order.

Parts []DashboardPartsResponse

The dashboard parts.

Metadata map[string]interface{}

The dashboard len's metadata.

order Integer

The lens order.

parts List<DashboardPartsResponse>

The dashboard parts.

metadata Map<String,Object>

The dashboard len's metadata.

order number

The lens order.

parts DashboardPartsResponse[]

The dashboard parts.

metadata {[key: string]: any}

The dashboard len's metadata.

order int

The lens order.

parts Sequence[DashboardPartsResponse]

The dashboard parts.

metadata Mapping[str, Any]

The dashboard len's metadata.

order Number

The lens order.

parts List<Property Map>

The dashboard parts.

metadata Map<Any>

The dashboard len's metadata.

DashboardParts

Position DashboardPartsPosition

The dashboard's part position.

Metadata MarkdownPartMetadata

The dashboard part's metadata.

position DashboardPartsPosition

The dashboard's part position.

metadata MarkdownPartMetadata

The dashboard part's metadata.

position DashboardPartsPosition

The dashboard's part position.

metadata MarkdownPartMetadata

The dashboard part's metadata.

position DashboardPartsPosition

The dashboard's part position.

metadata MarkdownPartMetadata

The dashboard part's metadata.

position Property Map

The dashboard's part position.

metadata Property Map

The dashboard part's metadata.

DashboardPartsPosition

ColSpan int

The dashboard's part column span.

RowSpan int

The dashboard's part row span.

X int

The dashboard's part x coordinate.

Y int

The dashboard's part y coordinate.

Metadata Dictionary<string, object>

The dashboard part's metadata.

ColSpan int

The dashboard's part column span.

RowSpan int

The dashboard's part row span.

X int

The dashboard's part x coordinate.

Y int

The dashboard's part y coordinate.

Metadata map[string]interface{}

The dashboard part's metadata.

colSpan Integer

The dashboard's part column span.

rowSpan Integer

The dashboard's part row span.

x Integer

The dashboard's part x coordinate.

y Integer

The dashboard's part y coordinate.

metadata Map<String,Object>

The dashboard part's metadata.

colSpan number

The dashboard's part column span.

rowSpan number

The dashboard's part row span.

x number

The dashboard's part x coordinate.

y number

The dashboard's part y coordinate.

metadata {[key: string]: any}

The dashboard part's metadata.

col_span int

The dashboard's part column span.

row_span int

The dashboard's part row span.

x int

The dashboard's part x coordinate.

y int

The dashboard's part y coordinate.

metadata Mapping[str, Any]

The dashboard part's metadata.

colSpan Number

The dashboard's part column span.

rowSpan Number

The dashboard's part row span.

x Number

The dashboard's part x coordinate.

y Number

The dashboard's part y coordinate.

metadata Map<Any>

The dashboard part's metadata.

DashboardPartsResponse

Position DashboardPartsResponsePosition

The dashboard's part position.

Metadata MarkdownPartMetadataResponse

The dashboard part's metadata.

position DashboardPartsResponsePosition

The dashboard's part position.

metadata MarkdownPartMetadataResponse

The dashboard part's metadata.

position DashboardPartsResponsePosition

The dashboard's part position.

metadata MarkdownPartMetadataResponse

The dashboard part's metadata.

position DashboardPartsResponsePosition

The dashboard's part position.

metadata MarkdownPartMetadataResponse

The dashboard part's metadata.

position Property Map

The dashboard's part position.

metadata Property Map

The dashboard part's metadata.

DashboardPartsResponsePosition

ColSpan int

The dashboard's part column span.

RowSpan int

The dashboard's part row span.

X int

The dashboard's part x coordinate.

Y int

The dashboard's part y coordinate.

Metadata Dictionary<string, object>

The dashboard part's metadata.

ColSpan int

The dashboard's part column span.

RowSpan int

The dashboard's part row span.

X int

The dashboard's part x coordinate.

Y int

The dashboard's part y coordinate.

Metadata map[string]interface{}

The dashboard part's metadata.

colSpan Integer

The dashboard's part column span.

rowSpan Integer

The dashboard's part row span.

x Integer

The dashboard's part x coordinate.

y Integer

The dashboard's part y coordinate.

metadata Map<String,Object>

The dashboard part's metadata.

colSpan number

The dashboard's part column span.

rowSpan number

The dashboard's part row span.

x number

The dashboard's part x coordinate.

y number

The dashboard's part y coordinate.

metadata {[key: string]: any}

The dashboard part's metadata.

col_span int

The dashboard's part column span.

row_span int

The dashboard's part row span.

x int

The dashboard's part x coordinate.

y int

The dashboard's part y coordinate.

metadata Mapping[str, Any]

The dashboard part's metadata.

colSpan Number

The dashboard's part column span.

rowSpan Number

The dashboard's part row span.

x Number

The dashboard's part x coordinate.

y Number

The dashboard's part y coordinate.

metadata Map<Any>

The dashboard part's metadata.

MarkdownPartMetadata

Inputs List<object>

Input to dashboard part.

Settings Pulumi.AzureNative.Portal.Inputs.MarkdownPartMetadataSettings

Markdown part settings.

Inputs []interface{}

Input to dashboard part.

Settings MarkdownPartMetadataSettings

Markdown part settings.

inputs List<Object>

Input to dashboard part.

settings MarkdownPartMetadataSettings

Markdown part settings.

inputs any[]

Input to dashboard part.

settings MarkdownPartMetadataSettings

Markdown part settings.

inputs Sequence[Any]

Input to dashboard part.

settings MarkdownPartMetadataSettings

Markdown part settings.

inputs List<Any>

Input to dashboard part.

settings Property Map

Markdown part settings.

MarkdownPartMetadataContent

Settings MarkdownPartMetadataSettingsSettings

The setting of the content of markdown part.

settings MarkdownPartMetadataSettingsSettings

The setting of the content of markdown part.

settings MarkdownPartMetadataSettingsSettings

The setting of the content of markdown part.

settings MarkdownPartMetadataSettingsSettings

The setting of the content of markdown part.

settings Property Map

The setting of the content of markdown part.

MarkdownPartMetadataResponse

Inputs List<object>

Input to dashboard part.

Settings Pulumi.AzureNative.Portal.Inputs.MarkdownPartMetadataResponseSettings

Markdown part settings.

Inputs []interface{}

Input to dashboard part.

Settings MarkdownPartMetadataResponseSettings

Markdown part settings.

inputs List<Object>

Input to dashboard part.

settings MarkdownPartMetadataResponseSettings

Markdown part settings.

inputs any[]

Input to dashboard part.

settings MarkdownPartMetadataResponseSettings

Markdown part settings.

inputs Sequence[Any]

Input to dashboard part.

settings MarkdownPartMetadataResponseSettings

Markdown part settings.

inputs List<Any>

Input to dashboard part.

settings Property Map

Markdown part settings.

MarkdownPartMetadataResponseContent

Settings MarkdownPartMetadataResponseSettingsSettings

The setting of the content of markdown part.

settings MarkdownPartMetadataResponseSettingsSettings

The setting of the content of markdown part.

settings MarkdownPartMetadataResponseSettingsSettings

The setting of the content of markdown part.

settings MarkdownPartMetadataResponseSettingsSettings

The setting of the content of markdown part.

settings Property Map

The setting of the content of markdown part.

MarkdownPartMetadataResponseSettings

Content MarkdownPartMetadataResponseContent

The content of markdown part.

content MarkdownPartMetadataResponseContent

The content of markdown part.

content MarkdownPartMetadataResponseContent

The content of markdown part.

content MarkdownPartMetadataResponseContent

The content of markdown part.

content Property Map

The content of markdown part.

MarkdownPartMetadataResponseSettingsSettings

Content string

The content of the markdown part.

MarkdownSource int

The source of the content of the markdown part.

MarkdownUri string

The uri of markdown content.

Subtitle string

The subtitle of the markdown part.

Title string

The title of the markdown part.

Content string

The content of the markdown part.

MarkdownSource int

The source of the content of the markdown part.

MarkdownUri string

The uri of markdown content.

Subtitle string

The subtitle of the markdown part.

Title string

The title of the markdown part.

content String

The content of the markdown part.

markdownSource Integer

The source of the content of the markdown part.

markdownUri String

The uri of markdown content.

subtitle String

The subtitle of the markdown part.

title String

The title of the markdown part.

content string

The content of the markdown part.

markdownSource number

The source of the content of the markdown part.

markdownUri string

The uri of markdown content.

subtitle string

The subtitle of the markdown part.

title string

The title of the markdown part.

content str

The content of the markdown part.

markdown_source int

The source of the content of the markdown part.

markdown_uri str

The uri of markdown content.

subtitle str

The subtitle of the markdown part.

title str

The title of the markdown part.

content String

The content of the markdown part.

markdownSource Number

The source of the content of the markdown part.

markdownUri String

The uri of markdown content.

subtitle String

The subtitle of the markdown part.

title String

The title of the markdown part.

MarkdownPartMetadataSettings

Content MarkdownPartMetadataContent

The content of markdown part.

content MarkdownPartMetadataContent

The content of markdown part.

content MarkdownPartMetadataContent

The content of markdown part.

content MarkdownPartMetadataContent

The content of markdown part.

content Property Map

The content of markdown part.

MarkdownPartMetadataSettingsSettings

Content string

The content of the markdown part.

MarkdownSource int

The source of the content of the markdown part.

MarkdownUri string

The uri of markdown content.

Subtitle string

The subtitle of the markdown part.

Title string

The title of the markdown part.

Content string

The content of the markdown part.

MarkdownSource int

The source of the content of the markdown part.

MarkdownUri string

The uri of markdown content.

Subtitle string

The subtitle of the markdown part.

Title string

The title of the markdown part.

content String

The content of the markdown part.

markdownSource Integer

The source of the content of the markdown part.

markdownUri String

The uri of markdown content.

subtitle String

The subtitle of the markdown part.

title String

The title of the markdown part.

content string

The content of the markdown part.

markdownSource number

The source of the content of the markdown part.

markdownUri string

The uri of markdown content.

subtitle string

The subtitle of the markdown part.

title string

The title of the markdown part.

content str

The content of the markdown part.

markdown_source int

The source of the content of the markdown part.

markdown_uri str

The uri of markdown content.

subtitle str

The subtitle of the markdown part.

title str

The title of the markdown part.

content String

The content of the markdown part.

markdownSource Number

The source of the content of the markdown part.

markdownUri String

The uri of markdown content.

subtitle String

The subtitle of the markdown part.

title String

The title of the markdown part.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:portal:Dashboard testDashboard /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0