azure.mgmt.sql.operations.SensitivityLabelsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.sql.operations.SensitivityLabelsOperations
name: SensitivityLabelsOperations
fullName: azure.mgmt.sql.operations.SensitivityLabelsOperations
module: azure.mgmt.sql.operations
inheritances:
- builtins.object
summary: '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.'
constructor:
  syntax: SensitivityLabelsOperations(client, config, serializer, deserializer)
  parameters:
  - name: client
    description: Client for service requests.
    isRequired: true
  - name: config
    description: Configuration of service client.
    isRequired: true
  - name: serializer
    description: An object model serializer.
    isRequired: true
  - name: deserializer
    description: An object model deserializer.
    isRequired: true
variables:
- description: Alias to model classes used in this operation group.
  name: models
methods:
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.create_or_update
  name: create_or_update
  summary: Creates or updates the sensitivity label of a given column.
  signature: '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:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: schema_name
    description: The name of the schema.
    isRequired: true
    types:
    - <xref:str>
  - name: table_name
    description: The name of the table.
    isRequired: true
    types:
    - <xref:str>
  - name: column_name
    description: The name of the column.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The column sensitivity label resource.
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.SensitivityLabel>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: SensitivityLabel, or the result of cls(response)
    types:
    - <xref:azure.mgmt.sql.models.SensitivityLabel>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.delete
  name: delete
  summary: Deletes the sensitivity label of a given column.
  signature: 'delete(resource_group_name: str, server_name: str, database_name: str,
    schema_name: str, table_name: str, column_name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: schema_name
    description: The name of the schema.
    isRequired: true
    types:
    - <xref:str>
  - name: table_name
    description: The name of the table.
    isRequired: true
    types:
    - <xref:str>
  - name: column_name
    description: The name of the column.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None, or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.disable_recommendation
  name: disable_recommendation
  summary: Disables sensitivity recommendations on a given column.
  signature: '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:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: schema_name
    description: The name of the schema.
    isRequired: true
    types:
    - <xref:str>
  - name: table_name
    description: The name of the table.
    isRequired: true
    types:
    - <xref:str>
  - name: column_name
    description: The name of the column.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None, or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.enable_recommendation
  name: enable_recommendation
  summary: 'Enables sensitivity recommendations on a given column (recommendations
    are enabled by default

    on all columns).'
  signature: '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:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: schema_name
    description: The name of the schema.
    isRequired: true
    types:
    - <xref:str>
  - name: table_name
    description: The name of the table.
    isRequired: true
    types:
    - <xref:str>
  - name: column_name
    description: The name of the column.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None, or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.get
  name: get
  summary: Gets the sensitivity label of a given column.
  signature: 'get(resource_group_name: str, server_name: str, database_name: str,
    schema_name: str, table_name: str, column_name: str, sensitivity_label_source:
    str | ''_models.SensitivityLabelSource'', **kwargs: Any) -> _models.SensitivityLabel'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: schema_name
    description: The name of the schema.
    isRequired: true
    types:
    - <xref:str>
  - name: table_name
    description: The name of the table.
    isRequired: true
    types:
    - <xref:str>
  - name: column_name
    description: The name of the column.
    isRequired: true
    types:
    - <xref:str>
  - name: sensitivity_label_source
    description: The source of the sensitivity label.
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.sql.models.SensitivityLabelSource>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: SensitivityLabel, or the result of cls(response)
    types:
    - <xref:azure.mgmt.sql.models.SensitivityLabel>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.list_current_by_database
  name: list_current_by_database
  summary: Gets the sensitivity labels of a given database.
  signature: 'list_current_by_database(resource_group_name: str, server_name: str,
    database_name: str, skip_token: str | None = None, count: bool | None = None,
    filter: str | None = None, **kwargs: Any) -> Iterable[''_models.SensitivityLabelListResult'']'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: skip_token
    defaultValue: None
    types:
    - <xref:str>
  - name: count
    defaultValue: None
    types:
    - <xref:bool>
  - name: filter
    description: An OData filter expression that filters elements in the collection.
    defaultValue: None
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either SensitivityLabelListResult or
      the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.SensitivityLabelListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.list_recommended_by_database
  name: list_recommended_by_database
  summary: Gets the sensitivity labels of a given database.
  signature: 'list_recommended_by_database(resource_group_name: str, server_name:
    str, database_name: str, skip_token: str | None = None, include_disabled_recommendations:
    bool | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[''_models.SensitivityLabelListResult'']'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: skip_token
    defaultValue: None
    types:
    - <xref:str>
  - name: include_disabled_recommendations
    description: 'Specifies whether to include disabled recommendations

      or not.'
    defaultValue: None
    types:
    - <xref:bool>
  - name: filter
    description: An OData filter expression that filters elements in the collection.
    defaultValue: None
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either SensitivityLabelListResult or
      the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.SensitivityLabelListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.update
  name: update
  summary: Update sensitivity labels of a given database using an operations batch.
  signature: 'update(resource_group_name: str, server_name: str, database_name: str,
    parameters: ''_models.SensitivityLabelUpdateList'', **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group that contains the resource. You can

      obtain this value from the Azure Resource Manager API or the portal.'
    isRequired: true
    types:
    - <xref:str>
  - name: server_name
    description: The name of the server.
    isRequired: true
    types:
    - <xref:str>
  - name: database_name
    description: The name of the database.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    isRequired: true
    types:
    - <xref:azure.mgmt.sql.models.SensitivityLabelUpdateList>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None, or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.sql.operations.SensitivityLabelsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>