Class AzureKeyVaultManager

Provides operations on Azure Key Vault 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.keyVaultManager.createKeyVault('MyKeyVault', this, props)
  }
}

Index

Constructors

constructor

Methods

createKeyVault createKeyVaultSecret resolveKeyVault

Constructors

constructor

new AzureKeyVaultManager(): AzureKeyVaultManager
Returns AzureKeyVaultManager

Methods

createKeyVault

createKeyVault(
    id: string,
    scope: CommonAzureConstruct,
    props: KeyVaultProps,
    resourceOptions?: ResourceOptions,
): Vault
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: KeyVaultProps
  key vault properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Vault
See
[Pulumi Azure Native Key Vault]https://www.pulumi.com/registry/packages/azure-native/api-docs/keyvault/vault/
- Defined in packages/azure/src/services/key-vault/main.ts:35

createKeyVaultSecret

createKeyVaultSecret(
    id: string,
    scope: CommonAzureConstruct,
    props: SecretProps,
    resourceOptions?: ResourceOptions,
): Secret
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: SecretProps
  key vault secret properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Secret
See
[Pulumi Azure Native Key Vault Secret]https://www.pulumi.com/registry/packages/azure-native/api-docs/keyvault/secret/
- Defined in packages/azure/src/services/key-vault/main.ts:89

resolveKeyVault

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

Class AzureKeyVaultManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns AzureKeyVaultManager

Methods

createKeyVault

Parameters

Returns Vault

See

createKeyVaultSecret

Parameters

Returns Secret

See

resolveKeyVault

Parameters

Returns Output<GetVaultResult>

Settings

On This Page