Mongo DB Resources - Get Mongo User Definition
Recupera las propiedades de una definición de usuario de Mongo de Azure Cosmos DB existente con el identificador especificado.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}?api-version=2025-04-15
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
account
|
path | True |
string minLength: 3maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)* |
Nombre de la cuenta de base de datos de Cosmos DB. |
mongo
|
path | True |
string |
Identificador de la definición de usuario {dbName.userName}. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
subscription
|
path | True |
string minLength: 1 |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para la operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La definición de usuario se recuperó correctamente. |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | Suplantar tu cuenta de usuario |
Ejemplos
CosmosDBMongoDBUserDefinitionGet
Solicitud de ejemplo
GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myMongoUserDefinitionId?api-version=2025-04-15
Respuesta de muestra
{
"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"
}
}
Definiciones
Nombre | Description |
---|---|
Cloud |
Respuesta de error del servicio. |
Error |
Respuesta de error. |
Mongo |
Una definición de usuario de Azure Cosmos DB |
Role |
Conjunto de roles heredados por la definición de usuario. |
CloudError
Respuesta de error del servicio.
Nombre | Tipo | Description |
---|---|---|
error |
Respuesta de error. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
message |
string |
Mensaje de error que indica por qué se produjo un error en la operación. |
MongoUserDefinitionGetResults
Una definición de usuario de Azure Cosmos DB
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso único de la cuenta de base de datos. |
name |
string |
Nombre de la cuenta de base de datos. |
properties.customData |
string |
Una definición personalizada para la definición de USer. |
properties.databaseName |
string |
Nombre de base de datos para el que se concede acceso para esta definición de usuario. |
properties.mechanisms |
string |
Mecanismo de autenticación de Mongo. Por ahora, solo se admite el mecanismo de autenticación SCRAM-SHA-256. |
properties.password |
string |
Contraseña de definición de usuario. La respuesta no contiene contraseña de usuario. |
properties.roles |
Role[] |
Conjunto de roles heredados por la definición de usuario. |
properties.userName |
string |
Nombre de usuario para Definición de usuario. |
type |
string |
Tipo de recurso de Azure. |
Role
Conjunto de roles heredados por la definición de usuario.
Nombre | Tipo | Description |
---|---|---|
db |
string |
El nombre de la base de datos que se aplica al rol. |
role |
string |
Nombre del rol. |