Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Commands/file-share/_check-name-availability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share check-name-availability_

Implements local CheckNameAvailability operations

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2xvY2F0aW9ucy97fS9jaGVja25hbWVhdmFpbGFiaWxpdHk=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.fileshares/locations/{}/checknameavailability 2025-06-01-preview -->

#### examples

- Check Name Availability for File Shares
```bash
file-share check-name-availability --location dpplbglogsvzrbbeo --name fvykqbgmd --type kcyswj
```
16 changes: 16 additions & 0 deletions Commands/file-share/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share create_

Create a file share.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{} 2025-06-01-preview -->

#### examples

- Create a File Share
```bash
file-share create --resource-group rgfileshares --resource-name fileshare --mount-name fileshare --media-tier SSD --redundancy Local --protocol NFS --provisioned-storage-gib 8 --provisioned-io-per-sec 5 --provisioned-throughput-mib-per-sec 22 --nfs-protocol-properties "{root-squash:NoRootSquash}" --public-access-properties "{allowed-subnets:[/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3]}" --public-network-access Enabled --tags "{key9647:xwokdvyoae}" --location gdsuixfhrgfbbbfjtgocmlzyuonrr
```
16 changes: 16 additions & 0 deletions Commands/file-share/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share delete_

Delete a FileShare

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{} 2025-06-01-preview -->

#### examples

- Delete a File Share
```bash
file-share delete --resource-group rgfileshares --resource-name fileshare
```
16 changes: 16 additions & 0 deletions Commands/file-share/_get-limit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share get-limit_

Get file shares limits.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2xvY2F0aW9ucy97fS9nZXRsaW1pdHM=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.fileshares/locations/{}/getlimits 2025-06-01-preview -->

#### examples

- File Share Get Limits
```bash
file-share get-limit --location dpplbglogsvzrbbeo
```
16 changes: 16 additions & 0 deletions Commands/file-share/_get-provisioning-recommendation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share get-provisioning-recommendation_

Get file shares provisioning parameters recommendation.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2xvY2F0aW9ucy97fS9nZXRwcm92aXNpb25pbmdyZWNvbW1lbmRhdGlvbg==/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.fileshares/locations/{}/getprovisioningrecommendation 2025-06-01-preview -->

#### examples

- File Share Get Provisioning Recommendation
```bash
file-share get-provisioning-recommendation --location dpplbglogsvzrbbeo --provisioned-storage-gib 7
```
16 changes: 16 additions & 0 deletions Commands/file-share/_get-usage-data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share get-usage-data_

Get file shares usage data.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2xvY2F0aW9ucy97fS9nZXR1c2FnZWRhdGE=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.fileshares/locations/{}/getusagedata 2025-06-01-preview -->

#### examples

- File Share Get Usage Data
```bash
file-share get-usage-data --location dpplbglogsvzrbbeo
```
17 changes: 17 additions & 0 deletions Commands/file-share/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Command] _file-share list_

List FileShare resources by subscription ID

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXM=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.fileshares/fileshares 2025-06-01-preview -->
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares 2025-06-01-preview -->

#### examples

- List a File Share
```bash
file-share list -g resourcegroup1
```
16 changes: 16 additions & 0 deletions Commands/file-share/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share show_

Get a FileShare

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{} 2025-06-01-preview -->

#### examples

- Show a FileShare
```bash
file-share show --resource-group rgfileshares --resource-name fileshare
```
16 changes: 16 additions & 0 deletions Commands/file-share/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share update_

Update a file share.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30=/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{} 2025-06-01-preview -->

#### examples

- Update a File Share
```bash
file-share update --resource-group rgfileshares --resource-name fileshare --mount-name fileshare --media-tier SSD --redundancy Local --protocol NFS --provisioned-storage-gib 8 --provisioned-io-per-sec 5 --provisioned-throughput-mib-per-sec 22 --nfs-protocol-properties "{root-squash:NoRootSquash}" --public-access-properties "{allowed-subnets:[/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3]}" --public-network-access Enabled --tags "{key9647:xwokdvyoae}" --location gdsuixfhrgfbbbfjtgocmlzyuonrr
```
37 changes: 37 additions & 0 deletions Commands/file-share/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# [Group] _file-share_

Manage File Share

## Subgroups

- [snapshot](/Commands/file-share/snapshot/readme.md)
: Manage File Share Snapshot

## Commands

- [check-name-availability](/Commands/file-share/_check-name-availability.md)
: Implements local CheckNameAvailability operations

- [create](/Commands/file-share/_create.md)
: Create a file share.

- [delete](/Commands/file-share/_delete.md)
: Delete a FileShare

- [get-limit](/Commands/file-share/_get-limit.md)
: Get file shares limits.

- [get-provisioning-recommendation](/Commands/file-share/_get-provisioning-recommendation.md)
: Get file shares provisioning parameters recommendation.

- [get-usage-data](/Commands/file-share/_get-usage-data.md)
: Get file shares usage data.

- [list](/Commands/file-share/_list.md)
: List FileShare resources by subscription ID

- [show](/Commands/file-share/_show.md)
: Get a FileShare

- [update](/Commands/file-share/_update.md)
: Update a file share.
16 changes: 16 additions & 0 deletions Commands/file-share/snapshot/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share snapshot create_

Create a FileShareSnapshot.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30vZmlsZXNoYXJlc25hcHNob3RzL3t9/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{}/filesharesnapshots/{} 2025-06-01-preview -->

#### examples

- Create a File Share Snapshot
```bash
file-share snapshot create --resource-group rgfileshares --resource-name fileshare --name testfilesharesnapshot --metadata "{key9372:jtc}"
```
16 changes: 16 additions & 0 deletions Commands/file-share/snapshot/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share snapshot delete_

Delete a FileShareSnapshot.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30vZmlsZXNoYXJlc25hcHNob3RzL3t9/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{}/filesharesnapshots/{} 2025-06-01-preview -->

#### examples

- Delete a File Share Snapshot
```bash
file-share snapshot delete --resource-group rgfileshares --resource-name fileshare --name testfilesharesnapshot
```
16 changes: 16 additions & 0 deletions Commands/file-share/snapshot/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share snapshot list_

List FileShareSnapshot by FileShare.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30vZmlsZXNoYXJlc25hcHNob3Rz/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{}/filesharesnapshots 2025-06-01-preview -->

#### examples

- List File Share Snapshots
```bash
file-share snapshot list --resource-group rgfileshares --resource-name fileshare
```
16 changes: 16 additions & 0 deletions Commands/file-share/snapshot/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share snapshot show_

Get a FileShareSnapshot

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30vZmlsZXNoYXJlc25hcHNob3RzL3t9/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{}/filesharesnapshots/{} 2025-06-01-preview -->

#### examples

- Show a File Share Snapshot
```bash
file-share snapshot show --resource-group rgfileshares --resource-name fileshare --name testfilesharesnapshot
```
16 changes: 16 additions & 0 deletions Commands/file-share/snapshot/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _file-share snapshot update_

Update a FileShareSnapshot.

## Versions

### [2025-06-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5maWxlc2hhcmVzL2ZpbGVzaGFyZXMve30vZmlsZXNoYXJlc25hcHNob3RzL3t9/2025-06-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.fileshares/fileshares/{}/filesharesnapshots/{} 2025-06-01-preview -->

#### examples

- Update a File Share Snapshot
```bash
file-share snapshot create --resource-group rgfileshares --resource-name fileshare --name testfilesharesnapshot --metadata "{key9372:jtc}"
```
20 changes: 20 additions & 0 deletions Commands/file-share/snapshot/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _file-share snapshot_

Manage File Share Snapshot

## Commands

- [create](/Commands/file-share/snapshot/_create.md)
: Create a FileShareSnapshot.

- [delete](/Commands/file-share/snapshot/_delete.md)
: Delete a FileShareSnapshot.

- [list](/Commands/file-share/snapshot/_list.md)
: List FileShareSnapshot by FileShare.

- [show](/Commands/file-share/snapshot/_show.md)
: Get a FileShareSnapshot

- [update](/Commands/file-share/snapshot/_update.md)
: Update a FileShareSnapshot.
3 changes: 3 additions & 0 deletions Commands/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,9 @@
- [eventhubs](/Commands/eventhubs/readme.md)
: Manage Event Hub

- [file-share](/Commands/file-share/readme.md)
: Manage File Share

- [firmwareanalysis](/Commands/firmwareanalysis/readme.md)
: Commands to manage firmware analysis.

Expand Down
Loading
Loading