Package version:

Interface SensitivityLabels

Interface representing a SensitivityLabels.

Hierarchy

SensitivityLabels

Index

Methods

createOrUpdate delete disableRecommendation enableRecommendation get listCurrentByDatabase listRecommendedByDatabase update

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, parameters: SensitivityLabel, options?: SensitivityLabelsCreateOrUpdateOptionalParams): Promise<SensitivityLabel>
Creates or updates the sensitivity label of a given column
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.
- Optional options: SensitivityLabelsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SensitivityLabel>
- Defined in operationsInterfaces/sensitivityLabels.ts:148

delete

delete(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, options?: SensitivityLabelsDeleteOptionalParams): Promise<void>
Deletes the sensitivity label of a given column
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.
- Optional options: SensitivityLabelsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/sensitivityLabels.ts:169

disableRecommendation

disableRecommendation(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, options?: SensitivityLabelsDisableRecommendationOptionalParams): Promise<void>
Disables sensitivity recommendations on a given column
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.
- Optional options: SensitivityLabelsDisableRecommendationOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/sensitivityLabels.ts:105

enableRecommendation

enableRecommendation(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, options?: SensitivityLabelsEnableRecommendationOptionalParams): Promise<void>
Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)
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.
- Optional options: SensitivityLabelsEnableRecommendationOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/sensitivityLabels.ts:85

get

get(resourceGroupName: string, serverName: string, databaseName: string, schemaName: string, tableName: string, columnName: string, sensitivityLabelSource: SensitivityLabelSource, options?: SensitivityLabelsGetOptionalParams): Promise<SensitivityLabel>
Gets the sensitivity label of a given column
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.
- Optional options: SensitivityLabelsGetOptionalParams
  
  The options parameters.
Returns Promise<SensitivityLabel>
- Defined in operationsInterfaces/sensitivityLabels.ts:126

listCurrentByDatabase

listCurrentByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: SensitivityLabelsListCurrentByDatabaseOptionalParams): PagedAsyncIterableIterator<SensitivityLabel>
Gets the sensitivity labels of a given database
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.
- Optional options: SensitivityLabelsListCurrentByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SensitivityLabel>
- Defined in operationsInterfaces/sensitivityLabels.ts:37

listRecommendedByDatabase

listRecommendedByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: SensitivityLabelsListRecommendedByDatabaseOptionalParams): PagedAsyncIterableIterator<SensitivityLabel>
Gets the sensitivity labels of a given database
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.
- Optional options: SensitivityLabelsListRecommendedByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SensitivityLabel>
- Defined in operationsInterfaces/sensitivityLabels.ts:51

update

update(resourceGroupName: string, serverName: string, databaseName: string, parameters: SensitivityLabelUpdateList, options?: SensitivityLabelsUpdateOptionalParams): Promise<void>
Update sensitivity labels of a given database using an operations batch.
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.
- Optional options: SensitivityLabelsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/sensitivityLabels.ts:66

Interface SensitivityLabels

Hierarchy

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

schemaName: string

tableName: string

columnName: string

parameters: SensitivityLabel

Optional options: SensitivityLabelsCreateOrUpdateOptionalParams

Returns Promise<SensitivityLabel>

delete

Parameters

resourceGroupName: string

serverName: string

databaseName: string

schemaName: string

tableName: string

columnName: string

Optional options: SensitivityLabelsDeleteOptionalParams

Returns Promise<void>

disableRecommendation

Parameters

resourceGroupName: string

serverName: string

databaseName: string

schemaName: string

tableName: string

columnName: string

Optional options: SensitivityLabelsDisableRecommendationOptionalParams

Returns Promise<void>

enableRecommendation

Parameters

resourceGroupName: string

serverName: string

databaseName: string

schemaName: string

tableName: string

columnName: string

Optional options: SensitivityLabelsEnableRecommendationOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

databaseName: string

schemaName: string

tableName: string

columnName: string

sensitivityLabelSource: SensitivityLabelSource

Optional options: SensitivityLabelsGetOptionalParams

Returns Promise<SensitivityLabel>

listCurrentByDatabase

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: SensitivityLabelsListCurrentByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<SensitivityLabel>

listRecommendedByDatabase

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: SensitivityLabelsListRecommendedByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<SensitivityLabel>

update

Parameters

resourceGroupName: string

serverName: string

databaseName: string

parameters: SensitivityLabelUpdateList

Optional options: SensitivityLabelsUpdateOptionalParams

Returns Promise<void>

Settings

`Optional` options: SensitivityLabelsCreateOrUpdateOptionalParams

`Optional` options: SensitivityLabelsDeleteOptionalParams

`Optional` options: SensitivityLabelsDisableRecommendationOptionalParams

`Optional` options: SensitivityLabelsEnableRecommendationOptionalParams

`Optional` options: SensitivityLabelsGetOptionalParams

`Optional` options: SensitivityLabelsListCurrentByDatabaseOptionalParams

`Optional` options: SensitivityLabelsListRecommendedByDatabaseOptionalParams

`Optional` options: SensitivityLabelsUpdateOptionalParams