Sensitivity Labels - Create Or Update

Ссылка

Служба:: SQL Database

Версия API:: 2023-08-01

Создает или обновляет метку конфиденциальности заданного столбца.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/current?api-version=2023-08-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
columnName	path	True	string	Имя столбца.
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
schemaName	path	True	string	Имя схемы.
sensitivityLabelSource	path	True	CurrentSensitivityLabelSource	Источник метки конфиденциальности.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
tableName	path	True	string	Имя таблицы.
api-version	query	True	string	Версия API, используемая для запроса.

Текст запроса

Имя	Тип	Описание
properties.clientClassificationSource	ClientClassificationSource
properties.informationType	string	Тип информации.
properties.informationTypeId	string	Идентификатор типа информации.
properties.labelId	string	Идентификатор метки.
properties.labelName	string	Имя метки.
properties.rank	SensitivityLabelRank

Ответы

Имя	Тип	Описание
200 OK	SensitivityLabel	Успешно обновлена метка конфиденциальности.
201 Created	SensitivityLabel	Успешно создана метка конфиденциальности.
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 DatawarehouseDatabaseIsDeactivated — не удалось выполнить операцию классификации данных, так как база данных приостановлена. Возобновите его. 400 SensitivityLabelSourceNameNotSupported — указанный источник метки конфиденциальности недопустим. 400 InvalidSensitivityLabelResource — указанный ресурс метки конфиденциальности недопустим 400 SensitivityLabelLabelNameAndInfoTypeNotProvided — необходимо указать по крайней мере один из меток и InformationType 400 LabelNameTooLong — имя метки не может превышать {0} символов 400 InformationTypeTooLong — тип сведений не может превышать {0} символов 400 LabelIdMustBeGuid — указан недопустимый идентификатор labelId. Значение должно быть GUID 400 InformationTypeIdMustBeGuid — указан недопустимый параметр InformationTypeId. Значение должно быть GUID 400 LabelMissing — требуется метка. Необходимо указать по крайней мере одну из метокName или labelId. 400 InformationTypeMissing — требуется тип сведений. Необходимо указать по крайней мере один из informationType или InformationTypeId. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 SensitivityLabelsSchemaNotFound — не удалось найти схему {0} 404 SensitivityLabelsTableNotFound — таблица {0} не найдена в {1} схемы 404 SensitivityLabelsColumnNotFound — столбец {0} не удалось найти в таблице {2}.{1} 404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует на этом экземпляре сервера. 404 SensitivityLabelsLabelNotFound — не удалось найти указанную метку конфиденциальности. 501 SensitivityLabelRecommendedSourceNameNotSupported — источник метки конфиденциальности "Рекомендуется" еще не поддерживается 501 SensitivityLabelRecommendedSourceNameNotSupported — источник метки конфиденциальности "Рекомендуется" еще не поддерживается

Имя

Тип

Описание

200 OK

SensitivityLabel

Успешно обновлена метка конфиденциальности.

201 Created

SensitivityLabel

Успешно создана метка конфиденциальности.

Other Status Codes

ErrorResponse

Ответы на ошибки: ***

400 DatawarehouseDatabaseIsDeactivated — не удалось выполнить операцию классификации данных, так как база данных приостановлена. Возобновите его.
400 SensitivityLabelSourceNameNotSupported — указанный источник метки конфиденциальности недопустим.
400 InvalidSensitivityLabelResource — указанный ресурс метки конфиденциальности недопустим
400 SensitivityLabelLabelNameAndInfoTypeNotProvided — необходимо указать по крайней мере один из меток и InformationType
400 LabelNameTooLong — имя метки не может превышать {0} символов
400 InformationTypeTooLong — тип сведений не может превышать {0} символов
400 LabelIdMustBeGuid — указан недопустимый идентификатор labelId. Значение должно быть GUID
400 InformationTypeIdMustBeGuid — указан недопустимый параметр InformationTypeId. Значение должно быть GUID
400 LabelMissing — требуется метка. Необходимо указать по крайней мере одну из метокName или labelId.
400 InformationTypeMissing — требуется тип сведений. Необходимо указать по крайней мере один из informationType или InformationTypeId.
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 SensitivityLabelsSchemaNotFound — не удалось найти схему {0}
404 SensitivityLabelsTableNotFound — таблица {0} не найдена в {1} схемы
404 SensitivityLabelsColumnNotFound — столбец {0} не удалось найти в таблице {2}.{1}
404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует на этом экземпляре сервера.
404 SensitivityLabelsLabelNotFound — не удалось найти указанную метку конфиденциальности.
501 SensitivityLabelRecommendedSourceNameNotSupported — источник метки конфиденциальности "Рекомендуется" еще не поддерживается
501 SensitivityLabelRecommendedSourceNameNotSupported — источник метки конфиденциальности "Рекомендуется" еще не поддерживается

Примеры

Updates the sensitivity label of a given column with all parameters

Образец запроса

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current?api-version=2023-08-01

{
  "properties": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "Low",
    "clientClassificationSource": "Native"
  }
}

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
  "properties": {
    "schemaName": "dbo",
    "tableName": "myTable",
    "columnName": "myColumn",
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "Medium"
  }
}

Код состояния:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
  "properties": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "High"
  }
}

Определения

Имя	Описание
ClientClassificationSource
CurrentSensitivityLabelSource	Источник метки конфиденциальности.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
SensitivityLabel	Метка конфиденциальности.
SensitivityLabelRank

ClientClassificationSource

Перечисление

Значение	Описание
MIP
Native
None
Recommended

CurrentSensitivityLabelSource

Перечисление

Источник метки конфиденциальности.

Значение	Описание
current

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

SensitivityLabel

Object

Метка конфиденциальности.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
managedBy	string	Ресурс, который управляет меткой конфиденциальности.
name	string	Имя ресурса.
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	Имя столбца.
properties.informationType	string	Тип информации.
properties.informationTypeId	string	Идентификатор типа информации.
properties.isDisabled	boolean	Отключена рекомендация конфиденциальности. Применимо только для рекомендуемой метки конфиденциальности. Указывает, отключена ли рекомендация конфиденциальности для этого столбца (отклонена) или нет.
properties.labelId	string	Идентификатор метки.
properties.labelName	string	Имя метки.
properties.rank	SensitivityLabelRank
properties.schemaName	string	Имя схемы.
properties.tableName	string	Имя таблицы.
type	string	Тип ресурса.

SensitivityLabelRank

Перечисление

Значение	Описание
Critical
High
Low
Medium
None

Поделиться через

Sensitivity Labels - Create Or Update

Параметры URI

Текст запроса

Ответы

Примеры

Updates the sensitivity label of a given column with all parameters

Образец запроса

Пример ответа

Определения

ClientClassificationSource

CurrentSensitivityLabelSource

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SensitivityLabel

SensitivityLabelRank

Дополнительные ресурсы