Share via

Microsoft.DocumentDB databaseAccounts/tableRoleAssignments

  • Article

Bicep resource definition

The databaseAccounts/tableRoleAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments@2024-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    principalId: 'string'
    roleDefinitionId: 'string'
    scope: 'string'
  }
}

Property values

Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databaseAccounts
properties Properties to create and update an Azure Cosmos DB Table Role Assignment. TableRoleAssignmentResourceProperties

TableRoleAssignmentResourceProperties

Name Description Value
principalId The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Table Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. string
roleDefinitionId The unique identifier for the associated Role Definition. string
scope The data plane resource path for which access is being granted through this Table Role Assignment. string

ARM template resource definition

The databaseAccounts/tableRoleAssignments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "properties": {
    "principalId": "string",
    "roleDefinitionId": "string",
    "scope": "string"
  }
}

Property values

Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments

Name Description Value
apiVersion The api version '2024-12-01-preview'
name The resource name string (required)
properties Properties to create and update an Azure Cosmos DB Table Role Assignment. TableRoleAssignmentResourceProperties
type The resource type 'Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments'

TableRoleAssignmentResourceProperties

Name Description Value
principalId The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Table Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. string
roleDefinitionId The unique identifier for the associated Role Definition. string
scope The data plane resource path for which access is being granted through this Table Role Assignment. string

Terraform (AzAPI provider) resource definition

The databaseAccounts/tableRoleAssignments resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments@2024-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      principalId = "string"
      roleDefinitionId = "string"
      scope = "string"
    }
  })
}

Property values

Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts
properties Properties to create and update an Azure Cosmos DB Table Role Assignment. TableRoleAssignmentResourceProperties
type The resource type "Microsoft.DocumentDB/databaseAccounts/tableRoleAssignments@2024-12-01-preview"

TableRoleAssignmentResourceProperties

Name Description Value
principalId The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Table Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. string
roleDefinitionId The unique identifier for the associated Role Definition. string
scope The data plane resource path for which access is being granted through this Table Role Assignment. string