published on Friday, Mar 20, 2026 by Pulumi
published on Friday, Mar 20, 2026 by Pulumi
Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.
Uses Azure REST API version 2025-10-15.
Other available API versions: 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-preview, 2025-04-15, 2025-05-01-preview, 2025-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.
Using getMongoDBResourceMongoUserDefinition
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getMongoDBResourceMongoUserDefinition(args: GetMongoDBResourceMongoUserDefinitionArgs, opts?: InvokeOptions): Promise<GetMongoDBResourceMongoUserDefinitionResult>
function getMongoDBResourceMongoUserDefinitionOutput(args: GetMongoDBResourceMongoUserDefinitionOutputArgs, opts?: InvokeOptions): Output<GetMongoDBResourceMongoUserDefinitionResult>def get_mongo_db_resource_mongo_user_definition(account_name: Optional[str] = None,
mongo_user_definition_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetMongoDBResourceMongoUserDefinitionResult
def get_mongo_db_resource_mongo_user_definition_output(account_name: Optional[pulumi.Input[str]] = None,
mongo_user_definition_id: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMongoDBResourceMongoUserDefinitionResult]func LookupMongoDBResourceMongoUserDefinition(ctx *Context, args *LookupMongoDBResourceMongoUserDefinitionArgs, opts ...InvokeOption) (*LookupMongoDBResourceMongoUserDefinitionResult, error)
func LookupMongoDBResourceMongoUserDefinitionOutput(ctx *Context, args *LookupMongoDBResourceMongoUserDefinitionOutputArgs, opts ...InvokeOption) LookupMongoDBResourceMongoUserDefinitionResultOutput> Note: This function is named LookupMongoDBResourceMongoUserDefinition in the Go SDK.
public static class GetMongoDBResourceMongoUserDefinition
{
public static Task<GetMongoDBResourceMongoUserDefinitionResult> InvokeAsync(GetMongoDBResourceMongoUserDefinitionArgs args, InvokeOptions? opts = null)
public static Output<GetMongoDBResourceMongoUserDefinitionResult> Invoke(GetMongoDBResourceMongoUserDefinitionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetMongoDBResourceMongoUserDefinitionResult> getMongoDBResourceMongoUserDefinition(GetMongoDBResourceMongoUserDefinitionArgs args, InvokeOptions options)
public static Output<GetMongoDBResourceMongoUserDefinitionResult> getMongoDBResourceMongoUserDefinition(GetMongoDBResourceMongoUserDefinitionArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cosmosdb:getMongoDBResourceMongoUserDefinition
arguments:
# arguments dictionaryThe following arguments are supported:
- Account
Name string - Cosmos DB database account name.
- Mongo
User stringDefinition Id - The ID for the User Definition {dbName.userName}.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Account
Name string - Cosmos DB database account name.
- Mongo
User stringDefinition Id - The ID for the User Definition {dbName.userName}.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- account
Name String - Cosmos DB database account name.
- mongo
User StringDefinition Id - The ID for the User Definition {dbName.userName}.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- account
Name string - Cosmos DB database account name.
- mongo
User stringDefinition Id - The ID for the User Definition {dbName.userName}.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- account_
name str - Cosmos DB database account name.
- mongo_
user_ strdefinition_ id - The ID for the User Definition {dbName.userName}.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- account
Name String - Cosmos DB database account name.
- mongo
User StringDefinition Id - The ID for the User Definition {dbName.userName}.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getMongoDBResourceMongoUserDefinition Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The unique resource identifier of the database account.
- Name string
- The name of the database account.
- Type string
- The type of Azure resource.
- Custom
Data string - A custom definition for the USer Definition.
- Database
Name 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.
- Password string
- The password for User Definition. Response does not contain user password.
- Roles
List<Pulumi.
Azure Native. Cosmos DB. Outputs. Role Response> - The set of roles inherited by the User Definition.
- User
Name string - The user name for User Definition.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The unique resource identifier of the database account.
- Name string
- The name of the database account.
- Type string
- The type of Azure resource.
- Custom
Data string - A custom definition for the USer Definition.
- Database
Name 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.
- Password string
- The password for User Definition. Response does not contain user password.
- Roles
[]Role
Response - The set of roles inherited by the User Definition.
- User
Name string - The user name for User Definition.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The unique resource identifier of the database account.
- name String
- The name of the database account.
- type String
- The type of Azure resource.
- custom
Data String - A custom definition for the USer Definition.
- database
Name 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.
- password String
- The password for User Definition. Response does not contain user password.
- roles
List<Role
Response> - The set of roles inherited by the User Definition.
- user
Name String - The user name for User Definition.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The unique resource identifier of the database account.
- name string
- The name of the database account.
- type string
- The type of Azure resource.
- custom
Data string - A custom definition for the USer Definition.
- database
Name 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.
- password string
- The password for User Definition. Response does not contain user password.
- roles
Role
Response[] - The set of roles inherited by the User Definition.
- user
Name string - The user name for User Definition.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The unique resource identifier of the database account.
- name str
- The name of the database account.
- type str
- The type of Azure resource.
- 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.
- password str
- The password for User Definition. Response does not contain user password.
- roles
Sequence[Role
Response] - The set of roles inherited by the User Definition.
- user_
name str - The user name for User Definition.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The unique resource identifier of the database account.
- name String
- The name of the database account.
- type String
- The type of Azure resource.
- custom
Data String - A custom definition for the USer Definition.
- database
Name 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.
- 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.
- user
Name String - The user name for User Definition.
Supporting Types
RoleResponse
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Friday, Mar 20, 2026 by Pulumi
