azure-native.portal.Dashboard
Explore with Pulumi AI
The shared dashboard resource definition. API Version: 2020-09-01-preview.
Example Usage
Create or update a Dashboard
using System.Collections.Generic;
using System.Linq;
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" },
},
});
});
package main
import (
portal "github.com/pulumi/pulumi-azure-native-sdk/portal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := portal.NewDashboard(ctx, "dashboard", &portal.DashboardArgs{
DashboardName: pulumi.String("testDashboard"),
Lenses: []portal.DashboardLensArgs{
{
Order: pulumi.Int(1),
Parts: []portal.DashboardPartsArgs{
{
Position: {
ColSpan: pulumi.Int(3),
RowSpan: pulumi.Int(4),
X: pulumi.Int(1),
Y: pulumi.Int(2),
},
},
{
Position: {
ColSpan: pulumi.Int(6),
RowSpan: pulumi.Int(6),
X: pulumi.Int(5),
Y: pulumi.Int(5),
},
},
},
},
{
Order: pulumi.Int(2),
Parts: portal.DashboardPartsArray{},
},
},
Location: pulumi.String("eastus"),
Metadata: pulumi.AnyMap{
"metadata": pulumi.Any{
ColSpan: 2,
RowSpan: 1,
X: 4,
Y: 3,
},
},
ResourceGroupName: pulumi.String("testRG"),
Tags: pulumi.StringMap{
"aKey": pulumi.String("aValue"),
"anotherKey": pulumi.String("anotherValue"),
},
})
if err != nil {
return err
}
return nil
})
}
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": azure_native.portal.DashboardPartsPositionArgs(
col_span=3,
row_span=4,
x=1,
y=2,
),
},
{
"position": azure_native.portal.DashboardPartsPositionArgs(
col_span=6,
row_span=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:
- Resource
Group stringName The name of the resource group.
- Dashboard
Name string The name of the dashboard.
- Lenses
List<Pulumi.
Azure Native. Portal. Inputs. Dashboard Lens Args> The dashboard lenses.
- Location string
Resource location
- Metadata Dictionary<string, object>
The dashboard metadata.
- Dictionary<string, string>
Resource tags
- Resource
Group stringName The name of the resource group.
- Dashboard
Name string The name of the dashboard.
- Lenses
[]Dashboard
Lens Args The dashboard lenses.
- Location string
Resource location
- Metadata map[string]interface{}
The dashboard metadata.
- map[string]string
Resource tags
- resource
Group StringName The name of the resource group.
- dashboard
Name String The name of the dashboard.
- lenses
List<Dashboard
Lens Args> The dashboard lenses.
- location String
Resource location
- metadata Map<String,Object>
The dashboard metadata.
- Map<String,String>
Resource tags
- resource
Group stringName The name of the resource group.
- dashboard
Name string The name of the dashboard.
- lenses
Dashboard
Lens Args[] The dashboard lenses.
- location string
Resource location
- metadata {[key: string]: any}
The dashboard metadata.
- {[key: string]: string}
Resource tags
- resource_
group_ strname The name of the resource group.
- dashboard_
name str The name of the dashboard.
- lenses
Sequence[Dashboard
Lens Args] The dashboard lenses.
- location str
Resource location
- metadata Mapping[str, Any]
The dashboard metadata.
- Mapping[str, str]
Resource tags
- resource
Group StringName The name of the resource group.
- dashboard
Name String The name of the dashboard.
- lenses List<Property Map>
The dashboard lenses.
- location String
Resource location
- metadata Map<Any>
The dashboard metadata.
- Map<String>
Resource tags
Outputs
All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:
Supporting Types
DashboardLens
- Order int
The lens order.
- Parts
List<Pulumi.
Azure Native. Portal. Inputs. Dashboard Parts> The dashboard parts.
- Metadata Dictionary<string, object>
The dashboard len's metadata.
- Order int
The lens order.
- Parts
[]Dashboard
Parts The dashboard parts.
- Metadata map[string]interface{}
The dashboard len's metadata.
- order Integer
The lens order.
- parts
List<Dashboard
Parts> The dashboard parts.
- metadata Map<String,Object>
The dashboard len's metadata.
- order number
The lens order.
- parts
Dashboard
Parts[] The dashboard parts.
- metadata {[key: string]: any}
The dashboard len's metadata.
- order int
The lens order.
- parts
Sequence[Dashboard
Parts] 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.
Azure Native. Portal. Inputs. Dashboard Parts Response> The dashboard parts.
- Metadata Dictionary<string, object>
The dashboard len's metadata.
- Order int
The lens order.
- Parts
[]Dashboard
Parts Response The dashboard parts.
- Metadata map[string]interface{}
The dashboard len's metadata.
- order Integer
The lens order.
- parts
List<Dashboard
Parts Response> The dashboard parts.
- metadata Map<String,Object>
The dashboard len's metadata.
- order number
The lens order.
- parts
Dashboard
Parts Response[] The dashboard parts.
- metadata {[key: string]: any}
The dashboard len's metadata.
- order int
The lens order.
- parts
Sequence[Dashboard
Parts Response] 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
Pulumi.
Azure Native. Portal. Inputs. Dashboard Parts Position The dashboard's part position.
- Metadata
Pulumi.
Azure Native. Portal. Inputs. Markdown Part Metadata The dashboard part's metadata.
- Position
Dashboard
Parts Position The dashboard's part position.
- Metadata
Markdown
Part Metadata The dashboard part's metadata.
- position
Dashboard
Parts Position The dashboard's part position.
- metadata
Markdown
Part Metadata The dashboard part's metadata.
- position
Dashboard
Parts Position The dashboard's part position.
- metadata
Markdown
Part Metadata The dashboard part's metadata.
- position
Dashboard
Parts Position The dashboard's part position.
- metadata
Markdown
Part Metadata The dashboard part's metadata.
- position Property Map
The dashboard's part position.
- metadata Property Map
The dashboard part's metadata.
DashboardPartsPosition
DashboardPartsResponse
- Position
Pulumi.
Azure Native. Portal. Inputs. Dashboard Parts Response Position The dashboard's part position.
- Metadata
Pulumi.
Azure Native. Portal. Inputs. Markdown Part Metadata Response The dashboard part's metadata.
- Position
Dashboard
Parts Response Position The dashboard's part position.
- Metadata
Markdown
Part Metadata Response The dashboard part's metadata.
- position
Dashboard
Parts Response Position The dashboard's part position.
- metadata
Markdown
Part Metadata Response The dashboard part's metadata.
- position
Dashboard
Parts Response Position The dashboard's part position.
- metadata
Markdown
Part Metadata Response The dashboard part's metadata.
- position
Dashboard
Parts Response Position The dashboard's part position.
- metadata
Markdown
Part Metadata Response The dashboard part's metadata.
- position Property Map
The dashboard's part position.
- metadata Property Map
The dashboard part's metadata.
DashboardPartsResponsePosition
MarkdownPartMetadata
- Inputs List<object>
Input to dashboard part.
- Settings
Pulumi.
Azure Native. Portal. Inputs. Markdown Part Metadata Settings Markdown part settings.
- Inputs []interface{}
Input to dashboard part.
- Settings
Markdown
Part Metadata Settings Markdown part settings.
- inputs List<Object>
Input to dashboard part.
- settings
Markdown
Part Metadata Settings Markdown part settings.
- inputs any[]
Input to dashboard part.
- settings
Markdown
Part Metadata Settings Markdown part settings.
- inputs Sequence[Any]
Input to dashboard part.
- settings
Markdown
Part Metadata Settings Markdown part settings.
- inputs List<Any>
Input to dashboard part.
- settings Property Map
Markdown part settings.
MarkdownPartMetadataContent
- Settings
Pulumi.
Azure Native. Portal. Inputs. Markdown Part Metadata Settings Settings The setting of the content of markdown part.
- Settings
Markdown
Part Metadata Settings Settings The setting of the content of markdown part.
- settings
Markdown
Part Metadata Settings Settings The setting of the content of markdown part.
- settings
Markdown
Part Metadata Settings Settings The setting of the content of markdown part.
- settings
Markdown
Part Metadata Settings Settings 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.
Azure Native. Portal. Inputs. Markdown Part Metadata Response Settings Markdown part settings.
- Inputs []interface{}
Input to dashboard part.
- Settings
Markdown
Part Metadata Response Settings Markdown part settings.
- inputs List<Object>
Input to dashboard part.
- settings
Markdown
Part Metadata Response Settings Markdown part settings.
- inputs any[]
Input to dashboard part.
- settings
Markdown
Part Metadata Response Settings Markdown part settings.
- inputs Sequence[Any]
Input to dashboard part.
- settings
Markdown
Part Metadata Response Settings Markdown part settings.
- inputs List<Any>
Input to dashboard part.
- settings Property Map
Markdown part settings.
MarkdownPartMetadataResponseContent
- Settings
Pulumi.
Azure Native. Portal. Inputs. Markdown Part Metadata Response Settings Settings The setting of the content of markdown part.
- Settings
Markdown
Part Metadata Response Settings Settings The setting of the content of markdown part.
- settings
Markdown
Part Metadata Response Settings Settings The setting of the content of markdown part.
- settings
Markdown
Part Metadata Response Settings Settings The setting of the content of markdown part.
- settings
Markdown
Part Metadata Response Settings Settings The setting of the content of markdown part.
- settings Property Map
The setting of the content of markdown part.
MarkdownPartMetadataResponseSettings
- Content
Pulumi.
Azure Native. Portal. Inputs. Markdown Part Metadata Response Content The content of markdown part.
- Content
Markdown
Part Metadata Response Content The content of markdown part.
- content
Markdown
Part Metadata Response Content The content of markdown part.
- content
Markdown
Part Metadata Response Content The content of markdown part.
- content
Markdown
Part Metadata Response Content The content of markdown part.
- content Property Map
The content of markdown part.
MarkdownPartMetadataResponseSettingsSettings
- Content string
The content of the markdown part.
- Markdown
Source int The source of the content of the markdown part.
- Markdown
Uri 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.
- Markdown
Source int The source of the content of the markdown part.
- Markdown
Uri 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.
- markdown
Source Integer The source of the content of the markdown part.
- markdown
Uri 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.
- markdown
Source number The source of the content of the markdown part.
- markdown
Uri 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.
- markdown
Source Number The source of the content of the markdown part.
- markdown
Uri String The uri of markdown content.
- subtitle String
The subtitle of the markdown part.
- title String
The title of the markdown part.
MarkdownPartMetadataSettings
- Content
Pulumi.
Azure Native. Portal. Inputs. Markdown Part Metadata Content The content of markdown part.
- Content
Markdown
Part Metadata Content The content of markdown part.
- content
Markdown
Part Metadata Content The content of markdown part.
- content
Markdown
Part Metadata Content The content of markdown part.
- content
Markdown
Part Metadata Content The content of markdown part.
- content Property Map
The content of markdown part.
MarkdownPartMetadataSettingsSettings
- Content string
The content of the markdown part.
- Markdown
Source int The source of the content of the markdown part.
- Markdown
Uri 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.
- Markdown
Source int The source of the content of the markdown part.
- Markdown
Uri 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.
- markdown
Source Integer The source of the content of the markdown part.
- markdown
Uri 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.
- markdown
Source number The source of the content of the markdown part.
- markdown
Uri 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.
- markdown
Source Number The source of the content of the markdown part.
- markdown
Uri 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
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0