azurerm_storage_share_[directory|file] - Deprecate storage_share_id in favor of storage_share_url

[magodo]

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

azurerm_storage_share_[directory|file] - Deprecate storage_share_id in favor of storage_share_url.

Both storage_share_id and storage_share_url are exact the same in terms of the schema definition and the expected value, that shall be the storage share data plane URL. The split derives from how usres create the upstream azurerm_storage_share:

• If created using the deprecated storage_account_name, the resource id of azurerm_storage_share remains to be the data plane URL, which is accepted to be assigned to storage_share_id of the downstream azurerm_storage_share_[directory|file]. This means for existing configurations that use the deprecated properties, no breaking change is introduced.
• If created using the newly introduced storage_account_id, the resource id of azurerm_storage_share remains to be the azure resource manager id, which will cause issues like The attribute storage_share_id of azurerm_storage_share_directory expects to use a domain suffix of "core.windows.net".  #28032. In this case, users are expected to assign the url attribute of the azurerm_storage_share to the storage_share_url (or storage_share_id, though deprecated).

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_storage_share_[directory|file] - Deprecate storage_share_id in favor of storage_share_url [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 #28032

Note

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