Share via

az synapse sql pool classification recommendation

Manage sensitivity classification recommendations.

Commands

Name Description Type Status
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 recommendation disable

Edit

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

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

Examples

Disable sensitivity recommendations for a given column.

az synapse sql pool classification recommendation disable --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

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

The SQL pool name.

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

The workspace name.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az synapse sql pool classification recommendation enable

Edit

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

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

Examples

Enable sensitivity recommendations for a given column.

az synapse sql pool classification recommendation enable --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

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

The SQL pool name.

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

The workspace name.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az synapse sql pool classification recommendation list

Edit

List the recommended sensitivity classifications of a given SQL pool.

az synapse sql pool classification recommendation list --name
                                                       --resource-group
                                                       --workspace-name
                                                       [--filter]
                                                       [--included-disabled {false, true}]
                                                       [--skip-token]

Examples

List the recommended sensitivity classifications of a given SQL pool.

az synapse sql pool classification recommendation 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

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

--filter

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

--included-disabled

Indicates whether the result should include disabled recommendations.

Property Value
Accepted values: false, true
--skip-token

An OData query option to indicate how many elements to skip in the collection. Default value is None.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False