Azure Native v1.102.0, May 2 23

azure-native.documentdb.MongoDBResourceMongoUserDefinition

Explore with Pulumi AI

An Azure Cosmos DB User Definition API Version: 2021-10-15-preview.

Example Usage

CosmosDBMongoDBUserDefinitionCreateUpdate

using System.Collections.Generic;
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/go/azure/documentdb"
	"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.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 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(Map.ofEntries(
                Map.entry("db", "sales"),
                Map.entry("role", "myReadRole")
            ))
            .userName("myUserName")
            .build());

    }
}

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=[azure_native.documentdb.RoleArgs(
        db="sales",
        role="myReadRole",
    )],
    user_name="myUserName")

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",
});

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

new MongoDBResourceMongoUserDefinition(name: string, args: MongoDBResourceMongoUserDefinitionArgs, opts?: CustomResourceOptions);

@overload
def MongoDBResourceMongoUserDefinition(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       account_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,
                                       resource_group_name: Optional[str] = None,
                                       roles: Optional[Sequence[RoleArgs]] = None,
                                       user_name: Optional[str] = None)
@overload
def MongoDBResourceMongoUserDefinition(resource_name: str,
                                       args: MongoDBResourceMongoUserDefinitionArgs,
                                       opts: Optional[ResourceOptions] = 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.

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.

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

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.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 []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<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 RoleArgs[]: 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

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

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/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0