Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The databaseAccounts/mongoMIRoleAssignments 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/mongoMIRoleAssignments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments@2025-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
principalId: 'string'
roleDefinitionId: 'string'
scope: 'string'
}
}
Property Values
Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments
| 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 MongoMI Role Assignment. | MongoMIRoleAssignmentResourceProperties |
MongoMIRoleAssignmentResourceProperties
| Name | Description | Value |
|---|---|---|
| principalId | The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this MongoMI 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 MongoMI Role Assignment. | string |
ARM template resource definition
The databaseAccounts/mongoMIRoleAssignments 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/mongoMIRoleAssignments resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments",
"apiVersion": "2025-05-01-preview",
"name": "string",
"properties": {
"principalId": "string",
"roleDefinitionId": "string",
"scope": "string"
}
}
Property Values
Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-05-01-preview' |
| name | The resource name | string (required) |
| properties | Properties to create and update an Azure Cosmos DB MongoMI Role Assignment. | MongoMIRoleAssignmentResourceProperties |
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments' |
MongoMIRoleAssignmentResourceProperties
| Name | Description | Value |
|---|---|---|
| principalId | The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this MongoMI 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 MongoMI Role Assignment. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The databaseAccounts/mongoMIRoleAssignments 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/mongoMIRoleAssignments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments@2025-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
principalId = "string"
roleDefinitionId = "string"
scope = "string"
}
}
}
Property Values
Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments
| 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 MongoMI Role Assignment. | MongoMIRoleAssignmentResourceProperties |
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleAssignments@2025-05-01-preview" |
MongoMIRoleAssignmentResourceProperties
| Name | Description | Value |
|---|---|---|
| principalId | The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this MongoMI 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 MongoMI Role Assignment. | string |