Skip to content

Commit a2e73c3

Browse files
committed
update README and examples
1 parent 69afede commit a2e73c3

6 files changed

Lines changed: 59 additions & 6 deletions

File tree

src/storage-discovery/README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,55 @@
22
This is an extension to Azure CLI to manage StorageDiscovery resources.
33

44
## How to use ##
5-
Please add commands usage here.
5+
### az storage-discovery workspace create ###
6+
```commandline
7+
az storage-discovery workspace create \
8+
--resource-group myRG \
9+
--name myWorkspace \
10+
--location francecentral \
11+
--workspace-roots "/subscriptions/mySubId/resourceGroups/myRG" \
12+
--scopes '[{"displayName":"basic","resourceTypes":["Microsoft.Storage/storageAccounts"]}]'
13+
```
14+
15+
### az storage-discovery workspace create (with full configuration) ###
16+
```commandline
17+
az storage-discovery workspace create \
18+
--resource-group myRG \
19+
--name myWorkspace \
20+
--location francecentral \
21+
--description "My workspace for storage discovery" \
22+
--sku Standard \
23+
--workspace-roots "/subscriptions/mySubId/resourceGroups/myRG" \
24+
--scopes '[{"displayName":"production","resourceTypes":["Microsoft.Storage/storageAccounts"],"tagKeysOnly":["environment"],"tags":{"project":"demo","tier":"prod"}}]'
25+
```
26+
27+
### az storage-discovery workspace show ###
28+
```commandline
29+
az storage-discovery workspace show --resource-group myRG --name myWorkspace
30+
```
31+
32+
### az storage-discovery workspace update ###
33+
```commandline
34+
az storage-discovery workspace update \
35+
--resource-group myRG \
36+
--name myWorkspace \
37+
--description "Updated description" \
38+
--sku Free \
39+
--scopes '[{"displayName":"updated","resourceTypes":["Microsoft.Storage/storageAccounts"],"tags":{"environment":"test"}}]' \
40+
--tags environment=production team=storage
41+
```
42+
43+
### az storage-discovery workspace list ###
44+
```commandline
45+
az storage-discovery workspace list --resource-group myRG
46+
```
47+
48+
### az storage-discovery workspace list (subscription level) ###
49+
```commandline
50+
az storage-discovery workspace list
51+
```
52+
53+
### az storage-discovery workspace delete ###
54+
```commandline
55+
az storage-discovery workspace delete --resource-group myRG --name myWorkspace
56+
```

src/storage-discovery/azext_storage_discovery/aaz/latest/storage_discovery/workspace/_create.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@
1818
class Create(AAZCommand):
1919
"""Create a StorageDiscoveryWorkspace
2020
21-
:example: Create StorageDiscoveryWorkspace
22-
az storage-discovery workspace create --resource-group sample-rg --storage-discovery-workspace-name Sample-Storage-Workspace --location westeurope --tags "{tag1:value1,tag2:value2}" --workspace-roots "[/subscriptions/b79cb3ba-745e-5d9a-8903-4a02327a7e09]" --description Sample Storage Discovery Workspace --scopes "[{display-name:Sample-Collection,resource-types:[/subscriptions/b79cb3ba-745e-5d9a-8903-4a02327a7e09/resourceGroups/sample-rg/providers/Microsoft.Storage/storageAccounts/sample-storageAccount],tag-keys-only:[filterTag1,filterTag2],tags:{filterTag3:value3,filterTag4:value4}},{display-name:Sample-Collection-2,resource-types:[/subscriptions/b79cb3ba-745e-5d9a-8903-4a02327a7e09/resourceGroups/sample-rg/providers/Microsoft.Storage/storageAccounts/sample-storageAccount],tag-keys-only:[filterTag5],tags:{filterTag6:value6}}]"
21+
:example: Create or Update a StorageDiscoveryWorkspace
22+
az az storage-discovery workspace create --resource-group myRG --name myWorkspace --location francecentral --workspace-roots "/subscriptions/mySubId/resourceGroups/myRG" --scopes '[{"displayName":"basic","resourceTypes":["Microsoft.Storage/storageAccounts"]}]'
23+
az storage-discovery workspace create --resource-group myRG --name myWorkspace --location francecentral --description "My workspace for storage discovery" --sku Standard --workspace-roots "/subscriptions/mySubId/resourceGroups/myRG" --scopes '[{"displayName":"production","resourceTypes":["Microsoft.Storage/storageAccounts"],"tagKeysOnly":["environment"],"tags":{"project":"demo","tier":"prod"}}]'
2324
"""
2425

2526
_aaz_info = {

src/storage-discovery/azext_storage_discovery/aaz/latest/storage_discovery/workspace/_delete.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class Delete(AAZCommand):
2020
"""Delete a StorageDiscoveryWorkspace
2121
2222
:example: Delete a StorageDiscoveryWorkspace
23-
az storage-discovery workspace delete --resource-group sample-rg --storage-discovery-workspace-name sampleworkspace
23+
az storage-discovery workspace delete --resource-group myRG --name myWorkspace
2424
"""
2525

2626
_aaz_info = {

src/storage-discovery/azext_storage_discovery/aaz/latest/storage_discovery/workspace/_list.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ class List(AAZCommand):
2020
2121
:example: List StorageDiscoveryWorkspaces by Subscription
2222
az storage-discovery workspace list
23+
az storage-discovery workspace list --resource-group myRG
2324
"""
2425

2526
_aaz_info = {

src/storage-discovery/azext_storage_discovery/aaz/latest/storage_discovery/workspace/_show.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Show(AAZCommand):
1919
"""Get a StorageDiscoveryWorkspace
2020
2121
:example: Get a StorageDiscoveryWorkspace
22-
az storage-discovery workspace show --resource-group sample-rg --storage-discovery-workspace-name Sample-Storage-Workspace
22+
az storage-discovery workspace show --resource-group myRG --name myWorkspace
2323
"""
2424

2525
_aaz_info = {

src/storage-discovery/azext_storage_discovery/aaz/latest/storage_discovery/workspace/_update.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Update(AAZCommand):
1919
"""Update a StorageDiscoveryWorkspace
2020
2121
:example: Update a StorageDiscoveryWorkspace
22-
az storage-discovery workspace update --resource-group sample-rg --storage-discovery-workspace-name Sample-Storage-Workspace --location westeurope --tags "{tag1:value1,tag2:value2}" --workspace-roots "[/subscriptions/b79cb3ba-745e-5d9a-8903-4a02327a7e09]" --description Sample Storage Discovery Workspace --scopes "[{display-name:Sample-Collection,resource-types:[/subscriptions/b79cb3ba-745e-5d9a-8903-4a02327a7e09/resourceGroups/sample-rg/providers/Microsoft.Storage/storageAccounts/sample-storageAccount],tag-keys-only:[filterTag1,filterTag2],tags:{filterTag3:value3,filterTag4:value4}},{display-name:Sample-Collection-2,resource-types:[/subscriptions/b79cb3ba-745e-5d9a-8903-4a02327a7e09/resourceGroups/sample-rg/providers/Microsoft.Storage/storageAccounts/sample-storageAccount],tag-keys-only:[filterTag5],tags:{filterTag6:value6}}]"
22+
az storage-discovery workspace update --resource-group myRG --name myWorkspace --description "Updated description" --sku Free --scopes '[{"displayName":"updated","resourceTypes":["Microsoft.Storage/storageAccounts"],"tags":{"environment":"test"}}]' --tags environment=production team=storage
2323
"""
2424

2525
_aaz_info = {

0 commit comments

Comments
 (0)