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.

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_servicebus_namespace - split create update funcs #28539

Merged
merged 6 commits into from
Feb 25, 2025

Conversation

catriona-m
Copy link
Member

@catriona-m catriona-m commented Jan 17, 2025

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

This PR splits the create and update functions so that ignore_changes works as expected.

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 relevent 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)
image

Change Log

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

  • azurerm_servicebus_namespace - split create/update functions to enable use of ignore_changes [GH-00000]

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Related Issue(s)

Fixes #0000

Note

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

defer cancel()

log.Printf("[INFO] preparing arguments for ServiceBus Namespace create/update.")
log.Printf("[INFO] preparing arguments for ServiceBus Namespace create")

location := azure.NormalizeLocation(d.Get("location").(string))
sku := d.Get("sku").(string)
Copy link
Member

@stephybun stephybun Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't comment further down, but I don't think we need the d.IsNewResource() check down on line 287 anymore


d.SetId(id.ID())

if d.HasChange("network_rule_set") {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without any context here, why do we need to wrap this update on the network rule set ind.HasChange in the Create?

Comment on lines 387 to 391
if existing.Model == nil {
return fmt.Errorf("retrieving existing %s: `model` was nil", *id)
}
if existing.Model.Properties == nil {
return fmt.Errorf("retrieving existing %s: `model.Properties` was nil", *id)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if existing.Model == nil {
return fmt.Errorf("retrieving existing %s: `model` was nil", *id)
}
if existing.Model.Properties == nil {
return fmt.Errorf("retrieving existing %s: `model.Properties` was nil", *id)
if existing.Model == nil {
return fmt.Errorf("retrieving %s: `model` was nil", *id)
}
if existing.Model.Properties == nil {
return fmt.Errorf("retrieving %s: `model.Properties` was nil", *id)

Comment on lines 435 to 436
minimumTls := namespaces.TlsVersion(tlsValue)
payload.Properties.MinimumTlsVersion = &minimumTls
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
minimumTls := namespaces.TlsVersion(tlsValue)
payload.Properties.MinimumTlsVersion = &minimumTls
payload.Properties.MinimumTlsVersion = pointer.To(namespaces.TlsVersion(tlsValue))

return err
}
log.Printf("[DEBUG] Reset the Existing Network Rule Set associated with %s", id)
} else {
log.Printf("[DEBUG] Creating the Network Rule Set associated with %s..", id)
if err = createNetworkRuleSetForNamespace(ctx, client, id, newNetworkRuleSet.([]interface{})); err != nil {
log.Printf("[DEBUG] Creating/updating the Network Rule Set associated with %s..", id)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this just be

Suggested change
log.Printf("[DEBUG] Creating/updating the Network Rule Set associated with %s..", id)
log.Printf("[DEBUG] Updating the Network Rule Set associated with %s..", id)

return err
}
log.Printf("[DEBUG] Created the Network Rule Set associated with %s", id)
log.Printf("[DEBUG] Created/updated the Network Rule Set associated with %s", id)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise

Suggested change
log.Printf("[DEBUG] Created/updated the Network Rule Set associated with %s", id)
log.Printf("[DEBUG] Updated the Network Rule Set associated with %s", id)

Comment on lines 617 to 624
if v["identity_id"].(string) == "" {
encryption.KeyVaultProperties = &[]namespaces.KeyVaultProperties{
{
KeyName: pointer.To(keyId.Name),
KeyVersion: pointer.To(keyId.Version),
KeyVaultUri: pointer.To(keyId.KeyVaultBaseUrl),
},
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we allow identity_id to be Optional, can users actually create a servicebus namespace with CMK using SystemAssigned identity on first go?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they can't, so I've reverted this to how it was before 👍

@catriona-m catriona-m requested a review from stephybun February 14, 2025 14:19
Comment on lines +433 to +436
if !strings.EqualFold(sku, string(namespaces.SkuNamePremium)) && capacity.(int) > 0 {
return fmt.Errorf("service bus SKU %q only supports `capacity` of 0", sku)
}
if strings.EqualFold(sku, string(namespaces.SkuNamePremium)) && capacity.(int) == 0 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect there's a typo here and one of these conditions should be comparing against a different sku

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this, just copied from the create, but I believe it is correct. The first check is that it is NOT premium and greater than 0, because basic and standard skus can only have a capacity of 0. The second check returns an error if it is premium and set to 0 because if the sku is premium the sku needs to be 1,2,4,8 or 16.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, I missed the not at the front of the first condition.

@@ -87,7 +87,7 @@ A `customer_managed_key` block supports the following:

* `key_vault_key_id` - (Required) The ID of the Key Vault Key which should be used to Encrypt the data in this ServiceBus Namespace.

* `identity_id` - (Required) The ID of the User Assigned Identity that has access to the key.
* `identity_id` - (Optional) The ID of the User Assigned Identity that has access to the key.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `identity_id` - (Optional) The ID of the User Assigned Identity that has access to the key.
* `identity_id` - (Required) The ID of the User Assigned Identity that has access to the key.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed! thank you

Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @catriona-m LGTM 🎿

@catriona-m catriona-m merged commit ba7c2b3 into main Feb 25, 2025
33 checks passed
@catriona-m catriona-m deleted the cm/servicebussplit branch February 25, 2025 13:55
@github-actions github-actions bot added this to the v4.21.0 milestone Feb 25, 2025
catriona-m added a commit that referenced this pull request Feb 25, 2025
jackofallops added a commit that referenced this pull request Feb 27, 2025
* Update CHANGELOG.md for #28840

* Update CHANGELOG.md #28808

* Update CHANGELOG.md #27962

* Update CHANGELOG.md for #28859

* Update for #28825

* Update CHANGELOG.md for #28864

* Update CHANGELOG.md #28539

* Update CHANGELOG.md #28685

* Update CHANGELOG.md for #28818

* Update for #28857 #28799 #28856

* Update for #28122

* Update for #28248 #27805

* Update for #28853

* Update for #28316 #28494 #28696

* Update for #28754

* Update CHANGELOG.md #28771

* Update CHANGELOG.md #28842

* Update for #28879

* Update for #28199

* Update CHANGELOG.md #28862

* prep for release v4.21.0

---------

Co-authored-by: sreallymatt <[email protected]>
Co-authored-by: Wodans Son <[email protected]>
Co-authored-by: stephybun <[email protected]>
Co-authored-by: catriona-m <[email protected]>
Co-authored-by: Matthew Frahry <[email protected]>
Co-authored-by: Wyatt Fry <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants