role_assignments

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

Overview

Name	role_assignments
Type	Resource
Id	azure_extras.customer_insights.role_assignments

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the role assignment.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The Role Assignment definition.
type	string	Resource type.

list_by_hub

OK. Successfully get all the role assignment in the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The Role Assignment definition.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, hubName, assignmentName, subscriptionId		Gets the role assignment in the hub.
list_by_hub	select	resourceGroupName, hubName, subscriptionId		Gets all the role assignments for the specified hub.
create_or_update	insert	resourceGroupName, hubName, assignmentName, subscriptionId		Creates or updates a role assignment in the hub.
delete	delete	resourceGroupName, hubName, assignmentName, subscriptionId		Deletes the role assignment in the hub.

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
assignmentName	string	The name of the role assignment.
hubName	string	The name of the hub.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets the role assignment in the hub.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.role_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND assignmentName = '{{ assignmentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_hub

Gets all the role assignments for the specified hub.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.role_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a role assignment in the hub.

INSERT INTO azure_extras.customer_insights.role_assignments (
data__properties,
resourceGroupName,
hubName,
assignmentName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ hubName }}',
'{{ assignmentName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: role_assignments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the role_assignments resource.
    - name: hubName
      value: string
      description: Required parameter for the role_assignments resource.
    - name: assignmentName
      value: string
      description: Required parameter for the role_assignments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the role_assignments resource.
    - name: properties
      value: object
      description: |
        The Role Assignment definition.

DELETE examples

delete

Deletes the role assignment in the hub.

DELETE FROM azure_extras.customer_insights.role_assignments
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND hubName = '{{ hubName }}' --required
AND assignmentName = '{{ assignmentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;