Mongo DB Resources - Get Mongo User Definition

Layanan:: Cosmos DB Resource Provider

Versi API:: 2025-04-15

Mengambil properti Definisi Pengguna Azure Cosmos DB Mongo yang ada dengan Id yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nama akun database Cosmos DB.
mongoUserDefinitionId	path	True	string	ID untuk Definisi Pengguna {dbName.userName}.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	MongoUserDefinitionGetResults	Definisi Pengguna berhasil diambil.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBMongoDBUserDefinitionGet

Permintaan sampel

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


/**
 * Samples for MongoDBResources GetMongoUserDefinition.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBMongoDBUserDefinitionGet.json
     */
    /**
     * Sample code: CosmosDBMongoDBUserDefinitionGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBUserDefinitionGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().getMongoUserDefinitionWithResponse(
            "myMongoUserDefinitionId", "myResourceGroupName", "myAccountName", 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_get.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.get_mongo_user_definition(
        mongo_user_definition_id="myMongoUserDefinitionId",
        resource_group_name="myResourceGroupName",
        account_name="myAccountName",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBUserDefinitionGet.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/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/CosmosDBMongoDBUserDefinitionGet.json
func ExampleMongoDBResourcesClient_GetMongoUserDefinition() {
	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)
	}
	res, err := clientFactory.NewMongoDBResourcesClient().GetMongoUserDefinition(ctx, "myMongoUserDefinitionId", "myResourceGroupName", "myAccountName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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("myUserId"),
	// 	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");
require("dotenv/config");

/**
 * This sample demonstrates how to Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.
 *
 * @summary Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBUserDefinitionGet.json
 */
async function cosmosDbMongoDbuserDefinitionGet() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "mySubscriptionId";
  const mongoUserDefinitionId = "myMongoUserDefinitionId";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "myResourceGroupName";
  const accountName = "myAccountName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.getMongoUserDefinition(
    mongoUserDefinitionId,
    resourceGroupName,
    accountName,
  );
  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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari layanan.
ErrorResponse	Respons Kesalahan.
MongoUserDefinitionGetResults	Definisi Pengguna Azure Cosmos DB
Role	Kumpulan peran yang diwariskan oleh Definisi Pengguna.

CloudError

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons Kesalahan.

ErrorResponse

Objek

Respons Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

MongoUserDefinitionGetResults

Objek

Definisi Pengguna Azure Cosmos DB

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya unik akun database.
name	string	Nama akun database.
properties.customData	string	Definisi kustom untuk Definisi USer.
properties.databaseName	string	Nama database yang aksesnya diberikan untuk Definisi Pengguna ini.
properties.mechanisms	string	Mekanisme Mongo Auth. Untuk saat ini, kami hanya mendukung mekanisme autentikasi SCRAM-SHA-256.
properties.password	string	Kata sandi untuk Definisi Pengguna. Respons tidak berisi kata sandi pengguna.
properties.roles	Role[]	Kumpulan peran yang diwariskan oleh Definisi Pengguna.
properties.userName	string	Nama pengguna untuk Definisi Pengguna.
type	string	Jenis sumber daya Azure.

Role

Objek

Kumpulan peran yang diwariskan oleh Definisi Pengguna.

Nama	Jenis	Deskripsi
db	string	Nama database peran diterapkan.
role	string	Nama peran.

Bagikan melalui

Mongo DB Resources - Get Mongo User Definition

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

CosmosDBMongoDBUserDefinitionGet

Permintaan sampel

Respon sampel

Definisi

CloudError

ErrorResponse

MongoUserDefinitionGetResults

Role