sql_role_definitions

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

Overview

Name	sql_role_definitions
Type	Resource
Id	azure.cosmos_db.sql_role_definitions

Fields

vw_sql_role_definitions

Name	Datatype	Description
id	text	The unique resource identifier of the database account.
name	text	The name of the database account.
accountName	text	field from the properties object
assignable_scopes	text	field from the properties object
permissions	text	field from the properties object
resourceGroupName	text	field from the properties object
roleDefinitionId	text	field from the properties object
role_name	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type of Azure resource.

sql_role_definitions

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Azure Cosmos DB SQL Role Definition resource object.
type	string	The type of Azure resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, resourceGroupName, roleDefinitionId, subscriptionId	Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
list	SELECT	accountName, resourceGroupName, subscriptionId	Retrieves the list of all Azure Cosmos DB SQL Role Definitions.
create_update	INSERT	accountName, resourceGroupName, roleDefinitionId, subscriptionId	Creates or updates an Azure Cosmos DB SQL Role Definition.
delete	DELETE	accountName, resourceGroupName, roleDefinitionId, subscriptionId	Deletes an existing Azure Cosmos DB SQL Role Definition.

SELECT examples

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

vw_sql_role_definitions

SELECT
id,
name,
accountName,
assignable_scopes,
permissions,
resourceGroupName,
roleDefinitionId,
role_name,
subscriptionId,
type
FROM azure.cosmos_db.vw_sql_role_definitions
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

sql_role_definitions

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

INSERT example

Use the following StackQL query and manifest file to create a new sql_role_definitions resource.

All Properties

/*+ create */
INSERT INTO azure.cosmos_db.sql_role_definitions (
accountName,
resourceGroupName,
roleDefinitionId,
subscriptionId,
properties
)
SELECT 
'{{ accountName }}',
'{{ resourceGroupName }}',
'{{ roleDefinitionId }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: roleName
          value: string
        - name: type
          value: string
        - name: assignableScopes
          value:
            - string
        - name: permissions
          value:
            - - name: dataActions
                value:
                  - string
              - name: notDataActions
                value:
                  - string

DELETE example

Deletes the specified sql_role_definitions resource.

/*+ delete */
DELETE FROM azure.cosmos_db.sql_role_definitions
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND roleDefinitionId = '{{ roleDefinitionId }}'
AND subscriptionId = '{{ subscriptionId }}';