role_definitions

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

Overview

Name	role_definitions
Type	Resource
Id	azure.synapse_access_control.role_definitions

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_role_definitions	exec	endpoint		List roles.
get_role_definition_by_id	exec	role_id, endpoint		Get role by role Id.
list_role_definitions	exec	endpoint	isBuiltIn, scope	List role definitions.
list_scopes	exec	endpoint		List rbac scopes.

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
endpoint	string	The service endpoint host (no scheme). (default: )
role_id	string	Synapse Built-In Role Id.
isBuiltIn	boolean	Is a Synapse Built-In Role or not.
scope	string	Scope of the Synapse Built-in Role.

Lifecycle Methods

get_role_definitions

List roles.

EXEC azure.synapse_access_control.role_definitions.get_role_definitions 
@endpoint='{{ endpoint }}' --required
;

get_role_definition_by_id

Get role by role Id.

EXEC azure.synapse_access_control.role_definitions.get_role_definition_by_id 
@role_id='{{ role_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_role_definitions

List role definitions.

EXEC azure.synapse_access_control.role_definitions.list_role_definitions 
@endpoint='{{ endpoint }}' --required, 
@isBuiltIn={{ isBuiltIn }}, 
@scope='{{ scope }}'
;

list_scopes

List rbac scopes.

EXEC azure.synapse_access_control.role_definitions.list_scopes 
@endpoint='{{ endpoint }}' --required
;