Introduce first Public Preview API version for microsoft.fileshares (2025-06-01-preview) by afedyashov · Pull Request #36135 · Azure/azure-rest-api-specs

afedyashov · 2025-07-23T13:24:15Z

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
Other, please clarify:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

…review cycle. This allows reviewers to easily diff subsequent changes against the previous spec. It is based on release-Microsoft.FileShares-2024-01-01-preview In https://github.com/Azure/azure-rest-api-specs-pr

Based on private API version: 2024-01-01-preview

…ctor MediaTier, Redundancy, Protocol, and ShareRootSquash to use union types

…tSquash to specify they are enums

…rage admins

… to improve outcome of Az PowerShell generation

…d pattern.

openapi-pipeline-app · 2025-07-23T13:24:19Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
This PR is awaiting ARM reviewer feedback (label: WaitForARMFeedback).
To learn when this PR will get reviewed, see ARM review queue at aka.ms/azsdk/pr-arm-review
For details of the ARM review, see aka.ms/azsdk/pr-arm-review
❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

openapi-pipeline-app · 2025-07-23T13:24:20Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

github-actions · 2025-07-23T13:27:09Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
TypeSpec	Microsoft.FileShares
Go	sdk/resourcemanager/fileshares/armfileshares
Python	azure-mgmt-fileshares
Java	com.azure.resourcemanager:azure-resourcemanager-fileshares
Swagger	Microsoft.FileShares
C#	Azure.ResourceManager.Fileshares
JavaScript	@azure/arm-fileshares

…/2025-06-01-preview

* Revert changes to snapshot proxy resource * Update readme.md * Update fileshares.tsp * Add 200 response to snapshots PATCH * Update readme.md * Update readme.md * Update readme.md * Update readme.md * Update readme.md * Update readme.md * Add 200 response example for file share snapshots * Update FileShareSnapshot_Update_MaximumSet_Gen.json

* Revert changes to snapshot proxy resource * Update readme.md * Update fileshares.tsp * Add 200 response to snapshots PATCH * Update readme.md * Update readme.md * Update readme.md * Update readme.md * Update readme.md * Update readme.md * Add 200 response example for file share snapshots * Update FileShareSnapshot_Update_MaximumSet_Gen.json * Update readme.md

…/2025-06-01-preview

ankushbindlish2 · 2025-07-28T16:48:05Z

/azp run

azure-pipelines · 2025-07-28T16:48:11Z

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

ankushbindlish2 · 2025-07-28T16:59:11Z

/azp run

azure-pipelines · 2025-07-28T16:59:17Z

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

…/2025-06-01-preview

openapi-pipeline-app · 2025-07-29T01:10:06Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

…/2025-06-01-preview

ankushbindlish2 · 2025-07-29T06:45:28Z

/azp run

azure-pipelines · 2025-07-29T06:45:34Z

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

dhruvesh · 2025-07-29T06:49:22Z

This Service was in Private Preview for long time, and had taken exception in 2023 for Private Preview API Version. They are extending the exception for Public Preview as well.

specification/fileshares/resource-manager/readme.az.md

ravimeda · 2025-07-29T11:45:49Z

nit - I would suggest including a *_List_MinimumSet_Gen.json to show an example of the minimum set for LIST for each resource type.

…/2025-06-01-preview

* Add sdk related files to resolve CI * PrivateEndpointID Resource correction in examples * TspConfig yaml changes * prettier * commands npm ci npx tsp format specification\fileshares\FileShares.Management\*.tsp npx tsv specification\fileshares\FileShares.Management npx tsp compile specification\fileshares\FileShares.Management\main.tsp * Prettier command npx prettier --write "specification/fileshares/resource-manager/Microsoft.FileShares/preview/2025-06-01-preview/**/*.json" * revert examples * sdk generation errors * Prettier check on Swagger examples npx prettier --write specification/fileshares/FileShares.Management/examples/2025-06-01-preview/FileShares_CreateOrUpdate_MaximumSet_Gen.json npx prettier --write specification/fileshares/FileShares.Management/examples/2025-06-01-preview/FileShares_Get_MaximumSet_Gen.json npx prettier --write specification/fileshares/FileShares.Management/examples/2025-06-01-preview/FileShares_ListByParent_MaximumSet_Gen.json npx prettier --write specification/fileshares/FileShares.Management/examples/2025-06-01-preview/FileShares_Update_MaximumSet_Gen.json npx prettier --write specification/fileshares/resource-manager/Microsoft.FileShares/preview/2025-06-01-preview/examples/FileShares_CreateOrUpdate_MaximumSet_Gen.json npx prettier --write specification/fileshares/resource-manager/Microsoft.FileShares/preview/2025-06-01-preview/examples/FileShares_Get_MaximumSet_Gen.json npx prettier --write specification/fileshares/resource-manager/Microsoft.FileShares/preview/2025-06-01-preview/examples/FileShares_ListByParent_MaximumSet_Gen.json npx prettier --write specification/fileshares/resource-manager/Microsoft.FileShares/preview/2025-06-01-preview/examples/FileShares_Update_MaximumSet_Gen.json * Update client.tsp * Update client.tsp * Update readme.md * Add examples * Fix examples * revert * Update readme.python.md * update

…/2025-06-01-preview

ankushbindlish2 · 2025-07-29T17:57:09Z

nit - I would suggest including a *_List_MinimumSet_Gen.json to show an example of the minimum set for LIST for each resource type.

resolved

ravimeda

pahnallan · 2025-07-29T21:18:37Z

Hi @ravimeda ,
Looks like we also need sigh off on the suppressions.
❌ Approved-Suppression

Is this something you can take a look at?

Thanks,
Allan

ravimeda · 2025-07-29T21:56:24Z

Discussed with Ankush to validate the suppressions. Refer to guidelines

Andrey Fedyashov added 12 commits July 21, 2025 04:56

Update version to 2025-06-01-preview.

ad59bc8

Based on private API version: 2024-01-01-preview

Bring changes for 2025-06-01-preview from development repository

f85a7cb

Bring changes for 2025-06-01-preview from development repository

c855b0c

Remove unused InformationalRequestParameters model

aa2e03b

Remove VirtualNetworkRule model from FileShares specifications

9f721e1

Addressing @azure-tools/typespec-azure-core/no-enum suppression: Refa…

4442573

…ctor MediaTier, Redundancy, Protocol, and ShareRootSquash to use union types

Update descriptions for MediaTier, Redundancy, Protocol, and ShareRoo…

9c4dc35

…tSquash to specify they are enums

Add justification for casing-style: customized style suitable for sto…

8b13d02

…rage admins

Refactor operation IDs for FileShare and FileShareSnapshot interfaces…

ba9a12a

… to improve outcome of Az PowerShell generation

Correct PUT FileShareSnapshot spec to reflect it is using 202 Accepte…

f9d47d6

…d pattern.

Add examples and update example references in swagger

a466d29

AzureRestAPISpecReview added ARMReview CI-NewRPNamespaceWithoutRPaaS new-api-version new-rp-namespace NotReadyForARMReview resource-manager TypeSpec Authored with TypeSpec labels Jul 23, 2025

Merge branch 'main' into release-storage-Microsoft.FileShares-preview…

9173863

…/2025-06-01-preview

openapi-pipeline-app bot added PipelineBotTrigger and removed PipelineBotTrigger labels Jul 24, 2025

openapi-pipeline-app bot added PipelineBotTrigger and removed PipelineBotTrigger labels Jul 26, 2025

openapi-pipeline-app bot added PipelineBotTrigger and removed PipelineBotTrigger labels Jul 28, 2025

pahnallan and others added 2 commits July 27, 2025 23:02

Merge branch 'main' into release-storage-Microsoft.FileShares-preview…

efc2eea

…/2025-06-01-preview

ankushbindlish2 added 2 commits July 28, 2025 17:48

Merge branch 'main' into release-storage-Microsoft.FileShares-preview…

fd27987

…/2025-06-01-preview

Update readme.md

5c4de81

Merge branch 'main' into release-storage-Microsoft.FileShares-preview…

433ff78

…/2025-06-01-preview

ravimeda reviewed Jul 29, 2025

View reviewed changes

specification/fileshares/resource-manager/readme.az.md Outdated Show resolved Hide resolved

ankushbindlish2 added 4 commits July 29, 2025 09:11

Update readme.az.md

494e9f2

Merge branch 'main' into release-storage-Microsoft.FileShares-preview…

42f643e

…/2025-06-01-preview

Merge branch 'main' into release-storage-Microsoft.FileShares-preview…

8cd8b08

…/2025-06-01-preview

ravimeda approved these changes Jul 29, 2025

View reviewed changes

Conversation

afedyashov commented Jul 23, 2025 • edited by pahnallan Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

ankushbindlish2 commented Jul 28, 2025

Uh oh!

azure-pipelines bot commented Jul 28, 2025

Uh oh!

ankushbindlish2 commented Jul 28, 2025

Uh oh!

azure-pipelines bot commented Jul 28, 2025

Uh oh!

openapi-pipeline-app bot commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

ankushbindlish2 commented Jul 29, 2025

Uh oh!

azure-pipelines bot commented Jul 29, 2025

Uh oh!

dhruvesh commented Jul 29, 2025

Uh oh!

Uh oh!

ravimeda commented Jul 29, 2025

Uh oh!

ankushbindlish2 commented Jul 29, 2025

Uh oh!

ravimeda left a comment

Choose a reason for hiding this comment

Uh oh!

pahnallan commented Jul 29, 2025

Uh oh!

ravimeda commented Jul 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

afedyashov commented Jul 23, 2025 •

edited by pahnallan

Loading

openapi-pipeline-app bot commented Jul 23, 2025 •

edited

Loading

openapi-pipeline-app bot commented Jul 23, 2025 •

edited

Loading

github-actions bot commented Jul 23, 2025 •

edited

Loading

openapi-pipeline-app bot commented Jul 29, 2025 •

edited

Loading