azure-native.cosmosdb.getMongoDBResourceMongoRoleDefinition
Explore with Pulumi AI
Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.
Uses Azure REST API version 2024-11-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-12-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 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)
public static Output<GetMongoDBResourceMongoRoleDefinitionResult> getMongoDBResourceMongoRoleDefinition(GetMongoDBResourceMongoRoleDefinitionArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:cosmosdb:getMongoDBResourceMongoRoleDefinition
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Account
Name string - Cosmos DB database account name.
 - Mongo
Role stringDefinition Id  - The ID for the Role Definition {dbName.roleName}.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Account
Name string - Cosmos DB database account name.
 - Mongo
Role stringDefinition Id  - The ID for the Role Definition {dbName.roleName}.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- account
Name String - Cosmos DB database account name.
 - mongo
Role StringDefinition Id  - The ID for the Role Definition {dbName.roleName}.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- account
Name string - Cosmos DB database account name.
 - mongo
Role stringDefinition Id  - The ID for the Role Definition {dbName.roleName}.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- account_
name str - Cosmos DB database account name.
 - mongo_
role_ strdefinition_ id  - The ID for the Role Definition {dbName.roleName}.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 
- account
Name String - Cosmos DB database account name.
 - mongo
Role StringDefinition Id  - The ID for the Role Definition {dbName.roleName}.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
getMongoDBResourceMongoRoleDefinition 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.
 - Database
Name string - The database name for which access is being granted for this Role Definition.
 - Privileges
List<Pulumi.
Azure Native. Cosmos DB. Outputs. Privilege Response>  - 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 string - A user-friendly name for the Role Definition. Must be unique for the database account.
 - Roles
List<Pulumi.
Azure Native. Cosmos DB. Outputs. Role Response>  - The set of roles inherited by this Role 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.
 - Database
Name string - The database name for which access is being granted for this Role Definition.
 - Privileges
[]Privilege
Response  - 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 string - A user-friendly name for the Role Definition. Must be unique for the database account.
 - Roles
[]Role
Response  - The set of roles inherited by this Role 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.
 - database
Name String - The database name for which access is being granted for this Role Definition.
 - privileges
List<Privilege
Response>  - 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 String - A user-friendly name for the Role Definition. Must be unique for the database account.
 - roles
List<Role
Response>  - The set of roles inherited by this Role 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.
 - database
Name string - The database name for which access is being granted for this Role Definition.
 - privileges
Privilege
Response[]  - 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 string - A user-friendly name for the Role Definition. Must be unique for the database account.
 - roles
Role
Response[]  - The set of roles inherited by this Role 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.
 - database_
name str - The database name for which access is being granted for this Role Definition.
 - privileges
Sequence[Privilege
Response]  - 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[Role
Response]  - The set of roles inherited by this Role 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.
 - database
Name 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.
 - role
Name 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.
Azure Native. Cosmos DB. Inputs. Privilege Response Resource  - An Azure Cosmos DB Mongo DB Resource.
 
- Actions []string
 - An array of actions that are allowed.
 - Resource
Privilege
Response Resource  - An Azure Cosmos DB Mongo DB Resource.
 
- actions List<String>
 - An array of actions that are allowed.
 - resource
Privilege
Response Resource  - An Azure Cosmos DB Mongo DB Resource.
 
- actions string[]
 - An array of actions that are allowed.
 - resource
Privilege
Response Resource  - An Azure Cosmos DB Mongo DB Resource.
 
- actions Sequence[str]
 - An array of actions that are allowed.
 - resource
Privilege
Response Resource  - 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 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0