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)

Test

terraform-provider-azurerm on  storage_share_file_directory_url via 🐹 v1.23.3 took 10s
❯ TF_ACC=1 go test -v -parallel 6 -timeout=20h -run='TestAccStorageShareDirectory_' ./internal/services/storage
=== RUN   TestAccStorageShareDirectory_basic_deprecated
=== PAUSE TestAccStorageShareDirectory_basic_deprecated
=== RUN   TestAccStorageShareDirectory_basicAzureADAuth_deprecated
=== PAUSE TestAccStorageShareDirectory_basicAzureADAuth_deprecated
=== RUN   TestAccStorageShareDirectory_uppercase_deprecated
=== PAUSE TestAccStorageShareDirectory_uppercase_deprecated
=== RUN   TestAccStorageShareDirectory_requiresImport_deprecated
=== PAUSE TestAccStorageShareDirectory_requiresImport_deprecated
=== RUN   TestAccStorageShareDirectory_complete_deprecated
=== PAUSE TestAccStorageShareDirectory_complete_deprecated
=== RUN   TestAccStorageShareDirectory_update_deprecated
=== PAUSE TestAccStorageShareDirectory_update_deprecated
=== RUN   TestAccStorageShareDirectory_nested_deprecated
=== PAUSE TestAccStorageShareDirectory_nested_deprecated
=== RUN   TestAccStorageShareDirectory_nestedWithBackslashes_deprecated
=== PAUSE TestAccStorageShareDirectory_nestedWithBackslashes_deprecated
=== RUN   TestAccStorageShareDirectory_basic
=== PAUSE TestAccStorageShareDirectory_basic
=== RUN   TestAccStorageShareDirectory_basicAzureADAuth                                                                                                                                                                                                                                                                   === PAUSE TestAccStorageShareDirectory_basicAzureADAuth
=== RUN   TestAccStorageShareDirectory_uppercase
=== PAUSE TestAccStorageShareDirectory_uppercase
=== RUN   TestAccStorageShareDirectory_requiresImport
=== PAUSE TestAccStorageShareDirectory_requiresImport
=== RUN   TestAccStorageShareDirectory_complete
=== PAUSE TestAccStorageShareDirectory_complete
=== RUN   TestAccStorageShareDirectory_update
=== PAUSE TestAccStorageShareDirectory_update
=== RUN   TestAccStorageShareDirectory_nested                                                                                                                                                                                                                                                                             === PAUSE TestAccStorageShareDirectory_nested
=== RUN   TestAccStorageShareDirectory_nestedWithBackslashes
=== PAUSE TestAccStorageShareDirectory_nestedWithBackslashes
=== CONT  TestAccStorageShareDirectory_basic_deprecated
=== CONT  TestAccStorageShareDirectory_basic
=== CONT  TestAccStorageShareDirectory_complete
=== CONT  TestAccStorageShareDirectory_nested
=== CONT  TestAccStorageShareDirectory_nestedWithBackslashes
=== CONT  TestAccStorageShareDirectory_update
--- PASS: TestAccStorageShareDirectory_complete (228.28s)
=== CONT  TestAccStorageShareDirectory_uppercase
--- PASS: TestAccStorageShareDirectory_basic_deprecated (232.10s)
=== CONT  TestAccStorageShareDirectory_requiresImport
--- PASS: TestAccStorageShareDirectory_basic (234.13s)
=== CONT  TestAccStorageShareDirectory_basicAzureADAuth
--- PASS: TestAccStorageShareDirectory_update (277.47s)
=== CONT  TestAccStorageShareDirectory_complete_deprecated
--- PASS: TestAccStorageShareDirectory_nestedWithBackslashes (280.98s)
=== CONT  TestAccStorageShareDirectory_nestedWithBackslashes_deprecated
--- PASS: TestAccStorageShareDirectory_nested (338.09s)
=== CONT  TestAccStorageShareDirectory_nested_deprecated
--- PASS: TestAccStorageShareDirectory_uppercase (219.41s)                                                                                                                                                                                                                                                                === CONT  TestAccStorageShareDirectory_update_deprecated
--- PASS: TestAccStorageShareDirectory_requiresImport (221.15s)
=== CONT  TestAccStorageShareDirectory_uppercase_deprecated
--- PASS: TestAccStorageShareDirectory_basicAzureADAuth (221.31s)
=== CONT  TestAccStorageShareDirectory_requiresImport_deprecated
--- PASS: TestAccStorageShareDirectory_complete_deprecated (238.54s)
=== CONT  TestAccStorageShareDirectory_basicAzureADAuth_deprecated
--- PASS: TestAccStorageShareDirectory_nestedWithBackslashes_deprecated (298.48s)
--- PASS: TestAccStorageShareDirectory_requiresImport_deprecated (204.86s)
--- PASS: TestAccStorageShareDirectory_nested_deprecated (328.25s)
--- PASS: TestAccStorageShareDirectory_uppercase_deprecated (222.69s)
--- PASS: TestAccStorageShareDirectory_update_deprecated (271.17s)
--- PASS: TestAccStorageShareDirectory_basicAzureADAuth_deprecated (227.16s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/storage       743.208s
❯ TF_ACC=1 go test -v -parallel 6 -timeout=20h -run='TestAccAzureRMStorageShareFile_' ./internal/services/storage

=== RUN   TestAccAzureRMStorageShareFile_basic_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_basic_deprecated

=== RUN   TestAccAzureRMStorageShareFile_basicAzureADAuth_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_basicAzureADAuth_deprecated

=== RUN   TestAccAzureRMStorageShareFile_requiresImport_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_requiresImport_deprecated

=== RUN   TestAccAzureRMStorageShareFile_complete_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_complete_deprecated

=== RUN   TestAccAzureRMStorageShareFile_update_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_update_deprecated

=== RUN   TestAccAzureRMStorageShareFile_withFile_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_withFile_deprecated

=== RUN   TestAccAzureRMStorageShareFile_withEmptyFile_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_withEmptyFile_deprecated

=== RUN   TestAccAzureRMStorageShareFile_withPath_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_withPath_deprecated

=== RUN   TestAccAzureRMStorageShareFile_withPathUsingBackslashes_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_withPathUsingBackslashes_deprecated

=== RUN   TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes_deprecated

=== PAUSE TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes_deprecated

=== RUN   TestAccAzureRMStorageShareFile_basic

=== PAUSE TestAccAzureRMStorageShareFile_basic

=== RUN   TestAccAzureRMStorageShareFile_basicAzureADAuth

=== PAUSE TestAccAzureRMStorageShareFile_basicAzureADAuth

=== RUN   TestAccAzureRMStorageShareFile_requiresImport

=== PAUSE TestAccAzureRMStorageShareFile_requiresImport

=== RUN   TestAccAzureRMStorageShareFile_complete

=== PAUSE TestAccAzureRMStorageShareFile_complete

=== RUN   TestAccAzureRMStorageShareFile_update

=== PAUSE TestAccAzureRMStorageShareFile_update

=== RUN   TestAccAzureRMStorageShareFile_withFile

=== PAUSE TestAccAzureRMStorageShareFile_withFile

=== RUN   TestAccAzureRMStorageShareFile_withEmptyFile

=== PAUSE TestAccAzureRMStorageShareFile_withEmptyFile

=== RUN   TestAccAzureRMStorageShareFile_withPath

=== PAUSE TestAccAzureRMStorageShareFile_withPath

=== RUN   TestAccAzureRMStorageShareFile_withPathUsingBackslashes

=== PAUSE TestAccAzureRMStorageShareFile_withPathUsingBackslashes

=== RUN   TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes

=== PAUSE TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes

=== CONT  TestAccAzureRMStorageShareFile_basic_deprecated

=== CONT  TestAccAzureRMStorageShareFile_basic

=== CONT  TestAccAzureRMStorageShareFile_withFile_deprecated

=== CONT  TestAccAzureRMStorageShareFile_complete_deprecated

=== CONT  TestAccAzureRMStorageShareFile_update_deprecated

=== CONT  TestAccAzureRMStorageShareFile_withPathUsingBackslashes_deprecated

--- PASS: TestAccAzureRMStorageShareFile_complete_deprecated (179.73s)

=== CONT  TestAccAzureRMStorageShareFile_withPath_deprecated

--- PASS: TestAccAzureRMStorageShareFile_basic (181.47s)

=== CONT  TestAccAzureRMStorageShareFile_withEmptyFile_deprecated

--- PASS: TestAccAzureRMStorageShareFile_basic_deprecated (183.37s)

=== CONT  TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes_deprecated

--- PASS: TestAccAzureRMStorageShareFile_withFile_deprecated (207.25s)

=== CONT  TestAccAzureRMStorageShareFile_withFile

--- PASS: TestAccAzureRMStorageShareFile_update_deprecated (285.09s)

=== CONT  TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes

--- PASS: TestAccAzureRMStorageShareFile_withPathUsingBackslashes_deprecated (290.81s)

=== CONT  TestAccAzureRMStorageShareFile_withPathUsingBackslashes

--- PASS: TestAccAzureRMStorageShareFile_withEmptyFile_deprecated (136.71s)

=== CONT  TestAccAzureRMStorageShareFile_withPath

--- PASS: TestAccAzureRMStorageShareFile_withFile (202.49s)

=== CONT  TestAccAzureRMStorageShareFile_withEmptyFile

--- PASS: TestAccAzureRMStorageShareFile_withPath_deprecated (232.99s)

=== CONT  TestAccAzureRMStorageShareFile_complete

--- PASS: TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes_deprecated (282.20s)

=== CONT  TestAccAzureRMStorageShareFile_update

--- PASS: TestAccAzureRMStorageShareFile_withPath (234.77s)

=== CONT  TestAccAzureRMStorageShareFile_requiresImport

--- PASS: TestAccAzureRMStorageShareFile_withEmptyFile (148.51s)

=== CONT  TestAccAzureRMStorageShareFile_basicAzureADAuth

--- PASS: TestAccAzureRMStorageShareFile_withPathInNameUsingBackslashes (280.76s)

=== CONT  TestAccAzureRMStorageShareFile_requiresImport_deprecated

--- PASS: TestAccAzureRMStorageShareFile_withPathUsingBackslashes (279.88s)

=== CONT  TestAccAzureRMStorageShareFile_basicAzureADAuth_deprecated

--- PASS: TestAccAzureRMStorageShareFile_complete (169.56s)

--- PASS: TestAccAzureRMStorageShareFile_requiresImport (165.75s)

--- PASS: TestAccAzureRMStorageShareFile_requiresImport_deprecated (165.33s)

--- PASS: TestAccAzureRMStorageShareFile_update (268.79s)

--- PASS: TestAccAzureRMStorageShareFile_basicAzureADAuth (182.31s)

--- PASS: TestAccAzureRMStorageShareFile_basicAzureADAuth_deprecated (184.64s)

PASS

ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/storage       755.463s

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.

[magodo]