Data Masking Rules - List By Database

서비스:

SQL Database

API 버전:

2014-04-01

데이터베이스 데이터 마스킹 규칙 목록을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
databaseName	path	True	string	데이터베이스의 이름입니다.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	데이터 마스킹 규칙이 적용되는 데이터베이스의 이름입니다.
resourceGroupName	path	True	string	리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
serverName	path	True	string	서버의 이름입니다.
subscriptionId	path	True	string	Azure 구독을 식별하는 구독 ID입니다.
api-version	query	True	string	요청에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	DataMaskingRuleListResult	정상

예제

List data masking rules

샘플 요청

HTTP

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=2014-04-01

Java

import com.azure.core.util.Context;

/** Samples for DataMaskingRules ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
     */
    /**
     * Sample code: List data masking rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDataMaskingRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .sqlServers()
            .manager()
            .serviceClient()
            .getDataMaskingRules()
            .listByDatabase("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python data_masking_rule_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.data_masking_rules.list_by_database(
        resource_group_name="sqlcrudtest-6852",
        server_name="sqlcrudtest-2080",
        database_name="sqlcrudtest-331",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
if __name__ == "__main__":
    main()

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

Go

package armsql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sql/armsql/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a3913f4b26467aed413cdc907116e99894f08994/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
func ExampleDataMaskingRulesClient_NewListByDatabasePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDataMaskingRulesClient().NewListByDatabasePager("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DataMaskingRuleListResult = armsql.DataMaskingRuleListResult{
		// 	Value: []*armsql.DataMaskingRule{
		// 		{
		// 			Type: to.Ptr("Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
		// 			Location: to.Ptr("Central US"),
		// 			Properties: &armsql.DataMaskingRuleProperties{
		// 				ColumnName: to.Ptr("test1"),
		// 				ID: to.Ptr("dbo_Table_1_test1"),
		// 				MaskingFunction: to.Ptr(armsql.DataMaskingFunctionText),
		// 				PrefixSize: to.Ptr("1"),
		// 				ReplacementString: to.Ptr("asdf"),
		// 				RuleState: to.Ptr(armsql.DataMaskingRuleStateEnabled),
		// 				SchemaName: to.Ptr("dbo"),
		// 				SuffixSize: to.Ptr("0"),
		// 				TableName: to.Ptr("Table_1"),
		// 			},
		// 		},
		// 		{
		// 			Type: to.Ptr("Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
		// 			Location: to.Ptr("Central US"),
		// 			Properties: &armsql.DataMaskingRuleProperties{
		// 				ColumnName: to.Ptr("test1"),
		// 				ID: to.Ptr("dbo_Table_1_test1"),
		// 				MaskingFunction: to.Ptr(armsql.DataMaskingFunctionNumber),
		// 				NumberFrom: to.Ptr("0"),
		// 				NumberTo: to.Ptr("2"),
		// 				RuleState: to.Ptr(armsql.DataMaskingRuleStateEnabled),
		// 				SchemaName: to.Ptr("dbo"),
		// 				TableName: to.Ptr("Table_1"),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of database data masking rules.
 *
 * @summary Gets a list of database data masking rules.
 * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
 */
async function listDataMaskingRules() {
  const subscriptionId =
    process.env["SQL_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SQL_RESOURCE_GROUP"] || "sqlcrudtest-6852";
  const serverName = "sqlcrudtest-2080";
  const databaseName = "sqlcrudtest-331";
  const credential = new DefaultAzureCredential();
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.dataMaskingRules.listByDatabase(
    resourceGroupName,
    serverName,
    databaseName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

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/stable/2014-04-01/examples/DataMaskingRuleList.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";
ResourceIdentifier dataMaskingPolicyResourceId = DataMaskingPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
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": [
    {
      "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
      }
    }
  ]
}

정의

Name	Description
DataMaskingFunction	데이터 마스킹 규칙에 사용되는 마스킹 함수입니다.
DataMaskingPolicyName	데이터 마스킹 규칙이 적용되는 데이터베이스의 이름입니다.
DataMaskingRule	데이터베이스 데이터 마스킹 규칙을 나타냅니다.
DataMaskingRuleListResult	목록 데이터 마스킹 규칙 요청에 대한 응답입니다.
DataMaskingRuleState	규칙 상태입니다. 규칙을 삭제하는 데 사용됩니다. 기존 규칙을 삭제하려면 schemaName, tableName, columnName, maskingFunction을 지정하고 ruleState를 사용 안 함으로 지정합니다. 그러나 규칙이 아직 없는 경우 ruleState의 제공된 값에 관계없이 ruleState를 사용하도록 설정하여 규칙이 만들어집니다.

DataMaskingFunction

데이터 마스킹 규칙에 사용되는 마스킹 함수입니다.

Name	형식	Description
CCN	string
Default	string
Email	string
Number	string
SSN	string
Text	string

DataMaskingPolicyName

데이터 마스킹 규칙이 적용되는 데이터베이스의 이름입니다.

Name	형식	Description
Default	string

DataMaskingRule

데이터베이스 데이터 마스킹 규칙을 나타냅니다.

Name	형식	Description
id	string	리소스 ID입니다.
kind	string	데이터 마스킹 규칙의 종류입니다. 메타데이터- Azure Portal 사용됩니다.
location	string	데이터 마스킹 규칙의 위치입니다.
name	string	리소스 이름입니다.
properties.aliasName	string	별칭 이름입니다. 레거시 매개 변수이며 더 이상 사용되지 않습니다.
properties.columnName	string	데이터 마스킹 규칙이 적용되는 열 이름입니다.
properties.id	string	규칙 ID입니다.
properties.maskingFunction	DataMaskingFunction	데이터 마스킹 규칙에 사용되는 마스킹 함수입니다.
properties.numberFrom	string	마스킹 규칙의 numberFrom 속성입니다. maskingFunction이 Number로 설정된 경우 필수이고, 그렇지 않으면 이 매개 변수가 무시됩니다.
properties.numberTo	string	데이터 마스킹 규칙의 numberTo 속성입니다. maskingFunction이 Number로 설정된 경우 필수이고, 그렇지 않으면 이 매개 변수가 무시됩니다.
properties.prefixSize	string	maskingFunction이 Text로 설정된 경우 문자열의 시작 부분에 마스크되지 않은 상태로 표시할 문자 수입니다. 그렇지 않으면 이 매개 변수는 무시됩니다.
properties.replacementString	string	maskingFunction이 Text로 설정된 경우 문자열의 노출되지 않은 부분을 마스킹하는 데 사용할 문자입니다. 그렇지 않으면 이 매개 변수는 무시됩니다.
properties.ruleState	DataMaskingRuleState	규칙 상태입니다. 규칙을 삭제하는 데 사용됩니다. 기존 규칙을 삭제하려면 schemaName, tableName, columnName, maskingFunction을 지정하고 ruleState를 사용 안 함으로 지정합니다. 그러나 규칙이 아직 없는 경우 ruleState의 제공된 값에 관계없이 ruleState를 사용하도록 설정하여 규칙이 만들어집니다.
properties.schemaName	string	데이터 마스킹 규칙이 적용되는 스키마 이름입니다.
properties.suffixSize	string	maskingFunction이 Text로 설정된 경우 문자열 끝에 마스크가 없는 상태로 표시할 문자 수입니다. 그렇지 않으면 이 매개 변수는 무시됩니다.
properties.tableName	string	데이터 마스킹 규칙이 적용되는 테이블 이름입니다.
type	string	리소스 종류.

DataMaskingRuleListResult

목록 데이터 마스킹 규칙 요청에 대한 응답입니다.

Name	형식	Description
value	DataMaskingRule[]	데이터베이스 데이터 마스킹 규칙 목록입니다.

DataMaskingRuleState

규칙 상태입니다. 규칙을 삭제하는 데 사용됩니다. 기존 규칙을 삭제하려면 schemaName, tableName, columnName, maskingFunction을 지정하고 ruleState를 사용 안 함으로 지정합니다. 그러나 규칙이 아직 없는 경우 ruleState의 제공된 값에 관계없이 ruleState를 사용하도록 설정하여 규칙이 만들어집니다.

Name	형식	Description
Disabled	string
Enabled	string