azurerm_sentinel_watchlist - Add required property item_search_key

[magodo]

Since March, the sentinel API now requires the itemSearchey in the PUT request. Meanwhile, the contentType is now not needed here as we don't actually send any content, but delegate it to the azurerm_sentinel_watchlist_item.

Fixes #15851.
Superseds: #15856.

Test

💤  TF_ACC=1 go test -v -timeout=20h ./internal/services/sentinel  -run='TestAccWatchlist'
=== RUN   TestAccWatchlistItem_basic
=== PAUSE TestAccWatchlistItem_basic
=== RUN   TestAccWatchlistItem_update
=== PAUSE TestAccWatchlistItem_update
=== RUN   TestAccWatchlistItem_requiresImport
=== PAUSE TestAccWatchlistItem_requiresImport
=== RUN   TestAccWatchlist_basic
=== PAUSE TestAccWatchlist_basic
=== RUN   TestAccWatchlist_complete
=== PAUSE TestAccWatchlist_complete
=== RUN   TestAccWatchlist_requiresImport
=== PAUSE TestAccWatchlist_requiresImport
=== CONT  TestAccWatchlistItem_basic
=== CONT  TestAccWatchlist_requiresImport
=== CONT  TestAccWatchlist_basic
=== CONT  TestAccWatchlistItem_requiresImport
=== CONT  TestAccWatchlist_complete
=== CONT  TestAccWatchlistItem_update
--- PASS: TestAccWatchlist_basic (124.25s)
--- PASS: TestAccWatchlistItem_requiresImport (150.89s)
--- PASS: TestAccWatchlistItem_basic (184.24s)
--- PASS: TestAccWatchlistItem_update (228.30s)
--- PASS: TestAccWatchlist_requiresImport (784.88s)
--- PASS: TestAccWatchlist_complete (820.07s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/sentinel      820.092s

[magodo]

The CI failure of the example is due to there is new property introduced.

[mcamenzind]

Any reason for deviating from Microsoft's property naming itemsSearchKey (notice the s)?

[tombuildsstuff]

this is a breaking change, we should be exposing a field for this with a default value here?

[tombuildsstuff]

the possible values from the SDK here are:

// Source enumerates the values for source.
type Source string

const (
	// SourceLocalfile ...
	SourceLocalfile Source = "Local file"
	// SourceRemotestorage ...
	SourceRemotestorage Source = "Remote storage"
)

// PossibleSourceValues returns an array of possible values for the Source const type.
func PossibleSourceValues() []Source {
	return []Source{SourceLocalfile, SourceRemotestorage}
}

why is this a.csv?

[katbyte]

Thanks @magodo - left some comments inline. as for the the name items_seach_key sounds incorrect? correct grammar should be item_search_key regardless of what the SDK is using?

[katbyte]

"a.csv" is not a valid value for securityinsight.Source? at that should we not expose this in schema with a default?

[katbyte]

how come we are removing this? should it not be in schema with a default?

[katbyte]

ditto here? should this not just be in schema with a default?

[magodo]

@tombuildsstuff and @katbyte The Source and ContentType are not returned from API, they are used by the service during the PUT so that the service can create watchlist items based on the specified source. However, as is stated in #14258 this resource is only to create an empty watchlist, if users want to create watchlist items, they can then use azurerm_sentinel_watchlist_item resource.

Therefore, this PR removes the ContentType (as is actually optional in turns of API), and the value of the Source is actually doesn't have any real effect, but only to make API happy, which even can be regarded as not a breaking change for TF users.

About the naming of the items_search_key, I've reverted my last commit.

[Andyandpandy]

Any progress here?
This PR is blocking me from going > 3.0.x

[katbyte]

LGTM 🚜

[github-actions]

This functionality has been released in v3.2.0 of the Terraform Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

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.