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_maps_account - Update documentation for location to be (Required) #28652 #28675

Merged
merged 5 commits into from
Feb 4, 2025

Conversation

mikemadeja
Copy link
Contributor

@mikemadeja mikemadeja commented Feb 4, 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

For this issue, I have added a default to global for location - #28652

I have removed the location on a test so it validates working with global default location.

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_maps_account - Default location to global if nothing is passed to location parameter.

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 #28652

Note

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

@mikemadeja mikemadeja changed the title azurerm_maps_account added default to global for location for issue #28652 azurerm_maps_account - added default to location as global for issue #28652 Feb 4, 2025
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.

Hey @mikemadeja, location becoming Required in the schema was a breaking change that was made in 4.0 but it looks like we missed updating the documentation to reflect this when it was released. Could you please revert these changes and update the documentation instead?

@mikemadeja
Copy link
Contributor Author

@stephybun - I have reverted and updated the documentation.

@@ -50,7 +50,7 @@ The following arguments are supported:

* `local_authentication_enabled` - (Optional) Is local authentication enabled for this Azure Maps Account? When `false`, all authentication to the Azure Maps data-plane REST API is disabled, except Azure AD authentication. Defaults to `true`.

* `location` - (Optional) The Location in which the Azure Maps Account should be provisioned. Changing this forces a new resource to be created. Defaults to `global`.
* `location` - (Required) The Location in which the Azure Maps Account should be provisioned. Changing this forces a new resource to be created.
Copy link
Member

Choose a reason for hiding this comment

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

Could I ask you to scoot the position of this up so that it is listed between resource_group_name and sku_name? Required properties are grouped together by convention in the documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Has been moved.

@mikemadeja mikemadeja changed the title azurerm_maps_account - added default to location as global for issue #28652 azurerm_maps_account - Update documentation for location to be (Required) #28652 Feb 4, 2025
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 for this @mikemadeja LGTM 💯

@stephybun stephybun merged commit f072138 into hashicorp:main Feb 4, 2025
8 checks passed
@github-actions github-actions bot added this to the v4.18.0 milestone Feb 4, 2025
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.

azurerm_maps_account - location field is advertised as optional but is actually required
2 participants