[FileShare] Add Az.FileShare module first preview release#29208
Open
blueww wants to merge 4 commits intoAzure:mainfrom
Open
[FileShare] Add Az.FileShare module first preview release#29208blueww wants to merge 4 commits intoAzure:mainfrom
blueww wants to merge 4 commits intoAzure:mainfrom
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces the Az.FileShare module as a first preview release. It is an AutoRest-generated PowerShell module for managing Azure File Shares and their snapshots through the Microsoft.FileShares resource provider.
Changes:
- Added new Az.FileShare module with complete AutoRest-generated structure
- Included cmdlets for file share management (CRUD operations), snapshot management, and utility functions
- Added comprehensive help documentation with examples for all cmdlets
- Configured module mapping and integration with Az PowerShell build system
Reviewed changes
Copilot reviewed 75 out of 75 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/CreateMappings_rules.json | Added FileShare module mapping entry |
| src/FileShare/FileShare/ChangeLog.md | Module changelog documenting first preview release |
| src/FileShare/FileShare/Az.FileShare.psd1 | Module manifest with metadata and exported cmdlets |
| src/FileShare/FileShare/Properties/AssemblyInfo.cs | Assembly information with version 0.1.0 |
| src/FileShare/FileShare/FileShare.csproj | Project file for module build configuration |
| src/FileShare/FileShare/help/*.md | Help documentation for 12 cmdlets (Get, New, Update, Remove, Test operations) |
| src/FileShare/FileShare.Autorest/* | AutoRest-generated module structure including custom, test, examples, and docs folders |
| src/FileShare/FileShare.Autorest/tsp-location.yaml | TypeSpec location configuration with commit hash reference |
| src/FileShare/FileShare.Autorest/README.md | Module overview and development instructions |
src/FileShare/FileShare.Autorest/examples/Remove-AzFileShareSnapshot.md
Outdated
Show resolved
Hide resolved
src/FileShare/FileShare.Autorest/docs/Remove-AzFileShareSnapshot.md
Outdated
Show resolved
Hide resolved
5e38a9a to
aa4e2d0
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 75 out of 75 changed files in this pull request and generated 3 comments.
Comments suppressed due to low confidence (6)
src/FileShare/FileShare.Autorest/test/loadEnv.ps1:1
- Line 27 ignores
$envFilePathand always loads from(Join-Path $PSScriptRoot $envFile), which breaks the fallback path logic in lines 20–24. Load from$envFilePath(and use it consistently) so playback/live can find env.json regardless of location.
src/FileShare/FileShare.Autorest/utils/Unprotect-SecureString.ps1:1 - This utility converts
SecureStringto plaintext and returns it, which can easily leak secrets via pipeline/out-default, transcript logs, or crash dumps. If this is only needed for tests, move it under the test folder (non-packaged) or otherwise ensure it is not shipped/exported; if it must ship, add strong guardrails (e.g., explicit -Force/-AsPlainText switch, warning, and avoid returning plaintext by default).
src/FileShare/FileShare.Autorest/tsp-location.yaml:1 - The
repopoints to a personal fork (blueww/azure-rest-api-specs). For a preview release, generation metadata should generally reference the canonical upstream repo (e.g.,Azure/azure-rest-api-specs) so others can reproduce generation without depending on a fork.
src/FileShare/FileShare/ChangeLog.md:1 - This changelog doesn't follow the template described at the top of the file (dated release header like
## YYYY.MM.DD - Version X.Y.Z) and leaves## Upcoming Releaseempty. Please either move the entry under## Upcoming Release(past tense) or format the release section per the required convention so release tooling/parsing stays consistent.
src/FileShare/FileShare.Autorest/test/Get-AzFileShare.Tests.ps1:1 - All newly added Pester tests are currently skipped and only assert that a NotImplementedException isn't thrown, which provides no functional coverage. Add at least basic playback-mode tests that invoke the cmdlets with recorded responses and validate key properties, then remove
-skipso CI can catch regressions.
src/FileShare/FileShare.Autorest/how-to.md:1 - Correct spelling of 'Supresses' to 'Suppresses'.
src/FileShare/FileShare.Autorest/test/Get-AzFileShareProvisioningRecommendation.Tests.ps1
Show resolved
Hide resolved
src/FileShare/FileShare.Autorest/test/Update-AzFileShareSnapshot.Tests.ps1
Show resolved
Hide resolved
src/FileShare/FileShare.Autorest/test/Remove-AzFileShareSnapshot.Tests.ps1
Show resolved
Hide resolved
src/FileShare/FileShare.Autorest/test/Test-AzFileShareNameAvailability.Tests.ps1
Show resolved
Hide resolved
Member
Author
|
@NoriZC |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
PSH Design review : https://github.com/Azure/azure-powershell-cmdlet-review-pr/issues/1536
PR to update typespec: Azure/azure-rest-api-specs#40789
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.