azure-native.documentdb.getMongoDBResourceMongoUserDefinition
Explore with Pulumi AI
Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id. Azure REST API version: 2023-04-15.
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:
- 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:
- 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. Document DB. Outputs. Role Response> The set of roles inherited by the User Definition.
- User
Name 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.
- 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.
- 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.
- 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.
- 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.
- 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