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	リソースを含むリソースグループの名前。この値は、Azure Resource Manager 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	ErrorResponse	エラー応答: ***

例

Gets a list of database 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=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	リソース 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

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	エラーオブジェクト。

次の方法で共有

Data Masking Rules - List By Database

URI パラメーター

応答

例

Gets a list of database data masking rules.

要求のサンプル

応答のサンプル

定義

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleListResult

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

その他のリソース