az synapse role definition

Manage Synapse's role definitions.

Commands

Name	Description	Type	Status
az synapse role definition list	List role definitions.	Core	GA
az synapse role definition show	Get role definition by role id/name.	Core	GA

az synapse role definition list

List role definitions.

az synapse role definition list --workspace-name
                                [--is-built-in {false, true}]

Examples

List role definitions.

az synapse role definition list --workspace-name testsynapseworkspace

List role definitions built-in by Synapse.

az synapse role definition list --workspace-name testsynapseworkspace --is-built-in True

Required Parameters

--workspace-name

The workspace name.

Optional Parameters

--is-built-in

Is a Synapse Built-In Role or not.

Accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse role definition show

Get role definition by role id/name.

az synapse role definition show --role
                                --workspace-name

Examples

Get role definition by role id.

az synapse role definition show --workspace-name testsynapseworkspace \
--role 00000000-0000-0000-0000-000000000000

Get role definition by role name.

az synapse role definition show --workspace-name testsynapseworkspace \
--role "Synapse SQL Administrator"

Required Parameters

--role

The role name/id that is assigned to the principal.

--workspace-name

The workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.