azurerm_route_server - Add support for hub_routing_preference property

[bubbletroubles]

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

• Add support for the hub_routing_preference property in azurerm_route_server.
• Updated docs to sort properties in alphabetical order, and added new docs for the hub_routing_preference property.

Here are the references for this feature

• https://learn.microsoft.com/en-us/azure/virtual-wan/about-virtual-hub-routing-preference
• https://learn.microsoft.com/en-us/rest/api/virtualwan/virtual-hubs/create-or-update?view=rest-virtualwan-2024-05-01&tabs=HTTP#hubroutingpreference

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)

All tests are passing - see here.

==> Checking that code complies with gofmt requirements...
==> Checking that Custom Timeouts are used...
==> Checking that acceptance test packages are used...
TF_ACC=1 go test -v ./internal/services/network -run=TestAccRouteServer -parallel 6 -timeout 600m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccRouteServerBgpConnection_basic
=== PAUSE TestAccRouteServerBgpConnection_basic
=== RUN   TestAccRouteServerBgpConnection_requiresImport
=== PAUSE TestAccRouteServerBgpConnection_requiresImport
=== RUN   TestAccRouteServer_basic
=== PAUSE TestAccRouteServer_basic
=== RUN   TestAccRouteServer_requiresImport
=== PAUSE TestAccRouteServer_requiresImport
=== RUN   TestAccRouteServer_complete
=== PAUSE TestAccRouteServer_complete
=== RUN   TestAccRouteServer_update
=== PAUSE TestAccRouteServer_update
=== CONT  TestAccRouteServerBgpConnection_basic
=== CONT  TestAccRouteServer_requiresImport
=== CONT  TestAccRouteServer_update
=== CONT  TestAccRouteServer_complete
=== CONT  TestAccRouteServer_basic
=== CONT  TestAccRouteServerBgpConnection_requiresImport
--- PASS: TestAccRouteServer_requiresImport (1211.88s)
--- PASS: TestAccRouteServer_basic (1221.75s)
--- PASS: TestAccRouteServerBgpConnection_requiresImport (1385.48s)
--- PASS: TestAccRouteServer_complete (1405.40s)
--- PASS: TestAccRouteServerBgpConnection_basic (1482.51s)
--- PASS: TestAccRouteServer_update (1518.60s)
PASS
ok  	github.com/hashicorp/terraform-provider-azurerm/internal/services/network	1518.659s

Finishing: make acctests

Change Log

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

• azurerm_route_server - support for the hub_routing_preference property [azurerm_route_server - Add support for hub_routing_preference property  #28363]

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.

[bubbletroubles]

@stephybun thanks for the review. I've updated the code as per your suggestions and added the extra test. There are still a couple of open comments - let me know how you want them addressed.

Updated tests are passing - results are here

[bubbletroubles]

Hi @stephybun I've updated the PR to remove the computed property and fix the update logic. It's ready for you to re-review.

Test are passing - https://dev.azure.com/bubbletroubles/terraform/_build/results?buildId=177&view=logs&j=275f1d19-1bd8-5591-b06b-07d489ea915a&t=33e5d3ec-87e7-5f80-0281-074c6962cb44