mongo_role_definitions

Creates, updates, deletes, gets or lists a mongo_role_definitions resource.

Overview

Name	mongo_role_definitions
Type	Resource
Id	azure.cosmos_db.mongo_role_definitions

Fields

The following fields are returned by SELECT queries:

get

The Mongo Role Definition was successfully retrieved.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Properties related to the Mongo Role Definition.
type	string	The type of Azure resource.

list

The list operation completed successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Properties related to the Mongo Role Definition.
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	mongoRoleDefinitionId, subscriptionId, resourceGroupName, accountName		Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.
list	select	subscriptionId, resourceGroupName, accountName		Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.
create_update	insert	mongoRoleDefinitionId, subscriptionId, resourceGroupName, accountName		Creates or updates an Azure Cosmos DB Mongo Role Definition.
delete	delete	mongoRoleDefinitionId, subscriptionId, resourceGroupName, accountName		Deletes an existing Azure Cosmos DB Mongo Role Definition.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.mongo_role_definitions
WHERE mongoRoleDefinitionId = '{{ mongoRoleDefinitionId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

list

Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.mongo_role_definitions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

INSERT examples

create_update

Creates or updates an Azure Cosmos DB Mongo Role Definition.

INSERT INTO azure.cosmos_db.mongo_role_definitions (
data__properties,
mongoRoleDefinitionId,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ properties }}',
'{{ mongoRoleDefinitionId }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: mongo_role_definitions
  props:
    - name: mongoRoleDefinitionId
      value: string
      description: Required parameter for the mongo_role_definitions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the mongo_role_definitions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the mongo_role_definitions resource.
    - name: accountName
      value: string
      description: Required parameter for the mongo_role_definitions resource.
    - name: properties
      value: object
      description: |
        Properties to create and update an Azure Cosmos DB Mongo Role Definition.

DELETE examples

delete

Deletes an existing Azure Cosmos DB Mongo Role Definition.

DELETE FROM azure.cosmos_db.mongo_role_definitions
WHERE mongoRoleDefinitionId = '{{ mongoRoleDefinitionId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
;