Share via

az synapse sql pool classification

  • Reference

Manage sensitivity classifications.

Commands

Name Description Type Status
az synapse sql pool classification create

Create a column's sensitivity classification.

 Core GA
az synapse sql pool classification delete

Delete the sensitivity classification of a given column.

 Core GA
az synapse sql pool classification list

Get the sensitivity classifications of a given SQL pool.

 Core GA
az synapse sql pool classification recommendation

Manage sensitivity classification recommendations.

 Core GA
az synapse sql pool classification recommendation disable

Disable sensitivity recommendations for a given column(recommendations are enabled by default on all columns).

 Core GA
az synapse sql pool classification recommendation enable

Enable sensitivity recommendations for a given column(recommendations are enabled by default on all columns).

 Core GA
az synapse sql pool classification recommendation list

List the recommended sensitivity classifications of a given SQL pool.

 Core GA
az synapse sql pool classification show

Get the sensitivity classification of a given column.

 Core GA
az synapse sql pool classification update

Update a column's sensitivity classification.

 Core GA

az synapse sql pool classification create

Edit

Create a column's sensitivity classification.

az synapse sql pool classification create --column
                                          --information-type
                                          --label
                                          --name
                                          --resource-group
                                          --schema
                                          --table
                                          --workspace-name

Examples

Create sensitivity classification for a given column.

az synapse sql pool classification create --name sqlpool --workspace-name testsynapseworkspace \
--resource-group rg --schema dbo --table mytable --column mycolumn \
--information-type Name --label "Confidential - GDPR"

Required Parameters

--column

The name of column.

--information-type

The information type.

--label

The label name.

--name -n

The SQL pool name.

--resource-group -g

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

--schema

The name of schema.

--table

The name of table.

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az synapse sql pool classification delete

Edit

Delete the sensitivity classification of a given column.

az synapse sql pool classification delete --column
                                          --schema
                                          --table
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--workspace-name]

Examples

Delete the sensitivity classification of a given column.

az synapse sql pool classification delete --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--schema dbo --table mytable --column mycolumn

Required Parameters

--column

The name of column.

--schema

The name of schema.

--table

The name of table.

Optional Parameters

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

--name -n

The SQL pool name.

--resource-group -g

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

--subscription

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

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az synapse sql pool classification list

Edit

Get the sensitivity classifications of a given SQL pool.

az synapse sql pool classification list --name
                                        --resource-group
                                        --workspace-name
                                        [--filter]

Examples

List the sensitivity classification of a given SQL pool.

az synapse sql pool classification list --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--name -n

The SQL pool name.

--resource-group -g

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

--workspace-name

The workspace name.

Optional Parameters

--filter

An OData filter expression that filters elements in the collection. Default value is None.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az synapse sql pool classification show

Edit

Get the sensitivity classification of a given column.

az synapse sql pool classification show --column
                                        --schema
                                        --table
                                        [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--subscription]
                                        [--workspace-name]

Examples

Get the sensitivity classification of a given column.

az synapse sql pool classification show --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--schema dbo --table mytable --column mycolumn

Required Parameters

--column

The name of column.

--schema

The name of schema.

--table

The name of table.

Optional Parameters

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

--name -n

The SQL pool name.

--resource-group -g

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

--subscription

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

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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

az synapse sql pool classification update

Edit

Update a column's sensitivity classification.

az synapse sql pool classification update --column
                                          --schema
                                          --table
                                          [--ids]
                                          [--information-type]
                                          [--label]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--workspace-name]

Examples

Update sensitivity classification for a given column.

az synapse sql pool classification update --name sqlpool --workspace-name testsynapseworkspace \
--resource-group rg --schema dbo --table mytable --column mycolumn \
--information-type Name --label "Confidential - GDPR"

Required Parameters

--column

The name of column.

--schema

The name of schema.

--table

The name of table.

Optional Parameters

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

--information-type

The information type.

--label

The label name.

--name -n

The SQL pool name.

--resource-group -g

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

--subscription

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

--workspace-name

The workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

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

--subscription

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

--verbose

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