Share via

SqlPoolSensitivityLabels interface

  • Reference
Package:
@azure/arm-synapse

Interface representing a SqlPoolSensitivityLabels.

Methods

createOrUpdate(string, string, string, string, string, string, SensitivityLabel, SqlPoolSensitivityLabelsCreateOrUpdateOptionalParams)

Creates or updates the sensitivity label of a given column in a Sql pool
delete(string, string, string, string, string, string, SqlPoolSensitivityLabelsDeleteOptionalParams)

Deletes the sensitivity label of a given column in a Sql pool
disableRecommendation(string, string, string, string, string, string, SqlPoolSensitivityLabelsDisableRecommendationOptionalParams)

Disables sensitivity recommendations on a given column
enableRecommendation(string, string, string, string, string, string, SqlPoolSensitivityLabelsEnableRecommendationOptionalParams)

Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)
get(string, string, string, string, string, string, SensitivityLabelSource, SqlPoolSensitivityLabelsGetOptionalParams)

Gets the sensitivity label of a given column
listCurrent(string, string, string, SqlPoolSensitivityLabelsListCurrentOptionalParams)

Gets SQL pool sensitivity labels.
listRecommended(string, string, string, SqlPoolSensitivityLabelsListRecommendedOptionalParams)

Gets sensitivity labels of a given SQL pool.
update(string, string, string, SensitivityLabelUpdateList, SqlPoolSensitivityLabelsUpdateOptionalParams)

Update sensitivity labels of a given SQL Pool using an operations batch.

Method Details

createOrUpdate(string, string, string, string, string, string, SensitivityLabel, SqlPoolSensitivityLabelsCreateOrUpdateOptionalParams)

Creates or updates the sensitivity label of a given column in a Sql pool

function createOrUpdate(resourceGroupName: string, workspaceName: string, sqlPoolName: string, schemaName: string, tableName: string, columnName: string, parameters: SensitivityLabel, options?: SqlPoolSensitivityLabelsCreateOrUpdateOptionalParams): Promise<SensitivityLabel>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

parameters
SensitivityLabel

The column sensitivity label resource.

options
SqlPoolSensitivityLabelsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SensitivityLabel>

delete(string, string, string, string, string, string, SqlPoolSensitivityLabelsDeleteOptionalParams)

Deletes the sensitivity label of a given column in a Sql pool

function delete(resourceGroupName: string, workspaceName: string, sqlPoolName: string, schemaName: string, tableName: string, columnName: string, options?: SqlPoolSensitivityLabelsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

options
SqlPoolSensitivityLabelsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

disableRecommendation(string, string, string, string, string, string, SqlPoolSensitivityLabelsDisableRecommendationOptionalParams)

Disables sensitivity recommendations on a given column

function disableRecommendation(resourceGroupName: string, workspaceName: string, sqlPoolName: string, schemaName: string, tableName: string, columnName: string, options?: SqlPoolSensitivityLabelsDisableRecommendationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

options
SqlPoolSensitivityLabelsDisableRecommendationOptionalParams

The options parameters.

Returns

Promise<void>

enableRecommendation(string, string, string, string, string, string, SqlPoolSensitivityLabelsEnableRecommendationOptionalParams)

Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)

function enableRecommendation(resourceGroupName: string, workspaceName: string, sqlPoolName: string, schemaName: string, tableName: string, columnName: string, options?: SqlPoolSensitivityLabelsEnableRecommendationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

options
SqlPoolSensitivityLabelsEnableRecommendationOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, string, string, SensitivityLabelSource, SqlPoolSensitivityLabelsGetOptionalParams)

Gets the sensitivity label of a given column

function get(resourceGroupName: string, workspaceName: string, sqlPoolName: string, schemaName: string, tableName: string, columnName: string, sensitivityLabelSource: SensitivityLabelSource, options?: SqlPoolSensitivityLabelsGetOptionalParams): Promise<SensitivityLabel>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

sensitivityLabelSource
SensitivityLabelSource

The source of the sensitivity label.

options
SqlPoolSensitivityLabelsGetOptionalParams

The options parameters.

Returns

Promise<SensitivityLabel>

listCurrent(string, string, string, SqlPoolSensitivityLabelsListCurrentOptionalParams)

Gets SQL pool sensitivity labels.

function listCurrent(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolSensitivityLabelsListCurrentOptionalParams): PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

options
SqlPoolSensitivityLabelsListCurrentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

listRecommended(string, string, string, SqlPoolSensitivityLabelsListRecommendedOptionalParams)

Gets sensitivity labels of a given SQL pool.

function listRecommended(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolSensitivityLabelsListRecommendedOptionalParams): PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

options
SqlPoolSensitivityLabelsListRecommendedOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

update(string, string, string, SensitivityLabelUpdateList, SqlPoolSensitivityLabelsUpdateOptionalParams)

Update sensitivity labels of a given SQL Pool using an operations batch.

function update(resourceGroupName: string, workspaceName: string, sqlPoolName: string, parameters: SensitivityLabelUpdateList, options?: SqlPoolSensitivityLabelsUpdateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

parameters
SensitivityLabelUpdateList

A list of sensitivity label update operations.

options
SqlPoolSensitivityLabelsUpdateOptionalParams

The options parameters.

Returns

Promise<void>