Skip to content

Commit 77ffa94

Browse files
init docs for pscloud (Azure#9078)
1 parent ad75aa3 commit 77ffa94

File tree

1 file changed

+39
-13
lines changed

1 file changed

+39
-13
lines changed

src/pscloud/README.md

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Azure CLI Pscloud Extension #
22

3-
This is an extension to Azure CLI to manage PureStorage Cloud resources including reservations and storage pools.
3+
This is an extension to Azure CLI to manage Pure Storage Cloud Azure Native resources.
44

55
## How to use ##
66

7+
For more details about the Pure Storage Cloud resources please visit [documentation on Pure Support](https://support.purestorage.com/bundle/m_azure_native_pure_storage_cloud/page/Pure_Cloud_Block_Store/Azure_Native_Pure_Storage_Cloud/design/c_resources_in_psc.html).
8+
79
### Install the extension ###
810

911
Install this extension using the below CLI command:
1012
```
11-
az extension add --name pscloud
13+
az extension add --name pscloud --allow-preview
1214
```
1315

1416
### Check the version ###
@@ -32,57 +34,81 @@ az group create -n demoResourceGroup -l eastus
3234

3335
## Available Commands ##
3436

35-
#### Show a PureStorage Cloud Resource ####
37+
### Pure Storage Cloud Resource ###
3638

37-
```
39+
This resource represents the enablement of the Pure Storage Cloud service within a selected region of the Azure subscription. This resource may be referred to in the documentation as a *Reservation* resource.
40+
41+
#### Create a Pure Storage Cloud Resource ####
42+
43+
To create a Pure Storage Cloud, you need to provide a subscription, resource group, selected location and the company information for billing.
44+
45+
Currently, creating a Pure Storage Cloud resource cannot be initiated from CLI.
46+
47+
#### Show a Pure Storage Cloud Resource ####
48+
49+
```bash
3850
az pscloud show --resource-group {resource_group} --name {reservation_name}
3951
```
4052

41-
#### List PureStorage Cloud Resources ####
53+
#### List Pure Storage Cloud Resources ####
4254

43-
```
55+
```bash
4456
az pscloud list --resource-group {resource_group}
4557
```
4658

59+
### Storage Pool Resource ###
60+
61+
This resource represents a block storage array instance, delivered as a service, within a specified availability zone and virtual network.
62+
4763
#### Create a Storage Pool ####
4864

49-
```
65+
To create a Storage Pool, you need to have a virtual network with a delegated subnet to `PureStorage.Block` service.
66+
67+
```bash
5068
az pscloud pool create --resource-group {resource_group} --storage-pool-name {storage_pool_name} --location {location} --availability-zone {availability_zone} --vnet-injection '{{"subnet-id": "{subnet_id}", "vnet-id": "{vnet_id}"}}' --provisioned-bandwidth {bandwidth_mb_per_sec} --reservation-id {reservation_resource_id} --system-assigned --user-assigned {user_assigned_identity_ids} --tags "{key:value}"
5169
```
5270

5371
#### Show a Storage Pool ####
5472

55-
```
73+
```bash
5674
az pscloud pool show --resource-group {resource_group} --storage-pool-name {storage_pool_name}
5775
```
5876

5977
#### List Storage Pools ####
6078

61-
```
79+
```bash
6280
az pscloud pool list --resource-group {resource_group}
6381
```
6482

6583
#### Update a Storage Pool ####
6684

67-
```
85+
```bash
6886
az pscloud pool update --resource-group {resource_group} --name {storage_pool_name} --provisioned-bandwidth {bandwidth_mb_per_sec}
6987
```
7088

7189
#### Delete a Storage Pool ####
7290

73-
```
91+
```bash
7492
az pscloud pool delete --resource-group {resource_group} --storage-pool-name {storage_pool_name}
7593
```
7694

95+
#### Connect a Storage Pool to AVS ####
96+
97+
Currently, establishing a connection between a Storage Pool and an Azure VMware Solution (AVS) resource must be initiated from the Azure Portal and cannot be initiated from CLI.
98+
7799
#### Get Storage Pool Health Status ####
78100

79-
```
101+
This command provides the health status about the Storage Pool.
102+
103+
```bash
80104
az pscloud pool get-health-status --resource-group {resource_group} --storage-pool-name {storage_pool_name}
81105
```
82106

83107
#### Get Storage Pool AVS Status ####
84108

85-
```
109+
This command provides the current connection status between the Storage Pool and Azure VMware Solution (AVS) resource.
110+
111+
```bash
86112
az pscloud pool get-avs-status --resource-group {resource_group} --storage-pool-name {storage_pool_name}
87113
```
88114

0 commit comments

Comments
 (0)