Share via

az sql db tde

Manage a database's transparent data encryption.

Commands

Name Description Type Status
az sql db tde key

Manage a database's encryption protector.

 Core GA
az sql db tde key revalidate

Revalidates a database's encryption protector key.

 Core GA
az sql db tde key revert

Reverts a database's encryption protector key to server level.

 Core GA
az sql db tde set

Sets a database's transparent data encryption configuration.

 Core GA
az sql db tde show

Shows a Transparent Data Encryption.

 Core GA

az sql db tde set

Edit

Sets a database's transparent data encryption configuration.

az sql db tde set --status {Disabled, Enabled}
                  [--database]
                  [--ids]
                  [--resource-group]
                  [--server]
                  [--subscription]

Examples

Sets a database's transparent data encryption configuration. (autogenerated)

az sql db tde set --database mydb --resource-group MyResourceGroup --server myserver --status Enabled

Required Parameters

--status

Status of the transparent data encryption.

Property Value
Accepted values: Disabled, Enabled

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--database -d

Name of the Azure SQL Database.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az sql db tde show

Edit

Shows a Transparent Data Encryption.

az sql db tde show [--database]
                   [--ids]
                   [--resource-group]
                   [--server]
                   [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--database -d

Name of the Azure SQL Database.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server -s

Name of the Azure SQL Server. You can configure the default using az configure --defaults sql-server=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False