Add guardrail parameters to Microsoft.FileShares 2025-06-01-preview

[afedyashov]

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.

[github-actions]

Next Steps to Merge

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:

• ⚠️ The check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.

If you still want to proceed merging this PR without addressing the above failures, refer to step 4 in the PR workflow diagram.

Comment generated by summarize-checks workflow run.

[github-actions]

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
JavaScript	@azure/arm-fileshares
C#	Azure.ResourceManager.Fileshares
Python	azure-mgmt-fileshares
Java	com.azure.resourcemanager:azure-resourcemanager-fileshares

[afedyashov]

/azp run

[azure-pipelines]

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.

[afedyashov]

Dear reviewers, this PR was introduced following a suggestion from Mike Harder to my question to RP API review alias.

Can non-breaking change be introduced into existing "preview" API version

Suggestion was: The easiest way to check, is to open a draft PR with the changes you are proposing, and see what the Breaking Changes checks tell you.

Question was:

Seeking your advice on whether introduction of read-only properties into a POST API output contract can be done incrementally to existing preview version of an RP API, instead of producing new version. We are familiar with the process of adding new API versions – but want to check if cost of introducing new API version can be avoided given the specifics of the change and public preview state of RP.
Details: Target API version is in use by our RP (Microsoft.FileShareS) in its public preview launched September this year.
There is no SDK issued for this API version.
API in question: POST /subscriptions/{subscriptionId}/providers/Microsoft.FileShares/locations/{location}/getLimits. Addition is to the returned contract:

"FileShareProvisioningConstants": {
  "type": "object",
  "description": "Constants used for calculating recommended values of file share provisioning properties.",
  "properties": {
    "baseIOPerSec": {
      "type": "integer",
      "format": "int32",
      "description": "Base IO per second."
    },
    "scalarIOPerSec": {
      "type": "number",
      "format": "double",
      "description": "Scalar IO per second."
    },
    "baseThroughputMiBPerSec": {
      "type": "integer",
      "format": "int32",
      "description": "Base throughput in MiB per second."
    },
    "scalarThroughputMiBPerSec": {
      "type": "number",
      "format": "double",
      "description": "Scalar throughput in MiB per second."
    }
  }

We are looking to add two properties – and from the nature of the API – they are non-breaking.

+ guardrailIOPerSecScalar: float64;
+ guardrailThroughputScalar: float64;