Class AzureResourceGroupManager

Provides operations on Azure Resource Group 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.resourceGroupManager.createResourceGroup('MyResourceGroup', this, props)
  }
}

Index

Constructors

constructor

Methods

createResourceGroup resolveResourceGroup

Constructors

constructor

new AzureResourceGroupManager(): AzureResourceGroupManager
Returns AzureResourceGroupManager

Methods

createResourceGroup

createResourceGroup(
    id: string,
    scope: CommonAzureConstruct,
    props: ResourceGroupProps,
    resourceOptions?: ResourceOptions,
): ResourceGroup
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: ResourceGroupProps
  resource group properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns ResourceGroup
See
[Pulumi Azure Native Resource Group]https://www.pulumi.com/registry/packages/azure-native/api-docs/resources/resourcegroup/
- Defined in packages/azure/src/services/resource-group/main.ts:35

resolveResourceGroup

resolveResourceGroup(
    scope: CommonAzureConstruct,
    resourceGroupName: string,
    resourceOptions?: ResourceOptions,
): Output<GetResourceGroupResult>
Parameters
- scope: CommonAzureConstruct
  scope in which this resource is defined
- resourceGroupName: string
  the resource group name
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Output<GetResourceGroupResult>
- Defined in packages/azure/src/services/resource-group/main.ts:66

Class AzureResourceGroupManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns AzureResourceGroupManager

Methods

createResourceGroup

Parameters

Returns ResourceGroup

See

resolveResourceGroup

Parameters

Returns Output<GetResourceGroupResult>

Settings

On This Page