Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getMongoDBResourceMongoUserDefinition
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.getMongoDBResourceMongoUserDefinition

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id. Azure REST API version: 2023-04-15.

    Other available API versions: 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.

    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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:documentdb:getMongoDBResourceMongoUserDefinition
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    MongoUserDefinitionId string
    The ID for the User Definition {dbName.userName}.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    Cosmos DB database account name.
    MongoUserDefinitionId string
    The ID for the User Definition {dbName.userName}.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    mongoUserDefinitionId String
    The ID for the User Definition {dbName.userName}.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    Cosmos DB database account name.
    mongoUserDefinitionId string
    The ID for the User Definition {dbName.userName}.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    Cosmos DB database account name.
    mongo_user_definition_id str
    The ID for the User Definition {dbName.userName}.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    mongoUserDefinitionId String
    The ID for the User Definition {dbName.userName}.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getMongoDBResourceMongoUserDefinition Result

    The following output properties are available:

    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.
    CustomData string
    A custom definition for the USer Definition.
    DatabaseName 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.AzureNative.DocumentDB.Outputs.RoleResponse>
    The set of roles inherited by the User Definition.
    UserName string
    The user name for User Definition.
    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.
    CustomData string
    A custom definition for the USer Definition.
    DatabaseName 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 []RoleResponse
    The set of roles inherited by the User Definition.
    UserName string
    The user name for User Definition.
    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.
    customData String
    A custom definition for the USer Definition.
    databaseName 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<RoleResponse>
    The set of roles inherited by the User Definition.
    userName String
    The user name for User Definition.
    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.
    customData string
    A custom definition for the USer Definition.
    databaseName 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 RoleResponse[]
    The set of roles inherited by the User Definition.
    userName string
    The user name for User Definition.
    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[RoleResponse]
    The set of roles inherited by the User Definition.
    user_name str
    The user name for User Definition.
    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.
    customData String
    A custom definition for the USer Definition.
    databaseName 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.
    userName String
    The user name for User Definition.

    Supporting Types

    RoleResponse

    Db string
    The database name the role is applied.
    Role string
    The role name.
    Db string
    The database name the role is applied.
    Role string
    The role name.
    db String
    The database name the role is applied.
    role String
    The role name.
    db string
    The database name the role is applied.
    role string
    The role name.
    db str
    The database name the role is applied.
    role str
    The role name.
    db String
    The database name the role is applied.
    role String
    The role name.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native