|
1 | 1 | ---
|
2 |
| -title: Create and manage a storage discovery workspace |
| 2 | +title: Create and manage an Azure Storage Discovery Workspace |
3 | 3 | titleSuffix: Azure Storage Discovery
|
4 |
| -description: Learn how to create a discovery workspace. |
5 |
| -author: pthippeswamy |
6 |
| -ms.service: azure-storage-mover |
7 |
| -ms.topic: how-to |
8 |
| -ms.author: shaas |
9 |
| -ms.date: 08/01/2025 |
| 4 | +description: Learn how to create an Azure Storage Discovery Workspace. |
| 5 | +author: fauhse |
| 6 | + |
| 7 | +ms.service: azure-storage-discovery |
| 8 | +ms.topic: overview |
| 9 | +ms.date: 07/22/2025 |
| 10 | +ms.author: fauhse |
10 | 11 | ---
|
11 | 12 |
|
| 13 | +<!-- |
| 14 | +!######################################################## |
| 15 | +STATUS: DRAFT |
| 16 | +
|
| 17 | +CONTENT: IN PROGRESS |
| 18 | +
|
| 19 | +REVIEW Stephen/Fabian: IN PROGRESS |
| 20 | +EDIT PASS: IN PROGRESS |
| 21 | +
|
| 22 | +Document score: 100 - 495/0 (words, issues) |
| 23 | +
|
| 24 | +!######################################################## |
| 25 | +--> |
| 26 | + |
12 | 27 | # Create and manage a storage discovery workspace
|
13 | 28 |
|
14 |
| -The Azure Storage Discovery Workspace (ASDW) is a central resource within the Azure Storage Discovery platform designed to help users manage and visualize storage data across various scopes—such as tenants, subscriptions, and resource groups. |
| 29 | +The Azure Storage Discovery Workspace (ASDW) is a central resource within the Azure Storage Discovery platform. A discovery workspace is designed to help users manage and visualize storage data across various scopes such as tenants, subscriptions, and resource groups. |
| 30 | + |
| 31 | +Follow the steps in this article to create an ASDW resource. |
15 | 32 |
|
16 |
| -This article helps you create an ASDW resource. |
| 33 | +## Create a storage discovery workspace |
17 | 34 |
|
18 |
| -## Create an ASDW from Azure portal |
| 35 | +You can create a storage discovery workspace using the Azure portal, Azure CLI, or ARM templates. |
19 | 36 |
|
20 |
| -Click on **Create** |
| 37 | +### [Azure portal](#tab/portal) |
21 | 38 |
|
22 |
| -> [!div class="mx-imgBorder"] |
23 |
| ->  |
| 39 | +Create an ASDW resource by selecting **Create** as shown in the following image. |
24 | 40 |
|
25 |
| -Choose a **Subscription** and **Resource group** to create the discovery workspace |
| 41 | +:::image source="media/create-workspace/create-resource-sml.png" alt-text="Screenshot of the Create ASDW page." lightbox="media/create-workspace/create-resource.png"::: |
26 | 42 |
|
27 |
| -The following table describes each element. |
| 43 | +Choose the **Subscription** and **Resource group** in which to create the discovery workspace. The following table describes each element. |
28 | 44 |
|
29 |
| -| Element | Description | |
30 |
| -|---|--| |
31 |
| -| `Name` | The name of the Discovery workspace resource. | |
32 |
| -| `Description` | Optional. Description of the Discovery workspace resource. | |
33 |
| -| `Region` | Azure region where the Discovery resource is created.<sup>1</sup>| |
34 |
| -| `Pricing plan` | Storage Discovery pricing plan.<sup>2</sup>| |
| 45 | +| Element | Description | |
| 46 | +|----------------|-------------------------------------------------------------------| |
| 47 | +| `Name` | The name of the Discovery workspace resource. | |
| 48 | +| `Description` | Optional. Description of the Discovery workspace resource. | |
| 49 | +| `Region` | Azure region where the Discovery resource is created.<sup>1</sup> | |
| 50 | +| `Pricing plan` | Storage Discovery pricing plan.<sup>2</sup> | |
35 | 51 |
|
36 | 52 | <sup>1</sup> For information on regions covered, see [Storage Discovery workspace regions](deployment-planning.md).
|
37 | 53 | <sup>2</sup> For information on Storage Discovery pricing plan, see [Understand Storage Discovery Pricing](pricing.md).
|
38 | 54 |
|
39 |
| -### Define workspace root |
40 |
| -Workspace root specifies the top-level Azure resource identifiers - such as subscriptions or resource groups - where Storage Discovery initiates its scan for storage accounts. These identifiers serve as the root of the discovery process, defining the overall scope and boundaries of your Azure estate that is analyzed. Select the subscriptions and/or resource groups that need to be included in the workspace. |
| 55 | +## Define workspaceRoots |
| 56 | + |
| 57 | +A workspaceRoot specifies the top-level Azure resource identifiers where Storage Discovery initiates its scan for storage accounts. These identifiers are typically subscriptions or resource groups, and serve as the root of the discovery process. WorkspaceRoots define the overall scope and boundaries of your Azure estate for analysis. |
| 58 | + |
| 59 | +Select the subscriptions and/or resource groups you want to include in the workspace. |
41 | 60 |
|
42 | 61 | > [!NOTE]
|
43 |
| -> - Ensure that the user or service principal deploying the workspace has at least **Reader** access to each specified resource. |
44 |
| -> - Up to 100 resources - subscriptions and/or resource groups can be included in one Discovery workspace. |
| 62 | +> - Ensure that the user or service principal deploying the workspace is granted at least **Reader** access to each specified root. |
| 63 | +> - Up to 100 resources - subscriptions and/or resource groups can be included in one ASDW. |
| 64 | +
|
| 65 | +:::image source="media/create-workspace/workspace-roots-checks-sml.png" alt-text="Screenshot of the workspaceRoots." lightbox="media/create-workspace/workspace-roots-checks.png"::: |
45 | 66 |
|
46 |
| -> [!div class="mx-imgBorder"] |
47 |
| ->  |
| 67 | +After you add your subscriptions, resource groups, or tenant to your workspace, the service runs an access check to verify that the user has `Microsoft.Storage/storageAccounts/read` on the added resources. The following image provides an example of an access check failure with the associated status message. |
48 | 68 |
|
49 |
| -Once the subscriptions, resource groups or tenant is added to the workspace, an access check is run to verify if the user has Microsoft.Storage/storageAccounts/read on the added resources. As the checks are running, status of the run is as shown: |
| 69 | +:::image source="media/create-workspace/create-access-sml.png" alt-text="Screenshot of the access check on workspaceRoots." lightbox="media/create-workspace/create-access.png"::: |
50 | 70 |
|
51 |
| -If you do not have Microsoft.Storage/storageAccounts/read on any of the resources added, remove the resource from the workSpace root to proceed with the creation of workspace or resolve the access issue and try again. |
| 71 | +If you don't have `Microsoft.Storage/storageAccounts/read` on any of the resources added, remove the resource from the workSpaceRoots to proceed with the creation of workspace or resolve the access issue and try again. |
52 | 72 |
|
53 |
| -### Create Scope |
54 |
| -Scopes are logical groupings of storage accounts within the defined workspace root. They allow you to filter and organize data using tags and resource types. Scope enables targeted insights - you can create scopes for different departments, environments, or compliance zones. |
| 73 | +## Create a Scope |
| 74 | +Scopes are logical groupings of storage accounts within the defined workspaceRoots. Scopes allow you to filter and organize data using tags and resource types, enabling targeted insights. For example, you can create scopes for individual departments, environments, or compliance zones. |
55 | 75 |
|
56 |
| -> [!div class="mx-imgBorder"] |
57 |
| ->  |
| 76 | +:::image source="media/create-workspace/create-scope-sml.png" alt-text="Screenshot of a scope." lightbox="media/create-workspace/create-scope.png"::: |
58 | 77 |
|
59 | 78 | > [!IMPORTANT]
|
60 |
| -> **Default Scope** is added automatically, which would include all storage accounts within the subscriptions or resource groups added in the **workspace root** |
| 79 | +> A **default Scope** is added automatically, which includes all storage accounts within subscriptions or resource groups added in the **workspaceRoots**. |
61 | 80 |
|
62 |
| -Add tags, if needed on the ASDW resource and click on Review and Create. |
| 81 | +Add tags on the ASDW resource, if needed, and select **Review and Create**. You aren't able to deploy the resource until an access validation is complete. If the check for the workspaceRoots resources isn't complete, a message is displayed. |
63 | 82 |
|
64 |
| -If the access check for the workspace root resources hasn’t finished yet, the Review and Create tab shows a message saying the check is still in progress. You won’t be able to deploy the resource until the check is complete. |
| 83 | +:::image source="media/create-workspace/access-check-sml.png" alt-text="Screenshot of access checks running." lightbox="media/create-workspace/access-check.png"::: |
65 | 84 |
|
66 | 85 | > [!NOTE]
|
67 |
| -> Note that Discovery resource creation fails if the access checks on any added subscription or resource group or tenant is not successful. |
| 86 | +> Discovery resource creation fails if the access checks on any subscription, resource group, or tenant isn't successful. |
68 | 87 |
|
69 |
| -When the access checks complete successfully, resource can be deployed. |
| 88 | +After the access checks complete successfully, the resource can be deployed as shown in the following sample image. |
| 89 | + |
| 90 | +:::image source="media/create-workspace/deploy-resource-sml.png" alt-text="Screenshot of the deployment complete." lightbox="media/create-workspace/deploy-resource.png"::: |
| 91 | + |
| 92 | +### [Azure PowerShell](#tab/powershell) |
| 93 | + |
| 94 | +Something like this: |
| 95 | + |
| 96 | +```powershell |
| 97 | +
|
| 98 | +# Set variables for the resources |
| 99 | +$resGroupName = "MyResourceGroup" |
| 100 | +$workSpaceName = "MyStorageDiscoveryWorkspace" |
| 101 | +$location = "East US" |
| 102 | +$DiscoveryScopeLevel1 = "MyScopeLevel1" |
| 103 | +$DiscoveryScopeLevel2 = "MyScopeLevel2" |
| 104 | +
|
| 105 | +# First, prepare local DiscoveryScope object, which can be used to |
| 106 | +# both create/update Workspace |
| 107 | +$scope1 = New-AzStorageDiscoveryScopeObject -DisplayName "test1" ` |
| 108 | + -ResourceType "Microsoft.Storage/storageAccounts" ` |
| 109 | + -TagKeysOnly "e2etest1" -Tag @{"tag1" = "value1"; "tag2" = "value2" } |
| 110 | +$scope2 = New-AzStorageDiscoveryScopeObject -DisplayName "test2" ` |
| 111 | + -ResourceType "Microsoft.Storage/storageAccounts" ` |
| 112 | + -TagKeysOnly "e2etest2" -Tag @{"tag3" = "value3" } |
| 113 | +
|
| 114 | +# CVreate the discovery workspace |
| 115 | +New-AzStorageDiscoveryWorkspace -Name $workSpaceName -ResourceGroupName $resGroupName ` |
| 116 | +-Location $location -Description 123 -WorkspaceRoot $DiscoveryScopeLevel1 ` |
| 117 | +-Sku Standard -Scope $scope1 # -debug |
| 118 | +
|
| 119 | +``` |
| 120 | + |
| 121 | +--- |
70 | 122 |
|
71 | 123 | > [!NOTE]
|
72 |
| -> Note that it will take up to 24 hours for the metrics to start appearing in the Reports after the scope is created. |
| 124 | +> It can take up to 24 hours after scope creation for metrics to begin appearing in reports. |
0 commit comments