Skip to content

Conversation

@andpiccione
Copy link
Member

@andpiccione andpiccione commented Sep 19, 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!

Purpose of this PR: add two new optional enum properties (EnclavePlatform and ApplicationType) to the ARM REST API specifications for Azure Confidential Ledger and Azure Managed CCF.

  • 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 preview/2024-07-09-preview to preview/2024-09-19-preview.
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 19, 2024

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
Copy link

openapi-pipeline-app bot commented Sep 19, 2024

@andpiccione andpiccione added the BreakingChange-Approved-Previously Changes were reviewed and approved in a previous PR label Sep 19, 2024
@andpiccione
Copy link
Member Author

The required check Breaking Change(Cross-Version) is failing due to changes that are not related to this new API version (see details).

This new preview API version has been based off the latest preview version (2024-07-09-preview) and the previous PR / preview API version, which also had the same detected breaking changes, was eventually approved. Therefore, I've added the BreakingChange-Approved-Previously label.

@andpiccione andpiccione added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Sep 19, 2024
@andpiccione
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@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 Dec 31, 2024
@azure-sdk
Copy link
Collaborator

azure-sdk commented Dec 31, 2024

API change check

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

Microsoft.ConfidentialLedger
Microsoft.CodeTransparency
Microsoft.ManagedCcf

@andpiccione andpiccione marked this pull request as ready for review December 31, 2024 19:34
@andpiccione
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@andpiccione andpiccione self-assigned this Dec 31, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 31, 2024
@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jan 2, 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 Jan 2, 2025
@andpiccione
Copy link
Member Author

Waiting for team review before merging the PR

@andpiccione andpiccione enabled auto-merge (squash) January 8, 2025 21:23
Copy link
Member

@ryazhang-microsoft ryazhang-microsoft left a comment

Choose a reason for hiding this comment

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

LGTM!

@andpiccione andpiccione merged commit 636f504 into main Jan 8, 2025
29 of 30 checks passed
@andpiccione andpiccione deleted the andpiccione-confidentialledger-Microsoft.ConfidentialLedger-2024-09-19-preview branch January 8, 2025 21:35
santiagxf pushed a commit to santiagxf/azure-rest-api-specs that referenced this pull request Jan 15, 2025
…9-19-preview (Azure#30653)

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

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

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

* Add enclave platform property

* Fix prettier

* Add application type property
pjpatel12 pushed a commit to pjpatel12/azure-rest-api-specs that referenced this pull request Apr 29, 2025
…9-19-preview (Azure#30653)

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

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

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

* Add enclave platform property

* Fix prettier

* Add application type property
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-Approved-Previously Changes were reviewed and approved in a previous PR BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. 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 RPaaS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants