dependencies: `azurerm_mssql_server_security_alert_policy` - update to API version `2023-08-01-preview/serversecurityalertpolicies` by WodansSon · Pull Request #29363 · hashicorp/terraform-provider-azurerm

WodansSon · 2025-04-17T06:30:43Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Update the azurerm_mssql_server_security_alert_policy resource to use the 2023-08-01-preview/serversecurityalertpolicies API due to deprecation of the 2014-04-01 APIs on 31 October 2025.

BREAKING CHANGE:

The state field no longer supports the New value in the 2023-08-01-preview/serversecurityalertpolicies API.

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevant documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

NOTE: This release contains a breaking change to the mssql_server_security_alert_policy resource. The state field no longer supports the New value in the 2023-08-01-preview/serversecurityalertpolicies API.

BREAKING CHANGE:

azurerm_mssql_server_security_alert_policy - The state field no longer supports the New value in the 2023-08-01-preview/serversecurityalertpolicies API. [GH-00000]

ENHANCEMENTS:

dependencies - serversecurityalertpolicies API updated to version 2023-08-01-preview/serversecurityalertpolicies [GH-00000]

This is a (please select all that apply):

Related Issue(s)

Fixes #0000

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

katbyte · 2025-04-21T17:31:34Z

+				// NOTE: 'SecurityAlertsPolicyStateNew' no longer exists in the new API...
+				ValidateFunc: validation.StringInSlice(serversecurityalertpolicies.PossibleValuesForSecurityAlertsPolicyState(),


this is a breaking change, will existing deployments be affected by its removal in the new api or only old ones?

so should we keep the validation for the old value around till 5.0 so users existing deployments are not broken?

I this this is fine as is except we can remove the comment. I did just check the current api and a few other api versions and the removed value doesn't exist and the value when passed into the api currently isn't allowed anymore. I don't see how someone could have New as their value and not see this issue. If it's going to cause issues for that use case, we could just add it back in but the work to get it out for 5.0 feels high here and not worth it

Error: updating mssql server security alert policy: sql.ServerSecurityAlertPoliciesClient#CreateOrUpdate: Failure sending request: StatusCode=400 -- Original Error: Code="DataSecurityInvalidUserSuppliedParameter" Message="Invalid parameter 'state'. Allowed values are 'Enabled' or 'Disabled'.\r\nParameter name: state"

mbfrahry

Hey @WodansSon, this change looks good except for the Update. We need to do d.HasChange on all the updatable values so we don't break ignore_changes

mbfrahry · 2025-04-21T17:42:38Z

+	resourceGroupName := d.Get("resource_group_name").(string)
+	serverName := d.Get("server_name").(string)
+
+	alertPolicy := expandSecurityAlertPolicy(d)


Not using d.HasChange breaks ignore_changes so we won't be able to use this function for the update

mbfrahry · 2025-04-21T21:59:20Z

+				// NOTE: 'SecurityAlertsPolicyStateNew' no longer exists in the new API...
+				ValidateFunc: validation.StringInSlice(serversecurityalertpolicies.PossibleValuesForSecurityAlertsPolicyState(),


I this this is fine as is except we can remove the comment. I did just check the current api and a few other api versions and the removed value doesn't exist and the value when passed into the api currently isn't allowed anymore. I don't see how someone could have New as their value and not see this issue. If it's going to cause issues for that use case, we could just add it back in but the work to get it out for 5.0 feels high here and not worth it

Error: updating mssql server security alert policy: sql.ServerSecurityAlertPoliciesClient#CreateOrUpdate: Failure sending request: StatusCode=400 -- Original Error: Code="DataSecurityInvalidUserSuppliedParameter" Message="Invalid parameter 'state'. Allowed values are 'Enabled' or 'Disabled'.\r\nParameter name: state"

mbfrahry · 2025-04-21T22:00:41Z

-					string(sql.SecurityAlertPolicyStateEnabled),
-					string(sql.SecurityAlertPolicyStateNew),
-				}, false),
+				// NOTE: 'SecurityAlertsPolicyStateNew' no longer exists in the new API...


We can remove this comment as it's not relevant unless looking at this PR

mbfrahry · 2025-04-21T22:01:29Z

+}
+
+// Sets the tests 'Primary' and 'Secondary' locations based on the 'ARM_MICROSOFT_TEST' environment variable due to subscription quota policies
+func setTestDataLocationBySubscription(data acceptance.TestData) acceptance.TestData {


Similar to a previous comment from another PR, we can remove this and just update the teamcity settings

mbfrahry

Thanks @WodansSon! It looks like there was an error with one of the tests

TestAccMsSqlServerSecurityAlertPolicy_update
storageAccountAccessKey parameter can not be null when storageEndpoint parameter is not null

WodansSon · 2025-04-28T09:25:45Z

@mbfrahry

Thanks @WodansSon! It looks like there was an error with one of the tests
TestAccMsSqlServerSecurityAlertPolicy_update
storageAccountAccessKey parameter can not be null when storageEndpoint parameter is not null

Fixed.

mbfrahry

Hey @WodansSon, this looks good but I just a minor nit around the test config naming.

mbfrahry · 2025-05-02T20:12:20Z

+`, r.server(data))
+}
+
+func (r MsSqlServerSecurityAlertPolicyResource) updateStepOne(data acceptance.TestData) string {


I understand the desire to use this naming scheme but we should have the test config names describe what is going on in the test so we can reuse test steps where necessary rather than having to rely on comments in other tests to understand what the config is doing

mbfrahry

LGTM! Thanks @WodansSon

Dismissing stale review

* changelog for 4.28 release * Update CHANGELOG.md #29410 * Update CHANGELOG.md #29397 * Update CHANGELOG.md #27454 * Update CHANGELOG.md #28919 * Update CHANGELOG.md #29443 * Update CHANGELOG.md #29443 * Update CHANGELOG.md #29456 * Update CHANGELOG.md for #29424 * Update CHANGELOG.md for #29150 * Update CHANGELOG.md #29435 * Update CHANGELOG.md #29431 * Update CHANGELOG.md #29396 * Update CHANGELOG.md #29197 * Update CHANGELOG.md for #28705 * Update CHANGELOG.md #28954 * Update CHANGELOG.md for #29363 * prep for release --------- Co-authored-by: catriona-m <86247157+catriona-m@users.noreply.github.com> Co-authored-by: Wodans Son <20408400+WodansSon@users.noreply.github.com> Co-authored-by: sreallymatt <106555974+sreallymatt@users.noreply.github.com> Co-authored-by: Matthew Frahry <mbfrahry@gmail.com> Co-authored-by: jackofallops <ste@hashicorp.com>

github-actions · 2025-06-08T02:30:36Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

Initial Check-in...

31798bc

WodansSon added documentation dependencies breaking-change service/mssql Microsoft SQL Server labels Apr 17, 2025

WodansSon requested a review from a team as a code owner April 17, 2025 06:30

github-actions Bot added the size/L label Apr 17, 2025

WodansSon marked this pull request as draft April 17, 2025 06:51

WodansSon marked this pull request as ready for review April 18, 2025 04:16

katbyte previously requested changes Apr 21, 2025

View reviewed changes

github-actions Bot assigned katbyte Apr 21, 2025

github-actions Bot added the waiting-response label Apr 21, 2025

mbfrahry requested changes Apr 21, 2025

View reviewed changes

github-actions Bot assigned mbfrahry Apr 21, 2025

Address PR comments...

e00cd22

github-actions Bot removed the waiting-response label Apr 22, 2025

WodansSon added 2 commits April 22, 2025 00:16

Move CRUD into correct order...

8c29fd4

Fix error message formatting...

bf5f9e4

mbfrahry requested changes Apr 23, 2025

View reviewed changes

github-actions Bot added waiting-response and removed waiting-response labels Apr 23, 2025

Update resource, documentation and test cases...

ce040df

github-actions Bot added size/XL waiting-response and removed size/L labels Apr 27, 2025

Fix lint errors...

d538abe

github-actions Bot removed the waiting-response label Apr 27, 2025

Refactor the d.HasChanges, Update test case and documentation...

bcc40f5

mbfrahry requested changes May 2, 2025

View reviewed changes

github-actions Bot added the waiting-response label May 2, 2025

Address PR comment....

1621880

github-actions Bot removed the waiting-response label May 3, 2025

mbfrahry approved these changes May 8, 2025

View reviewed changes

mbfrahry added this to the v4.28.0 milestone May 8, 2025

mbfrahry merged commit c3fe9f3 into main May 8, 2025

mbfrahry deleted the deps/u_mssql_security_alert branch May 8, 2025 23:03

mbfrahry added a commit that referenced this pull request May 8, 2025

Update CHANGELOG.md for #29363

25970d9

github-actions Bot locked as resolved and limited conversation to collaborators Jun 8, 2025

		// NOTE: 'SecurityAlertsPolicyStateNew' no longer exists in the new API...
		ValidateFunc: validation.StringInSlice(serversecurityalertpolicies.PossibleValuesForSecurityAlertsPolicyState(),

Conversation

WodansSon commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mbfrahry left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mbfrahry left a comment

Choose a reason for hiding this comment

Uh oh!

WodansSon commented Apr 28, 2025

Uh oh!

mbfrahry left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mbfrahry left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 8, 2025

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

WodansSon commented Apr 17, 2025 •

edited

Loading