Class AzureAuthorisationManager

Provides operations on Azure Authorisation 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.authorisationManager.createRoleAssignment('MyRoleAssignment', this, props)
  }
}

Index

Constructors

constructor

Methods

createRoleAssignment grantRoleAssignmentToApplicationConfiguration grantRoleAssignmentToEventgridTopic grantRoleAssignmentToKeyVault grantRoleAssignmentToStorageAccount grantRoleAssignmentToStorageTable

Constructors

constructor

new AzureAuthorisationManager(): AzureAuthorisationManager
Returns AzureAuthorisationManager

Methods

createRoleAssignment

createRoleAssignment(
    id: string,
    scope: CommonAzureConstruct,
    props: RoleAssignmentProps,
    resourceOptions?: ResourceOptions,
): RoleAssignment
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- props: RoleAssignmentProps
  Role assignment properties
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns RoleAssignment
See
[Pulumi Azure Native Role Assignment]https://www.pulumi.com/registry/packages/azure-native/api-docs/authorization/roleassignment/
- Defined in packages/azure/src/services/authorisation/main.ts:36

grantRoleAssignmentToApplicationConfiguration

grantRoleAssignmentToApplicationConfiguration(
    id: string,
    scope: CommonAzureConstruct,
    appConfigId: Input<string>,
    principalId: Input<string>,
    roleDefinitionId: RoleDefinitionId,
    resourceOptions?: ResourceOptions,
): RoleAssignment
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- appConfigId: Input<string>
  the application configuration id
- principalId: Input<string>
  the principal id to which the role is assigned to
- roleDefinitionId: RoleDefinitionId
  the role definition id
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns RoleAssignment
- Defined in packages/azure/src/services/authorisation/main.ts:128

grantRoleAssignmentToEventgridTopic

grantRoleAssignmentToEventgridTopic(
    id: string,
    scope: CommonAzureConstruct,
    topicName: string,
    resourceGroupName: string,
    principalId: Input<string>,
    roleDefinitionId: RoleDefinitionId,
    resourceOptions?: ResourceOptions,
): RoleAssignment
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- topicName: string
  the topic name
- resourceGroupName: string
  the resource group name
- principalId: Input<string>
  the principal id to which the role is assigned to
- roleDefinitionId: RoleDefinitionId
  the role definition id
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns RoleAssignment
- Defined in packages/azure/src/services/authorisation/main.ts:89

grantRoleAssignmentToKeyVault

grantRoleAssignmentToKeyVault(
    id: string,
    scope: CommonAzureConstruct,
    vaultName: string,
    resourceGroupName: string,
    principalId: Input<string>,
    roleDefinitionId: RoleDefinitionId,
    resourceOptions?: ResourceOptions,
): RoleAssignment
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- vaultName: string
  the key vault name
- resourceGroupName: string
  the resource group name
- principalId: Input<string>
  the principal id to which the role is assigned to
- roleDefinitionId: RoleDefinitionId
  the role definition id
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns RoleAssignment
- Defined in packages/azure/src/services/authorisation/main.ts:57

grantRoleAssignmentToStorageAccount

grantRoleAssignmentToStorageAccount(
    id: string,
    scope: CommonAzureConstruct,
    accountId: Input<string>,
    principalId: Input<string>,
    roleDefinitionId: RoleDefinitionId,
    resourceOptions?: ResourceOptions,
): RoleAssignment
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- accountId: Input<string>
  the storage account id
- principalId: Input<string>
  the principal id to which the role is assigned to
- roleDefinitionId: RoleDefinitionId
  the role definition id
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns RoleAssignment
- Defined in packages/azure/src/services/authorisation/main.ts:157

grantRoleAssignmentToStorageTable

grantRoleAssignmentToStorageTable(
    id: string,
    scope: CommonAzureConstruct,
    tableId: Input<string>,
    principalId: Input<string>,
    roleDefinitionId: RoleDefinitionId,
    resourceOptions?: ResourceOptions,
): RoleAssignment
Parameters
- id: string
  scoped id of the resource
- scope: CommonAzureConstruct
  scope in which this resource is defined
- tableId: Input<string>
  the storage table id
- principalId: Input<string>
  the principal id to which the role is assigned to
- roleDefinitionId: RoleDefinitionId
  the role definition id
- OptionalresourceOptions: ResourceOptions
  Optional settings to control resource behaviour
Returns RoleAssignment
- Defined in packages/azure/src/services/authorisation/main.ts:186

Class AzureAuthorisationManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns AzureAuthorisationManager

Methods

createRoleAssignment

Parameters

Returns RoleAssignment

See

grantRoleAssignmentToApplicationConfiguration

Parameters

Returns RoleAssignment

grantRoleAssignmentToEventgridTopic

Parameters

Returns RoleAssignment

grantRoleAssignmentToKeyVault

Parameters

Returns RoleAssignment

grantRoleAssignmentToStorageAccount

Parameters

Returns RoleAssignment

grantRoleAssignmentToStorageTable

Parameters

Returns RoleAssignment

Settings

On This Page