portal

package
v5.74.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Dashboard

type Dashboard struct {
	pulumi.CustomResourceState

	// JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
	DashboardProperties pulumi.StringOutput `pulumi:"dashboardProperties"`
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// 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.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a shared dashboard in the Azure Portal.

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

## Example Usage

```go 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
	})
}

```

It is recommended to follow the steps outlined [here](https://docs.microsoft.com/azure/azure-portal/azure-portal-dashboards-create-programmatically#fetch-the-json-representation-of-the-dashboard) 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 `templateFile` 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`:

`main.tf`

## Import

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

```sh $ 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.

func GetDashboard

func GetDashboard(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DashboardState, opts ...pulumi.ResourceOption) (*Dashboard, error)

GetDashboard gets an existing Dashboard resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDashboard

func NewDashboard(ctx *pulumi.Context,
	name string, args *DashboardArgs, opts ...pulumi.ResourceOption) (*Dashboard, error)

NewDashboard registers a new resource with the given unique name, arguments, and options.

func (*Dashboard) ElementType

func (*Dashboard) ElementType() reflect.Type

func (*Dashboard) ToDashboardOutput

func (i *Dashboard) ToDashboardOutput() DashboardOutput

func (*Dashboard) ToDashboardOutputWithContext

func (i *Dashboard) ToDashboardOutputWithContext(ctx context.Context) DashboardOutput

type DashboardArgs

type DashboardArgs struct {
	// JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
	DashboardProperties pulumi.StringPtrInput
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// 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.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Dashboard resource.

func (DashboardArgs) ElementType

func (DashboardArgs) ElementType() reflect.Type

type DashboardArray

type DashboardArray []DashboardInput

func (DashboardArray) ElementType

func (DashboardArray) ElementType() reflect.Type

func (DashboardArray) ToDashboardArrayOutput

func (i DashboardArray) ToDashboardArrayOutput() DashboardArrayOutput

func (DashboardArray) ToDashboardArrayOutputWithContext

func (i DashboardArray) ToDashboardArrayOutputWithContext(ctx context.Context) DashboardArrayOutput

type DashboardArrayInput

type DashboardArrayInput interface {
	pulumi.Input

	ToDashboardArrayOutput() DashboardArrayOutput
	ToDashboardArrayOutputWithContext(context.Context) DashboardArrayOutput
}

DashboardArrayInput is an input type that accepts DashboardArray and DashboardArrayOutput values. You can construct a concrete instance of `DashboardArrayInput` via:

DashboardArray{ DashboardArgs{...} }

type DashboardArrayOutput

type DashboardArrayOutput struct{ *pulumi.OutputState }

func (DashboardArrayOutput) ElementType

func (DashboardArrayOutput) ElementType() reflect.Type

func (DashboardArrayOutput) Index

func (DashboardArrayOutput) ToDashboardArrayOutput

func (o DashboardArrayOutput) ToDashboardArrayOutput() DashboardArrayOutput

func (DashboardArrayOutput) ToDashboardArrayOutputWithContext

func (o DashboardArrayOutput) ToDashboardArrayOutputWithContext(ctx context.Context) DashboardArrayOutput

type DashboardInput

type DashboardInput interface {
	pulumi.Input

	ToDashboardOutput() DashboardOutput
	ToDashboardOutputWithContext(ctx context.Context) DashboardOutput
}

type DashboardMap

type DashboardMap map[string]DashboardInput

func (DashboardMap) ElementType

func (DashboardMap) ElementType() reflect.Type

func (DashboardMap) ToDashboardMapOutput

func (i DashboardMap) ToDashboardMapOutput() DashboardMapOutput

func (DashboardMap) ToDashboardMapOutputWithContext

func (i DashboardMap) ToDashboardMapOutputWithContext(ctx context.Context) DashboardMapOutput

type DashboardMapInput

type DashboardMapInput interface {
	pulumi.Input

	ToDashboardMapOutput() DashboardMapOutput
	ToDashboardMapOutputWithContext(context.Context) DashboardMapOutput
}

DashboardMapInput is an input type that accepts DashboardMap and DashboardMapOutput values. You can construct a concrete instance of `DashboardMapInput` via:

DashboardMap{ "key": DashboardArgs{...} }

type DashboardMapOutput

type DashboardMapOutput struct{ *pulumi.OutputState }

func (DashboardMapOutput) ElementType

func (DashboardMapOutput) ElementType() reflect.Type

func (DashboardMapOutput) MapIndex

func (DashboardMapOutput) ToDashboardMapOutput

func (o DashboardMapOutput) ToDashboardMapOutput() DashboardMapOutput

func (DashboardMapOutput) ToDashboardMapOutputWithContext

func (o DashboardMapOutput) ToDashboardMapOutputWithContext(ctx context.Context) DashboardMapOutput

type DashboardOutput

type DashboardOutput struct{ *pulumi.OutputState }

func (DashboardOutput) DashboardProperties added in v5.5.0

func (o DashboardOutput) DashboardProperties() pulumi.StringOutput

JSON data representing dashboard body. See above for details on how to obtain this from the Portal.

func (DashboardOutput) ElementType

func (DashboardOutput) ElementType() reflect.Type

func (DashboardOutput) Location added in v5.5.0

func (o DashboardOutput) Location() pulumi.StringOutput

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

func (DashboardOutput) Name added in v5.5.0

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.

func (DashboardOutput) ResourceGroupName added in v5.5.0

func (o DashboardOutput) ResourceGroupName() pulumi.StringOutput

The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.

func (DashboardOutput) Tags added in v5.5.0

A mapping of tags to assign to the resource.

func (DashboardOutput) ToDashboardOutput

func (o DashboardOutput) ToDashboardOutput() DashboardOutput

func (DashboardOutput) ToDashboardOutputWithContext

func (o DashboardOutput) ToDashboardOutputWithContext(ctx context.Context) DashboardOutput

type DashboardState

type DashboardState struct {
	// JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
	DashboardProperties pulumi.StringPtrInput
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// 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.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (DashboardState) ElementType

func (DashboardState) ElementType() reflect.Type

type LookupDashboardArgs

type LookupDashboardArgs struct {
	// JSON data representing dashboard body.
	DashboardProperties *string `pulumi:"dashboardProperties"`
	// Specifies the display name of the shared Azure Portal Dashboard.
	DisplayName *string `pulumi:"displayName"`
	// Specifies the name of the shared Azure Portal Dashboard.
	Name *string `pulumi:"name"`
	// Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getDashboard.

type LookupDashboardOutputArgs

type LookupDashboardOutputArgs struct {
	// JSON data representing dashboard body.
	DashboardProperties pulumi.StringPtrInput `pulumi:"dashboardProperties"`
	// Specifies the display name of the shared Azure Portal Dashboard.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Specifies the name of the shared Azure Portal Dashboard.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
	ResourceGroupName pulumi.StringInput `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getDashboard.

func (LookupDashboardOutputArgs) ElementType

func (LookupDashboardOutputArgs) ElementType() reflect.Type

type LookupDashboardResult

type LookupDashboardResult struct {
	// JSON data representing dashboard body.
	DashboardProperties string  `pulumi:"dashboardProperties"`
	DisplayName         *string `pulumi:"displayName"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The Azure Region where the shared Azure Portal dashboard exists.
	Location          string  `pulumi:"location"`
	Name              *string `pulumi:"name"`
	ResourceGroupName string  `pulumi:"resourceGroupName"`
	// A mapping of tags assigned to the shared Azure Portal dashboard.
	Tags map[string]string `pulumi:"tags"`
}

A collection of values returned by getDashboard.

func LookupDashboard

func LookupDashboard(ctx *pulumi.Context, args *LookupDashboardArgs, opts ...pulumi.InvokeOption) (*LookupDashboardResult, error)

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/portal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := portal.LookupDashboard(ctx, &portal.LookupDashboardArgs{
			Name:              pulumi.StringRef("existing-dashboard"),
			ResourceGroupName: "dashboard-rg",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", exampleAzurermDashboard.Id)
		return nil
	})
}

```

type LookupDashboardResultOutput

type LookupDashboardResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDashboard.

func (LookupDashboardResultOutput) DashboardProperties

func (o LookupDashboardResultOutput) DashboardProperties() pulumi.StringOutput

JSON data representing dashboard body.

func (LookupDashboardResultOutput) DisplayName added in v5.8.0

func (LookupDashboardResultOutput) ElementType

func (LookupDashboardResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupDashboardResultOutput) Location

The Azure Region where the shared Azure Portal dashboard exists.

func (LookupDashboardResultOutput) Name

func (LookupDashboardResultOutput) ResourceGroupName

func (o LookupDashboardResultOutput) ResourceGroupName() pulumi.StringOutput

func (LookupDashboardResultOutput) Tags

A mapping of tags assigned to the shared Azure Portal dashboard.

func (LookupDashboardResultOutput) ToLookupDashboardResultOutput

func (o LookupDashboardResultOutput) ToLookupDashboardResultOutput() LookupDashboardResultOutput

func (LookupDashboardResultOutput) ToLookupDashboardResultOutputWithContext

func (o LookupDashboardResultOutput) ToLookupDashboardResultOutputWithContext(ctx context.Context) LookupDashboardResultOutput

type PortalDashboard

type PortalDashboard struct {
	pulumi.CustomResourceState

	// JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
	DashboardProperties pulumi.StringOutput `pulumi:"dashboardProperties"`
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// 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.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

## Import

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

```sh $ pulumi import azure:portal/portalDashboard:PortalDashboard 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.

func GetPortalDashboard

func GetPortalDashboard(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PortalDashboardState, opts ...pulumi.ResourceOption) (*PortalDashboard, error)

GetPortalDashboard gets an existing PortalDashboard resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPortalDashboard

func NewPortalDashboard(ctx *pulumi.Context,
	name string, args *PortalDashboardArgs, opts ...pulumi.ResourceOption) (*PortalDashboard, error)

NewPortalDashboard registers a new resource with the given unique name, arguments, and options.

func (*PortalDashboard) ElementType

func (*PortalDashboard) ElementType() reflect.Type

func (*PortalDashboard) ToPortalDashboardOutput

func (i *PortalDashboard) ToPortalDashboardOutput() PortalDashboardOutput

func (*PortalDashboard) ToPortalDashboardOutputWithContext

func (i *PortalDashboard) ToPortalDashboardOutputWithContext(ctx context.Context) PortalDashboardOutput

type PortalDashboardArgs

type PortalDashboardArgs struct {
	// JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
	DashboardProperties pulumi.StringInput
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// 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.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a PortalDashboard resource.

func (PortalDashboardArgs) ElementType

func (PortalDashboardArgs) ElementType() reflect.Type

type PortalDashboardArray

type PortalDashboardArray []PortalDashboardInput

func (PortalDashboardArray) ElementType

func (PortalDashboardArray) ElementType() reflect.Type

func (PortalDashboardArray) ToPortalDashboardArrayOutput

func (i PortalDashboardArray) ToPortalDashboardArrayOutput() PortalDashboardArrayOutput

func (PortalDashboardArray) ToPortalDashboardArrayOutputWithContext

func (i PortalDashboardArray) ToPortalDashboardArrayOutputWithContext(ctx context.Context) PortalDashboardArrayOutput

type PortalDashboardArrayInput

type PortalDashboardArrayInput interface {
	pulumi.Input

	ToPortalDashboardArrayOutput() PortalDashboardArrayOutput
	ToPortalDashboardArrayOutputWithContext(context.Context) PortalDashboardArrayOutput
}

PortalDashboardArrayInput is an input type that accepts PortalDashboardArray and PortalDashboardArrayOutput values. You can construct a concrete instance of `PortalDashboardArrayInput` via:

PortalDashboardArray{ PortalDashboardArgs{...} }

type PortalDashboardArrayOutput

type PortalDashboardArrayOutput struct{ *pulumi.OutputState }

func (PortalDashboardArrayOutput) ElementType

func (PortalDashboardArrayOutput) ElementType() reflect.Type

func (PortalDashboardArrayOutput) Index

func (PortalDashboardArrayOutput) ToPortalDashboardArrayOutput

func (o PortalDashboardArrayOutput) ToPortalDashboardArrayOutput() PortalDashboardArrayOutput

func (PortalDashboardArrayOutput) ToPortalDashboardArrayOutputWithContext

func (o PortalDashboardArrayOutput) ToPortalDashboardArrayOutputWithContext(ctx context.Context) PortalDashboardArrayOutput

type PortalDashboardInput

type PortalDashboardInput interface {
	pulumi.Input

	ToPortalDashboardOutput() PortalDashboardOutput
	ToPortalDashboardOutputWithContext(ctx context.Context) PortalDashboardOutput
}

type PortalDashboardMap

type PortalDashboardMap map[string]PortalDashboardInput

func (PortalDashboardMap) ElementType

func (PortalDashboardMap) ElementType() reflect.Type

func (PortalDashboardMap) ToPortalDashboardMapOutput

func (i PortalDashboardMap) ToPortalDashboardMapOutput() PortalDashboardMapOutput

func (PortalDashboardMap) ToPortalDashboardMapOutputWithContext

func (i PortalDashboardMap) ToPortalDashboardMapOutputWithContext(ctx context.Context) PortalDashboardMapOutput

type PortalDashboardMapInput

type PortalDashboardMapInput interface {
	pulumi.Input

	ToPortalDashboardMapOutput() PortalDashboardMapOutput
	ToPortalDashboardMapOutputWithContext(context.Context) PortalDashboardMapOutput
}

PortalDashboardMapInput is an input type that accepts PortalDashboardMap and PortalDashboardMapOutput values. You can construct a concrete instance of `PortalDashboardMapInput` via:

PortalDashboardMap{ "key": PortalDashboardArgs{...} }

type PortalDashboardMapOutput

type PortalDashboardMapOutput struct{ *pulumi.OutputState }

func (PortalDashboardMapOutput) ElementType

func (PortalDashboardMapOutput) ElementType() reflect.Type

func (PortalDashboardMapOutput) MapIndex

func (PortalDashboardMapOutput) ToPortalDashboardMapOutput

func (o PortalDashboardMapOutput) ToPortalDashboardMapOutput() PortalDashboardMapOutput

func (PortalDashboardMapOutput) ToPortalDashboardMapOutputWithContext

func (o PortalDashboardMapOutput) ToPortalDashboardMapOutputWithContext(ctx context.Context) PortalDashboardMapOutput

type PortalDashboardOutput

type PortalDashboardOutput struct{ *pulumi.OutputState }

func (PortalDashboardOutput) DashboardProperties added in v5.5.0

func (o PortalDashboardOutput) DashboardProperties() pulumi.StringOutput

JSON data representing dashboard body. See above for details on how to obtain this from the Portal.

func (PortalDashboardOutput) ElementType

func (PortalDashboardOutput) ElementType() reflect.Type

func (PortalDashboardOutput) Location added in v5.5.0

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

func (PortalDashboardOutput) Name added in v5.5.0

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.

func (PortalDashboardOutput) ResourceGroupName added in v5.5.0

func (o PortalDashboardOutput) ResourceGroupName() pulumi.StringOutput

The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.

func (PortalDashboardOutput) Tags added in v5.5.0

A mapping of tags to assign to the resource.

func (PortalDashboardOutput) ToPortalDashboardOutput

func (o PortalDashboardOutput) ToPortalDashboardOutput() PortalDashboardOutput

func (PortalDashboardOutput) ToPortalDashboardOutputWithContext

func (o PortalDashboardOutput) ToPortalDashboardOutputWithContext(ctx context.Context) PortalDashboardOutput

type PortalDashboardState

type PortalDashboardState struct {
	// JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
	DashboardProperties pulumi.StringPtrInput
	// Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// 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.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (PortalDashboardState) ElementType

func (PortalDashboardState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL