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)	ターゲットサブスクリプションの ID。値は 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
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

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

応答のサンプル

状態コード:: 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	リソースを作成した ID の種類。
DataMaskingFunction	データマスクルールに使用されるマスク関数。
DataMaskingPolicyName
DataMaskingRule	データベースデータマスキングルールです。
DataMaskingRuleListResult	DataMaskingRuleのリスト操作の応答。
DataMaskingRuleState	ルールの状態。ルールを削除するために使用されます。既存のルールを削除するには、schemaName、tableName、columnName、maskingFunction を指定し、ruleState を無効として指定します。ただし、ルールがまだ存在しない場合は、ruleState の指定された値に関係なく、ruleState を有効に設定してルールが作成されます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DataMaskingFunction

列挙

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

値	説明
Default	デフォルト
CCN	CCN
Email	Email
Number	番号
SSN	SSN
Text	テキスト

DataMaskingPolicyName

列挙

値	説明
Default	デフォルト

DataMaskingRule

Object

データベースデータマスキングルールです。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	データマスキングルールの一種です。 Azureポータルで使用されるメタデータ。
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	データマスクルールが適用されるテーブル名。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

DataMaskingRuleListResult

Object

DataMaskingRuleのリスト操作の応答。

名前	型	説明
nextLink	string (uri)	項目の次のページへのリンク
value	DataMaskingRule[]	このページのDataMaskingRule項目

DataMaskingRuleState

列挙

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

値	説明
Enabled	有効
Disabled	Disabled

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。