Class AzureCosmosDbManager

Provides operations on Azure CosmosDB 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.CosmosDbManager.createCosmosDbAccount('MyCosmosDb', this, props)
  }
}

Index

Constructors

constructor

Methods

createCosmosDbAccount createCosmosDbContainer createCosmosDbDatabase createSqlResourceSqlRoleAssignment grantSqlRoleDefinitionToAccount resolveCosmosDbAccount resolveSqlRoleDefinition

Constructors

constructor

new AzureCosmosDbManager(): AzureCosmosDbManager
Returns AzureCosmosDbManager

Methods

createCosmosDbAccount

createCosmosDbAccount(
    id: string,
    scope: CommonAzureConstruct,
    props: CosmosdbAccountProps,
    resourceOptions?: ResourceOptions,
): DatabaseAccount
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: CosmosdbAccountProps
  cosmosdb account properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns DatabaseAccount
See
[Pulumi Azure Native CosmosDB Database Account]https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/databaseaccount/
- Defined in packages/azure/src/services/cosmosdb/main.ts:49

createCosmosDbContainer

createCosmosDbContainer(
    id: string,
    scope: CommonAzureConstruct,
    props: CosmosdbSqlContainerProps,
    resourceOptions?: ResourceOptions,
): SqlResourceSqlContainer
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: CosmosdbSqlContainerProps
  cosmosdb container properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns SqlResourceSqlContainer
See
[Pulumi Azure Native CosmosDB SQL Container]https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/sqlresourcesqlcontainer/
- Defined in packages/azure/src/services/cosmosdb/main.ts:130

createCosmosDbDatabase

createCosmosDbDatabase(
    id: string,
    scope: CommonAzureConstruct,
    props: CosmosdbSqlDatabaseProps,
    resourceOptions?: ResourceOptions,
): SqlResourceSqlDatabase
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: CosmosdbSqlDatabaseProps
  cosmosdb database properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns SqlResourceSqlDatabase
See
[Pulumi Azure Native CosmosDB SQL Database]https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/sqlresourcesqldatabase/
- Defined in packages/azure/src/services/cosmosdb/main.ts:93

createSqlResourceSqlRoleAssignment

createSqlResourceSqlRoleAssignment(
    id: string,
    scope: CommonAzureConstruct,
    props: SqlResourceSqlRoleAssignmentProps,
    resourceOptions?: ResourceOptions,
): SqlResourceSqlRoleAssignment
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: SqlResourceSqlRoleAssignmentProps
  sql role assignment properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns SqlResourceSqlRoleAssignment
See
[Pulumi Azure Native CosmosDB SQL Role Assignment]https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/sqlresourcesqlroleassignment/
- Defined in packages/azure/src/services/cosmosdb/main.ts:167

grantSqlRoleDefinitionToAccount

grantSqlRoleDefinitionToAccount(
    id: string,
    scope: CommonAzureConstruct,
    accountName: string,
    resourceGroupName: string,
    principalId: Input<string>,
    roleDefinitions: CosmosRoleDefinition[],
    resourceOptions?: ResourceOptions,
): void
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- accountName: string
  the account name
- resourceGroupName: string
  the resource group name
- principalId: Input<string>
  the principal id to which the role is assigned to
- roleDefinitions: CosmosRoleDefinition[]
  list of role definitions to
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns void
- Defined in packages/azure/src/services/cosmosdb/main.ts:223

resolveCosmosDbAccount

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

resolveSqlRoleDefinition

resolveSqlRoleDefinition(
    scope: CommonAzureConstruct,
    accountName: Input<string>,
    resourceGroupName: string,
    roleDefinitionId: string,
    resourceOptions?: ResourceOptions,
): Output<GetSqlResourceSqlRoleDefinitionResult>
Parameters
- scope: CommonAzureConstruct
  scope in which this resource is defined
- accountName: Input<string>
  the account name
- resourceGroupName: string
  the resource group name
- roleDefinitionId: string
  the role definition id
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns Output<GetSqlResourceSqlRoleDefinitionResult>
- Defined in packages/azure/src/services/cosmosdb/main.ts:200

Class AzureCosmosDbManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns AzureCosmosDbManager

Methods

createCosmosDbAccount

Parameters

Returns DatabaseAccount

See

createCosmosDbContainer

Parameters

Returns SqlResourceSqlContainer

See

createCosmosDbDatabase

Parameters

Returns SqlResourceSqlDatabase

See

createSqlResourceSqlRoleAssignment

Parameters

Returns SqlResourceSqlRoleAssignment

See

grantSqlRoleDefinitionToAccount

Parameters

Returns void

resolveCosmosDbAccount

Parameters

Returns Output<GetDatabaseAccountResult>

resolveSqlRoleDefinition

Parameters

Returns Output<GetSqlResourceSqlRoleDefinitionResult>

Settings

On This Page