1. Packages
  2. Azure Classic
  3. API Docs
  4. portal
  5. Dashboard

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.portal.Dashboard

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    Manages a shared dashboard in the Azure Portal.

    !> Note: The azure.portal.Dashboard resource is deprecated in version 3.0 of the AzureRM provider and will be removed in version 4.0. Please use the azure.portal.PortalDashboard resource instead.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const config = new pulumi.Config();
    // Content for the MD tile
    const mdContent = config.get("mdContent") || "# Hello all :)";
    // Link to a video
    const videoLink = config.get("videoLink") || "https://www.youtube.com/watch?v=......";
    const current = azure.core.getSubscription({});
    const example = new azure.core.ResourceGroup("example", {
        name: "mygroup",
        location: "West Europe",
    });
    const my_board = new azure.portal.Dashboard("my-board", {
        name: "my-cool-dashboard",
        resourceGroupName: example.name,
        location: example.location,
        tags: {
            source: "managed",
        },
        dashboardProperties: current.then(current => `{
       "lenses": {
            "0": {
                "order": 0,
                "parts": {
                    "0": {
                        "position": {
                            "x": 0,
                            "y": 0,
                            "rowSpan": 2,
                            "colSpan": 3
                        },
                        "metadata": {
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/MarkdownPart",
                            "settings": {
                                "content": {
                                    "settings": {
                                        "content": "${mdContent}",
                                        "subtitle": "",
                                        "title": ""
                                    }
                                }
                            }
                        }
                    },               
                    "1": {
                        "position": {
                            "x": 5,
                            "y": 0,
                            "rowSpan": 4,
                            "colSpan": 6
                        },
                        "metadata": {
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/VideoPart",
                            "settings": {
                                "content": {
                                    "settings": {
                                        "title": "Important Information",
                                        "subtitle": "",
                                        "src": "${videoLink}",
                                        "autoplay": true
                                    }
                                }
                            }
                        }
                    },
                    "2": {
                        "position": {
                            "x": 0,
                            "y": 4,
                            "rowSpan": 4,
                            "colSpan": 6
                        },
                        "metadata": {
                            "inputs": [
                                {
                                    "name": "ComponentId",
                                    "value": "/subscriptions/${current.subscriptionId}/resourceGroups/myRG/providers/microsoft.insights/components/myWebApp"
                                }
                            ],
                            "type": "Extension/AppInsightsExtension/PartType/AppMapGalPt",
                            "settings": {},
                            "asset": {
                                "idInputName": "ComponentId",
                                "type": "ApplicationInsights"
                            }
                        }
                    }              
                }
            }
        },
        "metadata": {
            "model": {
                "timeRange": {
                    "value": {
                        "relative": {
                            "duration": 24,
                            "timeUnit": 1
                        }
                    },
                    "type": "MsPortalFx.Composition.Configuration.ValueTypes.TimeRange"
                },
                "filterLocale": {
                    "value": "en-us"
                },
                "filters": {
                    "value": {
                        "MsPortalFx_TimeRange": {
                            "model": {
                                "format": "utc",
                                "granularity": "auto",
                                "relative": "24h"
                            },
                            "displayCache": {
                                "name": "UTC Time",
                                "value": "Past 24 hours"
                            },
                            "filteredPartIds": [
                                "StartboardPart-UnboundPart-ae44fef5-76b8-46b0-86f0-2b3f47bad1c7"
                            ]
                        }
                    }
                }
            }
        }
    }
    `),
    });
    
    import pulumi
    import pulumi_azure as azure
    
    config = pulumi.Config()
    # Content for the MD tile
    md_content = config.get("mdContent")
    if md_content is None:
        md_content = "# Hello all :)"
    # Link to a video
    video_link = config.get("videoLink")
    if video_link is None:
        video_link = "https://www.youtube.com/watch?v=......"
    current = azure.core.get_subscription()
    example = azure.core.ResourceGroup("example",
        name="mygroup",
        location="West Europe")
    my_board = azure.portal.Dashboard("my-board",
        name="my-cool-dashboard",
        resource_group_name=example.name,
        location=example.location,
        tags={
            "source": "managed",
        },
        dashboard_properties=f"""{{
       "lenses": {{
            "0": {{
                "order": 0,
                "parts": {{
                    "0": {{
                        "position": {{
                            "x": 0,
                            "y": 0,
                            "rowSpan": 2,
                            "colSpan": 3
                        }},
                        "metadata": {{
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/MarkdownPart",
                            "settings": {{
                                "content": {{
                                    "settings": {{
                                        "content": "{md_content}",
                                        "subtitle": "",
                                        "title": ""
                                    }}
                                }}
                            }}
                        }}
                    }},               
                    "1": {{
                        "position": {{
                            "x": 5,
                            "y": 0,
                            "rowSpan": 4,
                            "colSpan": 6
                        }},
                        "metadata": {{
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/VideoPart",
                            "settings": {{
                                "content": {{
                                    "settings": {{
                                        "title": "Important Information",
                                        "subtitle": "",
                                        "src": "{video_link}",
                                        "autoplay": true
                                    }}
                                }}
                            }}
                        }}
                    }},
                    "2": {{
                        "position": {{
                            "x": 0,
                            "y": 4,
                            "rowSpan": 4,
                            "colSpan": 6
                        }},
                        "metadata": {{
                            "inputs": [
                                {{
                                    "name": "ComponentId",
                                    "value": "/subscriptions/{current.subscription_id}/resourceGroups/myRG/providers/microsoft.insights/components/myWebApp"
                                }}
                            ],
                            "type": "Extension/AppInsightsExtension/PartType/AppMapGalPt",
                            "settings": {{}},
                            "asset": {{
                                "idInputName": "ComponentId",
                                "type": "ApplicationInsights"
                            }}
                        }}
                    }}              
                }}
            }}
        }},
        "metadata": {{
            "model": {{
                "timeRange": {{
                    "value": {{
                        "relative": {{
                            "duration": 24,
                            "timeUnit": 1
                        }}
                    }},
                    "type": "MsPortalFx.Composition.Configuration.ValueTypes.TimeRange"
                }},
                "filterLocale": {{
                    "value": "en-us"
                }},
                "filters": {{
                    "value": {{
                        "MsPortalFx_TimeRange": {{
                            "model": {{
                                "format": "utc",
                                "granularity": "auto",
                                "relative": "24h"
                            }},
                            "displayCache": {{
                                "name": "UTC Time",
                                "value": "Past 24 hours"
                            }},
                            "filteredPartIds": [
                                "StartboardPart-UnboundPart-ae44fef5-76b8-46b0-86f0-2b3f47bad1c7"
                            ]
                        }}
                    }}
                }}
            }}
        }}
    }}
    """)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/portal"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		// Content for the MD tile
    		mdContent := "# Hello all :)"
    		if param := cfg.Get("mdContent"); param != "" {
    			mdContent = param
    		}
    		// Link to a video
    		videoLink := "https://www.youtube.com/watch?v=......"
    		if param := cfg.Get("videoLink"); param != "" {
    			videoLink = param
    		}
    		current, err := core.LookupSubscription(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("mygroup"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = portal.NewDashboard(ctx, "my-board", &portal.DashboardArgs{
    			Name:              pulumi.String("my-cool-dashboard"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			Tags: pulumi.StringMap{
    				"source": pulumi.String("managed"),
    			},
    			DashboardProperties: pulumi.String(fmt.Sprintf(`{
       "lenses": {
            "0": {
                "order": 0,
                "parts": {
                    "0": {
                        "position": {
                            "x": 0,
                            "y": 0,
                            "rowSpan": 2,
                            "colSpan": 3
                        },
                        "metadata": {
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/MarkdownPart",
                            "settings": {
                                "content": {
                                    "settings": {
                                        "content": "%v",
                                        "subtitle": "",
                                        "title": ""
                                    }
                                }
                            }
                        }
                    },               
                    "1": {
                        "position": {
                            "x": 5,
                            "y": 0,
                            "rowSpan": 4,
                            "colSpan": 6
                        },
                        "metadata": {
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/VideoPart",
                            "settings": {
                                "content": {
                                    "settings": {
                                        "title": "Important Information",
                                        "subtitle": "",
                                        "src": "%v",
                                        "autoplay": true
                                    }
                                }
                            }
                        }
                    },
                    "2": {
                        "position": {
                            "x": 0,
                            "y": 4,
                            "rowSpan": 4,
                            "colSpan": 6
                        },
                        "metadata": {
                            "inputs": [
                                {
                                    "name": "ComponentId",
                                    "value": "/subscriptions/%v/resourceGroups/myRG/providers/microsoft.insights/components/myWebApp"
                                }
                            ],
                            "type": "Extension/AppInsightsExtension/PartType/AppMapGalPt",
                            "settings": {},
                            "asset": {
                                "idInputName": "ComponentId",
                                "type": "ApplicationInsights"
                            }
                        }
                    }              
                }
            }
        },
        "metadata": {
            "model": {
                "timeRange": {
                    "value": {
                        "relative": {
                            "duration": 24,
                            "timeUnit": 1
                        }
                    },
                    "type": "MsPortalFx.Composition.Configuration.ValueTypes.TimeRange"
                },
                "filterLocale": {
                    "value": "en-us"
                },
                "filters": {
                    "value": {
                        "MsPortalFx_TimeRange": {
                            "model": {
                                "format": "utc",
                                "granularity": "auto",
                                "relative": "24h"
                            },
                            "displayCache": {
                                "name": "UTC Time",
                                "value": "Past 24 hours"
                            },
                            "filteredPartIds": [
                                "StartboardPart-UnboundPart-ae44fef5-76b8-46b0-86f0-2b3f47bad1c7"
                            ]
                        }
                    }
                }
            }
        }
    }
    `, mdContent, videoLink, current.SubscriptionId)),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        // Content for the MD tile
        var mdContent = config.Get("mdContent") ?? "# Hello all :)";
        // Link to a video
        var videoLink = config.Get("videoLink") ?? "https://www.youtube.com/watch?v=......";
        var current = Azure.Core.GetSubscription.Invoke();
    
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "mygroup",
            Location = "West Europe",
        });
    
        var my_board = new Azure.Portal.Dashboard("my-board", new()
        {
            Name = "my-cool-dashboard",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Tags = 
            {
                { "source", "managed" },
            },
            DashboardProperties = @$"{{
       ""lenses"": {{
            ""0"": {{
                ""order"": 0,
                ""parts"": {{
                    ""0"": {{
                        ""position"": {{
                            ""x"": 0,
                            ""y"": 0,
                            ""rowSpan"": 2,
                            ""colSpan"": 3
                        }},
                        ""metadata"": {{
                            ""inputs"": [],
                            ""type"": ""Extension/HubsExtension/PartType/MarkdownPart"",
                            ""settings"": {{
                                ""content"": {{
                                    ""settings"": {{
                                        ""content"": ""{mdContent}"",
                                        ""subtitle"": """",
                                        ""title"": """"
                                    }}
                                }}
                            }}
                        }}
                    }},               
                    ""1"": {{
                        ""position"": {{
                            ""x"": 5,
                            ""y"": 0,
                            ""rowSpan"": 4,
                            ""colSpan"": 6
                        }},
                        ""metadata"": {{
                            ""inputs"": [],
                            ""type"": ""Extension/HubsExtension/PartType/VideoPart"",
                            ""settings"": {{
                                ""content"": {{
                                    ""settings"": {{
                                        ""title"": ""Important Information"",
                                        ""subtitle"": """",
                                        ""src"": ""{videoLink}"",
                                        ""autoplay"": true
                                    }}
                                }}
                            }}
                        }}
                    }},
                    ""2"": {{
                        ""position"": {{
                            ""x"": 0,
                            ""y"": 4,
                            ""rowSpan"": 4,
                            ""colSpan"": 6
                        }},
                        ""metadata"": {{
                            ""inputs"": [
                                {{
                                    ""name"": ""ComponentId"",
                                    ""value"": ""/subscriptions/{current.Apply(getSubscriptionResult => getSubscriptionResult.SubscriptionId)}/resourceGroups/myRG/providers/microsoft.insights/components/myWebApp""
                                }}
                            ],
                            ""type"": ""Extension/AppInsightsExtension/PartType/AppMapGalPt"",
                            ""settings"": {{}},
                            ""asset"": {{
                                ""idInputName"": ""ComponentId"",
                                ""type"": ""ApplicationInsights""
                            }}
                        }}
                    }}              
                }}
            }}
        }},
        ""metadata"": {{
            ""model"": {{
                ""timeRange"": {{
                    ""value"": {{
                        ""relative"": {{
                            ""duration"": 24,
                            ""timeUnit"": 1
                        }}
                    }},
                    ""type"": ""MsPortalFx.Composition.Configuration.ValueTypes.TimeRange""
                }},
                ""filterLocale"": {{
                    ""value"": ""en-us""
                }},
                ""filters"": {{
                    ""value"": {{
                        ""MsPortalFx_TimeRange"": {{
                            ""model"": {{
                                ""format"": ""utc"",
                                ""granularity"": ""auto"",
                                ""relative"": ""24h""
                            }},
                            ""displayCache"": {{
                                ""name"": ""UTC Time"",
                                ""value"": ""Past 24 hours""
                            }},
                            ""filteredPartIds"": [
                                ""StartboardPart-UnboundPart-ae44fef5-76b8-46b0-86f0-2b3f47bad1c7""
                            ]
                        }}
                    }}
                }}
            }}
        }}
    }}
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.core.inputs.GetSubscriptionArgs;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.portal.Dashboard;
    import com.pulumi.azure.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 config = ctx.config();
            final var mdContent = config.get("mdContent").orElse("# Hello all :)");
            final var videoLink = config.get("videoLink").orElse("https://www.youtube.com/watch?v=......");
            final var current = CoreFunctions.getSubscription();
    
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("mygroup")
                .location("West Europe")
                .build());
    
            var my_board = new Dashboard("my-board", DashboardArgs.builder()
                .name("my-cool-dashboard")
                .resourceGroupName(example.name())
                .location(example.location())
                .tags(Map.of("source", "managed"))
                .dashboardProperties("""
    {
       "lenses": {
            "0": {
                "order": 0,
                "parts": {
                    "0": {
                        "position": {
                            "x": 0,
                            "y": 0,
                            "rowSpan": 2,
                            "colSpan": 3
                        },
                        "metadata": {
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/MarkdownPart",
                            "settings": {
                                "content": {
                                    "settings": {
                                        "content": "%s",
                                        "subtitle": "",
                                        "title": ""
                                    }
                                }
                            }
                        }
                    },               
                    "1": {
                        "position": {
                            "x": 5,
                            "y": 0,
                            "rowSpan": 4,
                            "colSpan": 6
                        },
                        "metadata": {
                            "inputs": [],
                            "type": "Extension/HubsExtension/PartType/VideoPart",
                            "settings": {
                                "content": {
                                    "settings": {
                                        "title": "Important Information",
                                        "subtitle": "",
                                        "src": "%s",
                                        "autoplay": true
                                    }
                                }
                            }
                        }
                    },
                    "2": {
                        "position": {
                            "x": 0,
                            "y": 4,
                            "rowSpan": 4,
                            "colSpan": 6
                        },
                        "metadata": {
                            "inputs": [
                                {
                                    "name": "ComponentId",
                                    "value": "/subscriptions/%s/resourceGroups/myRG/providers/microsoft.insights/components/myWebApp"
                                }
                            ],
                            "type": "Extension/AppInsightsExtension/PartType/AppMapGalPt",
                            "settings": {},
                            "asset": {
                                "idInputName": "ComponentId",
                                "type": "ApplicationInsights"
                            }
                        }
                    }              
                }
            }
        },
        "metadata": {
            "model": {
                "timeRange": {
                    "value": {
                        "relative": {
                            "duration": 24,
                            "timeUnit": 1
                        }
                    },
                    "type": "MsPortalFx.Composition.Configuration.ValueTypes.TimeRange"
                },
                "filterLocale": {
                    "value": "en-us"
                },
                "filters": {
                    "value": {
                        "MsPortalFx_TimeRange": {
                            "model": {
                                "format": "utc",
                                "granularity": "auto",
                                "relative": "24h"
                            },
                            "displayCache": {
                                "name": "UTC Time",
                                "value": "Past 24 hours"
                            },
                            "filteredPartIds": [
                                "StartboardPart-UnboundPart-ae44fef5-76b8-46b0-86f0-2b3f47bad1c7"
                            ]
                        }
                    }
                }
            }
        }
    }
    ", mdContent,videoLink,current.applyValue(getSubscriptionResult -> getSubscriptionResult.subscriptionId())))
                .build());
    
        }
    }
    
    configuration:
      mdContent:
        type: string
        default: '# Hello all :)'
      videoLink:
        type: string
        default: https://www.youtube.com/watch?v=......
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: mygroup
          location: West Europe
      my-board:
        type: azure:portal:Dashboard
        properties:
          name: my-cool-dashboard
          resourceGroupName: ${example.name}
          location: ${example.location}
          tags:
            source: managed
          dashboardProperties: "{\n   \"lenses\": {\n        \"0\": {\n            \"order\": 0,\n            \"parts\": {\n                \"0\": {\n                    \"position\": {\n                        \"x\": 0,\n                        \"y\": 0,\n                        \"rowSpan\": 2,\n                        \"colSpan\": 3\n                    },\n                    \"metadata\": {\n                        \"inputs\": [],\n                        \"type\": \"Extension/HubsExtension/PartType/MarkdownPart\",\n                        \"settings\": {\n                            \"content\": {\n                                \"settings\": {\n                                    \"content\": \"${mdContent}\",\n                                    \"subtitle\": \"\",\n                                    \"title\": \"\"\n                                }\n                            }\n                        }\n                    }\n                },               \n                \"1\": {\n                    \"position\": {\n                        \"x\": 5,\n                        \"y\": 0,\n                        \"rowSpan\": 4,\n                        \"colSpan\": 6\n                    },\n                    \"metadata\": {\n                        \"inputs\": [],\n                        \"type\": \"Extension/HubsExtension/PartType/VideoPart\",\n                        \"settings\": {\n                            \"content\": {\n                                \"settings\": {\n                                    \"title\": \"Important Information\",\n                                    \"subtitle\": \"\",\n                                    \"src\": \"${videoLink}\",\n                                    \"autoplay\": true\n                                }\n                            }\n                        }\n                    }\n                },\n                \"2\": {\n                    \"position\": {\n                        \"x\": 0,\n                        \"y\": 4,\n                        \"rowSpan\": 4,\n                        \"colSpan\": 6\n                    },\n                    \"metadata\": {\n                        \"inputs\": [\n                            {\n                                \"name\": \"ComponentId\",\n                                \"value\": \"/subscriptions/${current.subscriptionId}/resourceGroups/myRG/providers/microsoft.insights/components/myWebApp\"\n                            }\n                        ],\n                        \"type\": \"Extension/AppInsightsExtension/PartType/AppMapGalPt\",\n                        \"settings\": {},\n                        \"asset\": {\n                            \"idInputName\": \"ComponentId\",\n                            \"type\": \"ApplicationInsights\"\n                        }\n                    }\n                }              \n            }\n        }\n    },\n    \"metadata\": {\n        \"model\": {\n            \"timeRange\": {\n                \"value\": {\n                    \"relative\": {\n                        \"duration\": 24,\n                        \"timeUnit\": 1\n                    }\n                },\n                \"type\": \"MsPortalFx.Composition.Configuration.ValueTypes.TimeRange\"\n            },\n            \"filterLocale\": {\n                \"value\": \"en-us\"\n            },\n            \"filters\": {\n                \"value\": {\n                    \"MsPortalFx_TimeRange\": {\n                        \"model\": {\n                            \"format\": \"utc\",\n                            \"granularity\": \"auto\",\n                            \"relative\": \"24h\"\n                        },\n                        \"displayCache\": {\n                            \"name\": \"UTC Time\",\n                            \"value\": \"Past 24 hours\"\n                        },\n                        \"filteredPartIds\": [\n                            \"StartboardPart-UnboundPart-ae44fef5-76b8-46b0-86f0-2b3f47bad1c7\"\n                        ]\n                    }\n                }\n            }\n        }\n    }\n}\n"
    variables:
      current:
        fn::invoke:
          Function: azure:core:getSubscription
          Arguments: {}
    

    It is recommended to follow the steps outlined here to create a Dashboard in the Portal and extract the relevant JSON to use in this resource. From the extracted JSON, the contents of the properties: {} object can used. Variables can be injected as needed - see above example.

    Using a template_file data source or the templatefile function

    Since the contents of the dashboard JSON can be quite lengthy, use a template file to improve readability:

    dash.tpl:

    {
        "lenses": {
             "0": {
                 "order": 0,
                 "parts": {
                     "0": {
                         "position": {
                             "x": 0,
                             "y": 0,
                             "rowSpan": 2,
                             "colSpan": 3
                         },
                         "metadata": {
                             "inputs": [],
                             "type": "Extension/HubsExtension/PartType/MarkdownPart",
                             "settings": {
                                 "content": {
                                     "settings": {
                                         "content": "${md_content}", // <-- note the 'var.' is dropped
                                         "subtitle": "",
                                         "title": ""
                                     }
                                 }
                             }
                         }
                     },  
                     ...
                     ...
    

    main.tf

    Create Dashboard Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
    @overload
    def Dashboard(resource_name: str,
                  args: DashboardArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dashboard(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  resource_group_name: Optional[str] = None,
                  dashboard_properties: Optional[str] = None,
                  location: Optional[str] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = 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:portal:Dashboard
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var dashboardResource = new Azure.Portal.Dashboard("dashboardResource", new()
    {
        ResourceGroupName = "string",
        DashboardProperties = "string",
        Location = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := portal.NewDashboard(ctx, "dashboardResource", &portal.DashboardArgs{
    	ResourceGroupName:   pulumi.String("string"),
    	DashboardProperties: pulumi.String("string"),
    	Location:            pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
        .resourceGroupName("string")
        .dashboardProperties("string")
        .location("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    dashboard_resource = azure.portal.Dashboard("dashboardResource",
        resource_group_name="string",
        dashboard_properties="string",
        location="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const dashboardResource = new azure.portal.Dashboard("dashboardResource", {
        resourceGroupName: "string",
        dashboardProperties: "string",
        location: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:portal:Dashboard
    properties:
        dashboardProperties: string
        location: string
        name: string
        resourceGroupName: string
        tags:
            string: string
    

    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 in which to create the dashboard. Changing this forces a new resource to be created.
    DashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ResourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    DashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    Tags map[string]string
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    dashboardProperties String
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    tags Map<String,String>
    A mapping of tags to assign to the resource.
    resourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    dashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    resource_group_name str
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    dashboard_properties str
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    dashboardProperties String
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    tags Map<String>
    A mapping of tags to assign to the resource.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Dashboard Resource

    Get an existing Dashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DashboardState, opts?: CustomResourceOptions): Dashboard
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dashboard_properties: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> Dashboard
    func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
    public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
    public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    ResourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    DashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    ResourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    dashboardProperties String
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    resourceGroupName String
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    dashboardProperties string
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    resourceGroupName string
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    dashboard_properties str
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    resource_group_name str
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    dashboardProperties String
    JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String

    Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.

    Note: You can specify a tag with the key hidden-title to set a more user-friendly title for this Dashboard.

    resourceGroupName String
    The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Import

    Dashboards can be imported using the resource id, e.g.

    $ pulumi import azure:portal/dashboard:Dashboard my-board /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Portal/dashboards/00000000-0000-0000-0000-000000000000
    

    Note the URI in the above sample can be found using the Resource Explorer tool in the Azure Portal.

    To learn more about importing existing cloud resources, see Importing resources.

    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.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi