SqlPoolSensitivityLabelsOperations Class

SqlPoolSensitivityLabelsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Constructor

SqlPoolSensitivityLabelsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

create_or_update	Creates or updates the sensitivity label of a given column in a Sql pool.
delete	Deletes the sensitivity label of a given column in a Sql pool.
disable_recommendation	Disables sensitivity recommendations on a given column.
enable_recommendation	Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns).
get	Gets the sensitivity label of a given column.
list_current	Gets SQL pool sensitivity labels. Gets SQL pool sensitivity labels.
list_recommended	Gets sensitivity labels of a given SQL pool. Gets sensitivity labels of a given SQL pool.
update	Update sensitivity labels of a given SQL Pool using an operations batch.

create_or_update

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

create_or_update(resource_group_name: str, workspace_name: str, sql_pool_name: str, schema_name: str, table_name: str, column_name: str, parameters: '_models.SensitivityLabel', **kwargs: Any) -> _models.SensitivityLabel

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
schema_name Required	str The name of the schema.
table_name Required	str The name of the table.
column_name Required	str The name of the column.
parameters Required	SensitivityLabel The column sensitivity label resource.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SensitivityLabel	SensitivityLabel, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

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

delete(resource_group_name: str, workspace_name: str, sql_pool_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
schema_name Required	str The name of the schema.
table_name Required	str The name of the table.
column_name Required	str The name of the column.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

disable_recommendation

Disables sensitivity recommendations on a given column.

disable_recommendation(resource_group_name: str, workspace_name: str, sql_pool_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
schema_name Required	str The name of the schema.
table_name Required	str The name of the table.
column_name Required	str The name of the column.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

enable_recommendation

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

enable_recommendation(resource_group_name: str, workspace_name: str, sql_pool_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
schema_name Required	str The name of the schema.
table_name Required	str The name of the table.
column_name Required	str The name of the column.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the sensitivity label of a given column.

get(resource_group_name: str, workspace_name: str, sql_pool_name: str, schema_name: str, table_name: str, column_name: str, sensitivity_label_source: str | '_models.SensitivityLabelSource', **kwargs: Any) -> _models.SensitivityLabel

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
schema_name Required	str The name of the schema.
table_name Required	str The name of the table.
column_name Required	str The name of the column.
sensitivity_label_source Required	str or SensitivityLabelSource The source of the sensitivity label.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SensitivityLabel	SensitivityLabel, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_current

Gets SQL pool sensitivity labels.

Gets SQL pool sensitivity labels.

list_current(resource_group_name: str, workspace_name: str, sql_pool_name: str, filter: str | None = None, **kwargs: Any) -> Iterable['_models.SensitivityLabelListResult']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
filter	str An OData filter expression that filters elements in the collection. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[SensitivityLabelListResult]	An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_recommended

Gets sensitivity labels of a given SQL pool.

Gets sensitivity labels of a given SQL pool.

list_recommended(resource_group_name: str, workspace_name: str, sql_pool_name: str, include_disabled_recommendations: bool | None = None, skip_token: str | None = None, filter: str | None = None, **kwargs: Any) -> Iterable['_models.SensitivityLabelListResult']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
include_disabled_recommendations	bool Specifies whether to include disabled recommendations or not. Default value: None
skip_token	str An OData query option to indicate how many elements to skip in the collection. Default value: None
filter	str An OData filter expression that filters elements in the collection. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[SensitivityLabelListResult]	An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

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

update(resource_group_name: str, workspace_name: str, sql_pool_name: str, parameters: '_models.SensitivityLabelUpdateList', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
workspace_name Required	str The name of the workspace.
sql_pool_name Required	str SQL pool name.
parameters Required	SensitivityLabelUpdateList

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.synapse.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv264\\Lib\\site-packages\\azure\\mgmt\\synapse\\models\\__init__.py'>