Add InferencePools resource to 2024-10-01-preview #30531

paledger · 2024-09-12T07:13:23Z

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.

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.

openapi-pipeline-app · 2024-09-12T07:13:26Z

Next Steps to Merge

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

openapi-pipeline-app · 2024-09-12T07:13:27Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-resourcemanager-machinelearning	https://apiview.dev/Assemblies/Review/e1c428cb12c840a2b15ad2ba61d138e7?revisionId=434f1135a76040f88767e31e56bc707a
.Net	Azure.ResourceManager.MachineLearning	There is no API change compared with the previous version

paledger · 2024-09-12T20:44:28Z

Waiting for this PR to help with presenting scoped changes better: #30540

My changes are represented by this contract change PR: https://dev.azure.com/msdata/Vienna/_git/vienna/pullrequest/1455945?_a=files

* re-order mfe.json * update order for properties * fix description

razvanbadea-msft · 2024-09-17T11:47:55Z

          "environmentId": {

is his of arm-id format? #Resolved

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:18601 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

razvanbadea-msft · 2024-09-17T11:48:43Z

              "additionalProperties": {

Use of additionalProperties is not allowed for properties owned by the service. The only time its ok to use it is when the properties are pass thru (user defined) and not subject to any validations. Please make this an array or provide an explanation for why you need this.

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:18609 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

razvanbadea-msft · 2024-09-17T11:49:24Z

          "modelId": {

is the url format applicable here? #Resolved

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:18637 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

razvanbadea-msft · 2024-09-17T11:56:37Z

                  "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample Kâ€“S) metric."

is this intended?

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:22123 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

razvanbadea-msft · 2024-09-17T11:57:24Z

                  "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample Kâ€“S) metric."

is this as intended

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:22224 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

razvanbadea-msft · 2024-09-17T11:58:33Z

/azp run

azure-pipelines · 2024-09-17T11:58:48Z

Azure Pipelines successfully started running 3 pipeline(s).

razvanbadea-msft · 2024-09-17T11:59:33Z

          "properties": {

Use of additionalProperties is not allowed for properties owned by the service. The only time its ok to use it is when the properties are pass thru (user defined) and not subject to any validations. Please make this an array or provide an explanation for why you need this.

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:23228 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

razvanbadea-msft · 2024-09-17T12:05:25Z

      "post": {

shouldnt this be a get? #Resolved

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:9898 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

razvanbadea-msft · 2024-09-17T12:05:50Z

                  "$ref": "./examples/Workspace/InferenceGroup/getStatus.json"

are the example files added? #Resolved

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:9951 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

paledger · 2024-09-19T02:23:12Z

Swagger SemanticValidation failed with missing example file.

Updated, SemanticValidation and ModelValidation passing

paledger · 2024-09-19T20:46:22Z

          "properties": {
ARM is trying to reduce instances of unschematized APIs to make it easier for consumers of those APIs to understand them and use them reliably, not to mention provide better support in the various SDKs.

You should attend ARM modeling office hours to see if there are better options for you use case scenario

In reply to: 2355511204

Refers to: specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2024-10-01-preview/mfe.json:23228 in 7cb9771. [](commit_id = 7cb9771, deletion_comment = False)

OK I updated to what you recommended IList<KeyValuePair<string, string>>, including examples.

paledger · 2024-09-19T20:46:36Z

/azp run

azure-pipelines · 2024-09-19T20:46:53Z

Azure Pipelines successfully started running 3 pipeline(s).

razvanbadea-msft · 2024-09-20T08:15:17Z

You need to fix the Swagger PrettierCheck for some example files. I will sign this off to speed things up as we discussed in office hours, but be aware that for merging the check must be fixed first.

paledger · 2024-09-20T21:57:00Z

/azp run

azure-pipelines · 2024-09-20T21:57:14Z

Azure Pipelines successfully started running 3 pipeline(s).

…024 10 01 preview (#30112) * Copy files from preview/2024-07-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from preview/2024-07-01-preview to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * Fix for Prettier gate failures on Oct24 Preview (#30373) * [AML]re-order mfe.json in 2024-10-01-preview (#30540) * re-order mfe.json * update order for properties * fix description * Add InferencePools resource to 2024-10-01-preview (#30531) * Add InferencePool APIs to 2024-10-01-preview * Run Prettier to fix gates * [AML]re-order mfe.json in 2024-10-01-preview (#30540) * re-order mfe.json * update order for properties * fix description * rebase main * Run prettier to fix gates * Add delta model API - accidentally excluded before * Add deltamodel examples * Move delta model examples * Fix examples * Update examples to remove outdated properties * Remove schema * KeyValuePair * Update examples with array of KVP * Update examples with array of KVP * Update examples with array of KVP * Run prettier on examples --------- Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com> * [AML] 2024-10-01-preview change for workspace RP (#30651) * update workspace RP fix proxy API version parameter fix format * Fix JS automation * update properties * update with fix * address feedback * resolve lintdiff * Update format * remove one property * Updated "WorkspaceRP.json" to add the property `ProvisionNetworkNow`. (#30754) - To provision the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing Co-authored-by: Jing Li <jingli8@microsoft.com> * [MFE][InferencePools] Add operation IDs (#30776) Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> * 2024-10-01-preview - Update finetuning job related contracts in oct preview api. (#30798) * Update finetuning contracts. * Prettify * update examples. * make it prettier. * Fix gates. * fix bad json. * prettify * Fix the model validation gates. * Fix model validation gates. * Fix. --------- Co-authored-by: Sagar Sumant <sasum@microsoft.com> * [AML] Add capabilityHosts support in MFE (#30666) * temp save * Add capabilityHost support to MFE * Update location header in example * Fix errors * Change readonly location to enum * Add suppression * [AML]Update capabilityHost schema (#30957) * Update capabilityHost * Update CapabilityHost schema * Fix typo * Fix bug in swagger (#31070) * [AML] Fix LintDiff in staging branch (#31135) * Add some suppression * Fixing MFE LintDiff * Update RP suppression * Add missing parameter pattern (#31197) add missing pattern for parameter Add missing pattern for the parameter --------- Co-authored-by: ZhidaLiu <zhili@microsoft.com> Co-authored-by: Paula Ledgerwood <pledgerw@calpoly.edu> Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: Jing Li <u9009@outlook.com> Co-authored-by: Jing Li <jingli8@microsoft.com> Co-authored-by: sagarsumant <sagar.sumant@gmail.com> Co-authored-by: Sagar Sumant <sasum@microsoft.com>

…024 10 01 preview (Azure#30112) * Copy files from preview/2024-07-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from preview/2024-07-01-preview to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * Fix for Prettier gate failures on Oct24 Preview (Azure#30373) * [AML]re-order mfe.json in 2024-10-01-preview (Azure#30540) * re-order mfe.json * update order for properties * fix description * Add InferencePools resource to 2024-10-01-preview (Azure#30531) * Add InferencePool APIs to 2024-10-01-preview * Run Prettier to fix gates * [AML]re-order mfe.json in 2024-10-01-preview (Azure#30540) * re-order mfe.json * update order for properties * fix description * rebase main * Run prettier to fix gates * Add delta model API - accidentally excluded before * Add deltamodel examples * Move delta model examples * Fix examples * Update examples to remove outdated properties * Remove schema * KeyValuePair * Update examples with array of KVP * Update examples with array of KVP * Update examples with array of KVP * Run prettier on examples --------- Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com> * [AML] 2024-10-01-preview change for workspace RP (Azure#30651) * update workspace RP fix proxy API version parameter fix format * Fix JS automation * update properties * update with fix * address feedback * resolve lintdiff * Update format * remove one property * Updated "WorkspaceRP.json" to add the property `ProvisionNetworkNow`. (Azure#30754) - To provision the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing Co-authored-by: Jing Li <jingli8@microsoft.com> * [MFE][InferencePools] Add operation IDs (Azure#30776) Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> * 2024-10-01-preview - Update finetuning job related contracts in oct preview api. (Azure#30798) * Update finetuning contracts. * Prettify * update examples. * make it prettier. * Fix gates. * fix bad json. * prettify * Fix the model validation gates. * Fix model validation gates. * Fix. --------- Co-authored-by: Sagar Sumant <sasum@microsoft.com> * [AML] Add capabilityHosts support in MFE (Azure#30666) * temp save * Add capabilityHost support to MFE * Update location header in example * Fix errors * Change readonly location to enum * Add suppression * [AML]Update capabilityHost schema (Azure#30957) * Update capabilityHost * Update CapabilityHost schema * Fix typo * Fix bug in swagger (Azure#31070) * [AML] Fix LintDiff in staging branch (Azure#31135) * Add some suppression * Fixing MFE LintDiff * Update RP suppression * Add missing parameter pattern (Azure#31197) add missing pattern for parameter Add missing pattern for the parameter --------- Co-authored-by: ZhidaLiu <zhili@microsoft.com> Co-authored-by: Paula Ledgerwood <pledgerw@calpoly.edu> Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: Jing Li <u9009@outlook.com> Co-authored-by: Jing Li <jingli8@microsoft.com> Co-authored-by: sagarsumant <sagar.sumant@gmail.com> Co-authored-by: Sagar Sumant <sasum@microsoft.com>

…024 10 01 preview (#30112) * Copy files from preview/2024-07-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from preview/2024-07-01-preview to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * Fix for Prettier gate failures on Oct24 Preview (#30373) * [AML]re-order mfe.json in 2024-10-01-preview (#30540) * re-order mfe.json * update order for properties * fix description * Add InferencePools resource to 2024-10-01-preview (#30531) * Add InferencePool APIs to 2024-10-01-preview * Run Prettier to fix gates * [AML]re-order mfe.json in 2024-10-01-preview (#30540) * re-order mfe.json * update order for properties * fix description * rebase main * Run prettier to fix gates * Add delta model API - accidentally excluded before * Add deltamodel examples * Move delta model examples * Fix examples * Update examples to remove outdated properties * Remove schema * KeyValuePair * Update examples with array of KVP * Update examples with array of KVP * Update examples with array of KVP * Run prettier on examples --------- Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com> * [AML] 2024-10-01-preview change for workspace RP (#30651) * update workspace RP fix proxy API version parameter fix format * Fix JS automation * update properties * update with fix * address feedback * resolve lintdiff * Update format * remove one property * Updated "WorkspaceRP.json" to add the property `ProvisionNetworkNow`. (#30754) - To provision the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing Co-authored-by: Jing Li <jingli8@microsoft.com> * [MFE][InferencePools] Add operation IDs (#30776) Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> * 2024-10-01-preview - Update finetuning job related contracts in oct preview api. (#30798) * Update finetuning contracts. * Prettify * update examples. * make it prettier. * Fix gates. * fix bad json. * prettify * Fix the model validation gates. * Fix model validation gates. * Fix. --------- Co-authored-by: Sagar Sumant <sasum@microsoft.com> * [AML] Add capabilityHosts support in MFE (#30666) * temp save * Add capabilityHost support to MFE * Update location header in example * Fix errors * Change readonly location to enum * Add suppression * [AML]Update capabilityHost schema (#30957) * Update capabilityHost * Update CapabilityHost schema * Fix typo * Fix bug in swagger (#31070) * [AML] Fix LintDiff in staging branch (#31135) * Add some suppression * Fixing MFE LintDiff * Update RP suppression * Add missing parameter pattern (#31197) add missing pattern for parameter Add missing pattern for the parameter --------- Co-authored-by: ZhidaLiu <zhili@microsoft.com> Co-authored-by: Paula Ledgerwood <pledgerw@calpoly.edu> Co-authored-by: Paula Ledgerwood <paledger@microsoft.com> Co-authored-by: Jing Li <u9009@outlook.com> Co-authored-by: Jing Li <jingli8@microsoft.com> Co-authored-by: sagarsumant <sagar.sumant@gmail.com> Co-authored-by: Sagar Sumant <sasum@microsoft.com>

Add InferencePool APIs to 2024-10-01-preview

11d98f5

AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 12, 2024

Run Prettier to fix gates

52bcbf4

azure-sdk mentioned this pull request Sep 12, 2024

[AutoPR azure-mgmt-machinelearningservices] Add InferencePools resource to 2024-10-01-preview azure-sdk/azure-sdk-for-python#8673

Closed

ZhidaLiu and others added 3 commits September 13, 2024 13:07

[AML]re-order mfe.json in 2024-10-01-preview (Azure#30540)

a093926

* re-order mfe.json * update order for properties * fix description

rebase main

e6de7af

rebase main and fix merge conflicts

7cb9771

razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 17, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 17, 2024

Run prettier to fix gates

7e37853

Paula Ledgerwood added 5 commits September 18, 2024 11:04

Add deltamodel examples

a5e3bda

Move delta model examples

ff8db75

Fix examples

c8b6555

Update examples to remove outdated properties

01c686d

Remove schema

9379ba1

KeyValuePair

0e95ca5

paledger removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 19, 2024

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 19, 2024

Paula Ledgerwood added 3 commits September 19, 2024 11:25

Update examples with array of KVP

2dcf4fc

Update examples with array of KVP

3d1b7b5

Update examples with array of KVP

9f6070a

razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 20, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 20, 2024

Run prettier on examples

a715168

raushan2016 approved these changes Sep 20, 2024

View reviewed changes

ZhidaLiu approved these changes Sep 20, 2024

View reviewed changes

paledger merged commit 3c01394 into Azure:release-machinelearningservices-Microsoft.MachineLearningServices-2024-10-01-preview Sep 20, 2024
19 of 27 checks passed

ragovada mentioned this pull request Oct 25, 2024

Release machinelearningservices microsoft.machine learning services 2024 10 01 preview #30112

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add InferencePools resource to 2024-10-01-preview #30531

Add InferencePools resource to 2024-10-01-preview #30531

paledger commented Sep 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Sep 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Sep 12, 2024 •

edited

Loading

paledger commented Sep 12, 2024

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024

azure-pipelines bot commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading

paledger commented Sep 19, 2024

paledger commented Sep 19, 2024

paledger commented Sep 19, 2024

azure-pipelines bot commented Sep 19, 2024

razvanbadea-msft commented Sep 20, 2024

paledger commented Sep 20, 2024

azure-pipelines bot commented Sep 20, 2024

Add InferencePools resource to 2024-10-01-preview #30531

Add InferencePools resource to 2024-10-01-preview #30531

Conversation

paledger commented Sep 12, 2024 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Sep 12, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Sep 12, 2024 • edited Loading

Generated ApiView

paledger commented Sep 12, 2024

razvanbadea-msft commented Sep 17, 2024 • edited Loading

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024 • edited Loading

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024

azure-pipelines bot commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024

razvanbadea-msft commented Sep 17, 2024 • edited Loading

razvanbadea-msft commented Sep 17, 2024 • edited Loading

paledger commented Sep 19, 2024

paledger commented Sep 19, 2024

paledger commented Sep 19, 2024

azure-pipelines bot commented Sep 19, 2024

razvanbadea-msft commented Sep 20, 2024

paledger commented Sep 20, 2024

azure-pipelines bot commented Sep 20, 2024

paledger commented Sep 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Sep 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Sep 12, 2024 •

edited

Loading

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading

razvanbadea-msft commented Sep 17, 2024 •

edited

Loading