Skip to content

Commit aa4e2d0

Browse files
bluewwblueww
committed
Add help examples
1 parent af45ef3 commit aa4e2d0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+721
-574
lines changed

‎src/FileShare/FileShare.Autorest/Properties/AssemblyInfo.cs‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,12 @@
2323
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
2424
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
2525
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - MicrosoftFileShares")]
26-
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0.0")]
27-
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")]
26+
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")]
27+
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")]
2828
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
29-
[assembly: System.CLSCompliantAttribute(false)]
29+
[assembly: System.CLSCompliantAttribute(false)]
30+
31+
32+
33+
34+

‎src/FileShare/FileShare.Autorest/docs/Get-AzFileShare.md‎

Lines changed: 60 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,27 +39,79 @@ Get a FileShare
3939

4040
## EXAMPLES
4141

42-
### Example 1: {{ Add title here }}
42+
### Example 1: Get a file share
4343
```powershell
44-
{{ Add code here }}
44+
Get-AzFileShare -ResourceName "testshare" -ResourceGroupName "myresourcegroup"
45+
46+
```
47+
48+
```output
49+
HostName : fs-xxxxxxxxxxxxxxxxx.z41.file.storage.azure.net
50+
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.FileShares/fileShares/testshare
51+
IncludedBurstIoPerSec : 15000
52+
Location : eastus2euap
53+
MaxBurstIoPerSecCredit : 36000000
54+
MediaTier : SSD
55+
MountName : testshare
56+
Name : testshare
57+
NfProtocolPropertyRootSquash : AllSquash
58+
PrivateEndpointConnection : {}
59+
Protocol : NFS
60+
ProvisionedIoPerSec : 5000
61+
ProvisionedIoPerSecNextAllowedDowngrade : 2/26/2026 6:56:35 AM
62+
ProvisionedStorageGiB : 100
63+
ProvisionedStorageNextAllowedDowngrade : 2/26/2026 6:56:35 AM
64+
ProvisionedThroughputMiBPerSec : 125
65+
ProvisionedThroughputNextAllowedDowngrade : 2/26/2026 6:56:35 AM
66+
ProvisioningState : Succeeded
67+
PublicAccessPropertyAllowedSubnet : {/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1,
68+
/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2}
69+
PublicNetworkAccess : Enabled
70+
Redundancy : Local
71+
ResourceGroupName : myresourcegroup
72+
SystemDataCreatedAt :
73+
SystemDataCreatedBy :
74+
SystemDataCreatedByType :
75+
SystemDataLastModifiedAt : 2/25/2026 6:51:08 AM
76+
SystemDataLastModifiedBy : username@microsoft.com
77+
SystemDataLastModifiedByType : User
78+
Tag : {
79+
"tag2": "value2",
80+
"tag1": "value1"
81+
}
82+
Type : Microsoft.FileShares/fileShares
83+
```
84+
85+
This command gets a file share properties.
86+
87+
### Example 2: List file shares in a resource group and format the output
88+
```powershell
89+
Get-AzFileShare -ResourceGroupName $resourceGroup | ft Name,Location,Protocol,ProvisionedStorageGiB,MediaTier
4590
```
4691

4792
```output
48-
{{ Add output here (remove the output block if the example doesn't have an output) }}
93+
Name Location Protocol ProvisionedStorageGiB MediaTier
94+
---- -------- -------- --------------------- ---------
95+
testshare1 eastus2euap NFS 100 SSD
96+
testshare2 uaecentral NFS 50 SSD
4997
```
5098

51-
{{ Add description here }}
99+
This command lists all file shares in a resource group and format the output to a table with selected properties.
52100

53-
### Example 2: {{ Add title here }}
101+
### Example 3: List file shares in the current subscription
54102
```powershell
55-
{{ Add code here }}
103+
Get-AzFileShare
56104
```
57105

58106
```output
59-
{{ Add output here (remove the output block if the example doesn't have an output) }}
107+
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGroupName
108+
-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -----------------
109+
eastus2euap testshare1 8/7/2025 3:36:39 AM user11@microsoft.com User 8/7/2025 3:36:39 AM user11@microsoft.com User myresourcegroup
110+
uaecentral testshare2 2/26/2026 8:13:58 AM user11@microsoft.com User 2/26/2026 8:13:58 AM user11@microsoft.com User myresourcegroup
111+
eastus2euap testshare3 5/14/2025 9:24:49 AM user11@microsoft.com User 5/14/2025 9:24:49 AM user11@microsoft.com User resourcegroup2
60112
```
61113

62-
{{ Add description here }}
114+
This command lists all file shares in the current subscription.
63115

64116
## PARAMETERS
65117

‎src/FileShare/FileShare.Autorest/docs/Get-AzFileShareLimit.md‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,31 @@ Get file shares limits.
2929

3030
## EXAMPLES
3131

32-
### Example 1: {{ Add title here }}
32+
### Example 1: Get file shares limitation
3333
```powershell
34-
{{ Add code here }}
34+
Get-AzFileShareLimit -Location uaecentral
3535
```
3636

3737
```output
38-
{{ Add output here (remove the output block if the example doesn't have an output) }}
38+
LimitMaxFileShare : 1000
39+
LimitMaxFileSharePrivateEndpointConnection : 100
40+
LimitMaxFileShareSnapshot : 200
41+
LimitMaxFileShareSubnet : 400
42+
LimitMaxProvisionedIoPerSec : 100000
43+
LimitMaxProvisionedStorageGiB : 262144
44+
LimitMaxProvisionedThroughputMiBPerSec : 10240
45+
LimitMinProvisionedIoPerSec : 3000
46+
LimitMinProvisionedStorageGiB : 32
47+
LimitMinProvisionedThroughputMiBPerSec : 125
48+
ProvisioningConstantBaseIoPerSec : 3000
49+
ProvisioningConstantBaseThroughputMiBPerSec : 125
50+
ProvisioningConstantGuardrailIoPerSecScalar : 5
51+
ProvisioningConstantGuardrailThroughputScalar : 5
52+
ProvisioningConstantScalarIoPerSec : 1
53+
ProvisioningConstantScalarThroughputMiBPerSec : 0.1
3954
```
4055

41-
{{ Add description here }}
42-
43-
### Example 2: {{ Add title here }}
44-
```powershell
45-
{{ Add code here }}
46-
```
47-
48-
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
50-
```
51-
52-
{{ Add description here }}
56+
This command gets file shares limitation of a specific location.
5357

5458
## PARAMETERS
5559

‎src/FileShare/FileShare.Autorest/docs/Get-AzFileShareProvisioningRecommendation.md‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,27 +55,18 @@ Get file shares provisioning parameters recommendation.
5555

5656
## EXAMPLES
5757

58-
### Example 1: {{ Add title here }}
58+
### Example 1: Get file shares provisioning parameters recommendation
5959
```powershell
60-
{{ Add code here }}
60+
Get-AzFileShareProvisioningRecommendation -Location uaecentral -ProvisionedStorageGiB 100
6161
```
6262

6363
```output
64-
{{ Add output here (remove the output block if the example doesn't have an output) }}
64+
AvailableRedundancyOption ProvisionedIoPerSec ProvisionedThroughputMiBPerSec
65+
------------------------- ------------------- ------------------------------
66+
{Local} 3050 130
6567
```
6668

67-
{{ Add description here }}
68-
69-
### Example 2: {{ Add title here }}
70-
```powershell
71-
{{ Add code here }}
72-
```
73-
74-
```output
75-
{{ Add output here (remove the output block if the example doesn't have an output) }}
76-
```
77-
78-
{{ Add description here }}
69+
This command gets file shares provisioning parameters recommendation.
7970

8071
## PARAMETERS
8172

‎src/FileShare/FileShare.Autorest/docs/Get-AzFileShareSnapshot.md‎

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,30 @@ Get a FileShareSnapshot
4040

4141
## EXAMPLES
4242

43-
### Example 1: {{ Add title here }}
43+
### Example 1: Get a file share snapshot properties
4444
```powershell
45-
{{ Add code here }}
45+
Get-AzFileShareSnapshot -ResourceName "testshare" -ResourceGroupName "myresourcegroup" -Name s123
4646
```
4747

4848
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
50-
```
51-
52-
{{ Add description here }}
53-
54-
### Example 2: {{ Add title here }}
55-
```powershell
56-
{{ Add code here }}
57-
```
58-
59-
```output
60-
{{ Add output here (remove the output block if the example doesn't have an output) }}
61-
```
62-
63-
{{ Add description here }}
49+
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.FileShares/fileShares/testshare/fileShareSnapshots/s123
50+
InitiatorId :
51+
Metadata : {
52+
"meta1": "value1"
53+
}
54+
Name : s123
55+
ResourceGroupName : myresourcegroup
56+
SnapshotTime : 2026-02-26T08:30:05Z
57+
SystemDataCreatedAt :
58+
SystemDataCreatedBy :
59+
SystemDataCreatedByType :
60+
SystemDataLastModifiedAt :
61+
SystemDataLastModifiedBy :
62+
SystemDataLastModifiedByType :
63+
Type : Microsoft.FileShares/fileShareSnapshots
64+
```
65+
66+
This command gets a file share snapshot properties.
6467

6568
## PARAMETERS
6669

‎src/FileShare/FileShare.Autorest/docs/Get-AzFileShareUsageData.md‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,18 @@ Get file shares usage data.
2929

3030
## EXAMPLES
3131

32-
### Example 1: {{ Add title here }}
32+
### Example 1: Get file shares usage data
3333
```powershell
34-
{{ Add code here }}
34+
Get-AzFileShareUsageData -Location uaecentral
3535
```
3636

3737
```output
38-
{{ Add output here (remove the output block if the example doesn't have an output) }}
38+
LiveShareFileShareCount
39+
-----------------------
40+
1
3941
```
4042

41-
{{ Add description here }}
42-
43-
### Example 2: {{ Add title here }}
44-
```powershell
45-
{{ Add code here }}
46-
```
47-
48-
```output
49-
{{ Add output here (remove the output block if the example doesn't have an output) }}
50-
```
51-
52-
{{ Add description here }}
43+
This command gets file shares usage data of current subscription in a specific location.
5344

5445
## PARAMETERS
5546

‎src/FileShare/FileShare.Autorest/docs/New-AzFileShare.md‎

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,27 +41,49 @@ Create a file share.
4141

4242
## EXAMPLES
4343

44-
### Example 1: {{ Add title here }}
44+
### Example 1: Create a file share
4545
```powershell
46-
{{ Add code here }}
46+
New-AzFileShare -ResourceName "testshare" -ResourceGroupName "myresourcegroup" -Location uaecentral -MediaTier SSD -NfProtocolPropertyRootSquash AllSquash -Protocol NFS -ProvisionedIoPerSec 5000 -ProvisionedStorageGiB 100 -ProvisionedThroughputMiBPerSec 125 -PublicAccessPropertyAllowedSubnet $vnet1,$vnet2 -Tag @{"tag1" = "value1"; "tag2" = "value2" }
4747
```
4848

4949
```output
50-
{{ Add output here (remove the output block if the example doesn't have an output) }}
51-
```
52-
53-
{{ Add description here }}
54-
55-
### Example 2: {{ Add title here }}
56-
```powershell
57-
{{ Add code here }}
58-
```
59-
60-
```output
61-
{{ Add output here (remove the output block if the example doesn't have an output) }}
62-
```
63-
64-
{{ Add description here }}
50+
HostName : fs-xxxxxxxxxxxxxxxxx.z41.file.storage.azure.net
51+
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.FileShares/fileShares/testshare
52+
IncludedBurstIoPerSec : 15000
53+
Location : uaecentral
54+
MaxBurstIoPerSecCredit : 36000000
55+
MediaTier : SSD
56+
MountName : testshare
57+
Name : testshare
58+
NfProtocolPropertyRootSquash : AllSquash
59+
PrivateEndpointConnection : {}
60+
Protocol : NFS
61+
ProvisionedIoPerSec : 5000
62+
ProvisionedIoPerSecNextAllowedDowngrade : 2/26/2026 6:56:35 AM
63+
ProvisionedStorageGiB : 100
64+
ProvisionedStorageNextAllowedDowngrade : 2/26/2026 6:56:35 AM
65+
ProvisionedThroughputMiBPerSec : 125
66+
ProvisionedThroughputNextAllowedDowngrade : 2/26/2026 6:56:35 AM
67+
ProvisioningState : Succeeded
68+
PublicAccessPropertyAllowedSubnet : {/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1,
69+
/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2}
70+
PublicNetworkAccess : Enabled
71+
Redundancy : Local
72+
ResourceGroupName : myresourcegroup
73+
SystemDataCreatedAt :
74+
SystemDataCreatedBy :
75+
SystemDataCreatedByType :
76+
SystemDataLastModifiedAt : 2/25/2026 6:51:08 AM
77+
SystemDataLastModifiedBy : username@microsoft.com
78+
SystemDataLastModifiedByType : User
79+
Tag : {
80+
"tag2": "value2",
81+
"tag1": "value1"
82+
}
83+
Type : Microsoft.FileShares/fileShares
84+
```
85+
86+
This command creates a file share.
6587

6688
## PARAMETERS
6789

‎src/FileShare/FileShare.Autorest/docs/New-AzFileShareSnapshot.md‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,27 +44,30 @@ Create a FileShareSnapshot.
4444

4545
## EXAMPLES
4646

47-
### Example 1: {{ Add title here }}
47+
### Example 1: Create a file share snapshot
4848
```powershell
49-
{{ Add code here }}
49+
New-AzFileShareSnapshot -ResourceName "testshare" -ResourceGroupName "myresourcegroup" -Name s123 -Metadata @{meta1="value1"}
5050
```
5151

5252
```output
53-
{{ Add output here (remove the output block if the example doesn't have an output) }}
53+
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.FileShares/fileShares/testshare/fileShareSnapshots/s123
54+
InitiatorId :
55+
Metadata : {
56+
"meta1": "value1"
57+
}
58+
Name : s123
59+
ResourceGroupName : myresourcegroup
60+
SnapshotTime : 2026-02-26T08:30:05Z
61+
SystemDataCreatedAt :
62+
SystemDataCreatedBy :
63+
SystemDataCreatedByType :
64+
SystemDataLastModifiedAt :
65+
SystemDataLastModifiedBy :
66+
SystemDataLastModifiedByType :
67+
Type : Microsoft.FileShares/fileShareSnapshots
5468
```
5569

56-
{{ Add description here }}
57-
58-
### Example 2: {{ Add title here }}
59-
```powershell
60-
{{ Add code here }}
61-
```
62-
63-
```output
64-
{{ Add output here (remove the output block if the example doesn't have an output) }}
65-
```
66-
67-
{{ Add description here }}
70+
This command creates a file share snapshot.
6871

6972
## PARAMETERS
7073

0 commit comments

Comments
 (0)