Skip to content

Commit f8ccc4a

Browse files
storage_discovery_workspace: update docs to match Azure docs and resource style
1 parent e1b08cf commit f8ccc4a

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

website/docs/r/storage_discovery_workspace.html.markdown

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ subcategory: "Storage"
33
layout: "azurerm"
44
page_title: "Azure Resource Manager: azurerm_storage_discovery_workspace"
55
description: |-
6-
Manages a Storage Discovery Workspace.
6+
Manages a Storage Discovery workspace.
77
---
88

99
# azurerm_storage_discovery_workspace
1010

11-
Manages a Storage Discovery Workspace.
11+
Manages a Storage Discovery workspace. A workspace defines which storage resources to scan across your Microsoft Entra tenant and how to segment reporting for them.
1212

1313
## Example Usage
1414

@@ -48,23 +48,23 @@ resource "azurerm_storage_discovery_workspace" "example" {
4848

4949
The following arguments are supported:
5050

51-
* `name` - (Required) The name of the Storage Discovery Workspace. Changing this forces a new resource to be created.
51+
* `name` - (Required) Specifies the name of the Discovery workspace. Must be 4-64 characters long, start with a letter, and contain only letters, numbers, and hyphens (no consecutive hyphens). Changing this forces a new resource to be created.
5252

53-
* `resource_group_name` - (Required) The name of the Resource Group where the Storage Discovery Workspace should exist. Changing this forces a new resource to be created.
53+
* `resource_group_name` - (Required) Specifies the name of the Resource Group where the Storage Discovery Workspace should exist. Changing this forces a new resource to be created.
5454

55-
* `location` - (Required) The Azure Region where the Storage Discovery Workspace should exist. Changing this forces a new resource to be created.
55+
* `location` - (Required) Specifies the Azure Region where the Discovery resource is created. Changing this forces a new resource to be created.
5656

57-
* `workspace_root` - (Required) A set of Azure Resource IDs that define the root scope for storage discovery. Each ID can be either a Subscription ID or a Resource Group ID. You cannot specify both a subscription and its child resource group. Maximum of 100 items.
57+
* `workspace_root` - (Required) A set of top-level Azure resource identifiers (Subscription IDs or Resource Group IDs) where Storage Discovery initiates its scan for storage accounts. You cannot specify both a subscription and its child resource group. Maximum of 100 items.
5858

59-
* `scopes` - (Required) One or more `scopes` blocks as defined below.
59+
-> **Note:** The user or service principal must have at least Reader access (`Microsoft.Storage/storageAccounts/read`) on each specified root. The default limit of 100 can be increased by contacting Azure Support.
6060

61-
---
61+
* `scopes` - (Required) One or more `scopes` blocks as defined below.
6262

63-
* `description` - (Optional) A description for the Storage Discovery Workspace.
63+
* `description` - (Optional) A description for the Discovery workspace resource.
6464

65-
* `sku` - (Optional) The SKU for the Storage Discovery Workspace. Possible values are `Free` and `Standard`. Defaults to `Standard`.
65+
* `sku` - (Optional) Specifies the Storage Discovery pricing plan. Possible values are `Free` and `Standard`. Defaults to `Standard`. See [Understand Storage Discovery Pricing](https://learn.microsoft.com/azure/storage-discovery/understand-pricing) for details.
6666

67-
* `tags` - (Optional) A mapping of tags to assign to the resource.
67+
* `tags` - (Optional) A mapping of tags which should be assigned to the resource.
6868

6969
---
7070

@@ -84,6 +84,8 @@ In addition to the Arguments listed above - the following Attributes are exporte
8484

8585
* `id` - The ID of the Storage Discovery Workspace.
8686

87+
-> **Note:** It can take up to 24 hours after workspace creation for metrics to begin appearing in reports.
88+
8789
## Timeouts
8890

8991
The `timeouts` block allows you to specify [timeouts](https://developer.hashicorp.com/terraform/language/resources/configure#define-operation-timeouts) for certain actions:

0 commit comments

Comments
 (0)