Class ExtendedServerBlobAuditingPolicy

An extended server blob auditing policy.

Inheritance
Object
Resource
ProxyResource
ExtendedServerBlobAuditingPolicy
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Microsoft.Azure.Management.Sql.dll
Syntax
[Microsoft.Rest.Serialization.JsonTransformation]
public class ExtendedServerBlobAuditingPolicy : Microsoft.Azure.Management.Sql.Models.ProxyResource

Constructors

ExtendedServerBlobAuditingPolicy()

Initializes a new instance of the ExtendedServerBlobAuditingPolicy class.

Declaration
public ExtendedServerBlobAuditingPolicy ();

ExtendedServerBlobAuditingPolicy(BlobAuditingPolicyState, String, String, String, String, String, String, Nullable<Int32>, IList<String>, Nullable<Guid>, Nullable<Boolean>, Nullable<Boolean>)

Initializes a new instance of the ExtendedServerBlobAuditingPolicy class.

Declaration
public ExtendedServerBlobAuditingPolicy (Microsoft.Azure.Management.Sql.Models.BlobAuditingPolicyState state, string id = null, string name = null, string type = null, string predicateExpression = null, string storageEndpoint = null, string storageAccountAccessKey = null, Nullable<int> retentionDays = null, System.Collections.Generic.IList<string> auditActionsAndGroups = null, Nullable<Guid> storageAccountSubscriptionId = null, Nullable<bool> isStorageSecondaryKeyInUse = null, Nullable<bool> isAzureMonitorTargetEnabled = null);
Parameters
BlobAuditingPolicyState state

Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'
String id

Resource ID.
String name

Resource name.
String type

Resource type.
String predicateExpression

Specifies condition of where clause when creating an audit.
String storageEndpoint

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.
String storageAccountAccessKey

Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.
Nullable<Int32> retentionDays

Specifies the number of days to keep in the audit logs in the storage account.
IList<String> auditActionsAndGroups

Specifies the Actions-Groups and Actions to audit.

         The recommended set of action groups to use is the following
         combination - this will audit all the queries and stored procedures
         executed against the database, as well as successful and failed
         logins:
        
         BATCH_COMPLETED_GROUP,
         SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
         FAILED_DATABASE_AUTHENTICATION_GROUP.
        
         This above combination is also the set that is configured by
         default when enabling auditing from the Azure portal.
        
         The supported action groups to audit are (note: choose only
         specific groups that cover your auditing needs. Using unnecessary
         groups could lead to very large quantities of audit records):
        
         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
         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
         BATCH_STARTED_GROUP
         BATCH_COMPLETED_GROUP
        
         These are groups that cover all sql statements and stored
         procedures executed against the database, and should not be used in
         combination with other groups as this will result in duplicate
         audit logs.
        
         For more information, see [Database-Level Audit Action
         Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).
        
         For Database auditing policy, specific Actions can also be
         specified (note that Actions cannot be specified for Server
         auditing policy). The supported actions to audit are:
         SELECT
         UPDATE
         INSERT
         DELETE
         EXECUTE
         RECEIVE
         REFERENCES
        
         The general form for defining an action to be audited is:
         {action} ON {object} BY {principal}
        
         Note that &lt;object&gt; in the above format can refer to an object
         like a table, view, or stored procedure, or an entire database or
         schema. For the latter cases, the forms DATABASE::{db_name} and
         SCHEMA::{schema_name} are used, respectively.
        
         For example:
         SELECT on dbo.myTable by public
         SELECT on DATABASE::myDatabase by public
         SELECT on SCHEMA::mySchema by public
        
         For more information, see [Database-Level Audit
         Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)

Nullable<Guid> storageAccountSubscriptionId

Specifies the blob storage subscription Id.
Nullable<Boolean> isStorageSecondaryKeyInUse

Specifies whether storageAccountAccessKey value is the storage's secondary key.
Nullable<Boolean> isAzureMonitorTargetEnabled

Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.

         When using REST API to configure auditing, Diagnostic Settings with
         'SQLSecurityAuditEvents' diagnostic logs category on the database
         should be also created.
         Note that for server level audit you should use the 'master'
         database as {databaseName}.
        
         Diagnostic Settings URI format:
         PUT
         https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
        
         For more information, see [Diagnostic Settings REST
         API](https://go.microsoft.com/fwlink/?linkid=2033207)
         or [Diagnostic Settings
         PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)

Properties

AuditActionsAndGroups

Gets or sets specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

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 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 BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that &lt;object&gt; in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.auditActionsAndGroups")]
public System.Collections.Generic.IList<string> AuditActionsAndGroups { get; set; }
Property Value
IList<String>

IsAzureMonitorTargetEnabled

Gets or sets specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.

When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.isAzureMonitorTargetEnabled")]
public Nullable<bool> IsAzureMonitorTargetEnabled { get; set; }
Property Value
Nullable<Boolean>

IsStorageSecondaryKeyInUse

Gets or sets specifies whether storageAccountAccessKey value is the storage's secondary key.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.isStorageSecondaryKeyInUse")]
public Nullable<bool> IsStorageSecondaryKeyInUse { get; set; }
Property Value
Nullable<Boolean>

PredicateExpression

Gets or sets specifies condition of where clause when creating an audit.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.predicateExpression")]
public string PredicateExpression { get; set; }
Property Value
String

RetentionDays

Gets or sets specifies the number of days to keep in the audit logs in the storage account.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.retentionDays")]
public Nullable<int> RetentionDays { get; set; }
Property Value
Nullable<Int32>

State

Gets or sets specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.state")]
public Microsoft.Azure.Management.Sql.Models.BlobAuditingPolicyState State { get; set; }
Property Value
BlobAuditingPolicyState

StorageAccountAccessKey

Gets or sets specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.storageAccountAccessKey")]
public string StorageAccountAccessKey { get; set; }
Property Value
String

StorageAccountSubscriptionId

Gets or sets specifies the blob storage subscription Id.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.storageAccountSubscriptionId")]
public Nullable<Guid> StorageAccountSubscriptionId { get; set; }
Property Value
Nullable<Guid>

StorageEndpoint

Gets or sets specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.

Declaration
[Newtonsoft.Json.JsonProperty(PropertyName="properties.storageEndpoint")]
public string StorageEndpoint { get; set; }
Property Value
String

Methods

Validate()

Validate the object.

Declaration
public virtual void Validate ();
Exceptions
ValidationException

Thrown if validation fails