Sql Pool Transparent Data Encryptions - Get

Get a SQL pool's transparent data encryption configuration.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/transparentDataEncryption/current?api-version=2021-06-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

sqlPoolName
path True

string

SQL pool name

subscriptionId
path True

string

The ID of the target subscription.

transparentDataEncryptionName
path True

TransparentDataEncryptionName

The name of the transparent data encryption configuration.

workspaceName
path True

string

The name of the workspace.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

TransparentDataEncryption

OK

Other Status Codes

ErrorResponse

Examples

Get transparent data encryption configuration of a SQL Analytics pool

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current?api-version=2021-06-01

Sample Response

{
  "name": "current",
  "location": "North Europe",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current",
  "type": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption",
  "properties": {
    "status": "Enabled"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

TransparentDataEncryption

Represents a Sql pool transparent data encryption configuration.

TransparentDataEncryptionName

The name of the transparent data encryption configuration.

TransparentDataEncryptionStatus

The status of the database transparent data encryption.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

TransparentDataEncryption

Represents a Sql pool transparent data encryption configuration.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Resource location.

name

string

The name of the resource

properties.status

TransparentDataEncryptionStatus

The status of the database transparent data encryption.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

TransparentDataEncryptionName

The name of the transparent data encryption configuration.

Name Type Description
current

string

TransparentDataEncryptionStatus

The status of the database transparent data encryption.

Name Type Description
Disabled

string

Enabled

string