Documentation ¶
Index ¶
- type Azurerm_portal_dashboardArgs
- type Azurerm_portal_dashboardOutputArgs
- type Azurerm_portal_dashboardResult
- type Azurerm_portal_dashboardResultOutput
- func (o Azurerm_portal_dashboardResultOutput) DashboardProperties() pulumi.StringOutput
- func (o Azurerm_portal_dashboardResultOutput) DisplayName() pulumi.StringPtrOutput
- func (Azurerm_portal_dashboardResultOutput) ElementType() reflect.Type
- func (o Azurerm_portal_dashboardResultOutput) Id() pulumi.StringOutput
- func (o Azurerm_portal_dashboardResultOutput) Location() pulumi.StringOutput
- func (o Azurerm_portal_dashboardResultOutput) Name() pulumi.StringPtrOutput
- func (o Azurerm_portal_dashboardResultOutput) ResourceGroupName() pulumi.StringOutput
- func (o Azurerm_portal_dashboardResultOutput) Tags() pulumi.StringMapOutput
- func (o Azurerm_portal_dashboardResultOutput) ToAzurerm_portal_dashboardResultOutput() Azurerm_portal_dashboardResultOutput
- func (o Azurerm_portal_dashboardResultOutput) ToAzurerm_portal_dashboardResultOutputWithContext(ctx context.Context) Azurerm_portal_dashboardResultOutput
- type Dashboarddeprecated
- type DashboardArgs
- type DashboardArray
- type DashboardArrayInput
- type DashboardArrayOutput
- func (DashboardArrayOutput) ElementType() reflect.Type
- func (o DashboardArrayOutput) Index(i pulumi.IntInput) DashboardOutput
- func (o DashboardArrayOutput) ToDashboardArrayOutput() DashboardArrayOutput
- func (o DashboardArrayOutput) ToDashboardArrayOutputWithContext(ctx context.Context) DashboardArrayOutput
- type DashboardInput
- type DashboardMap
- type DashboardMapInput
- type DashboardMapOutput
- type DashboardOutput
- func (o DashboardOutput) DashboardProperties() pulumi.StringOutput
- func (DashboardOutput) ElementType() reflect.Type
- func (o DashboardOutput) Location() pulumi.StringOutput
- func (o DashboardOutput) Name() pulumi.StringOutput
- func (o DashboardOutput) ResourceGroupName() pulumi.StringOutput
- func (o DashboardOutput) Tags() pulumi.StringMapOutput
- func (o DashboardOutput) ToDashboardOutput() DashboardOutput
- func (o DashboardOutput) ToDashboardOutputWithContext(ctx context.Context) DashboardOutput
- type DashboardState
- type Grafana
- type GrafanaArgs
- type GrafanaArray
- type GrafanaArrayInput
- type GrafanaArrayOutput
- type GrafanaIdentity
- type GrafanaIdentityArgs
- func (GrafanaIdentityArgs) ElementType() reflect.Type
- func (i GrafanaIdentityArgs) ToGrafanaIdentityOutput() GrafanaIdentityOutput
- func (i GrafanaIdentityArgs) ToGrafanaIdentityOutputWithContext(ctx context.Context) GrafanaIdentityOutput
- func (i GrafanaIdentityArgs) ToGrafanaIdentityPtrOutput() GrafanaIdentityPtrOutput
- func (i GrafanaIdentityArgs) ToGrafanaIdentityPtrOutputWithContext(ctx context.Context) GrafanaIdentityPtrOutput
- type GrafanaIdentityInput
- type GrafanaIdentityOutput
- func (GrafanaIdentityOutput) ElementType() reflect.Type
- func (o GrafanaIdentityOutput) PrincipalId() pulumi.StringPtrOutput
- func (o GrafanaIdentityOutput) TenantId() pulumi.StringPtrOutput
- func (o GrafanaIdentityOutput) ToGrafanaIdentityOutput() GrafanaIdentityOutput
- func (o GrafanaIdentityOutput) ToGrafanaIdentityOutputWithContext(ctx context.Context) GrafanaIdentityOutput
- func (o GrafanaIdentityOutput) ToGrafanaIdentityPtrOutput() GrafanaIdentityPtrOutput
- func (o GrafanaIdentityOutput) ToGrafanaIdentityPtrOutputWithContext(ctx context.Context) GrafanaIdentityPtrOutput
- func (o GrafanaIdentityOutput) Type() pulumi.StringOutput
- type GrafanaIdentityPtrInput
- type GrafanaIdentityPtrOutput
- func (o GrafanaIdentityPtrOutput) Elem() GrafanaIdentityOutput
- func (GrafanaIdentityPtrOutput) ElementType() reflect.Type
- func (o GrafanaIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput
- func (o GrafanaIdentityPtrOutput) TenantId() pulumi.StringPtrOutput
- func (o GrafanaIdentityPtrOutput) ToGrafanaIdentityPtrOutput() GrafanaIdentityPtrOutput
- func (o GrafanaIdentityPtrOutput) ToGrafanaIdentityPtrOutputWithContext(ctx context.Context) GrafanaIdentityPtrOutput
- func (o GrafanaIdentityPtrOutput) Type() pulumi.StringPtrOutput
- type GrafanaInput
- type GrafanaMap
- type GrafanaMapInput
- type GrafanaMapOutput
- type GrafanaOutput
- func (o GrafanaOutput) ApiKeyEnabled() pulumi.BoolPtrOutput
- func (o GrafanaOutput) AutoGeneratedDomainNameLabelScope() pulumi.StringPtrOutput
- func (o GrafanaOutput) DeterministicOutboundIpEnabled() pulumi.BoolPtrOutput
- func (GrafanaOutput) ElementType() reflect.Type
- func (o GrafanaOutput) Endpoint() pulumi.StringOutput
- func (o GrafanaOutput) GrafanaVersion() pulumi.StringOutput
- func (o GrafanaOutput) Identity() GrafanaIdentityPtrOutput
- func (o GrafanaOutput) Location() pulumi.StringOutput
- func (o GrafanaOutput) Name() pulumi.StringOutput
- func (o GrafanaOutput) OutboundIps() pulumi.StringArrayOutput
- func (o GrafanaOutput) PublicNetworkAccessEnabled() pulumi.BoolPtrOutput
- func (o GrafanaOutput) ResourceGroupName() pulumi.StringOutput
- func (o GrafanaOutput) Sku() pulumi.StringPtrOutput
- func (o GrafanaOutput) Tags() pulumi.StringMapOutput
- func (o GrafanaOutput) ToGrafanaOutput() GrafanaOutput
- func (o GrafanaOutput) ToGrafanaOutputWithContext(ctx context.Context) GrafanaOutput
- func (o GrafanaOutput) ZoneRedundancyEnabled() pulumi.BoolPtrOutput
- type GrafanaState
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
deprecated
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 `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", data.Azurerm_dashboard.Example.Id) return nil }) }
```
Deprecated: azure.dashboard.azurerm_portal_dashboard has been deprecated in favor of azure.portal.getDashboard
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 ¶ added in v5.8.0
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 Dashboard
deprecated
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. 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"` }
## 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, "") mdContent := "# Hello all :)" if param := cfg.Get("mdContent"); param != "" { mdContent = param } 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{ Location: pulumi.String("West Europe"), }) if err != nil { return err } _, err = portal.NewDashboard(ctx, "my-board", &portal.DashboardArgs{ 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.
## Import
Dashboards can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:dashboard/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.
Deprecated: azure.dashboard.Dashboard has been deprecated in favor of azure.portal.Dashboard
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) 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. 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 (o DashboardArrayOutput) Index(i pulumi.IntInput) DashboardOutput
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 (o DashboardMapOutput) MapIndex(k pulumi.StringInput) DashboardOutput
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
func (o DashboardOutput) Name() pulumi.StringOutput
Specifies the name of the Shared Dashboard. Changing this forces a new resource to be created.
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
func (o DashboardOutput) Tags() pulumi.StringMapOutput
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. 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 Grafana ¶ added in v5.18.0
type Grafana struct { pulumi.CustomResourceState // Whether to enable the api key setting of the Grafana instance. Defaults to `false`. ApiKeyEnabled pulumi.BoolPtrOutput `pulumi:"apiKeyEnabled"` // Scope for dns deterministic name hash calculation. The only possible value is `TenantReuse`. Defaults to `TenantReuse`. AutoGeneratedDomainNameLabelScope pulumi.StringPtrOutput `pulumi:"autoGeneratedDomainNameLabelScope"` // Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to `false`. DeterministicOutboundIpEnabled pulumi.BoolPtrOutput `pulumi:"deterministicOutboundIpEnabled"` // The endpoint of the Grafana instance. Endpoint pulumi.StringOutput `pulumi:"endpoint"` // The Grafana software version. GrafanaVersion pulumi.StringOutput `pulumi:"grafanaVersion"` // An `identity` block as defined below. Changing this forces a new Dashboard Grafana to be created. Identity GrafanaIdentityPtrOutput `pulumi:"identity"` // Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created. Location pulumi.StringOutput `pulumi:"location"` // Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created. Name pulumi.StringOutput `pulumi:"name"` // List of outbound IPs if deterministicOutboundIP is enabled. OutboundIps pulumi.StringArrayOutput `pulumi:"outboundIps"` // Whether to enable traffic over the public interface. Defaults to `true`. PublicNetworkAccessEnabled pulumi.BoolPtrOutput `pulumi:"publicNetworkAccessEnabled"` // Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The name of the SKU used for the Grafana instance. The only possible value is `Standard`. Defaults to `Standard`. Changing this forces a new Dashboard Grafana to be created. Sku pulumi.StringPtrOutput `pulumi:"sku"` // A mapping of tags which should be assigned to the Dashboard Grafana. Tags pulumi.StringMapOutput `pulumi:"tags"` // Whether to enable the zone redundancy setting of the Grafana instance. Defaults to `false`. Changing this forces a new Dashboard Grafana to be created. ZoneRedundancyEnabled pulumi.BoolPtrOutput `pulumi:"zoneRedundancyEnabled"` }
Manages a Dashboard Grafana.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dashboard" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } _, err = dashboard.NewGrafana(ctx, "exampleGrafana", &dashboard.GrafanaArgs{ ResourceGroupName: exampleResourceGroup.Name, Location: pulumi.String("West Europe"), ApiKeyEnabled: pulumi.Bool(true), DeterministicOutboundIpEnabled: pulumi.Bool(true), PublicNetworkAccessEnabled: pulumi.Bool(false), Identity: &dashboard.GrafanaIdentityArgs{ Type: pulumi.String("SystemAssigned"), }, Tags: pulumi.StringMap{ "key": pulumi.String("value"), }, }) if err != nil { return err } return nil }) }
```
## Import
Dashboard Grafana can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:dashboard/grafana:Grafana example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Dashboard/grafana/workspace1
```
func GetGrafana ¶ added in v5.18.0
func GetGrafana(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GrafanaState, opts ...pulumi.ResourceOption) (*Grafana, error)
GetGrafana gets an existing Grafana 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 NewGrafana ¶ added in v5.18.0
func NewGrafana(ctx *pulumi.Context, name string, args *GrafanaArgs, opts ...pulumi.ResourceOption) (*Grafana, error)
NewGrafana registers a new resource with the given unique name, arguments, and options.
func (*Grafana) ElementType ¶ added in v5.18.0
func (*Grafana) ToGrafanaOutput ¶ added in v5.18.0
func (i *Grafana) ToGrafanaOutput() GrafanaOutput
func (*Grafana) ToGrafanaOutputWithContext ¶ added in v5.18.0
func (i *Grafana) ToGrafanaOutputWithContext(ctx context.Context) GrafanaOutput
type GrafanaArgs ¶ added in v5.18.0
type GrafanaArgs struct { // Whether to enable the api key setting of the Grafana instance. Defaults to `false`. ApiKeyEnabled pulumi.BoolPtrInput // Scope for dns deterministic name hash calculation. The only possible value is `TenantReuse`. Defaults to `TenantReuse`. AutoGeneratedDomainNameLabelScope pulumi.StringPtrInput // Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to `false`. DeterministicOutboundIpEnabled pulumi.BoolPtrInput // An `identity` block as defined below. Changing this forces a new Dashboard Grafana to be created. Identity GrafanaIdentityPtrInput // Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created. Location pulumi.StringPtrInput // Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created. Name pulumi.StringPtrInput // Whether to enable traffic over the public interface. Defaults to `true`. PublicNetworkAccessEnabled pulumi.BoolPtrInput // Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created. ResourceGroupName pulumi.StringInput // The name of the SKU used for the Grafana instance. The only possible value is `Standard`. Defaults to `Standard`. Changing this forces a new Dashboard Grafana to be created. Sku pulumi.StringPtrInput // A mapping of tags which should be assigned to the Dashboard Grafana. Tags pulumi.StringMapInput // Whether to enable the zone redundancy setting of the Grafana instance. Defaults to `false`. Changing this forces a new Dashboard Grafana to be created. ZoneRedundancyEnabled pulumi.BoolPtrInput }
The set of arguments for constructing a Grafana resource.
func (GrafanaArgs) ElementType ¶ added in v5.18.0
func (GrafanaArgs) ElementType() reflect.Type
type GrafanaArray ¶ added in v5.18.0
type GrafanaArray []GrafanaInput
func (GrafanaArray) ElementType ¶ added in v5.18.0
func (GrafanaArray) ElementType() reflect.Type
func (GrafanaArray) ToGrafanaArrayOutput ¶ added in v5.18.0
func (i GrafanaArray) ToGrafanaArrayOutput() GrafanaArrayOutput
func (GrafanaArray) ToGrafanaArrayOutputWithContext ¶ added in v5.18.0
func (i GrafanaArray) ToGrafanaArrayOutputWithContext(ctx context.Context) GrafanaArrayOutput
type GrafanaArrayInput ¶ added in v5.18.0
type GrafanaArrayInput interface { pulumi.Input ToGrafanaArrayOutput() GrafanaArrayOutput ToGrafanaArrayOutputWithContext(context.Context) GrafanaArrayOutput }
GrafanaArrayInput is an input type that accepts GrafanaArray and GrafanaArrayOutput values. You can construct a concrete instance of `GrafanaArrayInput` via:
GrafanaArray{ GrafanaArgs{...} }
type GrafanaArrayOutput ¶ added in v5.18.0
type GrafanaArrayOutput struct{ *pulumi.OutputState }
func (GrafanaArrayOutput) ElementType ¶ added in v5.18.0
func (GrafanaArrayOutput) ElementType() reflect.Type
func (GrafanaArrayOutput) Index ¶ added in v5.18.0
func (o GrafanaArrayOutput) Index(i pulumi.IntInput) GrafanaOutput
func (GrafanaArrayOutput) ToGrafanaArrayOutput ¶ added in v5.18.0
func (o GrafanaArrayOutput) ToGrafanaArrayOutput() GrafanaArrayOutput
func (GrafanaArrayOutput) ToGrafanaArrayOutputWithContext ¶ added in v5.18.0
func (o GrafanaArrayOutput) ToGrafanaArrayOutputWithContext(ctx context.Context) GrafanaArrayOutput
type GrafanaIdentity ¶ added in v5.18.0
type GrafanaIdentity struct { // The Principal ID associated with this Managed Service Identity. PrincipalId *string `pulumi:"principalId"` // The Tenant ID associated with this Managed Service Identity. TenantId *string `pulumi:"tenantId"` // Specifies the type of Managed Service Identity. The only possible values is `SystemAssigned`. Type string `pulumi:"type"` }
type GrafanaIdentityArgs ¶ added in v5.18.0
type GrafanaIdentityArgs struct { // The Principal ID associated with this Managed Service Identity. PrincipalId pulumi.StringPtrInput `pulumi:"principalId"` // The Tenant ID associated with this Managed Service Identity. TenantId pulumi.StringPtrInput `pulumi:"tenantId"` // Specifies the type of Managed Service Identity. The only possible values is `SystemAssigned`. Type pulumi.StringInput `pulumi:"type"` }
func (GrafanaIdentityArgs) ElementType ¶ added in v5.18.0
func (GrafanaIdentityArgs) ElementType() reflect.Type
func (GrafanaIdentityArgs) ToGrafanaIdentityOutput ¶ added in v5.18.0
func (i GrafanaIdentityArgs) ToGrafanaIdentityOutput() GrafanaIdentityOutput
func (GrafanaIdentityArgs) ToGrafanaIdentityOutputWithContext ¶ added in v5.18.0
func (i GrafanaIdentityArgs) ToGrafanaIdentityOutputWithContext(ctx context.Context) GrafanaIdentityOutput
func (GrafanaIdentityArgs) ToGrafanaIdentityPtrOutput ¶ added in v5.18.0
func (i GrafanaIdentityArgs) ToGrafanaIdentityPtrOutput() GrafanaIdentityPtrOutput
func (GrafanaIdentityArgs) ToGrafanaIdentityPtrOutputWithContext ¶ added in v5.18.0
func (i GrafanaIdentityArgs) ToGrafanaIdentityPtrOutputWithContext(ctx context.Context) GrafanaIdentityPtrOutput
type GrafanaIdentityInput ¶ added in v5.18.0
type GrafanaIdentityInput interface { pulumi.Input ToGrafanaIdentityOutput() GrafanaIdentityOutput ToGrafanaIdentityOutputWithContext(context.Context) GrafanaIdentityOutput }
GrafanaIdentityInput is an input type that accepts GrafanaIdentityArgs and GrafanaIdentityOutput values. You can construct a concrete instance of `GrafanaIdentityInput` via:
GrafanaIdentityArgs{...}
type GrafanaIdentityOutput ¶ added in v5.18.0
type GrafanaIdentityOutput struct{ *pulumi.OutputState }
func (GrafanaIdentityOutput) ElementType ¶ added in v5.18.0
func (GrafanaIdentityOutput) ElementType() reflect.Type
func (GrafanaIdentityOutput) PrincipalId ¶ added in v5.18.0
func (o GrafanaIdentityOutput) PrincipalId() pulumi.StringPtrOutput
The Principal ID associated with this Managed Service Identity.
func (GrafanaIdentityOutput) TenantId ¶ added in v5.18.0
func (o GrafanaIdentityOutput) TenantId() pulumi.StringPtrOutput
The Tenant ID associated with this Managed Service Identity.
func (GrafanaIdentityOutput) ToGrafanaIdentityOutput ¶ added in v5.18.0
func (o GrafanaIdentityOutput) ToGrafanaIdentityOutput() GrafanaIdentityOutput
func (GrafanaIdentityOutput) ToGrafanaIdentityOutputWithContext ¶ added in v5.18.0
func (o GrafanaIdentityOutput) ToGrafanaIdentityOutputWithContext(ctx context.Context) GrafanaIdentityOutput
func (GrafanaIdentityOutput) ToGrafanaIdentityPtrOutput ¶ added in v5.18.0
func (o GrafanaIdentityOutput) ToGrafanaIdentityPtrOutput() GrafanaIdentityPtrOutput
func (GrafanaIdentityOutput) ToGrafanaIdentityPtrOutputWithContext ¶ added in v5.18.0
func (o GrafanaIdentityOutput) ToGrafanaIdentityPtrOutputWithContext(ctx context.Context) GrafanaIdentityPtrOutput
func (GrafanaIdentityOutput) Type ¶ added in v5.18.0
func (o GrafanaIdentityOutput) Type() pulumi.StringOutput
Specifies the type of Managed Service Identity. The only possible values is `SystemAssigned`.
type GrafanaIdentityPtrInput ¶ added in v5.18.0
type GrafanaIdentityPtrInput interface { pulumi.Input ToGrafanaIdentityPtrOutput() GrafanaIdentityPtrOutput ToGrafanaIdentityPtrOutputWithContext(context.Context) GrafanaIdentityPtrOutput }
GrafanaIdentityPtrInput is an input type that accepts GrafanaIdentityArgs, GrafanaIdentityPtr and GrafanaIdentityPtrOutput values. You can construct a concrete instance of `GrafanaIdentityPtrInput` via:
GrafanaIdentityArgs{...} or: nil
func GrafanaIdentityPtr ¶ added in v5.18.0
func GrafanaIdentityPtr(v *GrafanaIdentityArgs) GrafanaIdentityPtrInput
type GrafanaIdentityPtrOutput ¶ added in v5.18.0
type GrafanaIdentityPtrOutput struct{ *pulumi.OutputState }
func (GrafanaIdentityPtrOutput) Elem ¶ added in v5.18.0
func (o GrafanaIdentityPtrOutput) Elem() GrafanaIdentityOutput
func (GrafanaIdentityPtrOutput) ElementType ¶ added in v5.18.0
func (GrafanaIdentityPtrOutput) ElementType() reflect.Type
func (GrafanaIdentityPtrOutput) PrincipalId ¶ added in v5.18.0
func (o GrafanaIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput
The Principal ID associated with this Managed Service Identity.
func (GrafanaIdentityPtrOutput) TenantId ¶ added in v5.18.0
func (o GrafanaIdentityPtrOutput) TenantId() pulumi.StringPtrOutput
The Tenant ID associated with this Managed Service Identity.
func (GrafanaIdentityPtrOutput) ToGrafanaIdentityPtrOutput ¶ added in v5.18.0
func (o GrafanaIdentityPtrOutput) ToGrafanaIdentityPtrOutput() GrafanaIdentityPtrOutput
func (GrafanaIdentityPtrOutput) ToGrafanaIdentityPtrOutputWithContext ¶ added in v5.18.0
func (o GrafanaIdentityPtrOutput) ToGrafanaIdentityPtrOutputWithContext(ctx context.Context) GrafanaIdentityPtrOutput
func (GrafanaIdentityPtrOutput) Type ¶ added in v5.18.0
func (o GrafanaIdentityPtrOutput) Type() pulumi.StringPtrOutput
Specifies the type of Managed Service Identity. The only possible values is `SystemAssigned`.
type GrafanaInput ¶ added in v5.18.0
type GrafanaInput interface { pulumi.Input ToGrafanaOutput() GrafanaOutput ToGrafanaOutputWithContext(ctx context.Context) GrafanaOutput }
type GrafanaMap ¶ added in v5.18.0
type GrafanaMap map[string]GrafanaInput
func (GrafanaMap) ElementType ¶ added in v5.18.0
func (GrafanaMap) ElementType() reflect.Type
func (GrafanaMap) ToGrafanaMapOutput ¶ added in v5.18.0
func (i GrafanaMap) ToGrafanaMapOutput() GrafanaMapOutput
func (GrafanaMap) ToGrafanaMapOutputWithContext ¶ added in v5.18.0
func (i GrafanaMap) ToGrafanaMapOutputWithContext(ctx context.Context) GrafanaMapOutput
type GrafanaMapInput ¶ added in v5.18.0
type GrafanaMapInput interface { pulumi.Input ToGrafanaMapOutput() GrafanaMapOutput ToGrafanaMapOutputWithContext(context.Context) GrafanaMapOutput }
GrafanaMapInput is an input type that accepts GrafanaMap and GrafanaMapOutput values. You can construct a concrete instance of `GrafanaMapInput` via:
GrafanaMap{ "key": GrafanaArgs{...} }
type GrafanaMapOutput ¶ added in v5.18.0
type GrafanaMapOutput struct{ *pulumi.OutputState }
func (GrafanaMapOutput) ElementType ¶ added in v5.18.0
func (GrafanaMapOutput) ElementType() reflect.Type
func (GrafanaMapOutput) MapIndex ¶ added in v5.18.0
func (o GrafanaMapOutput) MapIndex(k pulumi.StringInput) GrafanaOutput
func (GrafanaMapOutput) ToGrafanaMapOutput ¶ added in v5.18.0
func (o GrafanaMapOutput) ToGrafanaMapOutput() GrafanaMapOutput
func (GrafanaMapOutput) ToGrafanaMapOutputWithContext ¶ added in v5.18.0
func (o GrafanaMapOutput) ToGrafanaMapOutputWithContext(ctx context.Context) GrafanaMapOutput
type GrafanaOutput ¶ added in v5.18.0
type GrafanaOutput struct{ *pulumi.OutputState }
func (GrafanaOutput) ApiKeyEnabled ¶ added in v5.18.0
func (o GrafanaOutput) ApiKeyEnabled() pulumi.BoolPtrOutput
Whether to enable the api key setting of the Grafana instance. Defaults to `false`.
func (GrafanaOutput) AutoGeneratedDomainNameLabelScope ¶ added in v5.18.0
func (o GrafanaOutput) AutoGeneratedDomainNameLabelScope() pulumi.StringPtrOutput
Scope for dns deterministic name hash calculation. The only possible value is `TenantReuse`. Defaults to `TenantReuse`.
func (GrafanaOutput) DeterministicOutboundIpEnabled ¶ added in v5.18.0
func (o GrafanaOutput) DeterministicOutboundIpEnabled() pulumi.BoolPtrOutput
Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to `false`.
func (GrafanaOutput) ElementType ¶ added in v5.18.0
func (GrafanaOutput) ElementType() reflect.Type
func (GrafanaOutput) Endpoint ¶ added in v5.18.0
func (o GrafanaOutput) Endpoint() pulumi.StringOutput
The endpoint of the Grafana instance.
func (GrafanaOutput) GrafanaVersion ¶ added in v5.18.0
func (o GrafanaOutput) GrafanaVersion() pulumi.StringOutput
The Grafana software version.
func (GrafanaOutput) Identity ¶ added in v5.18.0
func (o GrafanaOutput) Identity() GrafanaIdentityPtrOutput
An `identity` block as defined below. Changing this forces a new Dashboard Grafana to be created.
func (GrafanaOutput) Location ¶ added in v5.18.0
func (o GrafanaOutput) Location() pulumi.StringOutput
Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
func (GrafanaOutput) Name ¶ added in v5.18.0
func (o GrafanaOutput) Name() pulumi.StringOutput
Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
func (GrafanaOutput) OutboundIps ¶ added in v5.18.0
func (o GrafanaOutput) OutboundIps() pulumi.StringArrayOutput
List of outbound IPs if deterministicOutboundIP is enabled.
func (GrafanaOutput) PublicNetworkAccessEnabled ¶ added in v5.18.0
func (o GrafanaOutput) PublicNetworkAccessEnabled() pulumi.BoolPtrOutput
Whether to enable traffic over the public interface. Defaults to `true`.
func (GrafanaOutput) ResourceGroupName ¶ added in v5.18.0
func (o GrafanaOutput) ResourceGroupName() pulumi.StringOutput
Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
func (GrafanaOutput) Sku ¶ added in v5.18.0
func (o GrafanaOutput) Sku() pulumi.StringPtrOutput
The name of the SKU used for the Grafana instance. The only possible value is `Standard`. Defaults to `Standard`. Changing this forces a new Dashboard Grafana to be created.
func (GrafanaOutput) Tags ¶ added in v5.18.0
func (o GrafanaOutput) Tags() pulumi.StringMapOutput
A mapping of tags which should be assigned to the Dashboard Grafana.
func (GrafanaOutput) ToGrafanaOutput ¶ added in v5.18.0
func (o GrafanaOutput) ToGrafanaOutput() GrafanaOutput
func (GrafanaOutput) ToGrafanaOutputWithContext ¶ added in v5.18.0
func (o GrafanaOutput) ToGrafanaOutputWithContext(ctx context.Context) GrafanaOutput
func (GrafanaOutput) ZoneRedundancyEnabled ¶ added in v5.18.0
func (o GrafanaOutput) ZoneRedundancyEnabled() pulumi.BoolPtrOutput
Whether to enable the zone redundancy setting of the Grafana instance. Defaults to `false`. Changing this forces a new Dashboard Grafana to be created.
type GrafanaState ¶ added in v5.18.0
type GrafanaState struct { // Whether to enable the api key setting of the Grafana instance. Defaults to `false`. ApiKeyEnabled pulumi.BoolPtrInput // Scope for dns deterministic name hash calculation. The only possible value is `TenantReuse`. Defaults to `TenantReuse`. AutoGeneratedDomainNameLabelScope pulumi.StringPtrInput // Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to `false`. DeterministicOutboundIpEnabled pulumi.BoolPtrInput // The endpoint of the Grafana instance. Endpoint pulumi.StringPtrInput // The Grafana software version. GrafanaVersion pulumi.StringPtrInput // An `identity` block as defined below. Changing this forces a new Dashboard Grafana to be created. Identity GrafanaIdentityPtrInput // Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created. Location pulumi.StringPtrInput // Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created. Name pulumi.StringPtrInput // List of outbound IPs if deterministicOutboundIP is enabled. OutboundIps pulumi.StringArrayInput // Whether to enable traffic over the public interface. Defaults to `true`. PublicNetworkAccessEnabled pulumi.BoolPtrInput // Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created. ResourceGroupName pulumi.StringPtrInput // The name of the SKU used for the Grafana instance. The only possible value is `Standard`. Defaults to `Standard`. Changing this forces a new Dashboard Grafana to be created. Sku pulumi.StringPtrInput // A mapping of tags which should be assigned to the Dashboard Grafana. Tags pulumi.StringMapInput // Whether to enable the zone redundancy setting of the Grafana instance. Defaults to `false`. Changing this forces a new Dashboard Grafana to be created. ZoneRedundancyEnabled pulumi.BoolPtrInput }
func (GrafanaState) ElementType ¶ added in v5.18.0
func (GrafanaState) ElementType() reflect.Type