Data Masking Rules - List By Database

Служба:: SQL Database

Версия API:: 2025-01-01

Получает список правил маскировки данных базы данных.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Название базы данных, к которой применяется политика маскировки данных.
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, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	DataMaskingRuleListResult	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

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=2025-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/DataMaskingRuleListByDatabase.json
// this example is just showing the usage of "DataMaskingRules_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataMaskingPolicyResource created on azure
// for more information of creating DataMaskingPolicyResource, please refer to the document of DataMaskingPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-6852";
string serverName = "sqlcrudtest-2080";
string databaseName = "sqlcrudtest-331";
DataMaskingPolicyName dataMaskingPolicyName = DataMaskingPolicyName.Default;
ResourceIdentifier dataMaskingPolicyResourceId = DataMaskingPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, dataMaskingPolicyName);
DataMaskingPolicyResource dataMaskingPolicy = client.GetDataMaskingPolicyResource(dataMaskingPolicyResourceId);

// invoke the operation and iterate over the result
await foreach (DataMaskingRule item in dataMaskingPolicy.GetDataMaskingRulesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

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

{
  "value": [
    {
      "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": "Number",
        "numberFrom": "0",
        "numberTo": "2",
        "prefixSize": null,
        "replacementString": null,
        "ruleState": "Enabled",
        "schemaName": "dbo",
        "suffixSize": null,
        "tableName": "Table_1"
      }
    }
  ]
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
DataMaskingFunction	Функция маскирования, используемая для правила маскирования данных.
DataMaskingPolicyName
DataMaskingRule	Правило маскировки данных базы данных.
DataMaskingRuleListResult	Ответ операции списка 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» или «Майкрософт. Аккаунты хранения/хранения»

DataMaskingRuleListResult

Объект

Ответ операции списка DataMaskingRule.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	DataMaskingRule[]	Элементы DataMaskingRule на этой странице

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	Тип удостоверения, который последний раз изменил ресурс.