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

Data Masking Rules - List By Database

  • Ссылка
Служба:
SQL Database
Версия API:
2023-08-01

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

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

Параметры URI

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

string

Имя базы данных.
dataMaskingPolicyName
 path True

DataMaskingPolicyName

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

string

Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName
 path True

string

Имя сервера.
subscriptionId
 path True

string

Идентификатор подписки, идентифицирующий подписку Azure.
api-version
 query True

string

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

Ответы

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

DataMaskingRuleListResult

Успешно получен список состояний Расширенной защиты от угроз сервера.
Other Status Codes

ErrorResponse

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

Примеры

Gets a list of database data masking rules.

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

GET 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?api-version=2023-08-01

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

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/",
      "name": null,
      "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
      "location": "Central US",
      "kind": null,
      "properties": {
        "id": "dbo_Table_1_test1",
        "ruleState": "Enabled",
        "schemaName": "dbo",
        "tableName": "Table_1",
        "columnName": "test1",
        "aliasName": null,
        "maskingFunction": "Text",
        "numberFrom": null,
        "numberTo": null,
        "prefixSize": "1",
        "suffixSize": "0",
        "replacementString": "asdf"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/",
      "name": null,
      "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
      "location": "Central US",
      "kind": null,
      "properties": {
        "id": "dbo_Table_1_test1",
        "ruleState": "Enabled",
        "schemaName": "dbo",
        "tableName": "Table_1",
        "columnName": "test1",
        "aliasName": null,
        "maskingFunction": "Number",
        "numberFrom": "0",
        "numberTo": "2",
        "prefixSize": null,
        "suffixSize": null,
        "replacementString": null
      }
    }
  ]
}

Определения

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

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

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

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

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

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

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

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

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

DataMaskingFunction

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

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

Значение Описание
CCN
Default
Email
Number
SSN
Text

DataMaskingPolicyName

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

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

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

DataMaskingRule

Object

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

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

string

Идентификатор ресурса.
kind

string

Тип правила маскирования данных. Метаданные, используемые для портала Azure.
location

string

Расположение правила маскирования данных.
name

string

Имя ресурса.
properties.aliasName

string

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

string

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

string

Идентификатор правила.
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

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

string

Тип ресурса.

DataMaskingRuleListResult

Object

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

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

string

Ссылка на получение следующей страницы результатов.
value

DataMaskingRule[]

Массив результатов.

DataMaskingRuleState

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

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

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

ErrorAdditionalInfo

Object

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

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

Object

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

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

ErrorDetail

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