Resource Identity and List : voiceservices (hashicorp#31862)

Author: anurag-hashicorp

internal/services/voiceservices/registration.go

@@ -58,5 +58,8 @@ func (r Registration) EphemeralResources() []func() ephemeral.EphemeralResource
 }
 
 func (r Registration) ListResources() []sdk.FrameworkListWrappedResource {
-	return []sdk.FrameworkListWrappedResource{}
+	return []sdk.FrameworkListWrappedResource{
+		CommunicationsGatewayListResource{},
+		CommunicationsGatewayTestLineListResource{},
+	}
 }

internal/services/voiceservices/voice_services_communications_gateway_resource.go

@@ -15,12 +15,15 @@ import (
 	"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-helpers/resourcemanager/resourceids"
 	"github.com/hashicorp/go-azure-sdk/resource-manager/voiceservices/2023-04-03/communicationsgateways"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
 )
 
+//go:generate go run ../../tools/generator-tests resourceidentity -resource-name voice_services_communications_gateway -service-package-name voiceservices -properties "name,resource_group_name" -known-values "subscription_id:data.Subscriptions.Primary"
+
 type CommunicationsGatewayModel struct {
 	Name                               string                                                   `tfschema:"name"`
 	ResourceGroupName                  string                                                   `tfschema:"resource_group_name"`
@@ -50,9 +53,15 @@ type PrimaryRegionPropertiesModel struct{}
 
 type CommunicationsGatewayResource struct{}
 
-var _ sdk.ResourceWithUpdate = CommunicationsGatewayResource{}
+var (
+	_ sdk.ResourceWithUpdate        = CommunicationsGatewayResource{}
+	_ sdk.ResourceWithCustomizeDiff = CommunicationsGatewayResource{}
+	_ sdk.ResourceWithIdentity      = CommunicationsGatewayResource{}
+)
 
-var _ sdk.ResourceWithCustomizeDiff = CommunicationsGatewayResource{}
+func (r CommunicationsGatewayResource) Identity() resourceids.ResourceId {
+	return &communicationsgateways.CommunicationsGatewayId{}
+}
 
 func (r CommunicationsGatewayResource) ResourceType() string {
 	return "azurerm_voice_services_communications_gateway"
@@ -296,6 +305,9 @@ func (r CommunicationsGatewayResource) Create() sdk.ResourceFunc {
 			}
 
 			metadata.SetID(id)
+			if err := pluginsdk.SetResourceIdentityData(metadata.ResourceData, &id); err != nil {
+				return err
+			}
 
 			return nil
 		},
@@ -410,63 +422,57 @@ func (r CommunicationsGatewayResource) Read() sdk.ResourceFunc {
 				return fmt.Errorf("retrieving %s: model was nil", id)
 			}
 
-			state := CommunicationsGatewayModel{
-				Name:              id.CommunicationsGatewayName,
-				ResourceGroupName: id.ResourceGroupName,
-				Location:          location.Normalize(model.Location),
-			}
+			return r.flatten(metadata, id, model)
+		},
+	}
+}
 
-			if properties := model.Properties; properties != nil {
-				state.Connectivity = string(properties.Connectivity)
+func (r CommunicationsGatewayResource) flatten(metadata sdk.ResourceMetaData, id *communicationsgateways.CommunicationsGatewayId, model *communicationsgateways.CommunicationsGateway) error {
+	state := CommunicationsGatewayModel{
+		Name:              id.CommunicationsGatewayName,
+		ResourceGroupName: id.ResourceGroupName,
+		Location:          location.Normalize(model.Location),
+	}
 
-				codecsValue := ""
-				if len(properties.Codecs) > 0 {
-					codecsValue = string(properties.Codecs[0])
-				}
-				state.Codecs = codecsValue
+	if properties := model.Properties; properties != nil {
+		state.Connectivity = string(properties.Connectivity)
 
-				state.E911Type = properties.E911Type
+		codecsValue := ""
+		if len(properties.Codecs) > 0 {
+			codecsValue = string(properties.Codecs[0])
+		}
+		state.Codecs = codecsValue
 
-				state.Platforms = flattenCommunicationsPlatformModel(properties.Platforms)
+		state.E911Type = properties.E911Type
 
-				state.ServiceLocation = flattenServiceRegionPropertiesModel(&properties.ServiceLocations)
+		state.Platforms = flattenCommunicationsPlatformModel(properties.Platforms)
 
-				if properties.AutoGeneratedDomainNameLabelScope != nil {
-					state.AutoGeneratedDomainNameLabelScope = *properties.AutoGeneratedDomainNameLabelScope
-				}
+		state.ServiceLocation = flattenServiceRegionPropertiesModel(&properties.ServiceLocations)
 
-				if properties.ApiBridge != nil && *properties.ApiBridge != nil {
-					apiBridgeValue, err := json.Marshal(*properties.ApiBridge)
-					if err != nil {
-						return fmt.Errorf("marshalling value for ApiBridge: %+v", err)
-					}
-					state.ApiBridge = string(apiBridgeValue)
-				}
+		state.AutoGeneratedDomainNameLabelScope = pointer.From(properties.AutoGeneratedDomainNameLabelScope)
 
-				if properties.EmergencyDialStrings != nil {
-					state.EmergencyDialStrings = *properties.EmergencyDialStrings
-				}
+		if properties.ApiBridge != nil && *properties.ApiBridge != nil {
+			apiBridgeValue, err := json.Marshal(*properties.ApiBridge)
+			if err != nil {
+				return fmt.Errorf("marshalling value for ApiBridge: %+v", err)
+			}
+			state.ApiBridge = string(apiBridgeValue)
+		}
 
-				onPremMcpEnabled := false
-				if properties.OnPremMcpEnabled != nil {
-					onPremMcpEnabled = *properties.OnPremMcpEnabled
-				}
-				state.OnPremMcpEnabled = onPremMcpEnabled
+		state.EmergencyDialStrings = pointer.From(properties.EmergencyDialStrings)
 
-				v := ""
-				if properties.TeamsVoicemailPilotNumber != nil {
-					v = *properties.TeamsVoicemailPilotNumber
-				}
-				state.MicrosoftTeamsVoicemailPilotNumber = v
-			}
+		state.OnPremMcpEnabled = pointer.From(properties.OnPremMcpEnabled)
 
-			if model.Tags != nil {
-				state.Tags = *model.Tags
-			}
+		state.MicrosoftTeamsVoicemailPilotNumber = pointer.From(properties.TeamsVoicemailPilotNumber)
+	}
 
-			return metadata.Encode(&state)
-		},
+	state.Tags = pointer.From(model.Tags)
+
+	if err := pluginsdk.SetResourceIdentityData(metadata.ResourceData, id); err != nil {
+		return err
 	}
+
+	return metadata.Encode(&state)
 }
 
 func (r CommunicationsGatewayResource) Delete() sdk.ResourceFunc {

internal/services/voiceservices/voice_services_communications_gateway_resource_identity_gen_test.go

@@ -0,0 +1,39 @@
+// Copyright IBM Corp. 2014, 2025
+// SPDX-License-Identifier: MPL-2.0
+
+package voiceservices_test
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/knownvalue"
+	"github.com/hashicorp/terraform-plugin-testing/statecheck"
+	"github.com/hashicorp/terraform-plugin-testing/tfjsonpath"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
+	customstatecheck "github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/statecheck"
+)
+
+func TestAccVoiceServicesCommunicationsGateway_resourceIdentity(t *testing.T) {
+	data := acceptance.BuildTestData(t, "azurerm_voice_services_communications_gateway", "test")
+	r := VoiceServicesCommunicationsGatewayResource{}
+
+	checkedFields := map[string]struct{}{
+		"subscription_id":     {},
+		"name":                {},
+		"resource_group_name": {},
+	}
+
+	data.ResourceIdentityTest(t, []acceptance.TestStep{
+		{
+			Config: r.basic(data),
+			ConfigStateChecks: []statecheck.StateCheck{
+				customstatecheck.ExpectAllIdentityFieldsAreChecked("azurerm_voice_services_communications_gateway.test", checkedFields),
+				statecheck.ExpectIdentityValue("azurerm_voice_services_communications_gateway.test", tfjsonpath.New("subscription_id"), knownvalue.StringExact(data.Subscriptions.Primary)),
+				statecheck.ExpectIdentityValueMatchesStateAtPath("azurerm_voice_services_communications_gateway.test", tfjsonpath.New("name"), tfjsonpath.New("name")),
+				statecheck.ExpectIdentityValueMatchesStateAtPath("azurerm_voice_services_communications_gateway.test", tfjsonpath.New("resource_group_name"), tfjsonpath.New("resource_group_name")),
+			},
+		},
+		data.ImportBlockWithResourceIdentityStep(false),
+		data.ImportBlockWithIDStep(false),
+	}, false)
+}

internal/services/voiceservices/voice_services_communications_gateway_resource_list.go

@@ -0,0 +1,99 @@
+// Copyright IBM Corp. 2014, 2025
+// SPDX-License-Identifier: MPL-2.0
+
+package voiceservices
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/go-azure-helpers/lang/pointer"
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/voiceservices/2023-04-03/communicationsgateways"
+	"github.com/hashicorp/terraform-plugin-framework/list"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
+)
+
+type CommunicationsGatewayListResource struct{}
+
+var _ sdk.FrameworkListWrappedResource = new(CommunicationsGatewayListResource)
+
+func (CommunicationsGatewayListResource) ResourceFunc() *pluginsdk.Resource {
+	return sdk.WrappedResource(CommunicationsGatewayResource{})
+}
+
+func (CommunicationsGatewayListResource) Metadata(_ context.Context, _ resource.MetadataRequest, response *resource.MetadataResponse) {
+	response.TypeName = CommunicationsGatewayResource{}.ResourceType()
+}
+
+func (CommunicationsGatewayListResource) List(ctx context.Context, request list.ListRequest, stream *list.ListResultsStream, metadata sdk.ResourceMetadata) {
+	client := metadata.Client.VoiceServices.CommunicationsGatewaysClient
+
+	var data sdk.DefaultListModel
+	diags := request.Config.Get(ctx, &data)
+	if diags.HasError() {
+		stream.Results = list.ListResultsStreamDiagnostics(diags)
+		return
+	}
+
+	var results []communicationsgateways.CommunicationsGateway
+
+	subscriptionID := metadata.SubscriptionId
+	if !data.SubscriptionId.IsNull() {
+		subscriptionID = data.SubscriptionId.ValueString()
+	}
+
+	r := CommunicationsGatewayResource{}
+
+	switch {
+	case !data.ResourceGroupName.IsNull():
+		resp, err := client.ListByResourceGroupComplete(ctx, commonids.NewResourceGroupID(subscriptionID, data.ResourceGroupName.ValueString()))
+		if err != nil {
+			sdk.SetResponseErrorDiagnostic(stream, fmt.Sprintf("listing `%s`", r.ResourceType()), err)
+			return
+		}
+
+		results = resp.Items
+	default:
+		resp, err := client.ListBySubscriptionComplete(ctx, commonids.NewSubscriptionID(subscriptionID))
+		if err != nil {
+			sdk.SetResponseErrorDiagnostic(stream, fmt.Sprintf("listing `%s`", r.ResourceType()), err)
+			return
+		}
+
+		results = resp.Items
+	}
+
+	stream.Results = func(push func(list.ListResult) bool) {
+		for _, gateway := range results {
+			result := request.NewListResult(ctx)
+			result.DisplayName = pointer.From(gateway.Name)
+
+			id, err := communicationsgateways.ParseCommunicationsGatewayID(pointer.From(gateway.Id))
+			if err != nil {
+				sdk.SetErrorDiagnosticAndPushListResult(result, push, "parsing Communications Gateway ID", err)
+				return
+			}
+
+			rmd := sdk.NewResourceMetaData(metadata.Client, r)
+			rmd.SetID(id)
+
+			if err := r.flatten(rmd, id, &gateway); err != nil {
+				sdk.SetErrorDiagnosticAndPushListResult(result, push, fmt.Sprintf("encoding `%s` resource data", r.ResourceType()), err)
+				return
+			}
+
+			sdk.EncodeListResult(ctx, rmd.ResourceData, &result)
+			if result.Diagnostics.HasError() {
+				push(result)
+				return
+			}
+
+			if !push(result) {
+				return
+			}
+		}
+	}
+}