Set-AzureRmSqlServerAuditingPolicy

  • リファレンス
モジュール:
AzureRM.Sql

SQL Database サーバーの監査ポリシーを変更します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmSqlServerAuditingPolicy
   [-AuditType <AuditType>]
   [-AuditActionGroup <AuditActionGroups[]>]
   [-PassThru]
   [-EventType <String[]>]
   [-StorageAccountName <String>]
   [-StorageKeyType <String>]
   [-RetentionInDays <UInt32>]
   [-TableIdentifier <String>]
   -ServerName <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzureRmSqlServerAuditingPolicy コマンドレットは、Azure SQL Database サーバーの監査ポリシーを変更します。 サーバーを 識別する ResourceGroupName パラメーターと ServerName パラメーター、 監査ログのストレージ アカウントを指定する StorageAccountName パラメーター、使用するストレージ キーを 定義する StorageKeyType パラメーターを指定します。 また、RetentionInDays パラメーターと TableIdentifier パラメーターの値を設定して、監査ログ テーブル名の期間とシードを定義することで、監査ログ テーブルのリテンション期間を定義することもできます。 EventType パラメーターを指定して、監査するイベントの種類を定義します。 このコマンドレットを実行すると、このサーバーのポリシーを使用するデータベースの監査が有効になります。 コマンドレットが成功し、PassThru パラメーターを指定すると、現在の監査ポリシーとサーバー識別子を記述するオブジェクトが返されます。 サーバー識別子には、ResourceGroupName と ServerName が含まれます。

例

例 1: テーブル監査を使用する Azure SQL サーバーの監査ポリシーを設定する

PS C:\>Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -AuditType Table -StorageAccountName "Storage22"

このコマンドは、Storage22 という名前のストレージ アカウントを使用するように Server01 という名前のサーバーの監査ポリシーを設定します。

例 2: Azure SQL Server の既存の監査ポリシーのストレージ アカウント キーを設定する

PS C:\>Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -StorageAccountKey Secondary

このコマンドは、セカンダリ キーを使用するように Server01 という名前のサーバーの監査ポリシーを設定します。 このコマンドでは、ストレージ アカウント名は変更されません。

例 3: 特定のイベントの種類を使用するように Azure SQL サーバーの監査ポリシーを設定する

PS C:\>Set-AzureRmSqlServerAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventType Login_Failure

例 4: BLOB 監査を使用するようにデータベースの監査ポリシーを設定する

PS C:\>Set-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -AuditType Blob -StorageAccountName "Storage31" -AuditActionGroup "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP" -RetentionInDays 8

このコマンドは、Login_Failure イベントの種類を使用するように Server01 という名前のサーバーの監査ポリシーを設定します。 このコマンドは、他の設定を変更しません。

パラメーター

-AuditActionGroup

1 つ以上の監査アクション グループを指定します。 このパラメーターは、BLOB 監査にのみ適用されます。

型:AuditActionGroups[]
指定可能な値:BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, AUDIT_CHANGE_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-AuditType

監査の種類を指定します。 監査ログは、Table Storage または Blob Storage に書き込むことができます。 BLOB 監査により、パフォーマンスが向上し、オブジェクト レベルの監査がサポートされます。

型:AuditType
指定可能な値:NotSet, Table, Blob
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-EventType

監査するイベントの種類を指定します。 このパラメーターは、テーブル監査にのみ適用されます。 いくつかのイベントの種類を指定できます。 すべてのイベントの種類を監査する場合は [すべて] を、監査対象のイベントを指定する場合は [なし] を指定できます。 All または None を同時に指定すると、コマンドは失敗します。

型:String[]
指定可能な値:PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure, StoredProcedure_Success, StoredProcedure_Failure, Login_Success, Login_Failure, TransactionManagement_Success, TransactionManagement_Failure, All, None
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PassThru

作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ResourceGroupName

データベースを含むリソース グループの名前を指定します。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-RetentionInDays

監査ログ テーブルの保持日数を指定します。 0 の値は、テーブルが保持されていないことを意味します。 これが既定値です。 0 より大きい値を指定する場合は、TableIdentifer パラメーターの値も指定する必要があります。

型:Nullable<T>[UInt32]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ServerName

データベースを含むサーバーの名前を指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-StorageAccountName

データベースを監査するためのストレージ アカウントの名前を指定します。 ワイルドカード文字は使用できません。 このパラメーターを指定しない場合、コマンドレットは、データベースの監査ポリシーの一部として以前に定義されたストレージ アカウントを使用します。 データベース監査ポリシーが初めて定義されていて、このパラメーターを指定しない場合、コマンドは失敗します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-StorageKeyType

使用するストレージ アクセス キーを指定します。 このパラメーターの有効値は、次のとおりです。

  • プライマリ
  • Secondary 既定値は Primary です。
型:String
指定可能な値:Primary, Secondary
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-TableIdentifier

監査ログ テーブルの名前を指定します。 RetentionInDays パラメーターに 0 より大きい値を指定する場合は、 この値を 指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

AuditType

AuditActionGroups[]

String[]

String

Nullable<T>[[System.UInt32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

出力

AuditingPolicyModel