Partager via

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2024-11-15

  • Article

Bicep resource definition

The databaseAccounts/sqlRoleDefinitions 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/sqlRoleDefinitions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-11-15' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    assignableScopes: [
      'string'
    ]
    permissions: [
      {
        dataActions: [
          'string'
        ]
        notDataActions: [
          'string'
        ]
      }
    ]
    roleName: 'string'
    type: 'string'
  }
}

Property values

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

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 SQL Role Definition. SqlRoleDefinitionResource

Permission

Name Description Value
dataActions An array of data actions that are allowed. string[]
notDataActions An array of data actions that are denied. string[]

SqlRoleDefinitionResource

Name Description Value
assignableScopes A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. string[]
permissions The set of operations allowed through this Role Definition. Permission[]
roleName A user-friendly name for the Role Definition. Must be unique for the database account. string
type Indicates whether the Role Definition was built-in or user created. 'BuiltInRole'
'CustomRole'

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Create an Azure Cosmos DB SQL Account with data plane RBAC This template will create a SQL Cosmos account, a natively maintained Role Definition, and a natively maintained Role Assignment for an AAD identity.

ARM template resource definition

The databaseAccounts/sqlRoleDefinitions 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/sqlRoleDefinitions resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "apiVersion": "2024-11-15",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

Property values

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Name Description Value
apiVersion The api version '2024-11-15'
name The resource name string (required)
properties Properties to create and update an Azure Cosmos DB SQL Role Definition. SqlRoleDefinitionResource
type The resource type 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'

Permission

Name Description Value
dataActions An array of data actions that are allowed. string[]
notDataActions An array of data actions that are denied. string[]

SqlRoleDefinitionResource

Name Description Value
assignableScopes A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. string[]
permissions The set of operations allowed through this Role Definition. Permission[]
roleName A user-friendly name for the Role Definition. Must be unique for the database account. string
type Indicates whether the Role Definition was built-in or user created. 'BuiltInRole'
'CustomRole'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos DB SQL Account with data plane RBAC

Deploy to Azure		 This template will create a SQL Cosmos account, a natively maintained Role Definition, and a natively maintained Role Assignment for an AAD identity.

Terraform (AzAPI provider) resource definition

The databaseAccounts/sqlRoleDefinitions 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/sqlRoleDefinitions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-11-15"
  name = "string"
  body = jsonencode({
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  })
}

Property values

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

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 SQL Role Definition. SqlRoleDefinitionResource
type The resource type "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-11-15"

Permission

Name Description Value
dataActions An array of data actions that are allowed. string[]
notDataActions An array of data actions that are denied. string[]

SqlRoleDefinitionResource

Name Description Value
assignableScopes A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist. string[]
permissions The set of operations allowed through this Role Definition. Permission[]
roleName A user-friendly name for the Role Definition. Must be unique for the database account. string
type Indicates whether the Role Definition was built-in or user created. 'BuiltInRole'
'CustomRole'