New Data Source: azurerm_storage_containers

.github/labeler-issue-triage.yml

@@ -319,7 +319,7 @@ service/sql:
   - '### (|New or )Affected Resource\(s\)\/Data Source\(s\)((.|\n)*)azurerm_sql_((.|\n)*)###'
 
 service/storage:
-  - '### (|New or )Affected Resource\(s\)\/Data Source\(s\)((.|\n)*)azurerm_(storage_account\W+|storage_account_blob_container_sas\W+|storage_account_customer_managed_key\W+|storage_account_local_user\W+|storage_account_network_rules\W+|storage_account_sas\W+|storage_blob\W+|storage_blob_inventory_policy\W+|storage_container\W+|storage_data_lake_gen2_filesystem\W+|storage_data_lake_gen2_path\W+|storage_encryption_scope\W+|storage_management_policy\W+|storage_object_replication\W+|storage_queue\W+|storage_share\W+|storage_share_directory\W+|storage_share_file\W+|storage_sync\W+|storage_sync_cloud_endpoint\W+|storage_sync_group\W+|storage_table\W+|storage_table_entity\W+)((.|\n)*)###'
+  - '### (|New or )Affected Resource\(s\)\/Data Source\(s\)((.|\n)*)azurerm_(storage_account\W+|storage_account_blob_container_sas\W+|storage_account_customer_managed_key\W+|storage_account_local_user\W+|storage_account_network_rules\W+|storage_account_sas\W+|storage_blob\W+|storage_blob_inventory_policy\W+|storage_container\W+|storage_containers\W+|storage_data_lake_gen2_filesystem\W+|storage_data_lake_gen2_path\W+|storage_encryption_scope\W+|storage_management_policy\W+|storage_object_replication\W+|storage_queue\W+|storage_share\W+|storage_share_directory\W+|storage_share_file\W+|storage_sync\W+|storage_sync_cloud_endpoint\W+|storage_sync_group\W+|storage_table\W+|storage_table_entity\W+)((.|\n)*)###'
 
 service/storagemover:
   - '### (|New or )Affected Resource\(s\)\/Data Source\(s\)((.|\n)*)azurerm_storage_mover((.|\n)*)###'

internal/services/storage/registration.go

@@ -72,7 +72,9 @@ func (r Registration) SupportedResources() map[string]*pluginsdk.Resource {
 }
 
 func (r Registration) DataSources() []sdk.DataSource {
-	return []sdk.DataSource{}
+	return []sdk.DataSource{
+		storageContainersDataSource{},
+	}
 }
 
 func (r Registration) Resources() []sdk.Resource {

internal/services/storage/storage_containers_data_source.go

@@ -0,0 +1,141 @@
+package storage
+
+import (
+	"context"
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-01-01/blobcontainers"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/services/storage/parse"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
+)
+
+type storageContainersDataSource struct{}
+
+var _ sdk.DataSource = storageContainersDataSource{}
+
+type storageContainersDataSourceModel struct {
+	StorageAccountId string           `tfschema:"storage_account_id"`
+	NamePrefix       string           `tfschema:"name_prefix"`
+	Containers       []containerModel `tfschema:"containers"`
+}
+
+type containerModel struct {
+	Name              string `tfschema:"name"`
+	DataPlaneId       string `tfschema:"data_plane_id"`
+	ResourceManagerId string `tfschema:"resource_manager_id"`
+}
+
+func (r storageContainersDataSource) Arguments() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"storage_account_id": {
+			Type:         pluginsdk.TypeString,
+			Required:     true,
+			ValidateFunc: commonids.ValidateStorageAccountID,
+		},
+		"name_prefix": {
+			Type:         pluginsdk.TypeString,
+			Optional:     true,
+			ValidateFunc: validation.StringIsNotEmpty,
+		},
+	}
+}
+
+func (r storageContainersDataSource) Attributes() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"containers": {
+			Type:     pluginsdk.TypeList,
+			Computed: true,
+			Elem: &pluginsdk.Resource{
+				Schema: map[string]*pluginsdk.Schema{
+					"name": {
+						Type:     pluginsdk.TypeString,
+						Computed: true,
+					},
+					"data_plane_id": {
+						Type:     pluginsdk.TypeString,
+						Computed: true,
+					},
+					"resource_manager_id": {
+						Type:     pluginsdk.TypeString,
+						Computed: true,
+					},
+				},
+			},
+		},
+	}
+}
+
+func (r storageContainersDataSource) ResourceType() string {
+	return "azurerm_storage_containers"
+}
+
+func (r storageContainersDataSource) ModelObject() interface{} {
+	return &storageContainersDataSourceModel{}
+}
+
+func (r storageContainersDataSource) Read() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 5 * time.Minute,
+
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.Storage.ResourceManager.BlobContainers
+
+			var plan storageContainersDataSourceModel
+			if err := metadata.Decode(&plan); err != nil {
+				return fmt.Errorf("decoding %+v", err)
+			}
+
+			id, err := commonids.ParseStorageAccountID(plan.StorageAccountId)
+			if err != nil {
+				return err
+			}
+
+			resp, err := client.ListCompleteMatchingPredicate(ctx, *id, blobcontainers.DefaultListOperationOptions(), blobcontainers.ListContainerItemOperationPredicate{})
+			if err != nil {
+				return fmt.Errorf("retrieving %s: %+v", id, err)
+			}
+
+			plan.Containers = flattenStorageContainersContainers(resp.Items, id.StorageAccountName, metadata.Client.Storage.Environment.StorageEndpointSuffix, plan.NamePrefix)
+
+			if err := metadata.Encode(&plan); err != nil {
+				return fmt.Errorf("encoding %s: %+v", id, err)
+			}
+
+			metadata.SetID(id)
+
+			return nil
+		},
+	}
+}
+
+func flattenStorageContainersContainers(l []blobcontainers.ListContainerItem, accountName, endpointSuffix, prefix string) []containerModel {
+	var output []containerModel
+	for _, item := range l {
+		var name string
+		if item.Name != nil {
+			name = *item.Name
+		}
+
+		if prefix != "" && !strings.HasPrefix(name, prefix) {
+			continue
+		}
+
+		var mgmtId string
+		if item.Id != nil {
+			mgmtId = *item.Id
+		}
+
+		output = append(output, containerModel{
+			Name:              name,
+			ResourceManagerId: mgmtId,
+			DataPlaneId:       parse.NewStorageContainerDataPlaneId(accountName, endpointSuffix, name).ID(),
+		})
+	}
+
+	return output
+}

internal/services/storage/storage_containers_data_source_test.go

@@ -0,0 +1,104 @@
+package storage_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check"
+)
+
+type storageContainersDataSource struct{}
+
+func TestAccDataSourceStorageContainers_basic(t *testing.T) {
+	data := acceptance.BuildTestData(t, "data.azurerm_storage_containers", "test")
+	d := storageContainersDataSource{}
+
+	data.DataSourceTest(t, []resource.TestStep{
+		{
+			Config: d.basic(data, "null"),
+			Check: resource.ComposeTestCheckFunc(
+				check.That(data.ResourceName).Key("containers.#").HasValue("2"),
+				check.That(data.ResourceName).Key("containers.0.name").HasValue("test1"),
+				check.That(data.ResourceName).Key("containers.0.resource_manager_id").HasValue(
+					fmt.Sprintf("/subscriptions/%s/resourceGroups/acctestRG-%d/providers/Microsoft.Storage/storageAccounts/acctestacc%s/blobServices/default/containers/test1",
+						data.Client().SubscriptionID, data.RandomInteger, data.RandomString),
+				),
+				check.That(data.ResourceName).Key("containers.0.data_plane_id").HasValue(
+					fmt.Sprintf("https://acctestacc%s.blob.core.windows.net/test1", data.RandomString),
+				),
+				check.That(data.ResourceName).Key("containers.1.name").HasValue("test2"),
+				check.That(data.ResourceName).Key("containers.1.resource_manager_id").HasValue(
+					fmt.Sprintf("/subscriptions/%s/resourceGroups/acctestRG-%d/providers/Microsoft.Storage/storageAccounts/acctestacc%s/blobServices/default/containers/test2",
+						data.Client().SubscriptionID, data.RandomInteger, data.RandomString),
+				),
+				check.That(data.ResourceName).Key("containers.1.data_plane_id").HasValue(
+					fmt.Sprintf("https://acctestacc%s.blob.core.windows.net/test2", data.RandomString),
+				),
+			),
+		},
+	})
+}
+
+func TestAccDataSourceStorageContainers_prefix(t *testing.T) {
+	data := acceptance.BuildTestData(t, "data.azurerm_storage_containers", "test")
+	d := storageContainersDataSource{}
+
+	data.DataSourceTest(t, []resource.TestStep{
+		{
+			Config: d.basic(data, `"test1"`),
+			Check: resource.ComposeTestCheckFunc(
+				check.That(data.ResourceName).Key("containers.#").HasValue("1"),
+				check.That(data.ResourceName).Key("containers.0.name").HasValue("test1"),
+				check.That(data.ResourceName).Key("containers.0.resource_manager_id").HasValue(
+					fmt.Sprintf("/subscriptions/%s/resourceGroups/acctestRG-%d/providers/Microsoft.Storage/storageAccounts/acctestacc%s/blobServices/default/containers/test1",
+						data.Client().SubscriptionID, data.RandomInteger, data.RandomString),
+				),
+				check.That(data.ResourceName).Key("containers.0.data_plane_id").HasValue(
+					fmt.Sprintf("https://acctestacc%s.blob.core.windows.net/test1", data.RandomString),
+				),
+			),
+		},
+	})
+}
+
+func (d storageContainersDataSource) basic(data acceptance.TestData, prefix string) string {
+	return fmt.Sprintf(`
+provider "azurerm" {
+  features {}
+}
+
+resource "azurerm_resource_group" "test" {
+  name     = "acctestRG-%d"
+  location = "%s"
+}
+
+resource "azurerm_storage_account" "test" {
+  name                            = "acctestacc%s"
+  resource_group_name             = azurerm_resource_group.test.name
+  location                        = azurerm_resource_group.test.location
+  account_tier                    = "Standard"
+  account_replication_type        = "LRS"
+  allow_nested_items_to_be_public = true
+}
+
+resource "azurerm_storage_container" "test1" {
+  name                  = "test1"
+  storage_account_name  = azurerm_storage_account.test.name
+  container_access_type = "private"
+}
+
+resource "azurerm_storage_container" "test2" {
+  name                  = "test2"
+  storage_account_name  = azurerm_storage_account.test.name
+  container_access_type = "private"
+}
+
+data "azurerm_storage_containers" "test" {
+  storage_account_id = azurerm_storage_account.test.id
+  name_prefix        = %s
+  depends_on         = [azurerm_storage_container.test1, azurerm_storage_container.test2]
+}
+`, data.RandomInteger, data.Locations.Primary, data.RandomString, prefix)
+}

website/docs/d/storage_containers.html.markdown

@@ -0,0 +1,57 @@
+---
+subcategory: "Storage"
+layout: "azurerm"
+page_title: "Azure Resource Manager: Data Source: azurerm_storage_containers"
+description: |-
+  Gets information about an existing Storage Containers.
+---
+
+# Data Source: azurerm_storage_containers
+
+Use this data source to access information about the existing Storage Containers within a Storage Account.
+
+## Example Usage
+
+```hcl
+data "azurerm_storage_containers" "example" {
+  storage_account_id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/sa1"
+}
+
+output "container_id" {
+  value = data.azurerm_storage_containers.example.containers.0.resource_manager_id
+}
+```
+
+## Arguments Reference
+
+The following arguments are supported:
+
+* `storage_account_id` - (Required) The ID of the Storage Account that the Storage Containers reside in.
+
+---
+
+* `name_prefix` - (Optional) A prefix match used for the Storage Container `name` field.
+
+## Attributes Reference
+
+In addition to the Arguments listed above - the following Attributes are exported: 
+
+* `id` - The ID of the Storage Containers.
+
+* `containers` - A `containers` block as defined below.
+
+---
+
+A `containers` block exports the following:
+
+* `data_plane_id` - The data plane ID of the Storage Container.
+
+* `name` - The name of this Storage Container.
+
+* `resource_manager_id` - The resource manager ID of the Storage Container.
+
+## 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 Storage Containers.