Skip to content
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

Alecb stable20240910 desktopvirtualization #30530

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

Conversation

alec-baird
Copy link
Member

@alec-baird alec-baird commented Sep 12, 2024

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.

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.

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/2024-04-03 to stable/2024-09-10.
Copy link

openapi-pipeline-app bot commented Sep 12, 2024

Next Steps to Merge

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

Copy link

openapi-pipeline-app bot commented Sep 12, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization https://apiview.dev/Assemblies/Review/5d2d754fdb64441e992b57b5f303fe2b?revisionId=848f4067e36e4e2c951589e8205b9792
Java azure-resourcemanager-desktopvirtualization https://apiview.dev/Assemblies/Review/eff8617dd2654aee80849b835d97ce5b?revisionId=95c6c29c57244cce82928c3b41678e3b
.Net Azure.ResourceManager.DesktopVirtualization https://apiview.dev/Assemblies/Review/30b33565a4ee48778fb650c65d7f62d3?revisionId=1f0682047257471cb9a6f90c81bba7fb
JavaScript @azure/arm-desktopvirtualization Create ApiView timeout. Package is too large and we cannot create ApiView for it.
Swagger Microsoft.DesktopVirtualization https://apiview.dev/Assemblies/Review/9a75471881634d42b7daa81a823c4b2e?revisionId=7a809e5dbb9d438cb54fabb58f7bece0

@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Sep 12, 2024
@alec-baird
Copy link
Member Author

Don't know why this is Python breaking change

@razvanbadea-msft
Copy link
Contributor

    "managedPrivateUDP": {

in place of adding this flags cant you have for example a udpType enum property with values like [ManagedPrivateUDP, DirectUDP, PublicUDP, RelayUDP]?

I see the description for all of them is the same


Refers to: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-09-10/desktopvirtualization.json:4881 in b53d368. [](commit_id = b53d368, deletion_comment = False)

@razvanbadea-msft 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 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
@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Oct 7, 2024
@alec-baird
Copy link
Member Author

    "managedPrivateUDP": {

in place of adding this flags cant you have for example a udpType enum property with values like [ManagedPrivateUDP, DirectUDP, PublicUDP, RelayUDP]?

I see the description for all of them is the same

Refers to: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-09-10/desktopvirtualization.json:4881 in b53d368. [](commit_id = b53d368, deletion_comment = False)

It can't be an enum because you can have combinations of these flags enabled/disabled. Separate properties seemed clearest.

@microsoft-github-policy-service microsoft-github-policy-service bot removed the no-recent-activity There has been no recent activity on this issue. label Oct 7, 2024
@alec-baird alec-baird added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required no-recent-activity There has been no recent activity on this issue. and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review no-recent-activity There has been no recent activity on this issue. labels Oct 7, 2024
@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 8, 2024
@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 Oct 8, 2024
@msyyc
Copy link
Member

msyyc commented Oct 9, 2024

Added approval label for python directly since I can't commit to sdk-suppresions.yaml to source branch.

@alec-baird alec-baird added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Python-Sdk-Approved new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants