Skip to content

Commit 0e75b42

Browse files
bluewwblueww
authored
[FileShare] Add Az.FileShare module first preview release (#29208)
1 parent 3ff827f commit 0e75b42

76 files changed

Lines changed: 7981 additions & 0 deletions

File tree

Some content is hidden

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

‎src/FileShare/FileShare.Autorest/.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

‎src/FileShare/FileShare.Autorest/.gitignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
bin
2+
obj
3+
.vs
4+
generated
5+
internal
6+
exports
7+
tools
8+
test/*-TestResults.xml
9+
license.txt
10+
/*.ps1
11+
/*.psd1
12+
/*.ps1xml
13+
/*.psm1
14+
/*.snk
15+
/*.csproj
16+
/*.nuspec

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License. See License.txt in the project root for license information.
3+
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
4+
// Copyright (c) Microsoft Corporation. All rights reserved.
5+
// Licensed under the Apache License, Version 2.0 (the ""License"");
6+
// you may not use this file except in compliance with the License.
7+
// You may obtain a copy of the License at
8+
// http://www.apache.org/licenses/LICENSE-2.0
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an ""AS IS"" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
15+
// is regenerated.
16+
17+
using System;
18+
using System.Reflection;
19+
using System.Runtime.CompilerServices;
20+
using System.Runtime.InteropServices;
21+
22+
[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
23+
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
24+
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
25+
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - MicrosoftFileShares")]
26+
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")]
27+
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")]
28+
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
29+
[assembly: System.CLSCompliantAttribute(false)]
30+

‎src/FileShare/FileShare.Autorest/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- region Generated -->
2+
# Az.FileShare
3+
This directory contains the PowerShell module for the FileShare service.
4+
5+
---
6+
## Info
7+
- Modifiable: yes
8+
- Generated: all
9+
- Committed: yes
10+
- Packaged: yes
11+
12+
---
13+
## Detail
14+
This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension.
15+
16+
## Module Requirements
17+
- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater
18+
19+
## Authentication
20+
AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.
21+
22+
## Development
23+
For information on how to develop for `Az.FileShare`, see [how-to.md](how-to.md).
24+
<!-- endregion -->

‎src/FileShare/FileShare.Autorest/UX/Microsoft.FileShares/fileShares-fileShareSnapshots.json‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"resourceType": "fileShares/fileShareSnapshots",
3+
"apiVersion": "2025-09-01-preview",
4+
"learnMore": {
5+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare"
6+
},
7+
"commands": [
8+
{
9+
"name": "Get-AzFileShareSnapshot",
10+
"description": "Get a FileShareSnapshot",
11+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots/{name}",
12+
"help": {
13+
"learnMore": {
14+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare/get-azfilesharesnapshot"
15+
},
16+
"parameterSets": [
17+
{
18+
"parameters": [
19+
"-Name <String>",
20+
"-ResourceGroupName <String>",
21+
"-ResourceName <String>",
22+
"[-SubscriptionId <String[]>]"
23+
]
24+
}
25+
]
26+
},
27+
"examples": [
28+
{
29+
"description": "Get a FileShareSnapshot",
30+
"parameters": [
31+
{
32+
"name": "-Name",
33+
"value": "[Path.name]"
34+
},
35+
{
36+
"name": "-ResourceGroupName",
37+
"value": "[Path.resourceGroupName]"
38+
},
39+
{
40+
"name": "-ResourceName",
41+
"value": "[Path.resourceName]"
42+
},
43+
{
44+
"name": "-SubscriptionId",
45+
"value": "[Path.subscriptionId]"
46+
}
47+
]
48+
}
49+
]
50+
},
51+
{
52+
"name": "Remove-AzFileShareSnapshot",
53+
"description": "Delete a FileShareSnapshot.",
54+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots/{name}",
55+
"help": {
56+
"learnMore": {
57+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare/remove-azfilesharesnapshot"
58+
},
59+
"parameterSets": [
60+
{
61+
"parameters": [
62+
"-Name <String>",
63+
"-ResourceGroupName <String>",
64+
"-ResourceName <String>",
65+
"[-SubscriptionId <String>]"
66+
]
67+
}
68+
]
69+
},
70+
"examples": [
71+
{
72+
"description": "Delete a FileShareSnapshot.",
73+
"parameters": [
74+
{
75+
"name": "-Name",
76+
"value": "[Path.name]"
77+
},
78+
{
79+
"name": "-ResourceGroupName",
80+
"value": "[Path.resourceGroupName]"
81+
},
82+
{
83+
"name": "-ResourceName",
84+
"value": "[Path.resourceName]"
85+
},
86+
{
87+
"name": "-SubscriptionId",
88+
"value": "[Path.subscriptionId]"
89+
}
90+
]
91+
}
92+
]
93+
}
94+
]
95+
}

‎src/FileShare/FileShare.Autorest/UX/Microsoft.FileShares/fileShares.json‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
{
2+
"resourceType": "fileShares",
3+
"apiVersion": "2025-09-01-preview",
4+
"learnMore": {
5+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare"
6+
},
7+
"commands": [
8+
{
9+
"name": "Get-AzFileShare",
10+
"description": "Get a FileShare",
11+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}",
12+
"help": {
13+
"learnMore": {
14+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare/get-azfileshare"
15+
},
16+
"parameterSets": [
17+
{
18+
"parameters": [
19+
"-ResourceGroupName <String>",
20+
"-ResourceName <String>",
21+
"[-SubscriptionId <String[]>]"
22+
]
23+
}
24+
]
25+
},
26+
"examples": [
27+
{
28+
"description": "Get a FileShare",
29+
"parameters": [
30+
{
31+
"name": "-ResourceGroupName",
32+
"value": "[Path.resourceGroupName]"
33+
},
34+
{
35+
"name": "-ResourceName",
36+
"value": "[Path.resourceName]"
37+
},
38+
{
39+
"name": "-SubscriptionId",
40+
"value": "[Path.subscriptionId]"
41+
}
42+
]
43+
}
44+
]
45+
},
46+
{
47+
"name": "Remove-AzFileShare",
48+
"description": "Delete a FileShare",
49+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}",
50+
"help": {
51+
"learnMore": {
52+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare/remove-azfileshare"
53+
},
54+
"parameterSets": [
55+
{
56+
"parameters": [
57+
"-ResourceGroupName <String>",
58+
"-ResourceName <String>",
59+
"[-SubscriptionId <String>]"
60+
]
61+
}
62+
]
63+
},
64+
"examples": [
65+
{
66+
"description": "Delete a FileShare",
67+
"parameters": [
68+
{
69+
"name": "-ResourceGroupName",
70+
"value": "[Path.resourceGroupName]"
71+
},
72+
{
73+
"name": "-ResourceName",
74+
"value": "[Path.resourceName]"
75+
},
76+
{
77+
"name": "-SubscriptionId",
78+
"value": "[Path.subscriptionId]"
79+
}
80+
]
81+
}
82+
]
83+
}
84+
]
85+
}

‎src/FileShare/FileShare.Autorest/UX/Microsoft.FileShares/locations.json‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{
2+
"resourceType": "locations",
3+
"apiVersion": "2025-09-01-preview",
4+
"learnMore": {
5+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare"
6+
},
7+
"commands": [
8+
{
9+
"name": "Get-AzFileShareLimit",
10+
"description": "Get file shares limits.",
11+
"path": "/subscriptions/{subscriptionId}/providers/Microsoft.FileShares/locations/{location}/getLimits",
12+
"help": {
13+
"learnMore": {
14+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare/get-azfilesharelimit"
15+
},
16+
"parameterSets": [
17+
{
18+
"parameters": [
19+
"-Location <String>",
20+
"[-SubscriptionId <String[]>]"
21+
]
22+
}
23+
]
24+
},
25+
"examples": [
26+
{
27+
"description": "Get file shares limits.",
28+
"parameters": [
29+
{
30+
"name": "-Location",
31+
"value": "[Path.location]"
32+
},
33+
{
34+
"name": "-SubscriptionId",
35+
"value": "[Path.subscriptionId]"
36+
}
37+
]
38+
}
39+
]
40+
},
41+
{
42+
"name": "Get-AzFileShareUsageData",
43+
"description": "Get file shares usage data.",
44+
"path": "/subscriptions/{subscriptionId}/providers/Microsoft.FileShares/locations/{location}/getUsageData",
45+
"help": {
46+
"learnMore": {
47+
"url": "https://learn.microsoft.com/powershell/module/az.fileshare/get-azfileshareusagedata"
48+
},
49+
"parameterSets": [
50+
{
51+
"parameters": [
52+
"-Location <String>",
53+
"[-SubscriptionId <String[]>]"
54+
]
55+
}
56+
]
57+
},
58+
"examples": [
59+
{
60+
"description": "Get file shares usage data.",
61+
"parameters": [
62+
{
63+
"name": "-Location",
64+
"value": "[Path.location]"
65+
},
66+
{
67+
"name": "-SubscriptionId",
68+
"value": "[Path.subscriptionId]"
69+
}
70+
]
71+
}
72+
]
73+
}
74+
]
75+
}

‎src/FileShare/FileShare.Autorest/custom/Az.FileShare.custom.psm1‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# region Generated
2+
# Load the private module dll
3+
$null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '..\bin\Az.FileShare.private.dll')
4+
5+
# Load the internal module
6+
$internalModulePath = Join-Path $PSScriptRoot '..\internal\Az.FileShare.internal.psm1'
7+
if(Test-Path $internalModulePath) {
8+
$null = Import-Module -Name $internalModulePath
9+
}
10+
11+
# Export nothing to clear implicit exports
12+
Export-ModuleMember
13+
14+
# Export script cmdlets
15+
Get-ChildItem -Path $PSScriptRoot -Recurse -Include '*.ps1' -File | ForEach-Object { . $_.FullName }
16+
Export-ModuleMember -Function (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot) -Alias (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot -AsAlias)
17+
# endregion

‎src/FileShare/FileShare.Autorest/custom/README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Custom
2+
This directory contains custom implementation for non-generated cmdlets for the `Az.FileShare` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.FileShare.custom.psm1`. This file should not be modified.
3+
4+
## Info
5+
- Modifiable: yes
6+
- Generated: partial
7+
- Committed: yes
8+
- Packaged: yes
9+
10+
## Details
11+
For `Az.FileShare` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*.
12+
13+
For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.FileShare.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder.
14+
15+
For script cmdlets, these are loaded via the `Az.FileShare.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.
16+
17+
## Purpose
18+
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder.
19+
20+
## Usage
21+
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
22+
- Break
23+
- DefaultProfile
24+
- HttpPipelineAppend
25+
- HttpPipelinePrepend
26+
- Proxy
27+
- ProxyCredential
28+
- ProxyUseDefaultCredentials
29+
30+
These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.FileShare`. For C#, follow the usage seen in the `ProcessRecordAsync` method.
31+
32+
### Attributes
33+
For processing the cmdlets, we've created some additional attributes:
34+
- `Microsoft.Azure.PowerShell.Cmdlets.FileShare.DescriptionAttribute`
35+
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
36+
- `Microsoft.Azure.PowerShell.Cmdlets.FileShare.DoNotExportAttribute`
37+
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.FileShare`.
38+
- `Microsoft.Azure.PowerShell.Cmdlets.FileShare.InternalExportAttribute`
39+
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.FileShare`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
40+
- `Microsoft.Azure.PowerShell.Cmdlets.FileShare.ProfileAttribute`
41+
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.

0 commit comments

Comments
 (0)