Cognitive Services 2024-10-01

[tianxin-ms]

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	https://apiview.dev/Assemblies/Review/66028a1b0484496b9acef54706863731?revisionId=aa40bb8f80a14fcfbfe4ff19cd6dbeb8
JavaScript	@azure/arm-cognitiveservices	https://apiview.dev/Assemblies/Review/a5c5802052af4553bdae74a523c883bd?revisionId=3d20e4c521c04a58ae336e21bfc6106d
Java	azure-resourcemanager-cognitiveservices	https://apiview.dev/Assemblies/Review/a73850d7bd4c49edbb4d514cb6626155?revisionId=df75d53386504f05bf00023a17635745
Swagger	Microsoft.CognitiveServices	https://apiview.dev/Assemblies/Review/5a98bbc1fc714e6880090e5e8e7d3366?revisionId=63594a2154c64692a9c270f24aa39a45

[razvanbadea-msft]

      "format": "arm-id",

you can also add a x-ms-arm-id-details with allowedResources if the id will be only Microsoft.CognitiveServices one

---

Refers to: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/cognitiveservices.json:5476 in 7125885. [](commit_id = 7125885, deletion_comment = False)

[razvanbadea-msft]

I signed it off but check also my comment about arm-id properties

[MaryGao]

@tianxin-ms @yangyuan is this a typo issue? should this be a type of array?

we notice that the relevant samples are array. this caused issue during release: https://github.com/Azure/sdk-release-request/issues/5715#issuecomment-2527162204.

[tianxin-ms]

Yes, I think you're right, I will fix this in the next api version. Thank you!