SensitivityLabels interface

Package:

@azure/arm-sql

Interface representing a SensitivityLabels.

Methods

createOrUpdate(string, string, string, string, string, string, SensitivityLabel, SensitivityLabelsCreateOrUpdateOptionalParams)	Creates or updates the sensitivity label of a given column
delete(string, string, string, string, string, string, SensitivityLabelsDeleteOptionalParams)	Deletes the sensitivity label of a given column
disableRecommendation(string, string, string, string, string, string, SensitivityLabelsDisableRecommendationOptionalParams)	Disables sensitivity recommendations on a given column
enableRecommendation(string, string, string, string, string, string, SensitivityLabelsEnableRecommendationOptionalParams)	Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)
get(string, string, string, string, string, string, SensitivityLabelSource, SensitivityLabelsGetOptionalParams)	Gets the sensitivity label of a given column
listCurrentByDatabase(string, string, string, SensitivityLabelsListCurrentByDatabaseOptionalParams)	Gets the sensitivity labels of a given database
listRecommendedByDatabase(string, string, string, SensitivityLabelsListRecommendedByDatabaseOptionalParams)	Gets the sensitivity labels of a given database
update(string, string, string, SensitivityLabelUpdateList, SensitivityLabelsUpdateOptionalParams)	Update sensitivity labels of a given database using an operations batch.

Method Details

createOrUpdate(string, string, string, string, string, string, SensitivityLabel, SensitivityLabelsCreateOrUpdateOptionalParams)

Creates or updates the sensitivity label of a given column

function createOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, parameters: SensitivityLabel, options?: SensitivityLabelsCreateOrUpdateOptionalParams): Promise<SensitivityLabel>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

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

SensitivityLabelsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SensitivityLabel>

delete(string, string, string, string, string, string, SensitivityLabelsDeleteOptionalParams)

Deletes the sensitivity label of a given column

function delete(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, options?: SensitivityLabelsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

options

SensitivityLabelsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

disableRecommendation(string, string, string, string, string, string, SensitivityLabelsDisableRecommendationOptionalParams)

Disables sensitivity recommendations on a given column

function disableRecommendation(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, options?: SensitivityLabelsDisableRecommendationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

options

SensitivityLabelsDisableRecommendationOptionalParams

The options parameters.

Returns

Promise<void>

enableRecommendation(string, string, string, string, string, string, SensitivityLabelsEnableRecommendationOptionalParams)

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

function enableRecommendation(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, options?: SensitivityLabelsEnableRecommendationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

schemaName

string

The name of the schema.

tableName

string

The name of the table.

columnName

string

The name of the column.

options

SensitivityLabelsEnableRecommendationOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, string, string, SensitivityLabelSource, SensitivityLabelsGetOptionalParams)

Gets the sensitivity label of a given column

function get(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, sensitivityLabelSource: SensitivityLabelSource, options?: SensitivityLabelsGetOptionalParams): Promise<SensitivityLabel>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

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

SensitivityLabelsGetOptionalParams

The options parameters.

Returns

Promise<SensitivityLabel>

listCurrentByDatabase(string, string, string, SensitivityLabelsListCurrentByDatabaseOptionalParams)

Gets the sensitivity labels of a given database

function listCurrentByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: SensitivityLabelsListCurrentByDatabaseOptionalParams): PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

options

SensitivityLabelsListCurrentByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

listRecommendedByDatabase(string, string, string, SensitivityLabelsListRecommendedByDatabaseOptionalParams)

Gets the sensitivity labels of a given database

function listRecommendedByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: SensitivityLabelsListRecommendedByDatabaseOptionalParams): PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

options

SensitivityLabelsListRecommendedByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SensitivityLabel, SensitivityLabel[], PageSettings>

update(string, string, string, SensitivityLabelUpdateList, SensitivityLabelsUpdateOptionalParams)

Update sensitivity labels of a given database using an operations batch.

function update(resourceGroupName: string, serverName: string, databaseName: string, parameters: SensitivityLabelUpdateList, options?: SensitivityLabelsUpdateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database.

parameters

SensitivityLabelUpdateList

A list of sensitivity label update operations.

options

SensitivityLabelsUpdateOptionalParams

The options parameters.

Returns

Promise<void>