Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azurerm_mssql_server_extended_auditing_policy - support for audit_actions_and_groups and predicate_expression #25425

Merged
merged 2 commits into from
Apr 3, 2024
Merged

azurerm_mssql_server_extended_auditing_policy - support for audit_actions_and_groups and predicate_expression #25425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33a4842
add support for audit_actions_and_groups and predicate_expression
mbfrahry Mar 26, 2024
809c846
goimports
mbfrahry Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions internal/services/mssql/mssql_server_extended_auditing_policy_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (

"github.com/Azure/azure-sdk-for-go/services/preview/sql/mgmt/v5.0/sql" // nolint: staticcheck
"github.com/gofrs/uuid"
"github.com/hashicorp/go-azure-helpers/lang/pointer"
"github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
"github.com/hashicorp/terraform-provider-azurerm/helpers/tf"
"github.com/hashicorp/terraform-provider-azurerm/internal/clients"
Expand Down Expand Up @@ -93,6 +94,23 @@ func resourceMsSqlServerExtendedAuditingPolicy() *pluginsdk.Resource {
Sensitive: true,
ValidateFunc: validation.IsUUID,
},

"predicate_expression": {
Type: pluginsdk.TypeString,
Optional: true,
ValidateFunc: validation.StringIsNotEmpty,
},

"audit_actions_and_groups": {
Type: pluginsdk.TypeList,
Optional: true,
// audit_actions_and_groups seems to be pre-populated with values ["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP"],
Computed: true,
Elem: &pluginsdk.Schema{
Type: pluginsdk.TypeString,
ValidateFunc: validation.StringIsNotEmpty,
},
},
},
}
}
Expand Down Expand Up @@ -151,6 +169,14 @@ func resourceMsSqlServerExtendedAuditingPolicyCreateUpdate(d *pluginsdk.Resource
params.ExtendedServerBlobAuditingPolicyProperties.StorageAccountAccessKey = utils.String(v.(string))
}

if v, ok := d.GetOk("predicate_expression"); ok {
params.ExtendedServerBlobAuditingPolicyProperties.PredicateExpression = pointer.To(v.(string))
}

if v, ok := d.GetOk("audit_actions_and_groups"); ok && len(v.([]interface{})) > 0 {
params.ExtendedServerBlobAuditingPolicyProperties.AuditActionsAndGroups = utils.ExpandStringSlice(v.([]interface{}))
}

future, err := client.CreateOrUpdate(ctx, serverId.ResourceGroupName, serverId.ServerName, params)
if err != nil {
return fmt.Errorf("creating MsSql Server Extended Auditing Policy %s: %+v", serverId, err)
Expand Down Expand Up @@ -195,6 +221,8 @@ func resourceMsSqlServerExtendedAuditingPolicyRead(d *pluginsdk.ResourceData, me
d.Set("retention_in_days", props.RetentionDays)
d.Set("log_monitoring_enabled", props.IsAzureMonitorTargetEnabled)
d.Set("enabled", props.State == sql.BlobAuditingPolicyStateEnabled)
d.Set("predicate_expression", props.PredicateExpression)
d.Set("audit_actions_and_groups", utils.FlattenStringSlice(props.AuditActionsAndGroups))

if props.StorageAccountSubscriptionID.String() != "00000000-0000-0000-0000-000000000000" {
d.Set("storage_account_subscription_id", props.StorageAccountSubscriptionID.String())
Expand Down
86 changes: 86 additions & 0 deletions internal/services/mssql/mssql_server_extended_auditing_policy_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,64 @@ func TestAccMsSqlServerExtendedAuditingPolicy_storageAccBehindFireWall(t *testin
})
}

func TestAccMsSqlServerExtendedAuditingPolicy_predicateExpression(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_mssql_server_extended_auditing_policy", "test")
r := MsSqlServerExtendedAuditingPolicyResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.basic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("storage_account_access_key"),
{
Config: r.predicateExpression(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("storage_account_access_key"),
{
Config: r.basic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("storage_account_access_key"),
})
}

func TestAccMsSqlServerExtendedAuditingPolicy_auditActionsAndGroups(t *testing.T) {
data := acceptance.BuildTestData(t, "azurerm_mssql_server_extended_auditing_policy", "test")
r := MsSqlServerExtendedAuditingPolicyResource{}

data.ResourceTest(t, r, []acceptance.TestStep{
{
Config: r.basic(data),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("storage_account_access_key"),
{
Config: r.auditActionsAndGroups(data, "[\"BATCH_COMPLETED_GROUP\"]"),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("storage_account_access_key"),
{
Config: r.auditActionsAndGroups(data, "[\"BATCH_COMPLETED_GROUP\", \"SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\"]"),
Check: acceptance.ComposeTestCheckFunc(
check.That(data.ResourceName).ExistsInAzure(r),
),
},
data.ImportStep("storage_account_access_key"),
})
}

func (MsSqlServerExtendedAuditingPolicyResource) Exists(ctx context.Context, client *clients.Client, state *pluginsdk.InstanceState) (*bool, error) {
id, err := parse.ServerExtendedAuditingPolicyID(state.ID)
if err != nil {
Expand Down Expand Up @@ -321,3 +379,31 @@ resource "azurerm_mssql_server_extended_auditing_policy" "test" {
}
`, data.RandomInteger, data.Locations.Primary, data.RandomString)
}

func (r MsSqlServerExtendedAuditingPolicyResource) predicateExpression(data acceptance.TestData) string {
return fmt.Sprintf(`
%[1]s

resource "azurerm_mssql_server_extended_auditing_policy" "test" {
server_id = azurerm_mssql_server.test.id
storage_endpoint = azurerm_storage_account.test.primary_blob_endpoint
storage_account_access_key = azurerm_storage_account.test.primary_access_key

predicate_expression = "action_id != 17234"
}
`, r.template(data))
}

func (r MsSqlServerExtendedAuditingPolicyResource) auditActionsAndGroups(data acceptance.TestData, input string) string {
return fmt.Sprintf(`
%[1]s

resource "azurerm_mssql_server_extended_auditing_policy" "test" {
server_id = azurerm_mssql_server.test.id
storage_endpoint = azurerm_storage_account.test.primary_blob_endpoint
storage_account_access_key = azurerm_storage_account.test.primary_access_key

audit_actions_and_groups = %s
}
`, r.template(data), input)
}
4 changes: 4 additions & 0 deletions website/docs/r/mssql_server_extended_auditing_policy.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,10 @@ The following arguments are supported:

* `storage_account_subscription_id` - (Optional) The ID of the Subscription containing the Storage Account.

* `predicate_expression` - (Optional) Specifies condition of where clause when creating an audit.

* `audit_actions_and_groups` - (Optional) A list of Actions-Groups and Actions to audit.

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:
Expand Down
Loading