`azurerm_eventhub` - deprecate `namespace_name` and `resource_group_name` in favour of `namespace_id` #28055

catriona-m · 2024-11-18T13:32:03Z

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

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)

Change Log

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

azurerm_eventhub - deprecate namespace_name and resource_group_name in favour of namespace_id [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 #27008

Note

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

stephybun

Thanks @catriona-m. Do the tests need to be updated as well?

stephybun · 2024-11-18T13:49:37Z

website/docs/5.0-upgrade-guide.html.markdown

+### `azurerm_eventhub`
+
+* The deprecated `namespace_name` property has been removed in favour of the `namespace_id` property.
+


These should be listed in alphabetical order, so should be moved further up

stephybun · 2024-11-18T13:50:10Z

website/docs/r/eventhub.html.markdown

+* `namespace_name` - (Optional) Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created. This property is deprecated in favour of `namespace_id`.
+
+* `namespace_id` - (Optional) Specifies the id of the EventHub Namespace. Changing this forces a new resource to be created.
+
+~> **NOTE:** One of `namespace_name` or `namespace_id` must be specified.


We remove deprecated properties entirely from the documentation to discourage use of them

Suggested change

* `namespace_name` - (Optional) Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created. This property is deprecated in favour of `namespace_id`.

* `namespace_id` - (Optional) Specifies the id of the EventHub Namespace. Changing this forces a new resource to be created.

~> **NOTE:** One of `namespace_name` or `namespace_id` must be specified.

* `namespace_id` - (Optional) Specifies the id of the EventHub Namespace. Changing this forces a new resource to be created.

stephybun · 2024-11-19T13:05:28Z

internal/services/eventhub/eventhub_resource.go

+		r.Schema["namespace_id"] = &pluginsdk.Schema{
+			Type:         pluginsdk.TypeString,
+			Optional:     true,
+			ForceNew:     true,


This probably shouldn't be ForceNew yet so that users can migrate over to using namespace_id

stephybun · 2024-11-19T13:05:39Z

internal/services/eventhub/eventhub_resource.go

+		r.Schema["namespace_name"] = &pluginsdk.Schema{
+			Type:         pluginsdk.TypeString,
+			Optional:     true,
+			ForceNew:     true,


Likewise here

Suggested change

ForceNew: true,

stephybun · 2024-11-19T13:09:49Z

internal/services/eventhub/eventhub_resource_test.go

@@ -379,7 +379,7 @@ resource "azurerm_eventhub_namespace" "test" {

 resource "azurerm_eventhub" "test" {
  name                = "acctesteventhub-%d"
-  namespace_name      = azurerm_eventhub_namespace.test.name
+  namespace_id        = azurerm_eventhub_namespace.test.id


I'm assuming all the test configs have been updated to use namespace_id instead of namespace_name now, provided the migration path for users switching from namespace_name -> namespace_id works this is fine but it might be worth keeping one test config with namespace_name to ensure it's still functional for the time being e.g.

func (EventHubResource) basic(data acceptance.TestData, partitionCount int) string { if !features.FivePointOhBeta() { // return config using namespace_name here } // return config using namespace_id here }

CorrenSoft · 2024-11-19T18:38:53Z

Dumb question: Shouldn't be also the resource group deprecated?

stephybun · 2024-11-20T06:59:06Z

@CorrenSoft not dumb at all, good catch 😄

stephybun · 2024-11-21T08:55:49Z

internal/services/eventhub/eventhub_resource.go

 				Type:         pluginsdk.TypeString,
 				Required:     true,
 				ForceNew:     true,
-				ValidateFunc: validate.ValidateEventHubNamespaceName(),
+				ValidateFunc: namespaces.ValidateNamespaceID,
 			},

 			"resource_group_name": commonschema.ResourceGroupName(),


@catriona-m as pointed out by @CorrenSoft this probably wants to be deprecated as well

catriona-m · 2024-11-22T10:04:24Z

Thanks @CorrenSoft and @stephybun - I've added that change now and re-run the tests, which look good (apart from 2 flaky tests)

stephybun

Thanks @catriona-m. Once the deprecation messages and upgrade guide have been updated this LGTM ⛄

stephybun · 2024-11-22T10:06:17Z

internal/services/eventhub/eventhub_resource.go

+			Computed:     true,
+			ValidateFunc: validate.ValidateEventHubNamespaceName(),
+			ExactlyOneOf: []string{"namespace_id", "namespace_name"},
+			Deprecated:   "`namespace_name` has been deprecated in favour of `namespace_id`",


Can't believe I didn't catch this in the previous review, but could we update this so it's consistent with other deprecation messages in the provider and also clear in that it will be removed in the next major release

Suggested change

Deprecated: "`namespace_name` has been deprecated in favour of `namespace_id`",

Deprecated: "`namespace_name` has been deprecated in favour of `namespace_id` and will be removed in v5.0 of the AzureRM Provider",

stephybun · 2024-11-22T10:06:30Z

internal/services/eventhub/eventhub_resource.go

+			Computed:     true,
+			ExactlyOneOf: []string{"namespace_id", "resource_group_name"},
+			ValidateFunc: resourcegroups.ValidateName,
+			Deprecated:   "`resource_group_name` has been deprecated in favour of `namespace_id` ",


Suggested change

Deprecated: "`resource_group_name` has been deprecated in favour of `namespace_id` ",

Deprecated: "`resource_group_name` has been deprecated in favour of `namespace_id` and will be removed in v5.0 of the AzureRM Provider ",

stephybun · 2024-11-22T10:09:19Z

website/docs/5.0-upgrade-guide.html.markdown


-* The deprecated `name` property has been removed.
+* The deprecated `namespace_name` property has been removed in favour of the `namespace_id` property.


We need to add a line for the resource_group_name property here as well

deprecate namespace_name in favour of namespace_id

9c3fe47

catriona-m requested review from katbyte and a team as code owners November 18, 2024 13:32

github-actions bot added enhancement documentation service/event-hubs EventHubs size/M labels Nov 18, 2024

update doc

b404816

stephybun reviewed Nov 18, 2024

View reviewed changes

github-actions bot added the waiting-response label Nov 18, 2024

fix guide,docs and tests

244ec13

github-actions bot removed the waiting-response label Nov 19, 2024

stephybun requested changes Nov 19, 2024

View reviewed changes

github-actions bot added the waiting-response label Nov 19, 2024

remove ForceNew and update test

85b2ff5

github-actions bot added waiting-response and removed waiting-response labels Nov 19, 2024

remove space

a3906b6

github-actions bot removed the waiting-response label Nov 19, 2024

stephybun reviewed Nov 21, 2024

View reviewed changes

deprecate resource_group_name

647122e

github-actions bot added size/L and removed size/M labels Nov 21, 2024

catriona-m and others added 2 commits November 21, 2024 16:06

Merge branch 'main' into cm/eventhubid

3e26c46

remove deprecated resource_group_name from docs

e60b082

github-actions bot added the waiting-response label Nov 21, 2024

lint

ad8d0d1

github-actions bot removed the waiting-response label Nov 21, 2024

catriona-m changed the title ~~azurerm_eventhub - deprecate namespace_name in favour of namespace_id~~ azurerm_eventhub - deprecate namespace_name and resource_group_name in favour of namespace_id Nov 21, 2024

Merge branch 'main' into cm/eventhubid

05f0ef1

stephybun approved these changes Nov 22, 2024

View reviewed changes

catriona-m and others added 2 commits November 22, 2024 10:18

add deprecation notes

1efcd20

Update eventhub.html.markdown

08a148d

catriona-m merged commit 3f13aa8 into main Nov 22, 2024
32 checks passed

catriona-m deleted the cm/eventhubid branch November 22, 2024 15:24

catriona-m added the deprecation label Nov 22, 2024

github-actions bot added this to the v4.12.0 milestone Nov 22, 2024

catriona-m added a commit that referenced this pull request Nov 22, 2024

Update CHANGELOG.md #28055

4a162aa

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`azurerm_eventhub` - deprecate `namespace_name` and `resource_group_name` in favour of `namespace_id` #28055

`azurerm_eventhub` - deprecate `namespace_name` and `resource_group_name` in favour of `namespace_id` #28055

catriona-m commented Nov 18, 2024 •

edited

Loading

stephybun left a comment

stephybun Nov 18, 2024

stephybun Nov 18, 2024

stephybun Nov 19, 2024

stephybun Nov 19, 2024

stephybun Nov 19, 2024

CorrenSoft commented Nov 19, 2024

stephybun commented Nov 20, 2024

stephybun Nov 21, 2024

catriona-m commented Nov 22, 2024

stephybun left a comment

stephybun Nov 22, 2024

stephybun Nov 22, 2024

stephybun Nov 22, 2024

		### `azurerm_eventhub`

		* The deprecated `namespace_name` property has been removed in favour of the `namespace_id` property.

	Deprecated: "`namespace_name` has been deprecated in favour of `namespace_id`",
	Deprecated: "`namespace_name` has been deprecated in favour of `namespace_id` and will be removed in v5.0 of the AzureRM Provider",

	Deprecated: "`resource_group_name` has been deprecated in favour of `namespace_id` ",
	Deprecated: "`resource_group_name` has been deprecated in favour of `namespace_id` and will be removed in v5.0 of the AzureRM Provider ",


		* The deprecated `name` property has been removed.
		* The deprecated `namespace_name` property has been removed in favour of the `namespace_id` property.

azurerm_eventhub - deprecate namespace_name and resource_group_name in favour of namespace_id #28055

azurerm_eventhub - deprecate namespace_name and resource_group_name in favour of namespace_id #28055

Conversation

catriona-m commented Nov 18, 2024 • edited Loading

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

stephybun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CorrenSoft commented Nov 19, 2024

stephybun commented Nov 20, 2024

Choose a reason for hiding this comment

catriona-m commented Nov 22, 2024

stephybun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

`azurerm_eventhub` - deprecate `namespace_name` and `resource_group_name` in favour of `namespace_id` #28055

`azurerm_eventhub` - deprecate `namespace_name` and `resource_group_name` in favour of `namespace_id` #28055

catriona-m commented Nov 18, 2024 •

edited

Loading