Skip to content

Conversation

@fmabroukmsft
Copy link
Member

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.

spec_pr_review_workflow_diagram

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.

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2025-09-01 to stable/2025-12-01.
@github-actions
Copy link

github-actions bot commented Nov 13, 2025

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 has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The required check named Swagger Avocado has failed. 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


Comment generated by summarize-checks workflow run.

@github-actions github-actions bot added brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 13, 2025
@github-actions
Copy link

github-actions bot commented Nov 13, 2025

API Change Check

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

Language API Review for Package
Swagger Microsoft.MachineLearningServices
Go sdk/resourcemanager/machinelearning/armmachinelearning
Java com.azure.resourcemanager:azure-resourcemanager-machinelearning
C# Azure.ResourceManager.MachineLearning
JavaScript @azure/arm-machinelearning
Python azure-mgmt-machinelearningservices

@sandipsh
Copy link
Contributor

@fmabroukmsft please address the Avocado errors or justify why these can't be addressed (and suppress in that case with the said justification).

@sandipsh
Copy link
Contributor

    },

I noticed some of the enum values are removed in lastest version from last preview version, how is back compat maintained for these properties for the customers?


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/machineLearningServices.json:3009 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

@sandipsh
Copy link
Contributor

    },

I think it's related to resizing


In reply to: 3530352905


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/machineLearningServices.json:3009 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

@sandipsh
Copy link
Contributor

  },

why is it enum if just one value? also how is back compat handled with previous version if AAD and and KeyAndAAD is passed in the payload?


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/mfe.json:22703 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

"description": "Details for managed resource group assigned identities.",
"type": "object",
"properties": {
"principalId": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

principalId

why uuid format removed in this version?

@sandipsh
Copy link
Contributor

      },

returning 202 is not recommended pattern anymore. please use 201 or 200 with provisioning state indicating the creation status. please follow this RPC guideline to make the change - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/workspaceRP.json:171 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

@sandipsh
Copy link
Contributor

      },

please make the change for other APIs in this PR.


In reply to: 3530405439


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/workspaceRP.json:171 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

@sandipsh
Copy link
Contributor

    "x-ms-long-running-operation": true,

please also add
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}

applies for all cases in this file


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/workspaceRP.json:478 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

@sandipsh
Copy link
Contributor

      ],

add descriptions to all enums in this PR.


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/workspaceRP.json:1900 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

@sandipsh
Copy link
Contributor

      "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.",

this is not recommended for public documentation unless this is a special string constant for this property (which doesn't seem to be the case), please remove '_'


Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-12-01/workspaceRP.json:1912 in 9670ec6. [](commit_id = 9670ec6, deletion_comment = False)

@sandipsh sandipsh added ARMChangesRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMChangesRequested ARMReview BreakingChange-JavaScript-Sdk brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. new-api-version resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants