SqlPoolSensitivityLabelsImpl | @azure/arm-synapse

Class containing SqlPoolSensitivityLabels operations.

Hierarchy

SqlPoolSensitivityLabelsImpl

Implements

SqlPoolSensitivityLabels

Index

Constructors

constructor

Methods

Constructors

constructor

new SqlPoolSensitivityLabelsImpl(client: SynapseManagementClient): SqlPoolSensitivityLabelsImpl

- Defined in operations/sqlPoolSensitivityLabels.ts:40
Initialize a new instance of the class SqlPoolSensitivityLabels class.

Parameters
- client: SynapseManagementClient
  
  Reference to the service client
Returns SqlPoolSensitivityLabelsImpl

Methods

createOrUpdate

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

Implementation of SqlPoolSensitivityLabels.createOrUpdate
- Defined in operations/sqlPoolSensitivityLabels.ts:280
Creates or updates the sensitivity label of a given column in a Sql pool

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.
- Optional options: SqlPoolSensitivityLabelsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SqlPoolSensitivityLabelsCreateOrUpdateResponse>

delete

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

Implementation of SqlPoolSensitivityLabels.delete
- Defined in operations/sqlPoolSensitivityLabels.ts:315
Deletes the sensitivity label of a given column in a Sql pool

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.
- Optional options: SqlPoolSensitivityLabelsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

disableRecommendation

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

Implementation of SqlPoolSensitivityLabels.disableRecommendation
- Defined in operations/sqlPoolSensitivityLabels.ts:418
Disables sensitivity recommendations on a given column

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.
- Optional options: SqlPoolSensitivityLabelsDisableRecommendationOptionalParams
  
  The options parameters.
Returns Promise<void>

enableRecommendation

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

Implementation of SqlPoolSensitivityLabels.enableRecommendation
- Defined in operations/sqlPoolSensitivityLabels.ts:385
Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)

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.
- Optional options: SqlPoolSensitivityLabelsEnableRecommendationOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of SqlPoolSensitivityLabels.get
- Defined in operations/sqlPoolSensitivityLabels.ts:349
Gets the sensitivity label of a given column

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.
- Optional options: SqlPoolSensitivityLabelsGetOptionalParams
  
  The options parameters.
Returns Promise<SqlPoolSensitivityLabelsGetResponse>

listCurrent

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

Implementation of SqlPoolSensitivityLabels.listCurrent
- Defined in operations/sqlPoolSensitivityLabels.ts:57
Gets SQL pool sensitivity labels.

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
- Optional options: SqlPoolSensitivityLabelsListCurrentOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SensitivityLabel>

listRecommended

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

Implementation of SqlPoolSensitivityLabels.listRecommended
- Defined in operations/sqlPoolSensitivityLabels.ts:137
Gets sensitivity labels of a given SQL pool.

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
- Optional options: SqlPoolSensitivityLabelsListRecommendedOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SensitivityLabel>

update

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

Implementation of SqlPoolSensitivityLabels.update
- Defined in operations/sqlPoolSensitivityLabels.ts:237
Update sensitivity labels of a given SQL Pool using an operations batch.

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.
- Optional options: SqlPoolSensitivityLabelsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SynapseManagementClient

Returns SqlPoolSensitivityLabelsImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

schemaName: string

tableName: string

columnName: string

parameters: SensitivityLabel

Optional options: SqlPoolSensitivityLabelsCreateOrUpdateOptionalParams

Returns Promise<SqlPoolSensitivityLabelsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

schemaName: string

tableName: string

columnName: string

Optional options: SqlPoolSensitivityLabelsDeleteOptionalParams

Returns Promise<void>

disableRecommendation

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

schemaName: string

tableName: string

columnName: string

Optional options: SqlPoolSensitivityLabelsDisableRecommendationOptionalParams

Returns Promise<void>

enableRecommendation

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

schemaName: string

tableName: string

columnName: string

Optional options: SqlPoolSensitivityLabelsEnableRecommendationOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

schemaName: string

tableName: string

columnName: string

sensitivityLabelSource: SensitivityLabelSource

Optional options: SqlPoolSensitivityLabelsGetOptionalParams

Returns Promise<SqlPoolSensitivityLabelsGetResponse>

listCurrent

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

Optional options: SqlPoolSensitivityLabelsListCurrentOptionalParams

Returns PagedAsyncIterableIterator<SensitivityLabel>

listRecommended

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

Optional options: SqlPoolSensitivityLabelsListRecommendedOptionalParams

Returns PagedAsyncIterableIterator<SensitivityLabel>

update

Parameters

resourceGroupName: string