Cognitive Services 2025-04-01

[ZhidaLiu]

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]

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]

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/cognitiveservices/armcognitiveservices	Create ApiView timeout. Package is too large and we cannot create ApiView for it.
Java	azure-resourcemanager-cognitiveservices	https://apiview.dev/Assemblies/Review/a73850d7bd4c49edbb4d514cb6626155?revisionId=994a2776f3554856b662c75e608e1e2f
.Net	Azure.ResourceManager.CognitiveServices	https://apiview.dev/Assemblies/Review/6d32d60e5cfc4217b399f2d21cf6df5f?revisionId=08cae5afbf1d40a98208138e35fcaf62
JavaScript	@azure/arm-cognitiveservices	https://apiview.dev/Assemblies/Review/a5c5802052af4553bdae74a523c883bd?revisionId=a47caf45b7604fbdaa2e62eee513a41d
Python	azure-mgmt-cognitiveservices	https://apiview.dev/Assemblies/Review/0e28ee9c469a48049a651419d2c0c67a?revisionId=a523d6582a8749509469025f7c2f13c0

[ZhidaLiu]

The connection and capabilityHost APIs and schema are directly copied from AML RP located in:

azure-rest-api-specs/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2025-01-01-preview/workspaceRP.json

Line 463 in c39f72c

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": {

we would like to keep the schema unchanged

[debuggerXi]

The lint diff error remain are now all caused by either the existing behavior of the Cognitive Service accounts CURD API getting copied to the accounts/projects APIs, or they are from the schema that we copied from the AML RP schema that we wish to keep (AML suppression link:

azure-rest-api-specs/specification/machinelearningservices/resource-manager/readme.md

Line 44 in 15ec244

suppressions:

). We do want to suppress these and not block this critical version release. Due to time limit, we won't have the suppression rules now but we will work on those items in the next version.

[tadelesh]

/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.

[azure-sdk]

API change check

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

Microsoft.CognitiveServices

[rkmanda]