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_subnet - the private_endpoint_network_policies_enabled property has been deprecated in favour of the private_endpoint_network_policies property #25779

Merged

Conversation

neil-yechenwei
Copy link
Contributor

@neil-yechenwei neil-yechenwei commented Apr 28, 2024

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 "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

Currently, azurerm_subnet has supported the "privateEndpointNetworkPolicies" property and it is marked as bool type in TF. But it's not expected since this property is expanded with new values and now it supports these values "Enabled"/"Disabled"/"NetworkSecurityGroupEnabled"/"RouteTableEnabled" in Swagger. So we have to convert it from bool to string to support more values in TF. This feature request is from Service team.

image

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_subnet - convert the privateEndpointNetworkPolicies property from bool to string to support more values

This is a (please select all that apply):

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

Note

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

@neil-yechenwei neil-yechenwei marked this pull request as ready for review April 28, 2024 07:26
Copy link
Collaborator

@katbyte katbyte left a comment

Choose a reason for hiding this comment

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

Aside from one commment i think this looks good

resource.Schema["private_endpoint_network_policies_enabled"] = &pluginsdk.Schema{
Type: pluginsdk.TypeBool,
Computed: true,
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

we should add a deprecation message here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added

@neil-yechenwei
Copy link
Contributor Author

@katbyte , thanks for the comment. I updated PR. Please take another look.

@neil-yechenwei neil-yechenwei requested a review from katbyte May 7, 2024 01:08
resource.Schema["private_endpoint_network_policies_enabled"] = &pluginsdk.Schema{
Type: pluginsdk.TypeBool,
Computed: true,
Deprecated: "This is deprecated in favor of `private_endpoint_network_policies`",
Copy link
Member

Choose a reason for hiding this comment

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

Can you please specify that the property will be removed in v4.0 of the provider

Suggested change
Deprecated: "This is deprecated in favor of `private_endpoint_network_policies`",
Deprecated: "This property has been superseded by `private_endpoint_network_policies` and will be removed in v4.0 of the AzureRM Provider.",

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

@neil-yechenwei
Copy link
Contributor Author

@stephybun , thanks for the comment. I updated PR. Please take another look.

@neil-yechenwei neil-yechenwei requested a review from stephybun May 7, 2024 08:09
Copy link
Collaborator

@katbyte katbyte left a comment

Choose a reason for hiding this comment

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

LGTM 🦕

@katbyte katbyte changed the title azurerm_subnet - convert the privateEndpointNetworkPolicies property from bool to string to support more values azurerm_subnet - the private_endpoint_network_policies_enabled property has been deprecated in favour of the private_endpoint_network_policies property May 7, 2024
@katbyte katbyte merged commit baa80a1 into hashicorp:main May 7, 2024
34 checks passed
@github-actions github-actions bot added this to the v3.103.0 milestone May 7, 2024
WodansSon added a commit that referenced this pull request May 15, 2024
Copy link

github-actions bot commented Jun 8, 2024

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants