New-AzSqlDatabaseDataMaskingRule
データベースのデータ マスク ルールを作成します。
構文
Default (既定)
New-AzSqlDatabaseDataMaskingRule
-MaskingFunction <String>
[-PrefixSize <UInt32>]
[-ReplacementString <String>]
[-SuffixSize <UInt32>]
[-NumberFrom <Double>]
[-NumberTo <Double>]
[-PassThru]
-SchemaName <String>
-TableName <String>
-ColumnName <String>
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
New-AzSqlDatabaseDataMaskingRule コマンドレットは、Azure SQL データベースのデータ マスク 規則を作成します。
コマンドレットを使用するには、 ResourceGroupName、 ServerName、および DatabaseName パラメーターを使用してルールを識別します。
TableName および ColumnName を指定して、ルールのターゲットを指定し、MaskingFunction パラメーターを指定して、データのマスク方法を定義します。
MaskingFunction に数値またはテキストの値がある場合は、数値マスクの場合は NumberFrom パラメーターと NumberTo パラメーター、テキスト マスクの場合は PrefixSize、ReplacementString、SuffixSize を指定できます。
コマンドが成功し、 PassThru パラメーターが使用されている場合、コマンドレットは、ルール識別子に加えて、データ マスク ルールのプロパティを記述するオブジェクトを返します。
ルール識別子には、 ResourceGroupName、 ServerName、 DatabaseName、および RuleID が含まれますが、これらに限定されません。
このコマンドレットは、Azure 上の SQL Server Stretch Database サービスでもサポートされています。
例
例 1: データベース内の数値列のデータ マスク ルールを作成する
New-AzSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName "Schema01" -TableName "Table01" -ColumnName "Column01" -MaskingFunction "Number" -NumberFrom 5 -NumberTo 14
このコマンドは、Schema01 という名前のスキーマの Table01 という名前のテーブルに Column01 という名前の列のデータ マスク 規則を作成します。
Database01 という名前のデータベースには、これらすべての項目が含まれています。
ルールは、マスク値として 5 ~ 14 の乱数を使用する数値マスク ルールです。
パラメーター
-ColumnName
マスク 規則の対象となる列の名前を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-DatabaseName
データベースの名前を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | 2 |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
型: | IAzureContextContainer
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-MaskingFunction
ルールが使用するマスク関数を指定します。
このパラメーターに使用できる値は次のとおりです。
- 既定値
- マスキングなし
- テキスト
- 番号
- ソーシャルセキュリティ番号
- クレジットカード番号
- 電子メール 既定値は既定値です。
パラメーターのプロパティ
型: | String
|
規定値: | None |
指定可能な値: | NoMasking, Default, Text, Number, SocialSecurityNumber, CreditCardNumber, Email |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-NumberFrom
ランダムな値を選択する間隔の下限番号を指定します。
このパラメーターは、 MaskingFunction パラメーターに Number の値を指定した場合にのみ指定します。
既定値は 0 です。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-NumberTo
ランダムな値が選択される間隔の上限番号を指定します。
このパラメーターは、 MaskingFunction パラメーターに Number の値を指定した場合にのみ指定します。
既定値は 0 です。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-PassThru
作業中のアイテムを表すオブジェクトを返します。
既定では、このコマンドレットは出力を生成しません。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-PrefixSize
マスクされないテキストの先頭の文字数を指定します。
このパラメーターは、 MaskingFunction パラメーターに Text の値を指定する場合にのみ指定します。
既定値は 0 です。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ReplacementString
マスクされないテキストの末尾の文字数を指定します。
このパラメーターは、 MaskingFunction パラメーターに Text の値を指定する場合にのみ指定します。
既定値は空の文字列です。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ResourceGroupName
データベースが割り当てられるリソース グループの名前を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | 0 |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-SchemaName
スキーマの名前を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ServerName
データベースをホストするサーバーの名前を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | 1 |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-SuffixSize
マスクされないテキストの末尾の文字数を指定します。
このパラメーターは、 MaskingFunction パラメーターに Text の値を指定する場合にのみ指定します。
既定値は 0 です。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-TableName
マスクされた列を含むデータベース テーブルの名前を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
型: | SwitchParameter
|
規定値: | False |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | ウィスコンシン |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力