# pylint: disable=too-many-lines
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import sys
from typing import Any, Callable, Dict, IO, Iterable, Optional, TypeVar, Union, overload
from azure.core.exceptions import (
ClientAuthenticationError,
HttpResponseError,
ResourceExistsError,
ResourceNotFoundError,
ResourceNotModifiedError,
map_error,
)
from azure.core.paging import ItemPaged
from azure.core.pipeline import PipelineResponse
from azure.core.pipeline.transport import HttpResponse
from azure.core.rest import HttpRequest
from azure.core.tracing.decorator import distributed_trace
from azure.core.utils import case_insensitive_dict
from azure.mgmt.core.exceptions import ARMErrorFormat
from .. import models as _models
from .._serialization import Serializer
from .._vendor import _convert_request, _format_url_section
if sys.version_info >= (3, 8):
from typing import Literal # pylint: disable=no-name-in-module, ungrouped-imports
else:
from typing_extensions import Literal # type: ignore # pylint: disable=ungrouped-imports
T = TypeVar("T")
ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]]
_SERIALIZER = Serializer()
_SERIALIZER.client_side_validation = False
def build_get_request(
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
sensitivity_label_source: Union[str, _models.SensitivityLabelSource],
subscription_id: str,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"schemaName": _SERIALIZER.url("schema_name", schema_name, "str"),
"tableName": _SERIALIZER.url("table_name", table_name, "str"),
"columnName": _SERIALIZER.url("column_name", column_name, "str"),
"sensitivityLabelSource": _SERIALIZER.url("sensitivity_label_source", sensitivity_label_source, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_create_or_update_request(
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
subscription_id: str,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["current"] = kwargs.pop("sensitivity_label_source", "current")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"schemaName": _SERIALIZER.url("schema_name", schema_name, "str"),
"tableName": _SERIALIZER.url("table_name", table_name, "str"),
"columnName": _SERIALIZER.url("column_name", column_name, "str"),
"sensitivityLabelSource": _SERIALIZER.url("sensitivity_label_source", sensitivity_label_source, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs)
def build_delete_request(
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
subscription_id: str,
**kwargs: Any
) -> HttpRequest:
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["current"] = kwargs.pop("sensitivity_label_source", "current")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"schemaName": _SERIALIZER.url("schema_name", schema_name, "str"),
"tableName": _SERIALIZER.url("table_name", table_name, "str"),
"columnName": _SERIALIZER.url("column_name", column_name, "str"),
"sensitivityLabelSource": _SERIALIZER.url("sensitivity_label_source", sensitivity_label_source, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs)
def build_disable_recommendation_request(
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
subscription_id: str,
**kwargs: Any
) -> HttpRequest:
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["recommended"] = kwargs.pop("sensitivity_label_source", "recommended")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/disable",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"schemaName": _SERIALIZER.url("schema_name", schema_name, "str"),
"tableName": _SERIALIZER.url("table_name", table_name, "str"),
"columnName": _SERIALIZER.url("column_name", column_name, "str"),
"sensitivityLabelSource": _SERIALIZER.url("sensitivity_label_source", sensitivity_label_source, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
return HttpRequest(method="POST", url=_url, params=_params, **kwargs)
def build_enable_recommendation_request(
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
subscription_id: str,
**kwargs: Any
) -> HttpRequest:
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["recommended"] = kwargs.pop("sensitivity_label_source", "recommended")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/enable",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"schemaName": _SERIALIZER.url("schema_name", schema_name, "str"),
"tableName": _SERIALIZER.url("table_name", table_name, "str"),
"columnName": _SERIALIZER.url("column_name", column_name, "str"),
"sensitivityLabelSource": _SERIALIZER.url("sensitivity_label_source", sensitivity_label_source, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
return HttpRequest(method="POST", url=_url, params=_params, **kwargs)
def build_list_current_by_database_request(
resource_group_name: str,
managed_instance_name: str,
database_name: str,
subscription_id: str,
*,
skip_token: Optional[str] = None,
count: Optional[bool] = None,
filter: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
if skip_token is not None:
_params["$skipToken"] = _SERIALIZER.query("skip_token", skip_token, "str")
if count is not None:
_params["$count"] = _SERIALIZER.query("count", count, "bool")
if filter is not None:
_params["$filter"] = _SERIALIZER.query("filter", filter, "str")
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_update_request(
resource_group_name: str, managed_instance_name: str, database_name: str, subscription_id: str, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs)
def build_list_recommended_by_database_request(
resource_group_name: str,
managed_instance_name: str,
database_name: str,
subscription_id: str,
*,
skip_token: Optional[str] = None,
include_disabled_recommendations: Optional[bool] = None,
filter: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/recommendedSensitivityLabels",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"managedInstanceName": _SERIALIZER.url("managed_instance_name", managed_instance_name, "str"),
"databaseName": _SERIALIZER.url("database_name", database_name, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _format_url_section(_url, **path_format_arguments) # type: ignore
# Construct parameters
if skip_token is not None:
_params["$skipToken"] = _SERIALIZER.query("skip_token", skip_token, "str")
if include_disabled_recommendations is not None:
_params["includeDisabledRecommendations"] = _SERIALIZER.query(
"include_disabled_recommendations", include_disabled_recommendations, "bool"
)
if filter is not None:
_params["$filter"] = _SERIALIZER.query("filter", filter, "str")
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
[docs]class ManagedDatabaseSensitivityLabelsOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.sql.SqlManagementClient`'s
:attr:`managed_database_sensitivity_labels` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
[docs] @distributed_trace
def get(
self,
resource_group_name: str,
managed_instance_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:
"""Gets the sensitivity label of a given column.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param schema_name: The name of the schema. Required.
:type schema_name: str
:param table_name: The name of the table. Required.
:type table_name: str
:param column_name: The name of the column. Required.
:type column_name: str
:param sensitivity_label_source: The source of the sensitivity label. Known values are:
"current" and "recommended". Required.
:type sensitivity_label_source: str or ~azure.mgmt.sql.models.SensitivityLabelSource
:keyword callable cls: A custom type or function that will be passed the direct response
:return: SensitivityLabel or the result of cls(response)
:rtype: ~azure.mgmt.sql.models.SensitivityLabel
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
cls: ClsType[_models.SensitivityLabel] = kwargs.pop("cls", None)
request = build_get_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
schema_name=schema_name,
table_name=table_name,
column_name=column_name,
sensitivity_label_source=sensitivity_label_source,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self.get.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SensitivityLabel", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}"
}
@overload
def create_or_update(
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
parameters: _models.SensitivityLabel,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.SensitivityLabel:
"""Creates or updates the sensitivity label of a given column.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param schema_name: The name of the schema. Required.
:type schema_name: str
:param table_name: The name of the table. Required.
:type table_name: str
:param column_name: The name of the column. Required.
:type column_name: str
:param parameters: The column sensitivity label resource. Required.
:type parameters: ~azure.mgmt.sql.models.SensitivityLabel
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword sensitivity_label_source: The source of the sensitivity label. Default value is
"current". Note that overriding this default value may result in unsupported behavior.
:paramtype sensitivity_label_source: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: SensitivityLabel or the result of cls(response)
:rtype: ~azure.mgmt.sql.models.SensitivityLabel
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def create_or_update(
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
parameters: IO,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.SensitivityLabel:
"""Creates or updates the sensitivity label of a given column.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param schema_name: The name of the schema. Required.
:type schema_name: str
:param table_name: The name of the table. Required.
:type table_name: str
:param column_name: The name of the column. Required.
:type column_name: str
:param parameters: The column sensitivity label resource. Required.
:type parameters: IO
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword sensitivity_label_source: The source of the sensitivity label. Default value is
"current". Note that overriding this default value may result in unsupported behavior.
:paramtype sensitivity_label_source: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: SensitivityLabel or the result of cls(response)
:rtype: ~azure.mgmt.sql.models.SensitivityLabel
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def create_or_update(
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
parameters: Union[_models.SensitivityLabel, IO],
**kwargs: Any
) -> _models.SensitivityLabel:
"""Creates or updates the sensitivity label of a given column.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param schema_name: The name of the schema. Required.
:type schema_name: str
:param table_name: The name of the table. Required.
:type table_name: str
:param column_name: The name of the column. Required.
:type column_name: str
:param parameters: The column sensitivity label resource. Is either a SensitivityLabel type or
a IO type. Required.
:type parameters: ~azure.mgmt.sql.models.SensitivityLabel or IO
:keyword sensitivity_label_source: The source of the sensitivity label. Default value is
"current". Note that overriding this default value may result in unsupported behavior.
:paramtype sensitivity_label_source: str
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: SensitivityLabel or the result of cls(response)
:rtype: ~azure.mgmt.sql.models.SensitivityLabel
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["current"] = kwargs.pop("sensitivity_label_source", "current")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SensitivityLabel] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(parameters, (IO, bytes)):
_content = parameters
else:
_json = self._serialize.body(parameters, "SensitivityLabel")
request = build_create_or_update_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
schema_name=schema_name,
table_name=table_name,
column_name=column_name,
subscription_id=self._config.subscription_id,
sensitivity_label_source=sensitivity_label_source,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.create_or_update.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if response.status_code == 200:
deserialized = self._deserialize("SensitivityLabel", pipeline_response)
if response.status_code == 201:
deserialized = self._deserialize("SensitivityLabel", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
create_or_update.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}"
}
[docs] @distributed_trace
def delete( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
**kwargs: Any
) -> None:
"""Deletes the sensitivity label of a given column.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param schema_name: The name of the schema. Required.
:type schema_name: str
:param table_name: The name of the table. Required.
:type table_name: str
:param column_name: The name of the column. Required.
:type column_name: str
:keyword sensitivity_label_source: The source of the sensitivity label. Default value is
"current". Note that overriding this default value may result in unsupported behavior.
:paramtype sensitivity_label_source: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["current"] = kwargs.pop("sensitivity_label_source", "current")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
cls: ClsType[None] = kwargs.pop("cls", None)
request = build_delete_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
schema_name=schema_name,
table_name=table_name,
column_name=column_name,
subscription_id=self._config.subscription_id,
sensitivity_label_source=sensitivity_label_source,
api_version=api_version,
template_url=self.delete.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {})
delete.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}"
}
[docs] @distributed_trace
def disable_recommendation( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
**kwargs: Any
) -> None:
"""Disables sensitivity recommendations on a given column.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param schema_name: The name of the schema. Required.
:type schema_name: str
:param table_name: The name of the table. Required.
:type table_name: str
:param column_name: The name of the column. Required.
:type column_name: str
:keyword sensitivity_label_source: Default value is "recommended". Note that overriding this
default value may result in unsupported behavior.
:paramtype sensitivity_label_source: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["recommended"] = kwargs.pop("sensitivity_label_source", "recommended")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
cls: ClsType[None] = kwargs.pop("cls", None)
request = build_disable_recommendation_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
schema_name=schema_name,
table_name=table_name,
column_name=column_name,
subscription_id=self._config.subscription_id,
sensitivity_label_source=sensitivity_label_source,
api_version=api_version,
template_url=self.disable_recommendation.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {})
disable_recommendation.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/disable"
}
[docs] @distributed_trace
def enable_recommendation( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
schema_name: str,
table_name: str,
column_name: str,
**kwargs: Any
) -> None:
"""Enables sensitivity recommendations on a given column (recommendations are enabled by default
on all columns).
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param schema_name: The name of the schema. Required.
:type schema_name: str
:param table_name: The name of the table. Required.
:type table_name: str
:param column_name: The name of the column. Required.
:type column_name: str
:keyword sensitivity_label_source: Default value is "recommended". Note that overriding this
default value may result in unsupported behavior.
:paramtype sensitivity_label_source: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
sensitivity_label_source: Literal["recommended"] = kwargs.pop("sensitivity_label_source", "recommended")
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
cls: ClsType[None] = kwargs.pop("cls", None)
request = build_enable_recommendation_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
schema_name=schema_name,
table_name=table_name,
column_name=column_name,
subscription_id=self._config.subscription_id,
sensitivity_label_source=sensitivity_label_source,
api_version=api_version,
template_url=self.enable_recommendation.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {})
enable_recommendation.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/enable"
}
[docs] @distributed_trace
def list_current_by_database(
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
skip_token: Optional[str] = None,
count: Optional[bool] = None,
filter: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.SensitivityLabel"]:
"""Gets the sensitivity labels of a given database.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param skip_token: Default value is None.
:type skip_token: str
:param count: Default value is None.
:type count: bool
:param filter: An OData filter expression that filters elements in the collection. Default
value is None.
:type filter: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either SensitivityLabel or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.sql.models.SensitivityLabel]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
cls: ClsType[_models.SensitivityLabelListResult] = kwargs.pop("cls", None)
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
request = build_list_current_by_database_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
skip_token=skip_token,
count=count,
filter=filter,
api_version=api_version,
template_url=self.list_current_by_database.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
else:
request = HttpRequest("GET", next_link)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
request.method = "GET"
return request
def extract_data(pipeline_response):
deserialized = self._deserialize("SensitivityLabelListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
list_current_by_database.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels"
}
@overload
def update( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
parameters: _models.SensitivityLabelUpdateList,
*,
content_type: str = "application/json",
**kwargs: Any
) -> None:
"""Update sensitivity labels of a given database using an operations batch.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param parameters: Required.
:type parameters: ~azure.mgmt.sql.models.SensitivityLabelUpdateList
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def update( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
parameters: IO,
*,
content_type: str = "application/json",
**kwargs: Any
) -> None:
"""Update sensitivity labels of a given database using an operations batch.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param parameters: Required.
:type parameters: IO
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def update( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
parameters: Union[_models.SensitivityLabelUpdateList, IO],
**kwargs: Any
) -> None:
"""Update sensitivity labels of a given database using an operations batch.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param parameters: Is either a SensitivityLabelUpdateList type or a IO type. Required.
:type parameters: ~azure.mgmt.sql.models.SensitivityLabelUpdateList or IO
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[None] = kwargs.pop("cls", None)
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(parameters, (IO, bytes)):
_content = parameters
else:
_json = self._serialize.body(parameters, "SensitivityLabelUpdateList")
request = build_update_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.update.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {})
update.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels"
}
[docs] @distributed_trace
def list_recommended_by_database(
self,
resource_group_name: str,
managed_instance_name: str,
database_name: str,
skip_token: Optional[str] = None,
include_disabled_recommendations: Optional[bool] = None,
filter: Optional[str] = None,
**kwargs: Any
) -> Iterable["_models.SensitivityLabel"]:
"""Gets the sensitivity labels of a given database.
:param resource_group_name: The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param managed_instance_name: The name of the managed instance. Required.
:type managed_instance_name: str
:param database_name: The name of the database. Required.
:type database_name: str
:param skip_token: Default value is None.
:type skip_token: str
:param include_disabled_recommendations: Specifies whether to include disabled recommendations
or not. Default value is None.
:type include_disabled_recommendations: bool
:param filter: An OData filter expression that filters elements in the collection. Default
value is None.
:type filter: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: An iterator like instance of either SensitivityLabel or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.sql.models.SensitivityLabel]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: Literal["2020-11-01-preview"] = kwargs.pop(
"api_version", _params.pop("api-version", "2020-11-01-preview")
)
cls: ClsType[_models.SensitivityLabelListResult] = kwargs.pop("cls", None)
error_map = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
request = build_list_recommended_by_database_request(
resource_group_name=resource_group_name,
managed_instance_name=managed_instance_name,
database_name=database_name,
subscription_id=self._config.subscription_id,
skip_token=skip_token,
include_disabled_recommendations=include_disabled_recommendations,
filter=filter,
api_version=api_version,
template_url=self.list_recommended_by_database.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
else:
request = HttpRequest("GET", next_link)
request = _convert_request(request)
request.url = self._client.format_url(request.url)
request.method = "GET"
return request
def extract_data(pipeline_response):
deserialized = self._deserialize("SensitivityLabelListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
list_recommended_by_database.metadata = {
"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/recommendedSensitivityLabels"
}