Mongo DB Resources - Create Update Mongo User Definition

Serviço:

Cosmos DB Resource Provider

Versão da API:

2025-04-15

Cria ou atualiza uma Definição de Usuário Mongo do Azure Cosmos DB.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome da conta do banco de dados do Cosmos DB.
mongoUserDefinitionId	path	True	string	A ID da definição de usuário {dbName.userName}.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
createUpdateMongoUserDefinitionParameters	MongoUserDefinitionCreateUpdateParameters	As propriedades necessárias para criar ou atualizar uma definição de usuário.

Respostas

Name	Tipo	Description
200 OK	MongoUserDefinitionGetResults	A operação de criação ou atualização da Definição de Usuário foi concluída com êxito.
202 Accepted		A solicitação de criação ou atualização da Definição de Usuário foi aceita e será concluída de forma assíncrona.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Exemplos

CosmosDBMongoDBUserDefinitionCreateUpdate

Pedido de amostra

HTTP

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

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

Java

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/2025-04-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

Python

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/2025-04-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

Go

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/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-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

JavaScript

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

/**
 * 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/2025-04-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

Resposta da amostra

Código de estado:

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"
  }
}

Código de estado:

202

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
ErrorResponse	Resposta de erro.
MongoUserDefinitionCreateUpdateParameters	As propriedades necessárias para criar ou atualizar uma definição de usuário.
MongoUserDefinitionGetResults	Uma definição de usuário do Azure Cosmos DB
Role	O conjunto de funções herdadas pela Definição de Usuário.

CloudError

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
error	ErrorResponse	Resposta de erro.

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

MongoUserDefinitionCreateUpdateParameters

Object

As propriedades necessárias para criar ou atualizar uma definição de usuário.

Name	Tipo	Description
properties.customData	string	Uma definição personalizada para a definição de USer.
properties.databaseName	string	O nome do banco de dados para o qual o acesso está sendo concedido para esta definição de usuário.
properties.mechanisms	string	O mecanismo Mongo Auth. Por enquanto, apoiamos apenas o mecanismo de autenticação SCRAM-SHA-256.
properties.password	string	A senha para Definição de Usuário. A resposta não contém senha de usuário.
properties.roles	Role[]	O conjunto de funções herdadas pela Definição de Usuário.
properties.userName	string	O nome de usuário para Definição de Usuário.

MongoUserDefinitionGetResults

Object

Uma definição de usuário do Azure Cosmos DB

Name	Tipo	Description
id	string	O identificador de recurso exclusivo da conta de banco de dados.
name	string	O nome da conta de banco de dados.
properties.customData	string	Uma definição personalizada para a definição de USer.
properties.databaseName	string	O nome do banco de dados para o qual o acesso está sendo concedido para esta definição de usuário.
properties.mechanisms	string	O mecanismo Mongo Auth. Por enquanto, apoiamos apenas o mecanismo de autenticação SCRAM-SHA-256.
properties.password	string	A senha para Definição de Usuário. A resposta não contém senha de usuário.
properties.roles	Role[]	O conjunto de funções herdadas pela Definição de Usuário.
properties.userName	string	O nome de usuário para Definição de Usuário.
type	string	O tipo de recurso do Azure.

Role

Object

O conjunto de funções herdadas pela Definição de Usuário.

Name	Tipo	Description
db	string	O nome do banco de dados em que a função é aplicada.
role	string	O nome da função.