list and identity - azurerm_servicebus_customer_managed_identity (#32315)

[FEATURE] * **New List Resource**: `azurerm_servicebus_customer_managed_identity`

Author: aayushsingh2502

internal/services/servicebus/registration.go

@@ -96,6 +96,7 @@ func (r Registration) EphemeralResources() []func() ephemeral.EphemeralResource
 
 func (r Registration) ListResources() []sdk.FrameworkListWrappedResource {
 	return []sdk.FrameworkListWrappedResource{
+		ServiceBusNamespaceCustomerManagedKeyListResource{},
 		ServiceBusNamespaceListResource{},
 	}
 }

internal/services/servicebus/servicebus_namespace_customer_managed_key_resource.go

@@ -12,11 +12,14 @@ import (
 	"github.com/hashicorp/go-azure-helpers/lang/pointer"
 	"github.com/hashicorp/go-azure-helpers/lang/response"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/keyvault"
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/resourceids"
 	"github.com/hashicorp/go-azure-sdk/resource-manager/servicebus/2024-01-01/namespaces"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
 )
 
+//go:generate go run ../../tools/generator-tests resourceidentity -resource-name servicebus_namespace_customer_managed_key -service-package-name servicebus -compare-values "subscription_id:namespace_id,resource_group_name:namespace_id,name:namespace_id"
+
 type ServiceBusNamespaceCustomerManagedKeyResource struct{}
 
 type ServiceBusNamespaceCustomerManagedKeyModel struct {
@@ -25,7 +28,14 @@ type ServiceBusNamespaceCustomerManagedKeyModel struct {
 	InfrastructureEncryptionEnabled bool   `tfschema:"infrastructure_encryption_enabled"`
 }
 
-var _ sdk.ResourceWithUpdate = ServiceBusNamespaceCustomerManagedKeyResource{}
+var (
+	_ sdk.ResourceWithIdentity = ServiceBusNamespaceCustomerManagedKeyResource{}
+	_ sdk.ResourceWithUpdate   = ServiceBusNamespaceCustomerManagedKeyResource{}
+)
+
+func (r ServiceBusNamespaceCustomerManagedKeyResource) Identity() resourceids.ResourceId {
+	return &namespaces.NamespaceId{}
+}
 
 func (r ServiceBusNamespaceCustomerManagedKeyResource) ModelObject() interface{} {
 	return &ServiceBusNamespaceCustomerManagedKeyModel{}
@@ -119,10 +129,13 @@ func (r ServiceBusNamespaceCustomerManagedKeyResource) Create() sdk.ResourceFunc
 				},
 			}
 
-			if err := client.CreateOrUpdateCallbackThenPoll(ctx, *id, *payload, metadata.SetIDCallback(id)); err != nil {
+			if err := client.CreateOrUpdateCallbackThenPoll(ctx, *id, *payload, metadata.SetIDAndIdentityCallback(id)); err != nil {
 				return fmt.Errorf("creating Customer Managed Key for %s: %+v", *id, err)
 			}
 			metadata.SetID(id)
+			if err := pluginsdk.SetResourceIdentityData(metadata.ResourceData, id); err != nil {
+				return err
+			}
 
 			return nil
 		},
@@ -148,23 +161,7 @@ func (r ServiceBusNamespaceCustomerManagedKeyResource) Read() sdk.ResourceFunc {
 				return fmt.Errorf("retrieving %s: %+v", *id, err)
 			}
 
-			var state ServiceBusNamespaceCustomerManagedKeyModel
-			state.NamespaceID = id.ID()
-
-			if model := resp.Model; model != nil {
-				if props := model.Properties; props != nil && props.Encryption != nil {
-					encryption := props.Encryption
-					if keyVaultProperties := encryption.KeyVaultProperties; keyVaultProperties != nil && len(*keyVaultProperties) > 0 {
-						keyVaultKeyId, err := keyvault.NewNestedItemID(pointer.From((*keyVaultProperties)[0].KeyVaultUri), keyvault.NestedItemTypeKey, pointer.From((*keyVaultProperties)[0].KeyName), pointer.From((*keyVaultProperties)[0].KeyVersion))
-						if err != nil {
-							return fmt.Errorf("parsing `key_vault_key_id`: %+v", err)
-						}
-						state.KeyVaultKeyID = keyVaultKeyId.ID()
-					}
-					state.InfrastructureEncryptionEnabled = pointer.From(encryption.RequireInfrastructureEncryption)
-				}
-			}
-			return metadata.Encode(&state)
+			return r.flatten(metadata, id, resp.Model)
 		},
 	}
 }
@@ -236,3 +233,31 @@ func (r ServiceBusNamespaceCustomerManagedKeyResource) Delete() sdk.ResourceFunc
 		},
 	}
 }
+
+func (r ServiceBusNamespaceCustomerManagedKeyResource) flatten(metadata sdk.ResourceMetaData, id *namespaces.NamespaceId, model *namespaces.SBNamespace) error {
+	state := ServiceBusNamespaceCustomerManagedKeyModel{
+		NamespaceID: id.ID(),
+	}
+
+	if model != nil {
+		if props := model.Properties; props != nil && props.Encryption != nil {
+			encryption := props.Encryption
+			if keyVaultProperties := encryption.KeyVaultProperties; keyVaultProperties != nil && len(*keyVaultProperties) > 0 {
+				keyVaultKeyId, err := keyvault.NewNestedItemID(pointer.From((*keyVaultProperties)[0].KeyVaultUri), keyvault.NestedItemTypeKey, pointer.From((*keyVaultProperties)[0].KeyName), pointer.From((*keyVaultProperties)[0].KeyVersion))
+				if err != nil {
+					return fmt.Errorf("parsing `key_vault_key_id`: %+v", err)
+				}
+
+				state.KeyVaultKeyID = keyVaultKeyId.ID()
+			}
+
+			state.InfrastructureEncryptionEnabled = pointer.From(encryption.RequireInfrastructureEncryption)
+		}
+	}
+
+	if err := pluginsdk.SetResourceIdentityData(metadata.ResourceData, id); err != nil {
+		return err
+	}
+
+	return metadata.Encode(&state)
+}

internal/services/servicebus/servicebus_namespace_customer_managed_key_resource_identity_gen_test.go

@@ -0,0 +1,38 @@
+// Copyright IBM Corp. 2014, 2025
+// SPDX-License-Identifier: MPL-2.0
+
+package servicebus_test
+
+import (
+	"testing"
+
+	"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 TestAccServicebusNamespaceCustomerManagedKey_resourceIdentity(t *testing.T) {
+	data := acceptance.BuildTestData(t, "azurerm_servicebus_namespace_customer_managed_key", "test")
+	r := ServicebusNamespaceCustomerManagedKeyResource{}
+
+	checkedFields := map[string]struct{}{
+		"name":                {},
+		"resource_group_name": {},
+		"subscription_id":     {},
+	}
+
+	data.ResourceIdentityTest(t, []acceptance.TestStep{
+		{
+			Config: r.basic(data),
+			ConfigStateChecks: []statecheck.StateCheck{
+				customstatecheck.ExpectAllIdentityFieldsAreChecked("azurerm_servicebus_namespace_customer_managed_key.test", checkedFields),
+				customstatecheck.ExpectStateContainsIdentityValueAtPath("azurerm_servicebus_namespace_customer_managed_key.test", tfjsonpath.New("name"), tfjsonpath.New("namespace_id")),
+				customstatecheck.ExpectStateContainsIdentityValueAtPath("azurerm_servicebus_namespace_customer_managed_key.test", tfjsonpath.New("resource_group_name"), tfjsonpath.New("namespace_id")),
+				customstatecheck.ExpectStateContainsIdentityValueAtPath("azurerm_servicebus_namespace_customer_managed_key.test", tfjsonpath.New("subscription_id"), tfjsonpath.New("namespace_id")),
+			},
+		},
+		data.ImportBlockWithResourceIdentityStep(false),
+		data.ImportBlockWithIDStep(false),
+	}, false)
+}

internal/services/servicebus/servicebus_namespace_customer_managed_key_resource_list.go

@@ -0,0 +1,102 @@
+// Copyright IBM Corp. 2014, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+package servicebus
+
+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/servicebus/2024-01-01/namespaces"
+	"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 ServiceBusNamespaceCustomerManagedKeyListResource struct{}
+
+var _ sdk.FrameworkListWrappedResource = new(ServiceBusNamespaceCustomerManagedKeyListResource)
+
+func (ServiceBusNamespaceCustomerManagedKeyListResource) Metadata(_ context.Context, _ resource.MetadataRequest, response *resource.MetadataResponse) {
+	response.TypeName = ServiceBusNamespaceCustomerManagedKeyResource{}.ResourceType()
+}
+
+func (ServiceBusNamespaceCustomerManagedKeyListResource) ResourceFunc() *pluginsdk.Resource {
+	return sdk.WrappedResource(ServiceBusNamespaceCustomerManagedKeyResource{})
+}
+
+func (ServiceBusNamespaceCustomerManagedKeyListResource) List(ctx context.Context, request list.ListRequest, stream *list.ListResultsStream, metadata sdk.ResourceMetadata) {
+	client := metadata.Client.ServiceBus.NamespacesClient
+
+	var data sdk.DefaultListModel
+	diags := request.Config.Get(ctx, &data)
+	if diags.HasError() {
+		stream.Results = list.ListResultsStreamDiagnostics(diags)
+		return
+	}
+
+	subscriptionID := metadata.SubscriptionId
+	if !data.SubscriptionId.IsNull() {
+		subscriptionID = data.SubscriptionId.ValueString()
+	}
+
+	var results []namespaces.SBNamespace
+	resource := ServiceBusNamespaceCustomerManagedKeyResource{}
+
+	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`", resource.ResourceType()), err)
+			return
+		}
+
+		results = resp.Items
+	default:
+		resp, err := client.ListComplete(ctx, commonids.NewSubscriptionID(subscriptionID))
+		if err != nil {
+			sdk.SetResponseErrorDiagnostic(stream, fmt.Sprintf("listing `%s`", resource.ResourceType()), err)
+			return
+		}
+
+		results = resp.Items
+	}
+
+	stream.Results = func(push func(list.ListResult) bool) {
+		for _, item := range results {
+			if item.Properties == nil || item.Properties.Encryption == nil || item.Properties.Encryption.KeyVaultProperties == nil || len(*item.Properties.Encryption.KeyVaultProperties) == 0 {
+				continue
+			}
+
+			result := request.NewListResult(ctx)
+			result.DisplayName = pointer.From(item.Name)
+
+			id, err := namespaces.ParseNamespaceID(pointer.From(item.Id))
+			if err != nil {
+				sdk.SetErrorDiagnosticAndPushListResult(result, push, "parsing Service Bus Namespace ID", err)
+				return
+			}
+
+			meta := sdk.NewResourceMetaData(metadata.Client, resource)
+			meta.SetID(id)
+
+			if err := resource.flatten(meta, id, &item); err != nil {
+				sdk.SetErrorDiagnosticAndPushListResult(result, push, fmt.Sprintf("encoding `%s` resource data", resource.ResourceType()), err)
+				return
+			}
+
+			sdk.EncodeListResult(ctx, meta.ResourceData, &result)
+			if result.Diagnostics.HasError() {
+				push(result)
+				return
+			}
+
+			if !push(result) {
+				return
+			}
+		}
+	}
+}

internal/services/servicebus/servicebus_namespace_customer_managed_key_resource_list_test.go

@@ -0,0 +1,87 @@
+// Copyright IBM Corp. 2014, 2026
+// SPDX-License-Identifier: MPL-2.0
+
+package servicebus_test
+
+import (
+	"context"
+	"fmt"
+	"regexp"
+	"strconv"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-plugin-testing/knownvalue"
+	"github.com/hashicorp/terraform-plugin-testing/querycheck"
+	"github.com/hashicorp/terraform-plugin-testing/tfversion"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/provider/framework"
+)
+
+func TestAccServicebusNamespaceCustomerManagedKey_list(t *testing.T) {
+	data := acceptance.BuildTestData(t, "azurerm_servicebus_namespace_customer_managed_key", "testlist")
+	r := ServicebusNamespaceCustomerManagedKeyResource{}
+
+	resource.Test(t, resource.TestCase{
+		TerraformVersionChecks: []tfversion.TerraformVersionCheck{
+			tfversion.SkipBelow(tfversion.Version1_14_0),
+		},
+		ProtoV5ProviderFactories: framework.ProtoV5ProviderFactoriesInit(context.Background(), "azurerm"),
+		Steps: []resource.TestStep{
+			{
+				Config: r.basic(data),
+			},
+			{
+				Query:  true,
+				Config: r.basicListQuery(),
+				QueryResultChecks: []querycheck.QueryResultCheck{
+					querycheck.ExpectLengthAtLeast("azurerm_servicebus_namespace_customer_managed_key.list", 1),
+					querycheck.ExpectIdentity(
+						"azurerm_servicebus_namespace_customer_managed_key.list",
+						map[string]knownvalue.Check{
+							"name":                knownvalue.StringRegexp(regexp.MustCompile(strconv.Itoa(data.RandomInteger))),
+							"resource_group_name": knownvalue.StringRegexp(regexp.MustCompile(strconv.Itoa(data.RandomInteger))),
+							"subscription_id":     knownvalue.StringExact(data.Subscriptions.Primary),
+						},
+					),
+				},
+			},
+			{
+				Query:  true,
+				Config: r.basicListQueryByResourceGroupName(data),
+				QueryResultChecks: []querycheck.QueryResultCheck{
+					querycheck.ExpectLength("azurerm_servicebus_namespace_customer_managed_key.list", 1),
+					querycheck.ExpectIdentity(
+						"azurerm_servicebus_namespace_customer_managed_key.list",
+						map[string]knownvalue.Check{
+							"name":                knownvalue.StringRegexp(regexp.MustCompile(strconv.Itoa(data.RandomInteger))),
+							"resource_group_name": knownvalue.StringRegexp(regexp.MustCompile(strconv.Itoa(data.RandomInteger))),
+							"subscription_id":     knownvalue.StringExact(data.Subscriptions.Primary),
+						},
+					),
+				},
+			},
+		},
+	})
+}
+
+func (r ServicebusNamespaceCustomerManagedKeyResource) basicListQuery() string {
+	return `
+list "azurerm_servicebus_namespace_customer_managed_key" "list" {
+  provider = azurerm
+  config {}
+}
+`
+}
+
+func (r ServicebusNamespaceCustomerManagedKeyResource) basicListQueryByResourceGroupName(data acceptance.TestData) string {
+	return fmt.Sprintf(`
+list "azurerm_servicebus_namespace_customer_managed_key" "list" {
+  provider = azurerm
+  config {
+    subscription_id     = "%s"
+    resource_group_name = "acctest-sb-%d"
+  }
+}
+`, data.Subscriptions.Primary, data.RandomInteger)
+}

website/docs/list-resources/servicebus_namespace_customer_managed_key.html.markdown

@@ -0,0 +1,41 @@
+---
+subcategory: "Messaging"
+layout: "azurerm"
+page_title: "Azure Resource Manager: azurerm_servicebus_namespace_customer_managed_key"
+description: |-
+  Lists Service Bus Namespace Customer Managed Key resources.
+---
+
+# List resource: azurerm_servicebus_namespace_customer_managed_key
+
+Lists Service Bus Namespace Customer Managed Key resources.
+
+## Example Usage
+
+### List all Service Bus Namespace Customer Managed Keys in the subscription
+
+```hcl
+list "azurerm_servicebus_namespace_customer_managed_key" "example" {
+  provider = azurerm
+  config {}
+}
+```
+
+### List all Service Bus Namespace Customer Managed Keys in a specific resource group
+
+```hcl
+list "azurerm_servicebus_namespace_customer_managed_key" "example" {
+  provider = azurerm
+  config {
+    resource_group_name = "example-rg"
+  }
+}
+```
+
+## Argument Reference
+
+This list resource supports the following arguments:
+
+* `resource_group_name` - (Optional) The name of the resource group to query.
+
+* `subscription_id` - (Optional) The Subscription ID to query. Defaults to the value specified in the Provider Configuration.