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

Release hybridcompute microsoft.hybrid compute 2024 09 10 preview #30546

Merged

Conversation

vedkale
Copy link
Member

@vedkale vedkale 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.

Ved Kale added 3 commits September 11, 2024 16:09
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/2024-07-31-preview to preview/2024-09-10-preview.
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

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels Sep 12, 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 Sep 30, 2024
@vedkale vedkale removed the no-recent-activity There has been no recent activity on this issue. label Sep 30, 2024
* add extension setup API and example

---------

Co-authored-by: Ved Kale <[email protected]>
@jiaqi-beep jiaqi-beep mentioned this pull request Oct 22, 2024
8 tasks
@jiaqi-beep
Copy link
Member

/azp run

Copy link

Azure Pipelines successfully started running 3 pipeline(s).

* use v3 common-types

* prettier

* attempt v5 common types

* dummy change to trigger checks

* Revert "dummy change to trigger checks"

This reverts commit 9925d24.

* Revert "attempt v5 common types"

This reverts commit 4ed6fa4.

* update to v5

* update subscriptionid to guid format in examples

* fix examples in machines

* Revert "fix examples in machines"

This reverts commit cf84a91.

* fix model validation

* fix model validation

* prettier

* prettier

* prettier

* Revert "prettier"

This reverts commit ea820f1.

* Revert "prettier"

This reverts commit 68b5bb6.

* Revert "prettier"

This reverts commit e5065de.

* Revert "fix model validation"

This reverts commit 4b0723f.

* Revert "fix model validation"

This reverts commit 9ad91b4.

* Reapply "fix examples in machines"

This reverts commit 8f00a27.

* Revert "fix examples in machines"

This reverts commit cf84a91.

* Revert "update subscriptionid to guid format in examples"

This reverts commit 8f1af4d.

* Revert "update to v5"

This reverts commit e0083cf.

* Reapply "attempt v5 common types"

This reverts commit 3df6b50.

* Reapply "dummy change to trigger checks"

This reverts commit 0956f17.

* Revert "dummy change to trigger checks"

This reverts commit 9925d24.

* use v3 common type

* Update sdk-suppressions.yaml

---------

Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
@vedkale
Copy link
Member Author

vedkale commented Oct 28, 2024

@TimLovellSmith The API is essentially used for installing a set of VM extensions, currently ARM doesn't support RBAC based on body, and we wanted to expose an API that lets you install certain VM extensions that we think are ok to install. Currently, it the /extensions API lets you install all VM extensions which contain some very powerful extensions that not all customers want to install on their machine. We have no issue with changing the names, we can change this to /addExtensions and change "extensionSetupList" to "extensions". and change 'MachineExtensionSetup' to 'SetupExtensionRequest'.

@raosuhas
Copy link

raosuhas commented Nov 4, 2024

@vedkale Could you also respond to the question about POST not being able be called using the ARM template ? Is it acceptable for your customers to not be able to call setup extentions using an ARM template ? It seems like an big limitation to me.

@raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 4, 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 Nov 4, 2024
@vedkale
Copy link
Member Author

vedkale commented Nov 4, 2024

@raosuhas that seems ok to me. From what I understand if we were to make this a PUT call, it would require the other actions like DELETE, PATCH and GET. We don't want to add those actions for this API. If my understand is incorrect, we will make it a PUT call.

I also created another PR to change the names like @TimLovellSmith suggested
#31346

@vedkale vedkale removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 4, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 4, 2024
@raosuhas
Copy link

raosuhas commented Nov 5, 2024

@raosuhas that seems ok to me. From what I understand if we were to make this a PUT call, it would require the other actions like DELETE, PATCH and GET. We don't want to add those actions for this API. If my understand is incorrect, we will make it a PUT call.

I also created another PR to change the names like @TimLovellSmith suggested #31346

PATCH\DELETE\GET is not a requirement as long as you model it as a Proxy resource. The main problem is that with POST you cannot use this in ARM templates and you cannot use it in ARM Policy

If this is acceptable please have your manager or PM ack this comment.

@raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 5, 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 Nov 5, 2024
@raghushantha
Copy link
Contributor

Hi @raosuhas - Thank you for taking the time to review the PR.
We don't intend to use this functionality via Templates or Policy. The API is designed to be used from our Cli experience via the on-premises machine.

ACK'ing your above comment.

@vedkale vedkale removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 5, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 5, 2024
@vedkale
Copy link
Member Author

vedkale commented Nov 5, 2024

@raosuhas can you also approve this PR to address the naming issues #31346

@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 6, 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 Nov 6, 2024
@vedkale vedkale removed the request for review from mikeharder November 7, 2024 18:05
@vedkale vedkale added ArcSignedOff PublishToCustomers Acknowledgement the changes will be published to Azure customers. labels Nov 7, 2024
@mikeharder mikeharder dismissed their stale review November 7, 2024 21:33

Issue addressed

@vedkale vedkale enabled auto-merge (squash) November 7, 2024 23:17
@vedkale vedkale merged commit 0383d4a into main Nov 11, 2024
29 of 30 checks passed
@vedkale vedkale deleted the release-hybridcompute-Microsoft.HybridCompute-2024-09-10-preview branch November 11, 2024 23:21
mikeharder pushed a commit to mikeharder/azure-rest-api-specs that referenced this pull request Nov 13, 2024
…ure#30546)

* Copy files from preview/2024-07-31-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-09-10-preview

Updated the API version from preview/2024-07-31-preview to preview/2024-09-10-preview.

* Added tag for 2024-09-10-preview in readme file

* add extension setup API and example (Azure#30592)

* add extension setup API and example

---------

Co-authored-by: Ved Kale <[email protected]>

* use v3 common-types (Azure#31063)

* use v3 common-types

* prettier

* attempt v5 common types

This reverts commit 9925d24.

* Revert "attempt v5 common types"

This reverts commit 4ed6fa4.

* update to v5

* update subscriptionid to guid format in examples

* fix examples in machines

* Revert "fix examples in machines"

This reverts commit cf84a91.

* fix model validation

* fix model validation

* prettier

* prettier

* prettier

* Revert "prettier"

This reverts commit ea820f1.

* Revert "prettier"

This reverts commit 68b5bb6.

* Revert "prettier"

This reverts commit e5065de.

* Revert "fix model validation"

This reverts commit 4b0723f.

* Revert "fix model validation"

This reverts commit 9ad91b4.

* Reapply "fix examples in machines"

This reverts commit 8f00a27.

* Revert "fix examples in machines"

This reverts commit cf84a91.

* Revert "update subscriptionid to guid format in examples"

This reverts commit 8f1af4d.

* Revert "update to v5"

This reverts commit e0083cf.

* Reapply "attempt v5 common types"

This reverts commit 3df6b50.

* Reapply "dummy change to trigger checks"

This reverts commit 0956f17.

* Revert "dummy change to trigger checks"

This reverts commit 9925d24.

* use v3 common type

* Update sdk-suppressions.yaml

---------

Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>

* Microsoft.HybridCompute-2024-09-10-preview update API and swagger with better naming (Azure#31346)

Co-authored-by: Ved Kale <[email protected]>

---------

Co-authored-by: Ved Kale <[email protected]>
Co-authored-by: jiaqi-beep <[email protected]>
Co-authored-by: Jiaqi Li <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ArcReview ArcSignedOff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Previously Changes were reviewed and approved in a previous PR BreakingChange-Python-Sdk-Suppression BreakingChange-Python-Sdk-Suppression-Approved BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version PipelineBotTrigger 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.

8 participants