new datasource azurerm_custom_location

[teowa]

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

Concept of Azure Custom Location: https://learn.microsoft.com/en-us/azure/azure-arc/platform/conceptual-custom-locations
How to create a custom location on your Azure Arc-enabled Kubernetes cluster: https://learn.microsoft.com/en-us/azure/azure-arc/kubernetes/custom-locations
REST API: https://learn.microsoft.com/en-us/rest/api/extendedlocation/custom-locations/get?view=rest-extendedlocation-2021-08-15&tabs=HTTP

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)

The custom location is created during with Azure Stack HCI deployment or an Arc-enabled Kubernetes. Below test is based on an existing custom location, which is created by Azure Stack HCI deployment, and the deployment steps are included in the acctest of PR #25646 which is quite complicated.

ARM_TEST_CUSTOM_LOCATION_NAME=customlocationnsm6h ARM_TEST_CUSTOM_LOCATION_RESOURCE_GROUP_NAME=acctest-hci-nsm6h TF_ACC=1 go test -v ./internal/services/extendedlocation -run TestAccCustomLocationDataSource_basic -timeout 24h
=== RUN   TestAccCustomLocationDataSource_basic
--- PASS: TestAccCustomLocationDataSource_basic (25.72s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/extendedlocation      25.755s

Acc test debug log:

2024/04/22 07:59:20 [DEBUG] GET https://management.azure.com/subscriptions/XXXX/resourceGroups/acctest-hci-nsm6h/providers/Microsoft.ExtendedLocation/customLocations/customlocationnsm6h?api-version=2021-08-15
2024/04/22 07:59:21 [DEBUG] AzureRM Response for https://management.azure.com/subscriptions/XXXX/resourceGroups/acctest-hci-nsm6h/providers/Microsoft.ExtendedLocation/customLocations/customlocationnsm6h?api-version=2021-08-15:
HTTP/2.0 200 OK
Content-Length: 1323
Cache-Control: no-cache
Content-Type: application/json
Date: Mon, 22 Apr 2024 07:59:20 GMT
Expires: -1
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Cache: CONFIG_NOCACHE
X-Content-Type-Options: nosniff
X-Ms-Correlation-Request-Id: b2362b51-fb37-3b72-915f-7a1b2d43c68e
X-Ms-Ratelimit-Remaining-Subscription-Reads: 11999
X-Ms-Request-Id: 1652766e-28e1-40eb-b2c3-5411f694d877
X-Ms-Routing-Request-Id: JAPANWEST:20240422T075921Z:06e976e3-6677-4a7a-ad0f-e41d813b0a37
X-Msedge-Ref: Ref A: A7533555A12C4B36895EA62796964C53 Ref B: TYO201151005029 Ref C: 2024-04-22T07:59:20Z

{"id":"/subscriptions/XXXX/resourceGroups/acctest-hci-nsm6h/providers/Microsoft.ExtendedLocation/customLocations/customlocationnsm6h","name":"customlocationnsm6h","location":"eastus","type":"Microsoft.ExtendedLocation/customLocations","systemData":{"createdBy":"XXXX","createdByType":"Application","createdAt":"2024-04-19T05:08:12.6009417Z","lastModifiedBy":"XXXX","lastModifiedByType":"Application","lastModifiedAt":"2024-04-19T05:12:14.1923853Z"},"properties":{"hostResourceId":"/subscriptions/XXXX/resourceGroups/acctest-hci-nsm6h/providers/Microsoft.ResourceConnector/appliances/hcinsm6h-cl-arcbridge","namespace":"default","displayName":"customlocationnsm6h","provisioningState":"Succeeded","clusterExtensionIds":["/subscriptions/XXXX/resourceGroups/acctest-hci-nsm6h/providers/Microsoft.ResourceConnector/appliances/hcinsm6h-cl-arcbridge/providers/Microsoft.KubernetesConfiguration/extensions/hybridaksextension","/subscriptions/XXXX/resourceGroups/acctest-hci-nsm6h/providers/Microsoft.ResourceConnector/appliances/hcinsm6h-cl-arcbridge/providers/Microsoft.KubernetesConfiguration/extensions/vmss-hci"],"authentication":{}}}

Change Log

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

• new datasource azurerm_custom_location

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

Note

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