Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getMongoDBResourceMongoRoleDefinition
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.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.getMongoDBResourceMongoRoleDefinition

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.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

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

    Other available API versions: 2023-03-01-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview.

    Using getMongoDBResourceMongoRoleDefinition

    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 getMongoDBResourceMongoRoleDefinition(args: GetMongoDBResourceMongoRoleDefinitionArgs, opts?: InvokeOptions): Promise<GetMongoDBResourceMongoRoleDefinitionResult>
function getMongoDBResourceMongoRoleDefinitionOutput(args: GetMongoDBResourceMongoRoleDefinitionOutputArgs, opts?: InvokeOptions): Output<GetMongoDBResourceMongoRoleDefinitionResult>
    def get_mongo_db_resource_mongo_role_definition(account_name: Optional[str] = None,
                                                mongo_role_definition_id: Optional[str] = None,
                                                resource_group_name: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetMongoDBResourceMongoRoleDefinitionResult
def get_mongo_db_resource_mongo_role_definition_output(account_name: Optional[pulumi.Input[str]] = None,
                                                mongo_role_definition_id: Optional[pulumi.Input[str]] = None,
                                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetMongoDBResourceMongoRoleDefinitionResult]
    func LookupMongoDBResourceMongoRoleDefinition(ctx *Context, args *LookupMongoDBResourceMongoRoleDefinitionArgs, opts ...InvokeOption) (*LookupMongoDBResourceMongoRoleDefinitionResult, error)
func LookupMongoDBResourceMongoRoleDefinitionOutput(ctx *Context, args *LookupMongoDBResourceMongoRoleDefinitionOutputArgs, opts ...InvokeOption) LookupMongoDBResourceMongoRoleDefinitionResultOutput

    > Note: This function is named LookupMongoDBResourceMongoRoleDefinition in the Go SDK.

    public static class GetMongoDBResourceMongoRoleDefinition 
{
    public static Task<GetMongoDBResourceMongoRoleDefinitionResult> InvokeAsync(GetMongoDBResourceMongoRoleDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetMongoDBResourceMongoRoleDefinitionResult> Invoke(GetMongoDBResourceMongoRoleDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMongoDBResourceMongoRoleDefinitionResult> getMongoDBResourceMongoRoleDefinition(GetMongoDBResourceMongoRoleDefinitionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    MongoRoleDefinitionId string
    The ID for the Role Definition {dbName.roleName}.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    Cosmos DB database account name.
    MongoRoleDefinitionId string
    The ID for the Role Definition {dbName.roleName}.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    mongoRoleDefinitionId String
    The ID for the Role Definition {dbName.roleName}.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    Cosmos DB database account name.
    mongoRoleDefinitionId string
    The ID for the Role Definition {dbName.roleName}.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    Cosmos DB database account name.
    mongo_role_definition_id str
    The ID for the Role Definition {dbName.roleName}.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    mongoRoleDefinitionId String
    The ID for the Role Definition {dbName.roleName}.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getMongoDBResourceMongoRoleDefinition 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.
    DatabaseName string
    The database name for which access is being granted for this Role Definition.
    Privileges List<Pulumi.AzureNative.DocumentDB.Outputs.PrivilegeResponse>
    A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
    RoleName string
    A user-friendly name for the Role Definition. Must be unique for the database account.
    Roles List<Pulumi.AzureNative.DocumentDB.Outputs.RoleResponse>
    The set of roles inherited by this Role 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.
    DatabaseName string
    The database name for which access is being granted for this Role Definition.
    Privileges []PrivilegeResponse
    A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
    RoleName string
    A user-friendly name for the Role Definition. Must be unique for the database account.
    Roles []RoleResponse
    The set of roles inherited by this Role 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.
    databaseName String
    The database name for which access is being granted for this Role Definition.
    privileges List<PrivilegeResponse>
    A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
    roleName String
    A user-friendly name for the Role Definition. Must be unique for the database account.
    roles List<RoleResponse>
    The set of roles inherited by this Role 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.
    databaseName string
    The database name for which access is being granted for this Role Definition.
    privileges PrivilegeResponse[]
    A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
    roleName string
    A user-friendly name for the Role Definition. Must be unique for the database account.
    roles RoleResponse[]
    The set of roles inherited by this Role 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.
    database_name str
    The database name for which access is being granted for this Role Definition.
    privileges Sequence[PrivilegeResponse]
    A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
    role_name str
    A user-friendly name for the Role Definition. Must be unique for the database account.
    roles Sequence[RoleResponse]
    The set of roles inherited by this Role 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.
    databaseName String
    The database name for which access is being granted for this Role Definition.
    privileges List<Property Map>
    A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
    roleName String
    A user-friendly name for the Role Definition. Must be unique for the database account.
    roles List<Property Map>
    The set of roles inherited by this Role Definition.

    Supporting Types

    PrivilegeResponse

    Actions List<string>
    An array of actions that are allowed.
    Resource Pulumi.AzureNative.DocumentDB.Inputs.PrivilegeResponseResource
    An Azure Cosmos DB Mongo DB Resource.
    Actions []string
    An array of actions that are allowed.
    Resource PrivilegeResponseResource
    An Azure Cosmos DB Mongo DB Resource.
    actions List<String>
    An array of actions that are allowed.
    resource PrivilegeResponseResource
    An Azure Cosmos DB Mongo DB Resource.
    actions string[]
    An array of actions that are allowed.
    resource PrivilegeResponseResource
    An Azure Cosmos DB Mongo DB Resource.
    actions Sequence[str]
    An array of actions that are allowed.
    resource PrivilegeResponseResource
    An Azure Cosmos DB Mongo DB Resource.
    actions List<String>
    An array of actions that are allowed.
    resource Property Map
    An Azure Cosmos DB Mongo DB Resource.

    PrivilegeResponseResource

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

    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.38.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure-native