Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. MongoDBResourceMongoUserDefinition
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.MongoDBResourceMongoUserDefinition

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    An Azure Cosmos DB User Definition Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-10-15-preview.

    Other available API versions: 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-preview.

    Example Usage

    CosmosDBMongoDBUserDefinitionCreateUpdate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var mongoDBResourceMongoUserDefinition = new AzureNative.DocumentDB.MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinition", new()
    {
        AccountName = "myAccountName",
        CustomData = "My custom data",
        DatabaseName = "sales",
        Mechanisms = "SCRAM-SHA-256",
        MongoUserDefinitionId = "myMongoUserDefinitionId",
        Password = "myPassword",
        ResourceGroupName = "myResourceGroupName",
        Roles = new[]
        {
            new AzureNative.DocumentDB.Inputs.RoleArgs
            {
                Db = "sales",
                Role = "myReadRole",
            },
        },
        UserName = "myUserName",
    });

});

    package main

import (
	documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewMongoDBResourceMongoUserDefinition(ctx, "mongoDBResourceMongoUserDefinition", &documentdb.MongoDBResourceMongoUserDefinitionArgs{
			AccountName:           pulumi.String("myAccountName"),
			CustomData:            pulumi.String("My custom data"),
			DatabaseName:          pulumi.String("sales"),
			Mechanisms:            pulumi.String("SCRAM-SHA-256"),
			MongoUserDefinitionId: pulumi.String("myMongoUserDefinitionId"),
			Password:              pulumi.String("myPassword"),
			ResourceGroupName:     pulumi.String("myResourceGroupName"),
			Roles: documentdb.RoleArray{
				&documentdb.RoleArgs{
					Db:   pulumi.String("sales"),
					Role: pulumi.String("myReadRole"),
				},
			},
			UserName: pulumi.String("myUserName"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.MongoDBResourceMongoUserDefinition;
import com.pulumi.azurenative.documentdb.MongoDBResourceMongoUserDefinitionArgs;
import com.pulumi.azurenative.documentdb.inputs.RoleArgs;
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 mongoDBResourceMongoUserDefinition = new MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinition", MongoDBResourceMongoUserDefinitionArgs.builder()
            .accountName("myAccountName")
            .customData("My custom data")
            .databaseName("sales")
            .mechanisms("SCRAM-SHA-256")
            .mongoUserDefinitionId("myMongoUserDefinitionId")
            .password("myPassword")
            .resourceGroupName("myResourceGroupName")
            .roles(RoleArgs.builder()
                .db("sales")
                .role("myReadRole")
                .build())
            .userName("myUserName")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const mongoDBResourceMongoUserDefinition = new azure_native.documentdb.MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinition", {
    accountName: "myAccountName",
    customData: "My custom data",
    databaseName: "sales",
    mechanisms: "SCRAM-SHA-256",
    mongoUserDefinitionId: "myMongoUserDefinitionId",
    password: "myPassword",
    resourceGroupName: "myResourceGroupName",
    roles: [{
        db: "sales",
        role: "myReadRole",
    }],
    userName: "myUserName",
});

    import pulumi
import pulumi_azure_native as azure_native

mongo_db_resource_mongo_user_definition = azure_native.documentdb.MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinition",
    account_name="myAccountName",
    custom_data="My custom data",
    database_name="sales",
    mechanisms="SCRAM-SHA-256",
    mongo_user_definition_id="myMongoUserDefinitionId",
    password="myPassword",
    resource_group_name="myResourceGroupName",
    roles=[{
        "db": "sales",
        "role": "myReadRole",
    }],
    user_name="myUserName")

    resources:
  mongoDBResourceMongoUserDefinition:
    type: azure-native:documentdb:MongoDBResourceMongoUserDefinition
    properties:
      accountName: myAccountName
      customData: My custom data
      databaseName: sales
      mechanisms: SCRAM-SHA-256
      mongoUserDefinitionId: myMongoUserDefinitionId
      password: myPassword
      resourceGroupName: myResourceGroupName
      roles:
        - db: sales
          role: myReadRole
      userName: myUserName

    Create MongoDBResourceMongoUserDefinition Resource

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

    Constructor syntax

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

@overload
def MongoDBResourceMongoUserDefinition(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       account_name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       custom_data: Optional[str] = None,
                                       database_name: Optional[str] = None,
                                       mechanisms: Optional[str] = None,
                                       mongo_user_definition_id: Optional[str] = None,
                                       password: Optional[str] = None,
                                       roles: Optional[Sequence[RoleArgs]] = None,
                                       user_name: Optional[str] = None)
    func NewMongoDBResourceMongoUserDefinition(ctx *Context, name string, args MongoDBResourceMongoUserDefinitionArgs, opts ...ResourceOption) (*MongoDBResourceMongoUserDefinition, error)
    public MongoDBResourceMongoUserDefinition(string name, MongoDBResourceMongoUserDefinitionArgs args, CustomResourceOptions? opts = null)
    public MongoDBResourceMongoUserDefinition(String name, MongoDBResourceMongoUserDefinitionArgs args)
public MongoDBResourceMongoUserDefinition(String name, MongoDBResourceMongoUserDefinitionArgs args, CustomResourceOptions options)

    type: azure-native:documentdb:MongoDBResourceMongoUserDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MongoDBResourceMongoUserDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MongoDBResourceMongoUserDefinitionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MongoDBResourceMongoUserDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongoDBResourceMongoUserDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongoDBResourceMongoUserDefinitionArgs
    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 mongoDBResourceMongoUserDefinitionResource = new AzureNative.DocumentDB.MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinitionResource", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    CustomData = "string",
    DatabaseName = "string",
    Mechanisms = "string",
    MongoUserDefinitionId = "string",
    Password = "string",
    Roles = new[]
    {
        new AzureNative.DocumentDB.Inputs.RoleArgs
        {
            Db = "string",
            Role = "string",
        },
    },
    UserName = "string",
});

    example, err := documentdb.NewMongoDBResourceMongoUserDefinition(ctx, "mongoDBResourceMongoUserDefinitionResource", &documentdb.MongoDBResourceMongoUserDefinitionArgs{
	AccountName:           pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	CustomData:            pulumi.String("string"),
	DatabaseName:          pulumi.String("string"),
	Mechanisms:            pulumi.String("string"),
	MongoUserDefinitionId: pulumi.String("string"),
	Password:              pulumi.String("string"),
	Roles: documentdb.RoleArray{
		&documentdb.RoleArgs{
			Db:   pulumi.String("string"),
			Role: pulumi.String("string"),
		},
	},
	UserName: pulumi.String("string"),
})

    var mongoDBResourceMongoUserDefinitionResource = new MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinitionResource", MongoDBResourceMongoUserDefinitionArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .customData("string")
    .databaseName("string")
    .mechanisms("string")
    .mongoUserDefinitionId("string")
    .password("string")
    .roles(RoleArgs.builder()
        .db("string")
        .role("string")
        .build())
    .userName("string")
    .build());

    mongo_db_resource_mongo_user_definition_resource = azure_native.documentdb.MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinitionResource",
    account_name="string",
    resource_group_name="string",
    custom_data="string",
    database_name="string",
    mechanisms="string",
    mongo_user_definition_id="string",
    password="string",
    roles=[{
        "db": "string",
        "role": "string",
    }],
    user_name="string")

    const mongoDBResourceMongoUserDefinitionResource = new azure_native.documentdb.MongoDBResourceMongoUserDefinition("mongoDBResourceMongoUserDefinitionResource", {
    accountName: "string",
    resourceGroupName: "string",
    customData: "string",
    databaseName: "string",
    mechanisms: "string",
    mongoUserDefinitionId: "string",
    password: "string",
    roles: [{
        db: "string",
        role: "string",
    }],
    userName: "string",
});

    type: azure-native:documentdb:MongoDBResourceMongoUserDefinition
properties:
    accountName: string
    customData: string
    databaseName: string
    mechanisms: string
    mongoUserDefinitionId: string
    password: string
    resourceGroupName: string
    roles:
        - db: string
          role: string
    userName: string

    MongoDBResourceMongoUserDefinition 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 MongoDBResourceMongoUserDefinition resource accepts the following input properties:

    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    CustomData string
    A custom definition for the USer Definition.
    DatabaseName string
    The database name for which access is being granted for this User Definition.
    Mechanisms string
    The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
    MongoUserDefinitionId string
    The ID for the User Definition {dbName.userName}.
    Password string
    The password for User Definition. Response does not contain user password.
    Roles List<Pulumi.AzureNative.DocumentDB.Inputs.Role>
    The set of roles inherited by the User Definition.
    UserName string
    The user name for User Definition.
    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    CustomData string
    A custom definition for the USer Definition.
    DatabaseName string
    The database name for which access is being granted for this User Definition.
    Mechanisms string
    The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
    MongoUserDefinitionId string
    The ID for the User Definition {dbName.userName}.
    Password string
    The password for User Definition. Response does not contain user password.
    Roles []RoleArgs
    The set of roles inherited by the User Definition.
    UserName string
    The user name for User Definition.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    customData String
    A custom definition for the USer Definition.
    databaseName String
    The database name for which access is being granted for this User Definition.
    mechanisms String
    The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
    mongoUserDefinitionId String
    The ID for the User Definition {dbName.userName}.
    password String
    The password for User Definition. Response does not contain user password.
    roles List<Role>
    The set of roles inherited by the User Definition.
    userName String
    The user name for User Definition.
    accountName string
    Cosmos DB database account name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    customData string
    A custom definition for the USer Definition.
    databaseName string
    The database name for which access is being granted for this User Definition.
    mechanisms string
    The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
    mongoUserDefinitionId string
    The ID for the User Definition {dbName.userName}.
    password string
    The password for User Definition. Response does not contain user password.
    roles Role[]
    The set of roles inherited by the User Definition.
    userName string
    The user name for User Definition.
    account_name str
    Cosmos DB database account name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    custom_data str
    A custom definition for the USer Definition.
    database_name str
    The database name for which access is being granted for this User Definition.
    mechanisms str
    The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
    mongo_user_definition_id str
    The ID for the User Definition {dbName.userName}.
    password str
    The password for User Definition. Response does not contain user password.
    roles Sequence[RoleArgs]
    The set of roles inherited by the User Definition.
    user_name str
    The user name for User Definition.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    customData String
    A custom definition for the USer Definition.
    databaseName String
    The database name for which access is being granted for this User Definition.
    mechanisms String
    The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
    mongoUserDefinitionId String
    The ID for the User Definition {dbName.userName}.
    password String
    The password for User Definition. Response does not contain user password.
    roles List<Property Map>
    The set of roles inherited by the User Definition.
    userName String
    The user name for User Definition.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the database account.
    Type string
    The type of Azure resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the database account.
    type String
    The type of Azure resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the database account.
    type string
    The type of Azure resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the database account.
    type str
    The type of Azure resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the database account.
    type String
    The type of Azure resource.

    Supporting Types

    Role, RoleArgs

    Db string
    The database name the role is applied.
    Role string
    The role name.
    Db string
    The database name the role is applied.
    Role string
    The role name.
    db String
    The database name the role is applied.
    role String
    The role name.
    db string
    The database name the role is applied.
    role string
    The role name.
    db str
    The database name the role is applied.
    role str
    The role name.
    db String
    The database name the role is applied.
    role String
    The role name.

    RoleResponse, RoleResponseArgs

    Db string
    The database name the role is applied.
    Role string
    The role name.
    Db string
    The database name the role is applied.
    Role string
    The role name.
    db String
    The database name the role is applied.
    role String
    The role name.
    db string
    The database name the role is applied.
    role string
    The role name.
    db str
    The database name the role is applied.
    role str
    The role name.
    db String
    The database name the role is applied.
    role String
    The role name.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:documentdb:MongoDBResourceMongoUserDefinition myUserName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native