tde.yml

### YamlMime:AzureCLIGroup
uid: az_synapse_sql_pool_tde
name: az synapse sql pool tde
summary: |-
  Manage a SQL pool's transparent data encryption.
status: GA
sourceType: Core
directCommands:
- uid: az_synapse_sql_pool_tde_set
  name: az synapse sql pool tde set
  summary: |-
    Set a SQL pool's transparent data encryption configuration.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/synapse/_help.py
  syntax: >-
    az synapse sql pool tde set --status {Disabled, Enabled}
                                --transparent-data-encryption-name
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]
                                [--workspace-name]
  examples:
  - summary: |-
      Set a SQL pool's transparent data encryption configuration. (autogenerated)
    syntax: >-
      az synapse sql pool tde set --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \

      --status Enabled --transparent-data-encryption-name current
  requiredParameters:
  - isRequired: true
    name: --status
    parameterValueGroup: "Disabled, Enabled"
    summary: |-
      Status of the transparent data encryption.
  - isRequired: true
    name: --transparent-data-encryption-name -d
    summary: |-
      Name of the transparent data encryption.
  optionalParameters:
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      The SQL pool name.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --workspace-name
    summary: |-
      The workspace name.
- uid: az_synapse_sql_pool_tde_show
  name: az synapse sql pool tde show
  summary: |-
    Get a SQL pool's transparent data encryption configuration.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/synapse/_help.py
  syntax: >-
    az synapse sql pool tde show --transparent-data-encryption-name
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--workspace-name]
  examples:
  - summary: |-
      Get a SQL pool's transparent data encryption configuration. (autogenerated)
    syntax: >-
      az synapse sql pool tde show --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \

      --transparent-data-encryption-name current
  requiredParameters:
  - isRequired: true
    name: --transparent-data-encryption-name -d
    summary: |-
      Name of the transparent data encryption.
  optionalParameters:
  - name: --ids
    summary: |-
      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: --name -n
    summary: |-
      The SQL pool name.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --workspace-name
    summary: |-
      The workspace name.
commands:
- az_synapse_sql_pool_tde_set
- az_synapse_sql_pool_tde_show
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  ms.date: 10/27/2021
  description: Manage a SQL pool's transparent data encryption.