role_assignments

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

Overview

Name	role_assignments
Type	Resource
Id	azure.key_vault_administration.role_assignments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The role assignment ID.
name	string	The role assignment name.
principalId	string	The principal ID.
roleDefinitionId	string	The role definition ID.
scope	string	The role scope. Known values are: "/" and "/keys". (/, /keys)
type	string	The role assignment type.

list_for_scope

Name	Datatype	Description
id	string	The role assignment ID.
name	string	The role assignment name.
principalId	string	The principal ID.
roleDefinitionId	string	The role definition ID.
scope	string	The role scope. Known values are: "/" and "/keys". (/, /keys)
type	string	The role assignment type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, role_assignment_name, vault_base_url		Get the specified role assignment.
list_for_scope	select	scope, vault_base_url	$filter	Gets role assignments for a scope.
create	insert	scope, role_assignment_name, vault_base_url, properties		Creates a role assignment.
delete	delete	scope, role_assignment_name, vault_base_url		Deletes a role assignment.

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
role_assignment_name	string	The name of the role assignment to delete. Required.
scope	string	The scope of the role assignment to delete. Required.
vault_base_url	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client vaultBaseUrl parameter. (default: )
$filter	string	The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal. Default value is None.

SELECT examples

get

Get the specified role assignment.

SELECT
id,
name,
principalId,
roleDefinitionId,
scope,
type
FROM azure.key_vault_administration.role_assignments
WHERE scope = '{{ scope }}' -- required
AND role_assignment_name = '{{ role_assignment_name }}' -- required
AND vault_base_url = '{{ vault_base_url }}' -- required
;

list_for_scope

Gets role assignments for a scope.

SELECT
id,
name,
principalId,
roleDefinitionId,
scope,
type
FROM azure.key_vault_administration.role_assignments
WHERE scope = '{{ scope }}' -- required
AND vault_base_url = '{{ vault_base_url }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates a role assignment.

INSERT INTO azure.key_vault_administration.role_assignments (
properties,
scope,
role_assignment_name,
vault_base_url
)
SELECT 
'{{ properties }}' /* required */,
'{{ scope }}',
'{{ role_assignment_name }}',
'{{ vault_base_url }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: role_assignments
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the role_assignments resource.
  - name: role_assignment_name
    value: "{{ role_assignment_name }}"
    description: Required parameter for the role_assignments resource.
  - name: vault_base_url
    value: "{{ vault_base_url }}"
    description: Required parameter for the role_assignments resource.
  - name: properties
    description: |
      Role assignment properties. Required.
    value:
      roleDefinitionId: "{{ roleDefinitionId }}"
      principalId: "{{ principalId }}"

DELETE examples

delete

Deletes a role assignment.

DELETE FROM azure.key_vault_administration.role_assignments
WHERE scope = '{{ scope }}' --required
AND role_assignment_name = '{{ role_assignment_name }}' --required
AND vault_base_url = '{{ vault_base_url }}' --required
;