portal

package
v6.8.0 Latest Latest
Warning

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

 Go to latest Published: Nov 4, 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 Azurerm_portal_dashboardArgs 

type Azurerm_portal_dashboardArgs 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 azurerm_portal_dashboard.

type Azurerm_portal_dashboardOutputArgs 

type Azurerm_portal_dashboardOutputArgs 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 azurerm_portal_dashboard.

func (Azurerm_portal_dashboardOutputArgs) ElementType 

func (Azurerm_portal_dashboardOutputArgs) ElementType() reflect.Type

type Azurerm_portal_dashboardResult 

type Azurerm_portal_dashboardResult 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 azurerm_portal_dashboard.

func Azurerm_portal_dashboard 

func Azurerm_portal_dashboard(ctx *pulumi.Context, args *Azurerm_portal_dashboardArgs, opts ...pulumi.InvokeOption) (*Azurerm_portal_dashboardResult, error)

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

## Example Usage

```go package main

import ( 

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

) 

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

```

type Azurerm_portal_dashboardResultOutput 

type Azurerm_portal_dashboardResultOutput struct{ *pulumi.OutputState }

A collection of values returned by azurerm_portal_dashboard.

func Azurerm_portal_dashboardOutput 

func Azurerm_portal_dashboardOutput(ctx *pulumi.Context, args Azurerm_portal_dashboardOutputArgs, opts ...pulumi.InvokeOption) Azurerm_portal_dashboardResultOutput

func (Azurerm_portal_dashboardResultOutput) DashboardProperties 

func (o Azurerm_portal_dashboardResultOutput) DashboardProperties() pulumi.StringOutput

JSON data representing dashboard body.

func (Azurerm_portal_dashboardResultOutput) DisplayName 

func (o Azurerm_portal_dashboardResultOutput) DisplayName() pulumi.StringPtrOutput

func (Azurerm_portal_dashboardResultOutput) ElementType 

func (Azurerm_portal_dashboardResultOutput) ElementType() reflect.Type

func (Azurerm_portal_dashboardResultOutput) Id 

func (o Azurerm_portal_dashboardResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (Azurerm_portal_dashboardResultOutput) Location 

func (o Azurerm_portal_dashboardResultOutput) Location() pulumi.StringOutput

The Azure Region where the shared Azure Portal dashboard exists.

func (Azurerm_portal_dashboardResultOutput) Name 

func (o Azurerm_portal_dashboardResultOutput) Name() pulumi.StringPtrOutput

func (Azurerm_portal_dashboardResultOutput) ResourceGroupName 

func (o Azurerm_portal_dashboardResultOutput) ResourceGroupName() pulumi.StringOutput

func (Azurerm_portal_dashboardResultOutput) Tags 

func (o Azurerm_portal_dashboardResultOutput) Tags() pulumi.StringMapOutput

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

func (Azurerm_portal_dashboardResultOutput) ToAzurerm_portal_dashboardResultOutput 

func (o Azurerm_portal_dashboardResultOutput) ToAzurerm_portal_dashboardResultOutput() Azurerm_portal_dashboardResultOutput

func (Azurerm_portal_dashboardResultOutput) ToAzurerm_portal_dashboardResultOutputWithContext 

func (o Azurerm_portal_dashboardResultOutput) ToAzurerm_portal_dashboardResultOutputWithContext(ctx context.Context) Azurerm_portal_dashboardResultOutput

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 (o PortalDashboardArrayOutput) Index(i pulumi.IntInput) PortalDashboardOutput

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 (o PortalDashboardMapOutput) MapIndex(k pulumi.StringInput) PortalDashboardOutput

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 

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 

func (o PortalDashboardOutput) Location() pulumi.StringOutput

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

func (PortalDashboardOutput) Name 

func (o PortalDashboardOutput) Name() pulumi.StringOutput

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 

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 

func (o PortalDashboardOutput) Tags() pulumi.StringMapOutput

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.