Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az sql server tde-key

Manage a server's encryption protector.

Commands

Name Description Type Status
az sql server tde-key revalidate

Revalidate a server encryption protector.

 Core GA
az sql server tde-key set

Sets the server's encryption protector. Ensure to create the key first https://learn.microsoft.com/en-us/cli/azure/sql/server/key?view=azure-cli-latest#az-sql-server-key-create.

 Core GA
az sql server tde-key show

Gets a server encryption protector.

 Core GA

az sql server tde-key revalidate

Revalidate a server encryption protector.

az sql server tde-key revalidate [--acquire-policy-token]
 [--change-reference]
 [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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

az sql server tde-key set

Sets the server's encryption protector. Ensure to create the key first https://learn.microsoft.com/en-us/cli/azure/sql/server/key?view=azure-cli-latest#az-sql-server-key-create.

az sql server tde-key set --server-key-type {AzureKeyVault, ServiceManaged}
 [--acquire-policy-token]
 [--auto-rotation-enabled {false, true}]
 [--change-reference]
 [--ids]
 [--kid]
 [--resource-group]
 [--server]
 [--subscription]

Required Parameters

--server-key-type -t

The type of the server key.

Property Value
Accepted values: AzureKeyVault, ServiceManaged

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--auto-rotation-enabled

The key auto rotation opt in status. Can be either true or false.

Property Value
Accepted values: false, true
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
--kid -k

The Azure Key Vault key identifier of the server key. An example key identifier is "https://YourVaultName.vault.azure.net/keys/YourKeyName/01234567890123456789012345678901".

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

az sql server tde-key show

Gets a server encryption protector.

az sql server tde-key show [--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.

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

Feedback

Was this page helpful?