Share via

az synapse sql ad-admin

  • Reference

Manage SQL Active Directory administrator.

Commands

Name Description Type Status
az synapse sql ad-admin create

Create the SQL Azure Active Directory administrator.

 Core GA
az synapse sql ad-admin delete

Delete the SQL Azure Active Directory administrator.

 Core GA
az synapse sql ad-admin show

Get the SQL Azure Active Directory administrator.

 Core GA
az synapse sql ad-admin update

Update the SQL Azure Active Directory administrator.

 Core GA
az synapse sql ad-admin wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az synapse sql ad-admin create

Edit

Create the SQL Azure Active Directory administrator.

az synapse sql ad-admin create --display-name
                               --object-id
                               --resource-group
                               --workspace-name
                               [--no-wait]

Examples

Create the SQL Azure Active admin.

az synapse sql ad-admin create --workspace-name testsynapseworkspace --resource-group rg \
--display-name youraccount@yourdomain --object-id 00000000-0000-0000-0000-000000000000

Required Parameters

--display-name -u

Display name of the Azure AD administrator user or group.

--object-id -i

The unique ID of the Azure AD administrator.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
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 sql ad-admin delete

Edit

Delete the SQL Azure Active Directory administrator.

az synapse sql ad-admin delete --resource-group
                               --workspace-name
                               [--no-wait]
                               [--yes]

Examples

Delete the SQL Azure Active admin.

az synapse sql ad-admin delete --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
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 sql ad-admin show

Edit

Get the SQL Azure Active Directory administrator.

az synapse sql ad-admin show --resource-group
                             --workspace-name

Examples

Get the SQL Azure Active admin.

az synapse sql ad-admin show --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--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.

az synapse sql ad-admin update

Edit

Update the SQL Azure Active Directory administrator.

az synapse sql ad-admin update --resource-group
                               --workspace-name
                               [--add]
                               [--display-name]
                               [--force-string]
                               [--no-wait]
                               [--object-id]
                               [--remove]
                               [--set]

Examples

Update the SQL Azure Active admin.

az synapse sql ad-admin update --workspace-name testsynapseworkspace --resource-group rg \
--display-name youraccount@yourdomain --object-id 00000000-0000-0000-0000-000000000000

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--display-name -u

Display name of the Azure AD administrator user or group.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--object-id -i

The unique ID of the Azure AD administrator.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
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 sql ad-admin wait

Edit

Place the CLI in a waiting state until a condition is met.

az synapse sql ad-admin wait --resource-group
                             --workspace-name
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--interval]
                             [--timeout]
                             [--updated]

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The workspace name.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.