New Data Source: azurerm_dev_center_dev_box_definition (#29790)

[FEATURE] * **New Data Source**: `azurerm_dev_center_dev_box_definition`

Author: neil-yechenwei

internal/services/devcenter/dev_center_dev_box_definition_data_source.go

@@ -0,0 +1,124 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package devcenter
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/hashicorp/go-azure-helpers/lang/pointer"
+	"github.com/hashicorp/go-azure-helpers/lang/response"
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2025-02-01/devboxdefinitions"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/services/devcenter/validate"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
+)
+
+var _ sdk.DataSource = DevCenterDevBoxDefinitionDataSource{}
+
+type DevCenterDevBoxDefinitionDataSource struct{}
+
+type DevCenterDevBoxDefinitionDataSourceModel struct {
+	Name             string            `tfschema:"name"`
+	Location         string            `tfschema:"location"`
+	DevCenterId      string            `tfschema:"dev_center_id"`
+	ImageReferenceId string            `tfschema:"image_reference_id"`
+	SkuName          string            `tfschema:"sku_name"`
+	Tags             map[string]string `tfschema:"tags"`
+}
+
+func (DevCenterDevBoxDefinitionDataSource) Arguments() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"name": {
+			Type:         pluginsdk.TypeString,
+			Required:     true,
+			ValidateFunc: validate.DevCenterDevBoxDefinitionName,
+		},
+
+		"dev_center_id": commonschema.ResourceIDReferenceRequired(&devboxdefinitions.DevCenterId{}),
+	}
+}
+
+func (DevCenterDevBoxDefinitionDataSource) Attributes() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"image_reference_id": {
+			Type:     schema.TypeString,
+			Computed: true,
+		},
+
+		"location": commonschema.LocationComputed(),
+
+		"sku_name": {
+			Type:     pluginsdk.TypeString,
+			Computed: true,
+		},
+
+		"tags": commonschema.TagsDataSource(),
+	}
+}
+
+func (DevCenterDevBoxDefinitionDataSource) ModelObject() interface{} {
+	return &DevCenterDevBoxDefinitionDataSourceModel{}
+}
+
+func (DevCenterDevBoxDefinitionDataSource) ResourceType() string {
+	return "azurerm_dev_center_dev_box_definition"
+}
+
+func (r DevCenterDevBoxDefinitionDataSource) Read() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 5 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.DevCenter.V20250201.DevBoxDefinitions
+			subscriptionId := metadata.Client.Account.SubscriptionId
+
+			var state DevCenterDevBoxDefinitionDataSourceModel
+			if err := metadata.Decode(&state); err != nil {
+				return fmt.Errorf("decoding: %+v", err)
+			}
+
+			devCenterId, err := devboxdefinitions.ParseDevCenterID(state.DevCenterId)
+			if err != nil {
+				return err
+			}
+
+			id := devboxdefinitions.NewDevCenterDevBoxDefinitionID(subscriptionId, devCenterId.ResourceGroupName, devCenterId.DevCenterName, state.Name)
+
+			resp, err := client.Get(ctx, id)
+			if err != nil {
+				if response.WasNotFound(resp.HttpResponse) {
+					return fmt.Errorf("%s was not found", id)
+				}
+
+				return fmt.Errorf("retrieving %s: %+v", id, err)
+			}
+
+			metadata.SetID(id)
+
+			state.Name = id.DevBoxDefinitionName
+			state.DevCenterId = devboxdefinitions.NewDevCenterID(id.SubscriptionId, id.ResourceGroupName, id.DevCenterName).ID()
+
+			if model := resp.Model; model != nil {
+				state.Location = location.Normalize(model.Location)
+				state.Tags = pointer.From(model.Tags)
+
+				if props := model.Properties; props != nil {
+					if v := props.ImageReference; v != nil {
+						state.ImageReferenceId = pointer.From(v.Id)
+					}
+
+					if v := props.Sku; v != nil {
+						state.SkuName = v.Name
+					}
+				}
+			}
+
+			return metadata.Encode(&state)
+		},
+	}
+}

internal/services/devcenter/dev_center_dev_box_definition_data_source_test.go

@@ -0,0 +1,43 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package devcenter_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check"
+)
+
+type DevCenterDevBoxDefinitionDataSource struct{}
+
+func TestAccDevCenterDevBoxDefinitionDataSource_basic(t *testing.T) {
+	data := acceptance.BuildTestData(t, "data.azurerm_dev_center_dev_box_definition", "test")
+	r := DevCenterDevBoxDefinitionDataSource{}
+
+	data.DataSourceTest(t, []acceptance.TestStep{
+		{
+			Config: r.basic(data),
+			Check: acceptance.ComposeTestCheckFunc(
+				check.That(data.ResourceName).Key("name").Exists(),
+				check.That(data.ResourceName).Key("dev_center_id").Exists(),
+				check.That(data.ResourceName).Key("location").Exists(),
+				check.That(data.ResourceName).Key("image_reference_id").Exists(),
+				check.That(data.ResourceName).Key("sku_name").Exists(),
+			),
+		},
+	})
+}
+
+func (d DevCenterDevBoxDefinitionDataSource) basic(data acceptance.TestData) string {
+	return fmt.Sprintf(`
+%s
+
+data "azurerm_dev_center_dev_box_definition" "test" {
+  name          = azurerm_dev_center_dev_box_definition.test.name
+  dev_center_id = azurerm_dev_center_dev_box_definition.test.dev_center_id
+}
+`, DevCenterDevBoxDefinitionTestResource{}.basic(data))
+}

internal/services/devcenter/registration.go

@@ -29,6 +29,7 @@ func (r Registration) DataSources() []sdk.DataSource {
 	return []sdk.DataSource{
 		DevCenterCatalogDataSource{},
 		DevCenterDataSource{},
+		DevCenterDevBoxDefinitionDataSource{},
 		DevCenterGalleryDataSource{},
 		DevCenterNetworkConnectionDataSource{},
 		DevCenterProjectDataSource{},

website/docs/d/dev_center_dev_box_definition.html.markdown

@@ -0,0 +1,52 @@
+---
+subcategory: "Dev Center"
+layout: "azurerm"
+page_title: "Azure Resource Manager: Data Source: azurerm_dev_center_dev_box_definition"
+description: |-
+  Gets information about an existing Dev Center Dev Box Definition.
+---
+
+# Data Source: azurerm_dev_center_dev_box_definition
+
+Use this data source to access information about an existing Dev Center Dev Box Definition.
+
+## Example Usage
+
+```hcl
+data "azurerm_dev_center_dev_box_definition" "example" {
+  name          = azurerm_dev_center_dev_box_definition.example.name
+  dev_center_id = azurerm_dev_center_dev_box_definition.example.dev_center_id
+}
+
+output "id" {
+  value = data.azurerm_dev_center_dev_box_definition.example.id
+}
+```
+
+## Arguments Reference
+
+The following arguments are supported:
+
+* `name` - (Required) The name of this Dev Center Dev Box Definition.
+
+* `dev_center_id` - (Required) The ID of the associated Dev Center.
+
+## Attributes Reference
+
+In addition to the Arguments listed above - the following Attributes are exported:
+
+* `id` - The ID of the Dev Center Dev Box Definition.
+
+* `image_reference_id` - The ID of the image for the Dev Center Dev Box Definition.
+
+* `location` - The Azure Region where the Dev Center Dev Box Definition exists.
+
+* `sku_name` - The name of the SKU for the Dev Center Dev Box Definition.
+
+* `tags` - A mapping of tags assigned to the Dev Center Dev Box Definition.
+
+## Timeouts
+
+The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:
+
+* `read` - (Defaults to 5 minutes) Used when retrieving the Dev Center Dev Box Definition.