Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzSynapseSqlPoolTransparentDataEncryption
- Module:
- Az.Synapse Module
Modifies TDE property for a SQL pool.
Syntax
SetByNameParameterSet (Default)
Set-AzSynapseSqlPoolTransparentDataEncryption
-WorkspaceName <String>
-Name <String>
-State <TransparentDataEncryptionStateType>
[-ResourceGroupName <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByParentObjectParameterSet
Set-AzSynapseSqlPoolTransparentDataEncryption
-Name <String>
-WorkspaceObject <PSSynapseWorkspace>
-State <TransparentDataEncryptionStateType>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByInputObjectParameterSet
Set-AzSynapseSqlPoolTransparentDataEncryption
-InputObject <PSSynapseSqlPool>
-State <TransparentDataEncryptionStateType>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByResourceIdParameterSet
Set-AzSynapseSqlPoolTransparentDataEncryption
-ResourceId <String>
-State <TransparentDataEncryptionStateType>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSynapseSqlPoolTransparentDataEncryption cmdlet modifies the Transparent Data Encryption (TDE) property of an Azure Synapse Analytics SQL pool.
Examples
Example 1
Set-AzSynapseSqlPoolTransparentDataEncryption -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -State Enabled
This command enables TDE for the SQL pool named ContosoSqlPool under the workspace named ContosoWorkspace.
Parameters
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-InputObject
SQL pool input object, usually passed through the pipeline.
Parameter properties
| Type: | PSSynapseSqlPool |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Name of Synapse SQL pool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
Resource identifier of Synapse SQL Pool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-State
The Azure Synapse Analytics Sql Pool Transparent Data Encryption state.
Parameter properties
| Type: | TransparentDataEncryptionStateType |
| Default value: | None |
| Accepted values: | Enabled, Disabled |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
-WorkspaceName
Name of Synapse workspace.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Parameter properties
| Type: | PSSynapseWorkspace |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
PSSynapseWorkspace
PSSynapseSqlPool
Outputs
PSTransparentDataEncryption
Azure PowerShell
Feedback
Was this page helpful?