Skip to content

[Microsoft.DevCenter] [ConrolPlane] New 2025-07-01-preview API version #35507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ArberH
Copy link
Contributor

@ArberH ArberH commented Jun 26, 2025

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.

Arber Hila added 4 commits June 26, 2025 09:49
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2025-04-01-preview to preview/2025-07-01-preview.
Copy link

openapi-pipeline-app bot commented Jun 26, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ 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 Automated merging requirements met has failed. This is the final check that must pass. 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. In addition, refer to step 4 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented Jun 26, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Jun 26, 2025
@ArberH ArberH added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Jun 26, 2025
Copy link

github-actions bot commented Jun 26, 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.DevCenter
Go sdk/resourcemanager/devcenter/armdevcenter
JavaScript @azure/arm-devcenter
Java com.azure.resourcemanager:azure-resourcemanager-devcenter
Python azure-mgmt-devcenter

@AzureRestAPISpecReview AzureRestAPISpecReview added new-api-version resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 26, 2025
@ArberH
Copy link
Contributor Author

ArberH commented Jun 26, 2025

Adding Approved-LintDiff label to surpress two errors that we cannot fix.

  1. Properties of a PATCH request body must not be required, property:type.
    Location: Microsoft.DevCenter/preview/2025-07-01-preview/devcenter.json#L524

This is because we reference the shared definition type ManagedServiceIdentity which has required property "type"

  1. Properties of a PATCH request body must not be required, property:name.
    Location: Microsoft.DevCenter/preview/2025-07-01-preview/vdi.json#L242

This is because we reference the shared definition type Sku, which has required property "name"

@ArberH
Copy link
Contributor Author

ArberH commented Jun 26, 2025

/azp run

Copy link

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.

Copy link
Member

@pshao25 pshao25 left a comment

Choose a reason for hiding this comment

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

Please check out the email titled "IMPORTANT: Your service is scheduled to be converted to TypeSpec in July". Any changes directly on swagger is not allowed. Contact Matthew Gertz Matthew.Gertz@microsoft.com for details.

reason: Patch Body comes from common-types v5 Sku object. Keeping here for consistency with existing parts of API to avoid breaking customers.
- code: PatchBodyParametersSchema
from: devcenter.json
reason: Patch Body comes from common-types managedidentity object. Keeping here for consistency with existing parts of API to avoid breaking customers.
Copy link
Contributor

Choose a reason for hiding this comment

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

please add the path for each suppression, instead of suppressing for the whole file.

@ramoka178
Copy link
Contributor

        "resourceId": {

if its only valid for user assigned identity, can this be renamed as "userAssignedIdentityResourceId" and be an optional field so that users can skip for system assigned identity case.


Refers to: specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2025-07-01-preview/devcenter.json:5612 in 5a5aa12. [](commit_id = 5a5aa12, deletion_comment = False)

@ramoka178 ramoka178 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jun 27, 2025
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-LintDiff ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. new-api-version PipelineBotTrigger PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager RPaaS SuppressionReviewRequired
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants