role_mappings

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

Overview

Name	role_mappings
Type	Resource
Id	azure_isv.commvault_content_store.role_mappings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
roles	array	The list of role assignments mapping roles to Entra entities (users and groups).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cloud_account_name, subscription_id		Get a RoleMapping.
create_or_update	insert	resource_group_name, cloud_account_name, subscription_id		Create a RoleMapping.
create_or_update	replace	resource_group_name, cloud_account_name, subscription_id		Create a RoleMapping.
delete	delete	resource_group_name, cloud_account_name, subscription_id		Delete a RoleMapping.
list_raw	exec	resource_group_name, cloud_account_name, subscription_id		List RoleMapping resources by CloudAccount.

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
cloud_account_name	string	Name of the Cloud Account resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a RoleMapping.

SELECT
id,
name,
provisioningState,
roles,
systemData,
type
FROM azure_isv.commvault_content_store.role_mappings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_account_name = '{{ cloud_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a RoleMapping.

INSERT INTO azure_isv.commvault_content_store.role_mappings (
properties,
resource_group_name,
cloud_account_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cloud_account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: role_mappings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the role_mappings resource.
  - name: cloud_account_name
    value: "{{ cloud_account_name }}"
    description: Required parameter for the role_mappings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the role_mappings resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      roles:
        - roleName: "{{ roleName }}"
          entities: "{{ entities }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a RoleMapping.

REPLACE azure_isv.commvault_content_store.role_mappings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_account_name = '{{ cloud_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a RoleMapping.

DELETE FROM azure_isv.commvault_content_store.role_mappings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cloud_account_name = '{{ cloud_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_raw

List RoleMapping resources by CloudAccount.

EXEC azure_isv.commvault_content_store.role_mappings.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@cloud_account_name='{{ cloud_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;