az synapse sql pool tde

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage a SQL pool's transparent data encryption.

Commands

az synapse sql pool tde set	Set a SQL pool's transparent data encryption configuration.
az synapse sql pool tde show	Get a SQL pool's transparent data encryption configuration.

az synapse sql pool tde set

Set a SQL pool's transparent data encryption configuration.

az synapse sql pool tde set --status {Disabled, Enabled}
                            --transparent-data-encryption-name
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--workspace-name]

Examples

Set a SQL pool's transparent data encryption configuration. (autogenerated)

az synapse sql pool tde set --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--status Enabled --transparent-data-encryption-name tdename

Required Parameters

--status

Status of the transparent data encryption.

accepted values: Disabled, Enabled

--transparent-data-encryption-name -d

Name of the transparent data encryption.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The SQL pool name.

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

--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 pool tde show

Get a SQL pool's transparent data encryption configuration.

az synapse sql pool tde show --transparent-data-encryption-name
                             [--ids]
                             [--name]
                             [--resource-group]
                             [--workspace-name]

Examples

Get a SQL pool's transparent data encryption configuration. (autogenerated)

az synapse sql pool tde show --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--transparent-data-encryption-name tdename

Required Parameters

--transparent-data-encryption-name -d

Name of the transparent data encryption.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The SQL pool name.

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

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