Data Masking Rules - Create Or Update

Создаёт или обновляет правило маскировки данных базы данных.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules/{dataMaskingRuleName}?api-version=2025-01-01

Параметры URI

Имя В Обязательно Тип Описание
databaseName
path True

string

Имя базы данных.

dataMaskingPolicyName
path True

DataMaskingPolicyName

Название базы данных, к которой применяется политика маскировки данных.

dataMaskingRuleName
path True

string

Название правила маскировки данных.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя регистронезависимо.

serverName
path True

string

Имени сервера.

subscriptionId
path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

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

Имя Обязательно Тип Описание
properties.columnName True

string

Имя столбца, к которому применяется правило маскирования данных.

properties.maskingFunction True

DataMaskingFunction

Функция маскирования, используемая для правила маскирования данных.

properties.schemaName True

string

Имя схемы, к которому применяется правило маскирования данных.

properties.tableName True

string

Имя таблицы, в которой применяется правило маскирования данных.

properties.aliasName

string

Имя псевдонима. Это устаревший параметр и больше не используется.

properties.numberFrom

string

Свойство numberFrom правила маскирования. Требуется, если для маскированияFunction задано значение Number, в противном случае этот параметр будет игнорироваться.

properties.numberTo

string

Свойство numberTo правила маскирования данных. Требуется, если для маскированияFunction задано значение Number, в противном случае этот параметр будет игнорироваться.

properties.prefixSize

string

Если для маскированияFunction задано значение Text, число символов, отображаемое в начале строки. В противном случае этот параметр будет игнорироваться.

properties.replacementString

string

Если для маскировкиFunction задано значение Text, символ, используемый для маскирования неподдержаемой части строки. В противном случае этот параметр будет игнорироваться.

properties.ruleState

DataMaskingRuleState

Состояние правила. Используется для удаления правила. Чтобы удалить существующее правило, укажите schemaName, tableName, columnName, maskingFunction и укажите значение ruleState как отключенное. Однако если правило еще не существует, правило будет создано с включенным параметром ruleState, независимо от предоставленного значения ruleState.

properties.suffixSize

string

Если для маскированияFunction задано значение Text, число символов, отображаемых в конце строки. В противном случае этот параметр будет игнорироваться.

Ответы

Имя Тип Описание
200 OK

DataMaskingRule

Операция Azure успешно завершена.

201 Created

DataMaskingRule

Операция создания ресурса 'DataMaskingRule' успешно выполнена

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Create/Update data masking rule for default max.
Create/Update data masking rule for default min.
Create/Update data masking rule for numbers.
Create/Update data masking rule for text.

Create/Update data masking rule for default max.

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

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "maskingFunction": "Default",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

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

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for default min.

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

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Default",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

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

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for numbers.

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

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

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

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for text.

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

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Text",
    "prefixSize": "1",
    "replacementString": "asdf",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

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

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}
{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

Определения

Имя Описание
createdByType

Тип удостоверения, создавшего ресурс.

DataMaskingFunction

Функция маскирования, используемая для правила маскирования данных.

DataMaskingPolicyName
DataMaskingRule

Правило маскировки данных базы данных.

DataMaskingRuleState

Состояние правила. Используется для удаления правила. Чтобы удалить существующее правило, укажите schemaName, tableName, columnName, maskingFunction и укажите значение ruleState как отключенное. Однако если правило еще не существует, правило будет создано с включенным параметром ruleState, независимо от предоставленного значения ruleState.

ErrorAdditionalInfo

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

ErrorDetail

Детали ошибки.

ErrorResponse

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

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

DataMaskingFunction

Функция маскирования, используемая для правила маскирования данных.

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

По умолчанию

CCN

CCN

Email

Эл. почта

Number

Number

SSN

Номер социального страхования

Text

Текст

DataMaskingPolicyName

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

По умолчанию

DataMaskingRule

Правило маскировки данных базы данных.

Имя Тип Описание
id

string (arm-id)

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind

string

Правило маскировки данных. Metadata, используемые для Azure portal.

location

string

Местоположение правила маскировки данных.

name

string

Имя ресурса

properties.aliasName

string

Имя псевдонима. Это устаревший параметр и больше не используется.

properties.columnName

string

Имя столбца, к которому применяется правило маскирования данных.

properties.id

string

Правило Id.

properties.maskingFunction

DataMaskingFunction

Функция маскирования, используемая для правила маскирования данных.

properties.numberFrom

string

Свойство numberFrom правила маскирования. Требуется, если для маскированияFunction задано значение Number, в противном случае этот параметр будет игнорироваться.

properties.numberTo

string

Свойство numberTo правила маскирования данных. Требуется, если для маскированияFunction задано значение Number, в противном случае этот параметр будет игнорироваться.

properties.prefixSize

string

Если для маскированияFunction задано значение Text, число символов, отображаемое в начале строки. В противном случае этот параметр будет игнорироваться.

properties.replacementString

string

Если для маскировкиFunction задано значение Text, символ, используемый для маскирования неподдержаемой части строки. В противном случае этот параметр будет игнорироваться.

properties.ruleState

DataMaskingRuleState

Состояние правила. Используется для удаления правила. Чтобы удалить существующее правило, укажите schemaName, tableName, columnName, maskingFunction и укажите значение ruleState как отключенное. Однако если правило еще не существует, правило будет создано с включенным параметром ruleState, независимо от предоставленного значения ruleState.

properties.schemaName

string

Имя схемы, к которому применяется правило маскирования данных.

properties.suffixSize

string

Если для маскированияFunction задано значение Text, число символов, отображаемых в конце строки. В противном случае этот параметр будет игнорироваться.

properties.tableName

string

Имя таблицы, в которой применяется правило маскирования данных.

systemData

systemData

Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.

type

string

Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

DataMaskingRuleState

Состояние правила. Используется для удаления правила. Чтобы удалить существующее правило, укажите schemaName, tableName, columnName, maskingFunction и укажите значение ruleState как отключенное. Однако если правило еще не существует, правило будет создано с включенным параметром ruleState, независимо от предоставленного значения ruleState.

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

Enabled

Disabled

Disabled

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

Дополнительная информация.

type

string

Тип дополнительной информации.

ErrorDetail

Детали ошибки.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Ошибка дополнительная информация.

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

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

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string (date-time)

Временная метка последнего изменения ресурса (UTC)

lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.

lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.