Class AzurePortalManager

Provides operations on Azure Portal Dashboards using Pulumi

A new instance of this class is injected into CommonAzureConstruct constructor.
If a custom construct extends CommonAzureConstruct, an instance is available within the context.

Example

import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'

class CustomConstruct extends CommonAzureConstruct {
  constructor(name: string, props: CommonAzureStackProps) {
    super(name, props)
    this.props = props
    this.azurePortalManager.createDashBoard('MyDashboard', this, props)
  }
}

Index

Constructors

constructor

Methods

createDashBoard

Constructors

constructor

new AzurePortalManager(): AzurePortalManager
Returns AzurePortalManager

Methods

createDashBoard

createDashBoard(
    id: string,
    scope: CommonAzureConstruct,
    props: PortalDashboardProps,
    renderer?: AzureDashboardRenderer,
    resourceOptions?: ResourceOptions,
): Dashboard
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: PortalDashboardProps
  the dashboard properties
- Optionalrenderer: AzureDashboardRenderer
  An optional renderer to use
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Dashboard
See
[Pulumi Azure Native Portal Dashboard]https://www.pulumi.com/registry/packages/azure-native/api-docs/portal/dashboard/
- Defined in packages/azure/src/services/portal/main.ts:39

Class AzurePortalManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns AzurePortalManager

Methods

createDashBoard

Parameters

Returns Dashboard

See

Settings

On This Page