Data Masking Rules - List By Database

リファレンス

Service:: SQL Database

API Version:: 2021-11-01

データベースデータマスクルールの一覧を取得します。

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

URI パラメーター

名前	/	必須	型	説明
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 のバージョン。

応答

名前	型	説明
200 OK	DataMaskingRuleListResult	サーバーの Advanced Threat Protection 状態の一覧が正常に取得されました。
Other Status Codes		エラー応答: ***

例

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=2021-11-01


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/** Samples for DataMaskingRules ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DataMaskingRuleListByDatabase.json
     */
    /**
     * Sample code: Gets a list of database data masking rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabaseDataMaskingRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDataMaskingRules().listByDatabase("sqlcrudtest-6852",
            "sqlcrudtest-2080", "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, 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

Sample Response

Status code:: 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 が有効に設定されたルールが作成されます。

DataMaskingFunction

データマスクルールに使用されるマスク関数。

名前	型	説明
CCN	string
Default	string
Email	string
Number	string
SSN	string
Text	string

DataMaskingPolicyName

データマスクルールが適用されるデータベースの名前。

名前	型	説明
Default	string

DataMaskingRule

データベースデータマスクルール。

名前	型	説明
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

データベースデータマスクルールの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	DataMaskingRule[]	結果の配列。

DataMaskingRuleState

ルールの状態。ルールを削除するために使用されます。既存のルールを削除するには、schemaName、tableName、columnName、maskingFunction を指定し、ruleState を無効として指定します。ただし、ルールがまだ存在しない場合は、ruleState の指定された値に関係なく、ruleState が有効に設定されたルールが作成されます。

名前	型	説明
Disabled	string
Enabled	string