azurerm_container_app_job Rename plural properties to singular for consistency with other Container App resources

[oWretch]

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

This PR just adds two TODOs to the azurerm_container_app_job resource to rename the secrets and registries properties from plural to singular to match the properties in the azurerm_container_app resource for consistency.

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.

Change Log

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

• azurerm_container_app_job - rename secrets to secret [azurerm_container_app_job Rename plural properties to singular for consistency with other Container App resources #26063]
• azurerm_container_app_job - rename registries to registry [azurerm_container_app_job Rename plural properties to singular for consistency with other Container App resources #26063]

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.

This is a (please select all that apply):

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

[stephybun]

Thanks for this PR @oWretch. I can see the value in this being consistent across the Container App resources, however given our backlog for 4.0 and the time frame in which we're planning to release it, we can't guarantee that someone in the team will get around to renaming this for 4.0.

I'm happy to merge this as is, just wanting to set expectations here. Alternatively you're welcome to give this a go yourself, we have some guidance in our contributor docs on how to deprecate and rename properties here.

[oWretch]

Thanks @stephybun. I was being slightly cheeky and thinking a simple rename for 4.0 would solve the problem instead of extra code 🙂

I've updated the PR to deprecate the plural properties, and move over to the singular properties.

[oWretch]

Note: I haven't included the logic to prevent deleting secrets that currently exists as it is now supported to remove secrets. The removal of this restriction exists in #25969.

[stephybun]

Thanks so much for doing the deprecation here @oWretch!

In addition to the comments left in-line. We should also add a test for the deprecated properties to ensure that these still work with the changes. This test can be skipped using t.Skip when features.FourPointOhBeta is true.

[Botje]

Hi, subscribing to this thread (as the author of #25969). If this lands before my PR I will update the tests and other needed files.

[stephybun]

Tests look good. Thanks for this @oWretch! LGTM 🦞

[github-actions]

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.