Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. MongoRoleDefinition

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.MongoRoleDefinition

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Cosmos DB Mongo Role Definition.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleAccount = new azure.cosmosdb.Account("example", {
    name: "example-ca",
    location: example.location,
    resourceGroupName: example.name,
    offerType: "Standard",
    kind: "MongoDB",
    capabilities: [
        {
            name: "EnableMongo",
        },
        {
            name: "EnableMongoRoleBasedAccessControl",
        },
    ],
    consistencyPolicy: {
        consistencyLevel: "Strong",
    },
    geoLocations: [{
        location: example.location,
        failoverPriority: 0,
    }],
});
const exampleMongoDatabase = new azure.cosmosdb.MongoDatabase("example", {
    name: "example-mongodb",
    resourceGroupName: exampleAccount.resourceGroupName,
    accountName: exampleAccount.name,
});
const exampleMongoRoleDefinition = new azure.cosmosdb.MongoRoleDefinition("example", {
    cosmosMongoDatabaseId: exampleMongoDatabase.id,
    roleName: "example-roledefinition",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_account = azure.cosmosdb.Account("example",
    name="example-ca",
    location=example.location,
    resource_group_name=example.name,
    offer_type="Standard",
    kind="MongoDB",
    capabilities=[
        {
            "name": "EnableMongo",
        },
        {
            "name": "EnableMongoRoleBasedAccessControl",
        },
    ],
    consistency_policy={
        "consistency_level": "Strong",
    },
    geo_locations=[{
        "location": example.location,
        "failover_priority": 0,
    }])
example_mongo_database = azure.cosmosdb.MongoDatabase("example",
    name="example-mongodb",
    resource_group_name=example_account.resource_group_name,
    account_name=example_account.name)
example_mongo_role_definition = azure.cosmosdb.MongoRoleDefinition("example",
    cosmos_mongo_database_id=example_mongo_database.id,
    role_name="example-roledefinition")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cosmosdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := cosmosdb.NewAccount(ctx, "example", &cosmosdb.AccountArgs{
			Name:              pulumi.String("example-ca"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			OfferType:         pulumi.String("Standard"),
			Kind:              pulumi.String("MongoDB"),
			Capabilities: cosmosdb.AccountCapabilityArray{
				&cosmosdb.AccountCapabilityArgs{
					Name: pulumi.String("EnableMongo"),
				},
				&cosmosdb.AccountCapabilityArgs{
					Name: pulumi.String("EnableMongoRoleBasedAccessControl"),
				},
			},
			ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
				ConsistencyLevel: pulumi.String("Strong"),
			},
			GeoLocations: cosmosdb.AccountGeoLocationArray{
				&cosmosdb.AccountGeoLocationArgs{
					Location:         example.Location,
					FailoverPriority: pulumi.Int(0),
				},
			},
		})
		if err != nil {
			return err
		}
		exampleMongoDatabase, err := cosmosdb.NewMongoDatabase(ctx, "example", &cosmosdb.MongoDatabaseArgs{
			Name:              pulumi.String("example-mongodb"),
			ResourceGroupName: exampleAccount.ResourceGroupName,
			AccountName:       exampleAccount.Name,
		})
		if err != nil {
			return err
		}
		_, err = cosmosdb.NewMongoRoleDefinition(ctx, "example", &cosmosdb.MongoRoleDefinitionArgs{
			CosmosMongoDatabaseId: exampleMongoDatabase.ID(),
			RoleName:              pulumi.String("example-roledefinition"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleAccount = new Azure.CosmosDB.Account("example", new()
    {
        Name = "example-ca",
        Location = example.Location,
        ResourceGroupName = example.Name,
        OfferType = "Standard",
        Kind = "MongoDB",
        Capabilities = new[]
        {
            new Azure.CosmosDB.Inputs.AccountCapabilityArgs
            {
                Name = "EnableMongo",
            },
            new Azure.CosmosDB.Inputs.AccountCapabilityArgs
            {
                Name = "EnableMongoRoleBasedAccessControl",
            },
        },
        ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
        {
            ConsistencyLevel = "Strong",
        },
        GeoLocations = new[]
        {
            new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
            {
                Location = example.Location,
                FailoverPriority = 0,
            },
        },
    });

    var exampleMongoDatabase = new Azure.CosmosDB.MongoDatabase("example", new()
    {
        Name = "example-mongodb",
        ResourceGroupName = exampleAccount.ResourceGroupName,
        AccountName = exampleAccount.Name,
    });

    var exampleMongoRoleDefinition = new Azure.CosmosDB.MongoRoleDefinition("example", new()
    {
        CosmosMongoDatabaseId = exampleMongoDatabase.Id,
        RoleName = "example-roledefinition",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.cosmosdb.Account;
import com.pulumi.azure.cosmosdb.AccountArgs;
import com.pulumi.azure.cosmosdb.inputs.AccountCapabilityArgs;
import com.pulumi.azure.cosmosdb.inputs.AccountConsistencyPolicyArgs;
import com.pulumi.azure.cosmosdb.inputs.AccountGeoLocationArgs;
import com.pulumi.azure.cosmosdb.MongoDatabase;
import com.pulumi.azure.cosmosdb.MongoDatabaseArgs;
import com.pulumi.azure.cosmosdb.MongoRoleDefinition;
import com.pulumi.azure.cosmosdb.MongoRoleDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example-ca")
            .location(example.location())
            .resourceGroupName(example.name())
            .offerType("Standard")
            .kind("MongoDB")
            .capabilities(            
                AccountCapabilityArgs.builder()
                    .name("EnableMongo")
                    .build(),
                AccountCapabilityArgs.builder()
                    .name("EnableMongoRoleBasedAccessControl")
                    .build())
            .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
                .consistencyLevel("Strong")
                .build())
            .geoLocations(AccountGeoLocationArgs.builder()
                .location(example.location())
                .failoverPriority(0)
                .build())
            .build());

        var exampleMongoDatabase = new MongoDatabase("exampleMongoDatabase", MongoDatabaseArgs.builder()
            .name("example-mongodb")
            .resourceGroupName(exampleAccount.resourceGroupName())
            .accountName(exampleAccount.name())
            .build());

        var exampleMongoRoleDefinition = new MongoRoleDefinition("exampleMongoRoleDefinition", MongoRoleDefinitionArgs.builder()
            .cosmosMongoDatabaseId(exampleMongoDatabase.id())
            .roleName("example-roledefinition")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:cosmosdb:Account
    name: example
    properties:
      name: example-ca
      location: ${example.location}
      resourceGroupName: ${example.name}
      offerType: Standard
      kind: MongoDB
      capabilities:
        - name: EnableMongo
        - name: EnableMongoRoleBasedAccessControl
      consistencyPolicy:
        consistencyLevel: Strong
      geoLocations:
        - location: ${example.location}
          failoverPriority: 0
  exampleMongoDatabase:
    type: azure:cosmosdb:MongoDatabase
    name: example
    properties:
      name: example-mongodb
      resourceGroupName: ${exampleAccount.resourceGroupName}
      accountName: ${exampleAccount.name}
  exampleMongoRoleDefinition:
    type: azure:cosmosdb:MongoRoleDefinition
    name: example
    properties:
      cosmosMongoDatabaseId: ${exampleMongoDatabase.id}
      roleName: example-roledefinition
Copy

Create MongoRoleDefinition Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MongoRoleDefinition(name: string, args: MongoRoleDefinitionArgs, opts?: CustomResourceOptions);
@overload
def MongoRoleDefinition(resource_name: str,
                        args: MongoRoleDefinitionArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def MongoRoleDefinition(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        cosmos_mongo_database_id: Optional[str] = None,
                        role_name: Optional[str] = None,
                        inherited_role_names: Optional[Sequence[str]] = None,
                        privileges: Optional[Sequence[MongoRoleDefinitionPrivilegeArgs]] = None)
func NewMongoRoleDefinition(ctx *Context, name string, args MongoRoleDefinitionArgs, opts ...ResourceOption) (*MongoRoleDefinition, error)
public MongoRoleDefinition(string name, MongoRoleDefinitionArgs args, CustomResourceOptions? opts = null)
public MongoRoleDefinition(String name, MongoRoleDefinitionArgs args)
public MongoRoleDefinition(String name, MongoRoleDefinitionArgs args, CustomResourceOptions options)

type: azure:cosmosdb:MongoRoleDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MongoRoleDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MongoRoleDefinitionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MongoRoleDefinitionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MongoRoleDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MongoRoleDefinitionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var mongoRoleDefinitionResource = new Azure.CosmosDB.MongoRoleDefinition("mongoRoleDefinitionResource", new()
{
    CosmosMongoDatabaseId = "string",
    RoleName = "string",
    InheritedRoleNames = new[]
    {
        "string",
    },
    Privileges = new[]
    {
        new Azure.CosmosDB.Inputs.MongoRoleDefinitionPrivilegeArgs
        {
            Actions = new[]
            {
                "string",
            },
            Resource = new Azure.CosmosDB.Inputs.MongoRoleDefinitionPrivilegeResourceArgs
            {
                CollectionName = "string",
                DbName = "string",
            },
        },
    },
});
Copy
example, err := cosmosdb.NewMongoRoleDefinition(ctx, "mongoRoleDefinitionResource", &cosmosdb.MongoRoleDefinitionArgs{
	CosmosMongoDatabaseId: pulumi.String("string"),
	RoleName:              pulumi.String("string"),
	InheritedRoleNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	Privileges: cosmosdb.MongoRoleDefinitionPrivilegeArray{
		&cosmosdb.MongoRoleDefinitionPrivilegeArgs{
			Actions: pulumi.StringArray{
				pulumi.String("string"),
			},
			Resource: &cosmosdb.MongoRoleDefinitionPrivilegeResourceArgs{
				CollectionName: pulumi.String("string"),
				DbName:         pulumi.String("string"),
			},
		},
	},
})
Copy
var mongoRoleDefinitionResource = new MongoRoleDefinition("mongoRoleDefinitionResource", MongoRoleDefinitionArgs.builder()
    .cosmosMongoDatabaseId("string")
    .roleName("string")
    .inheritedRoleNames("string")
    .privileges(MongoRoleDefinitionPrivilegeArgs.builder()
        .actions("string")
        .resource(MongoRoleDefinitionPrivilegeResourceArgs.builder()
            .collectionName("string")
            .dbName("string")
            .build())
        .build())
    .build());
Copy
mongo_role_definition_resource = azure.cosmosdb.MongoRoleDefinition("mongoRoleDefinitionResource",
    cosmos_mongo_database_id="string",
    role_name="string",
    inherited_role_names=["string"],
    privileges=[{
        "actions": ["string"],
        "resource": {
            "collection_name": "string",
            "db_name": "string",
        },
    }])
Copy
const mongoRoleDefinitionResource = new azure.cosmosdb.MongoRoleDefinition("mongoRoleDefinitionResource", {
    cosmosMongoDatabaseId: "string",
    roleName: "string",
    inheritedRoleNames: ["string"],
    privileges: [{
        actions: ["string"],
        resource: {
            collectionName: "string",
            dbName: "string",
        },
    }],
});
Copy
type: azure:cosmosdb:MongoRoleDefinition
properties:
    cosmosMongoDatabaseId: string
    inheritedRoleNames:
        - string
    privileges:
        - actions:
            - string
          resource:
            collectionName: string
            dbName: string
    roleName: string
Copy

MongoRoleDefinition Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MongoRoleDefinition resource accepts the following input properties:

CosmosMongoDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
RoleName
This property is required.
Changes to this property will trigger replacement.
string
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
InheritedRoleNames List<string>

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

Privileges List<MongoRoleDefinitionPrivilege>
A privilege block as defined below.
CosmosMongoDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
RoleName
This property is required.
Changes to this property will trigger replacement.
string
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
InheritedRoleNames []string

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

Privileges []MongoRoleDefinitionPrivilegeArgs
A privilege block as defined below.
cosmosMongoDatabaseId
This property is required.
Changes to this property will trigger replacement.
String
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
roleName
This property is required.
Changes to this property will trigger replacement.
String
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
inheritedRoleNames List<String>

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges List<MongoRoleDefinitionPrivilege>
A privilege block as defined below.
cosmosMongoDatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
roleName
This property is required.
Changes to this property will trigger replacement.
string
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
inheritedRoleNames string[]

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges MongoRoleDefinitionPrivilege[]
A privilege block as defined below.
cosmos_mongo_database_id
This property is required.
Changes to this property will trigger replacement.
str
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
role_name
This property is required.
Changes to this property will trigger replacement.
str
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
inherited_role_names Sequence[str]

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges Sequence[MongoRoleDefinitionPrivilegeArgs]
A privilege block as defined below.
cosmosMongoDatabaseId
This property is required.
Changes to this property will trigger replacement.
String
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
roleName
This property is required.
Changes to this property will trigger replacement.
String
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
inheritedRoleNames List<String>

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges List<Property Map>
A privilege block as defined below.

Outputs

All input properties are implicitly available as output properties. Additionally, the MongoRoleDefinition resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing MongoRoleDefinition Resource

Get an existing MongoRoleDefinition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MongoRoleDefinitionState, opts?: CustomResourceOptions): MongoRoleDefinition
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cosmos_mongo_database_id: Optional[str] = None,
        inherited_role_names: Optional[Sequence[str]] = None,
        privileges: Optional[Sequence[MongoRoleDefinitionPrivilegeArgs]] = None,
        role_name: Optional[str] = None) -> MongoRoleDefinition
func GetMongoRoleDefinition(ctx *Context, name string, id IDInput, state *MongoRoleDefinitionState, opts ...ResourceOption) (*MongoRoleDefinition, error)
public static MongoRoleDefinition Get(string name, Input<string> id, MongoRoleDefinitionState? state, CustomResourceOptions? opts = null)
public static MongoRoleDefinition get(String name, Output<String> id, MongoRoleDefinitionState state, CustomResourceOptions options)
resources:  _:    type: azure:cosmosdb:MongoRoleDefinition    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CosmosMongoDatabaseId Changes to this property will trigger replacement. string
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
InheritedRoleNames List<string>

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

Privileges List<MongoRoleDefinitionPrivilege>
A privilege block as defined below.
RoleName Changes to this property will trigger replacement. string
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
CosmosMongoDatabaseId Changes to this property will trigger replacement. string
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
InheritedRoleNames []string

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

Privileges []MongoRoleDefinitionPrivilegeArgs
A privilege block as defined below.
RoleName Changes to this property will trigger replacement. string
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
cosmosMongoDatabaseId Changes to this property will trigger replacement. String
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
inheritedRoleNames List<String>

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges List<MongoRoleDefinitionPrivilege>
A privilege block as defined below.
roleName Changes to this property will trigger replacement. String
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
cosmosMongoDatabaseId Changes to this property will trigger replacement. string
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
inheritedRoleNames string[]

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges MongoRoleDefinitionPrivilege[]
A privilege block as defined below.
roleName Changes to this property will trigger replacement. string
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
cosmos_mongo_database_id Changes to this property will trigger replacement. str
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
inherited_role_names Sequence[str]

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges Sequence[MongoRoleDefinitionPrivilegeArgs]
A privilege block as defined below.
role_name Changes to this property will trigger replacement. str
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.
cosmosMongoDatabaseId Changes to this property will trigger replacement. String
The resource ID of the Mongo DB. Changing this forces a new resource to be created.
inheritedRoleNames List<String>

A list of Mongo Roles which are inherited to the Mongo Role Definition.

Note: The role that needs to be inherited should exist in the Mongo DB of cosmos_mongo_database_id.

privileges List<Property Map>
A privilege block as defined below.
roleName Changes to this property will trigger replacement. String
The user-friendly name for the Mongo Role Definition. It must be unique for the database account. Changing this forces a new resource to be created.

Supporting Types

MongoRoleDefinitionPrivilege
, MongoRoleDefinitionPrivilegeArgs

Actions This property is required. List<string>
A list of actions that are allowed.
Resource This property is required. MongoRoleDefinitionPrivilegeResource
A resource block as defined below.
Actions This property is required. []string
A list of actions that are allowed.
Resource This property is required. MongoRoleDefinitionPrivilegeResource
A resource block as defined below.
actions This property is required. List<String>
A list of actions that are allowed.
resource This property is required. MongoRoleDefinitionPrivilegeResource
A resource block as defined below.
actions This property is required. string[]
A list of actions that are allowed.
resource This property is required. MongoRoleDefinitionPrivilegeResource
A resource block as defined below.
actions This property is required. Sequence[str]
A list of actions that are allowed.
resource This property is required. MongoRoleDefinitionPrivilegeResource
A resource block as defined below.
actions This property is required. List<String>
A list of actions that are allowed.
resource This property is required. Property Map
A resource block as defined below.

MongoRoleDefinitionPrivilegeResource
, MongoRoleDefinitionPrivilegeResourceArgs

CollectionName string
The name of the Mongo DB Collection that the Role Definition is applied.
DbName string
The name of the Mongo DB that the Role Definition is applied.
CollectionName string
The name of the Mongo DB Collection that the Role Definition is applied.
DbName string
The name of the Mongo DB that the Role Definition is applied.
collectionName String
The name of the Mongo DB Collection that the Role Definition is applied.
dbName String
The name of the Mongo DB that the Role Definition is applied.
collectionName string
The name of the Mongo DB Collection that the Role Definition is applied.
dbName string
The name of the Mongo DB that the Role Definition is applied.
collection_name str
The name of the Mongo DB Collection that the Role Definition is applied.
db_name str
The name of the Mongo DB that the Role Definition is applied.
collectionName String
The name of the Mongo DB Collection that the Role Definition is applied.
dbName String
The name of the Mongo DB that the Role Definition is applied.

Import

Cosmos DB Mongo Role Definitions can be imported using the resource id, e.g.

$ pulumi import azure:cosmosdb/mongoRoleDefinition:MongoRoleDefinition example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DocumentDB/databaseAccounts/account1/mongodbRoleDefinitions/dbname1.rolename1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure