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
The workspace name.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Is a Synapse Built-In Role or not.
Property | Value |
---|---|
Accepted values: | false, true |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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
The role name/id that is assigned to the principal.
The workspace name.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |