Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2024-05-15-preview
- Latest
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-01-preview
- 2020-06-01-preview
Bicep resource definition
The databaseAccounts/sqlRoleDefinitions resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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-05-15-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
assignableScopes: [
'string'
]
permissions: [
{
dataActions: [
'string'
]
notDataActions: [
'string'
]
}
]
roleName: 'string'
type: 'string'
}
}
Property values
databaseAccounts/sqlRoleDefinitions
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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 |
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' |
Permission
| Name | Description | Value |
|---|---|---|
| dataActions | An array of data actions that are allowed. | string[] |
| notDataActions | An array of data actions that are denied. | string[] |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | 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:
- Resource groups - See resource group deployment commands
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-05-15-preview",
"name": "string",
"properties": {
"assignableScopes": [ "string" ],
"permissions": [
{
"dataActions": [ "string" ],
"notDataActions": [ "string" ]
}
],
"roleName": "string",
"type": "string"
}
}
Property values
databaseAccounts/sqlRoleDefinitions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions' |
| apiVersion | The resource api version | '2024-05-15-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Properties to create and update an Azure Cosmos DB SQL Role Definition. | SqlRoleDefinitionResource |
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' |
Permission
| Name | Description | Value |
|---|---|---|
| dataActions | An array of data actions that are allowed. | string[] |
| notDataActions | An array of data actions that are denied. | string[] |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | 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. |
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-05-15-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
assignableScopes = [
"string"
]
permissions = [
{
dataActions = [
"string"
]
notDataActions = [
"string"
]
}
]
roleName = "string"
type = "string"
}
})
}
Property values
databaseAccounts/sqlRoleDefinitions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15-preview" |
| 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 |
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" |
Permission
| Name | Description | Value |
|---|---|---|
| dataActions | An array of data actions that are allowed. | string[] |
| notDataActions | An array of data actions that are denied. | string[] |