Mongo DB Resources - Create Update Mongo User Definition

Service:: Cosmos DB Resource Provider

API Version:: 2024-11-15

Creates or updates an Azure Cosmos DB Mongo User Definition.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB database account name.
mongoUserDefinitionId	path	True	string	The ID for the User Definition {dbName.userName}.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
createUpdateMongoUserDefinitionParameters	MongoUserDefinitionCreateUpdateParameters	The properties required to create or update a User Definition.

Responses

Name	Type	Description
200 OK	MongoUserDefinitionGetResults	The User Definition create or update operation was completed successfully.
202 Accepted		The User Definition create or update request was accepted and will complete asynchronously.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBMongoDBUserDefinitionCreateUpdate

Sample request

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myMongoUserDefinitionId?api-version=2024-11-15

{
  "properties": {
    "userName": "myUserName",
    "password": "myPassword",
    "databaseName": "sales",
    "customData": "My custom data",
    "roles": [
      {
        "role": "myReadRole",
        "db": "sales"
      }
    ],
    "mechanisms": "SCRAM-SHA-256"
  }
}


import com.azure.resourcemanager.cosmos.models.MongoUserDefinitionCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.Role;
import java.util.Arrays;

/**
 * Samples for MongoDBResources CreateUpdateMongoUserDefinition.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBMongoDBUserDefinitionCreateUpdate.json
     */
    /**
     * Sample code: CosmosDBMongoDBUserDefinitionCreateUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBUserDefinitionCreateUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().createUpdateMongoUserDefinition(
            "myMongoUserDefinitionId", "myResourceGroupName", "myAccountName",
            new MongoUserDefinitionCreateUpdateParameters().withUsername("myUserName")
                .withPassword("fakeTokenPlaceholder").withDatabaseName("sales").withCustomData("My custom data")
                .withRoles(Arrays.asList(new Role().withDb("sales").withRole("myReadRole")))
                .withMechanisms("SCRAM-SHA-256"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_mongo_db_user_definition_create_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="mySubscriptionId",
    )

    response = client.mongo_db_resources.begin_create_update_mongo_user_definition(
        mongo_user_definition_id="myMongoUserDefinitionId",
        resource_group_name="myResourceGroupName",
        account_name="myAccountName",
        create_update_mongo_user_definition_parameters={
            "properties": {
                "customData": "My custom data",
                "databaseName": "sales",
                "mechanisms": "SCRAM-SHA-256",
                "password": "myPassword",
                "roles": [{"db": "sales", "role": "myReadRole"}],
                "userName": "myUserName",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json
func ExampleMongoDBResourcesClient_BeginCreateUpdateMongoUserDefinition() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewMongoDBResourcesClient().BeginCreateUpdateMongoUserDefinition(ctx, "myMongoUserDefinitionId", "myResourceGroupName", "myAccountName", armcosmos.MongoUserDefinitionCreateUpdateParameters{
		Properties: &armcosmos.MongoUserDefinitionResource{
			CustomData:   to.Ptr("My custom data"),
			DatabaseName: to.Ptr("sales"),
			Mechanisms:   to.Ptr("SCRAM-SHA-256"),
			Password:     to.Ptr("myPassword"),
			Roles: []*armcosmos.Role{
				{
					Db:   to.Ptr("sales"),
					Role: to.Ptr("myReadRole"),
				}},
			UserName: to.Ptr("myUserName"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MongoUserDefinitionGetResults = armcosmos.MongoUserDefinitionGetResults{
	// 	Name: to.Ptr("myUserName"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions"),
	// 	ID: to.Ptr("/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId"),
	// 	Properties: &armcosmos.MongoUserDefinitionResource{
	// 		CustomData: to.Ptr("My custom data"),
	// 		DatabaseName: to.Ptr("sales"),
	// 		Mechanisms: to.Ptr("SCRAM-SHA-256"),
	// 		Roles: []*armcosmos.Role{
	// 			{
	// 				Db: to.Ptr("sales"),
	// 				Role: to.Ptr("myReadRole"),
	// 		}},
	// 		UserName: to.Ptr("myUserName"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates an Azure Cosmos DB Mongo User Definition.
 *
 * @summary Creates or updates an Azure Cosmos DB Mongo User Definition.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json
 */
async function cosmosDbMongoDbuserDefinitionCreateUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "mySubscriptionId";
  const mongoUserDefinitionId = "myMongoUserDefinitionId";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "myResourceGroupName";
  const accountName = "myAccountName";
  const createUpdateMongoUserDefinitionParameters = {
    customData: "My custom data",
    databaseName: "sales",
    mechanisms: "SCRAM-SHA-256",
    password: "myPassword",
    roles: [{ db: "sales", role: "myReadRole" }],
    userName: "myUserName",
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginCreateUpdateMongoUserDefinitionAndWait(
    mongoUserDefinitionId,
    resourceGroupName,
    accountName,
    createUpdateMongoUserDefinitionParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId",
  "name": "myUserName",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions",
  "properties": {
    "userName": "myUserName",
    "databaseName": "sales",
    "customData": "My custom data",
    "roles": [
      {
        "db": "sales",
        "role": "myReadRole"
      }
    ],
    "mechanisms": "SCRAM-SHA-256"
  }
}

Status code:: 202

Definitions

Name	Description
CloudError	An error response from the service.
ErrorResponse	Error Response.
MongoUserDefinitionCreateUpdateParameters	The properties required to create or update a User Definition.
MongoUserDefinitionGetResults	An Azure Cosmos DB User Definition
Role	The set of roles inherited by the User Definition.

CloudError

Object

An error response from the service.

Name	Type	Description
error	ErrorResponse	Error Response.

ErrorResponse

Object

Error Response.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

MongoUserDefinitionCreateUpdateParameters

Object

The properties required to create or update a User Definition.

Name	Type	Description
properties.customData	string	A custom definition for the USer Definition.
properties.databaseName	string	The database name for which access is being granted for this User Definition.
properties.mechanisms	string	The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
properties.password	string	The password for User Definition. Response does not contain user password.
properties.roles	Role[]	The set of roles inherited by the User Definition.
properties.userName	string	The user name for User Definition.

MongoUserDefinitionGetResults

Object

An Azure Cosmos DB User Definition

Name	Type	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties.customData	string	A custom definition for the USer Definition.
properties.databaseName	string	The database name for which access is being granted for this User Definition.
properties.mechanisms	string	The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
properties.password	string	The password for User Definition. Response does not contain user password.
properties.roles	Role[]	The set of roles inherited by the User Definition.
properties.userName	string	The user name for User Definition.
type	string	The type of Azure resource.

Role

Object

The set of roles inherited by the User Definition.

Name	Type	Description
db	string	The database name the role is applied.
role	string	The role name.

Share via

Mongo DB Resources - Create Update Mongo User Definition

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

CosmosDBMongoDBUserDefinitionCreateUpdate

Sample request

Sample response

Definitions

CloudError

ErrorResponse

MongoUserDefinitionCreateUpdateParameters

MongoUserDefinitionGetResults

Role