SensitivityLabelsOperations Class

SensitivityLabelsOperations 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.

Inheritance

builtins.object

SensitivityLabelsOperations

Constructor

SensitivityLabelsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

create_or_update	Creates or updates the sensitivity label of a given column.
delete	Deletes the sensitivity label of a given column.
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_by_database	Gets the sensitivity labels of a given database.
list_recommended_by_database	Gets the sensitivity labels of a given database.
update	Update sensitivity labels of a given database using an operations batch.

create_or_update

Creates or updates the sensitivity label of a given column.

create_or_update(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, parameters: _models.SensitivityLabel, **kwargs: Any) -> _models.SensitivityLabel

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

schema_name

str

Required

The name of the schema.

table_name

str

Required

The name of the table.

column_name

str

Required

The name of the column.

parameters

SensitivityLabel

Required

The column sensitivity label resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

SensitivityLabel, or the result of cls(response)

Return type

SensitivityLabel

Exceptions

HttpResponseError

delete

Deletes the sensitivity label of a given column.

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

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

schema_name

str

Required

The name of the schema.

table_name

str

Required

The name of the table.

column_name

str

Required

The name of the column.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

disable_recommendation

Disables sensitivity recommendations on a given column.

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

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

schema_name

str

Required

The name of the schema.

table_name

str

Required

The name of the table.

column_name

str

Required

The name of the column.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

enable_recommendation

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

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

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

schema_name

str

Required

The name of the schema.

table_name

str

Required

The name of the table.

column_name

str

Required

The name of the column.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets the sensitivity label of a given column.

get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, sensitivity_label_source: Union[str, _models.SensitivityLabelSource], **kwargs: Any) -> _models.SensitivityLabel

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

schema_name

str

Required

The name of the schema.

table_name

str

Required

The name of the table.

column_name

str

Required

The name of the column.

sensitivity_label_source

str or SensitivityLabelSource

Required

The source of the sensitivity label.

cls

callable

A custom type or function that will be passed the direct response

Returns

SensitivityLabel, or the result of cls(response)

Return type

SensitivityLabel

Exceptions

HttpResponseError

list_current_by_database

Gets the sensitivity labels of a given database.

list_current_by_database(resource_group_name: str, server_name: str, database_name: str, skip_token: Optional[str] = None, count: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.SensitivityLabelListResult]

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

skip_token

str

default value: None

count

bool

default value: None

filter

str

default value: None

An OData filter expression that filters elements in the collection.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Return type

ItemPaged[SensitivityLabelListResult]

Exceptions

HttpResponseError

list_recommended_by_database

Gets the sensitivity labels of a given database.

list_recommended_by_database(resource_group_name: str, server_name: str, database_name: str, skip_token: Optional[str] = None, include_disabled_recommendations: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.SensitivityLabelListResult]

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

skip_token

str

default value: None

include_disabled_recommendations

bool

default value: None

Specifies whether to include disabled recommendations or not.

filter

str

default value: None

An OData filter expression that filters elements in the collection.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Return type

ItemPaged[SensitivityLabelListResult]

Exceptions

HttpResponseError

update

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

update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.SensitivityLabelUpdateList, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

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

server_name

str

Required

The name of the server.

database_name

str

Required

The name of the database.

parameters

SensitivityLabelUpdateList

Required

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>