New service: DeviceRegistry + new resources: azurerm_device_registry_asset and azurerm_device_registry_asset_endpoint_profile

[mryanlo]

This PR introduces support for the Device Registry service, comprising of:

Resources

- azurerm_device_registry_asset
- azurerm_device_registry_asset_endpoint_profile

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

Swagger: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/deviceregistry/resource-manager/Microsoft.DeviceRegistry/stable/2024-11-01

Azure Doc: https://learn.microsoft.com/en-us/azure/iot-operations/discover-manage-assets/howto-manage-assets-remotely?tabs=cli

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 acceptance tests for azurerm_device_registry_asset and azurerm_device_registry_asset_endpoint_profile require an arc-enabled kubernetes cluster with Azure IoT Operations' service extension installed on the cluster in order to pass. Creating this cluster in the terraform acceptance tests has been unsuccessful, takes over 45 minutes to complete, and the installation of AIO script has proven to be flakey. Once the cluster is setup, you need to add these environment variables to pass:

ARM_DEVICE_REGISTRY_RESOURCE_GROUP=<myResourceGroup> // resource group where the AIO-enabled cluster is
ARM_DEVICE_REGISTRY_CUSTOM_LOCATION=/subscriptions/xxxx/resourceGroups/<myResourceGroup>/providers/Microsoft.ExtendedLocation/customLocations/<myCustomLocation> // full custom location path that is in <myResourceGroup> and connected to the AIO extension

Local tests against a pre-existing AIO cluster:

• Asset:

$ make acctests SERVICE='deviceregistry' TESTARGS='-run=TestAccAsset_'
TF_ACC=1 go test -v ./internal/services/deviceregistry -run=TestAccAsset_ -timeout 180m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccAsset_basic
=== PAUSE TestAccAsset_basic
=== RUN   TestAccAsset_complete
=== PAUSE TestAccAsset_complete
=== RUN   TestAccAsset_requiresImport
=== PAUSE TestAccAsset_requiresImport
=== RUN   TestAccAsset_update
=== PAUSE TestAccAsset_update
=== CONT  TestAccAsset_basic
=== CONT  TestAccAsset_requiresImport
--- PASS: TestAccAsset_requiresImport (148.12s)
=== CONT  TestAccAsset_update
--- PASS: TestAccAsset_basic (168.96s)
=== CONT  TestAccAsset_complete
--- PASS: TestAccAsset_complete (125.88s)
--- PASS: TestAccAsset_update (181.90s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/deviceregistry        340.311s

• Asset endpoint profile:

$ make acctests SERVICE='deviceregistry' TESTARGS='-run=TestAccAssetEndpointProfile_'
TF_ACC=1 go test -v ./internal/services/deviceregistry -run=TestAccAssetEndpointProfile_ -timeout 180m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccAssetEndpointProfile_basic
=== PAUSE TestAccAssetEndpointProfile_basic
=== RUN   TestAccAssetEndpointProfile_complete_certificate
=== PAUSE TestAccAssetEndpointProfile_complete_certificate
=== RUN   TestAccAssetEndpointProfile_complete_usernamePassword
=== PAUSE TestAccAssetEndpointProfile_complete_usernamePassword
=== RUN   TestAccAssetEndpointProfile_complete_anonymous
=== PAUSE TestAccAssetEndpointProfile_complete_anonymous
=== RUN   TestAccAssetEndpointProfile_requiresImport
=== PAUSE TestAccAssetEndpointProfile_requiresImport
=== RUN   TestAccAssetEndpointProfile_update
=== PAUSE TestAccAssetEndpointProfile_update
=== CONT  TestAccAssetEndpointProfile_basic
=== CONT  TestAccAssetEndpointProfile_complete_anonymous
--- PASS: TestAccAssetEndpointProfile_basic (141.14s)
=== CONT  TestAccAssetEndpointProfile_update
--- PASS: TestAccAssetEndpointProfile_complete_anonymous (146.94s)
=== CONT  TestAccAssetEndpointProfile_requiresImport
--- PASS: TestAccAssetEndpointProfile_requiresImport (113.54s)
=== CONT  TestAccAssetEndpointProfile_complete_usernamePassword
--- PASS: TestAccAssetEndpointProfile_complete_usernamePassword (118.11s)
=== CONT  TestAccAssetEndpointProfile_complete_certificate
--- PASS: TestAccAssetEndpointProfile_complete_certificate (118.48s)
--- PASS: TestAccAssetEndpointProfile_update (379.77s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/deviceregistry        531.097s

• Both resources' tests skipped if env variables not set:

 make acctests SERVICE='deviceregistry'
TF_ACC=1 go test -v ./internal/services/deviceregistry  -timeout 180m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccAsset_basic
    device_registry_asset_resource_test.go:30: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAsset_basic (0.00s)
=== RUN   TestAccAsset_complete
    device_registry_asset_resource_test.go:57: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAsset_complete (0.00s)
=== RUN   TestAccAsset_requiresImport
    device_registry_asset_resource_test.go:127: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAsset_requiresImport (0.00s)
=== RUN   TestAccAsset_update
    device_registry_asset_resource_test.go:148: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAsset_update (0.00s)
=== RUN   TestAccAssetEndpointProfile_basic
    device_registry_assetendpointprofile_resource_test.go:30: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAssetEndpointProfile_basic (0.00s)
=== RUN   TestAccAssetEndpointProfile_complete_certificate
    device_registry_assetendpointprofile_resource_test.go:57: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAssetEndpointProfile_complete_certificate (0.00s)
=== RUN   TestAccAssetEndpointProfile_complete_usernamePassword
    device_registry_assetendpointprofile_resource_test.go:85: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAssetEndpointProfile_complete_usernamePassword (0.00s)
=== RUN   TestAccAssetEndpointProfile_complete_anonymous
    device_registry_assetendpointprofile_resource_test.go:113: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAssetEndpointProfile_complete_anonymous (0.00s)
=== RUN   TestAccAssetEndpointProfile_requiresImport
    device_registry_assetendpointprofile_resource_test.go:141: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAssetEndpointProfile_requiresImport (0.00s)
=== RUN   TestAccAssetEndpointProfile_update
    device_registry_assetendpointprofile_resource_test.go:162: Skipping test due to missing environment variables ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and/or ARM_DEVICE_REGISTRY_RESOURCE_GROUP
--- SKIP: TestAccAssetEndpointProfile_update (0.00s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/deviceregistry        13.818s

Change Log

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

• new service DeviceRegistry - support for the device_registry service [GH-00000]
• new resource azurerm_device_registry_asset [GH-00000]
• new resource azurerm_device_registry_asset_endpoint_profile [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 #0000

Note

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

[mryanlo]

For both asset and asset endpoint profile resource tests, we require env vars ARM_DEVICE_REGISTRY_CUSTOM_LOCATION and ARM_DEVICE_REGISTRY_RESOURCE_GROUP to be set or else the tests will fail (to prevent this we skip the tests).

however, the resource group, custom location, and the AIO cluster must be pre-existing this test run. Investigation and efforts to get the acceptance tests to create and provision an AIO cluster are flakey, take a long time to run (45+ minutes), and we found that the test steps delete the cluster resources before the asset/asset endpoint profile resource tests run (causing the latter ones to fail). awaiting response from Hashicorp and Terraform PMs what the best course of action is here.