Update description of platformAttributes #31525

lkumaar · 2024-11-13T07:58:24Z

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 · 2024-11-13T07:58:28Z

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 · 2024-11-13T07:58:28Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/compute/armcompute	https://apiview.dev/Assemblies/Review/13fa09201aa545c19d240f82d38c09c9?revisionId=a2ee31b9ecbc449e9fa9afefe55e1cf4
Java	azure-resourcemanager-compute-generated	https://apiview.dev/Assemblies/Review/eb099b2efb0f4373a854e09003a6b31d?revisionId=9153d91fb508474a9f00fe26d94454fb
JavaScript	@azure/arm-compute	https://apiview.dev/Assemblies/Review/a802869b6345406cbb6d1e487132d7dd?revisionId=8aaa9c30a2b040869dc55d1db10761f9
.Net	Azure.ResourceManager.Compute	https://apiview.dev/Assemblies/Review/7fec998c6beb4201bb99c335d06c70fa?revisionId=e22d651570df4e208e4c768a22b9d888
Swagger	Microsoft.Compute	https://apiview.dev/Assemblies/Review/b32a43d6ad48477b9343d7a921e72411?revisionId=2fba4a3f89504beb9e78fd70ea597fe0

...fication/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/gallery.json

* copy last version folder as 2024-03-03 * change version reference in swagger json files and examples * add new readme.md tag with new version * [cplat-2024-03-03] Add inVMAccessControlProfile spec in GalleryRP (#30504) * Remove async responses for HTTP 200 and 204 in delete examples * Add spec for inVMAccessControlProfile * Change put to get for list inVMAccess endpoints * LintDiff - remove 202 for PUT LRO * LintDiff - add provisioningState for GalleryInVMAccessControlProfile * LintDiff - remove 200 for DELETE LRO * LintDiff - add missing type:object for new definitions * LintDiff - add regex pattern for resource names * LintDiff - add regex pattern for resource names * LintDiff - add regex pattern for resource names * LintDiff - add Location and Azure-AsyncOperation headers for 202 LROs * Add LintDiff suppressions for PATCH operations * Add LintDiff suppressions for AvoidAdditionalProperties * Update suppression reason for AvoidAdditionalProperties * Add maxLength for inVMAccessControlProfile name * Remove PATCH spec and PATCH suppressions * Revert "Remove PATCH spec and PATCH suppressions" This reverts commit 4b884a3. * Update spec with blockDeletionBeforeEndOfLife (#30505) * [cplat-2024-03-03] Update spec for "Update GalleryImageDefinition Feature" feature (#30536) * Update spec with startsAtVersion * Add allowUpdateImage property * [cplat-2024-03-03] Update spec for SoftDelete Restore feature (#30558) * Update spec with restore * Add example for soft delete restore * Update spec with scriptBehaviorAfterReboot (#30842) * Adding AdditionalReplicaSet parameter in swagger api version 2024-03-03 (#30855) * adding additionalReplicaSet in swagger * addressing lindiff errors * addressing comments * addressing comments * updating enum * running prettier * adding separate examples * adding file in readme.md * adding at the end of properties * addressing comments * Update spec with MSI support for Galleries (#30885) * Initial commit * Modify PUT/PATCH response * Fixes * Fixes * [cplat-2024-03-03] Add List soft-deleted resources api (#31094) * Add List soft-deleted resources api and example * fix bugs * [cplat-2024-03-03] Update spec for ValidationProfile (#30658) * Update spec with validationsProfile * Add examples for GetGalleryImageVersion with ValidationProfile * Run jq to format for prettier * LintDiff - add type:object for new definitions * Reorder validationsProfile to preserve param ordering * Make validations profile readonly * Update gallery.json --------- Co-authored-by: Theodore Chang <thchan@microsoft.com> * suppress lintDiff existing from last version * Move validationsProfile to GalleryImageVersionProperties (#31310) * Move validationsProfile to GalleryImageVersionProperties * Revert "Move validationsProfile to GalleryImageVersionProperties" This reverts commit ae39672. * Move validationsProfile to GalleryImageVersionProperties * Remove validationsProfile * Revert "Remove validationsProfile" This reverts commit 36ca3e0. * fix lintDiff failure * update disclaimer (#31430) * ARM review comment addressing * Make validation status an enum (#31526) * Make validation status an enum * Run prettier * Update description of platformAttributes (#31525) * Update description of platformAttributes * Run prettier * Add readOnly: true * update softDeletedArtifactType to enum * run prettier --------- Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com> Co-authored-by: lkumaar <168636550+lkumaar@users.noreply.github.com> Co-authored-by: kgulshan827 <56105750+kgulshan827@users.noreply.github.com> Co-authored-by: mayankdaruka-msft <133302048+mayankdaruka-msft@users.noreply.github.com> Co-authored-by: jackyChenAzure <131018173+jackyChenAzure@users.noreply.github.com>

* copy last version folder as 2024-03-03 * change version reference in swagger json files and examples * add new readme.md tag with new version * [cplat-2024-03-03] Add inVMAccessControlProfile spec in GalleryRP (Azure#30504) * Remove async responses for HTTP 200 and 204 in delete examples * Add spec for inVMAccessControlProfile * Change put to get for list inVMAccess endpoints * LintDiff - remove 202 for PUT LRO * LintDiff - add provisioningState for GalleryInVMAccessControlProfile * LintDiff - remove 200 for DELETE LRO * LintDiff - add missing type:object for new definitions * LintDiff - add regex pattern for resource names * LintDiff - add regex pattern for resource names * LintDiff - add regex pattern for resource names * LintDiff - add Location and Azure-AsyncOperation headers for 202 LROs * Add LintDiff suppressions for PATCH operations * Add LintDiff suppressions for AvoidAdditionalProperties * Update suppression reason for AvoidAdditionalProperties * Add maxLength for inVMAccessControlProfile name * Remove PATCH spec and PATCH suppressions * Revert "Remove PATCH spec and PATCH suppressions" This reverts commit 4b884a3. * Update spec with blockDeletionBeforeEndOfLife (Azure#30505) * [cplat-2024-03-03] Update spec for "Update GalleryImageDefinition Feature" feature (Azure#30536) * Update spec with startsAtVersion * Add allowUpdateImage property * [cplat-2024-03-03] Update spec for SoftDelete Restore feature (Azure#30558) * Update spec with restore * Add example for soft delete restore * Update spec with scriptBehaviorAfterReboot (Azure#30842) * Adding AdditionalReplicaSet parameter in swagger api version 2024-03-03 (Azure#30855) * adding additionalReplicaSet in swagger * addressing lindiff errors * addressing comments * addressing comments * updating enum * running prettier * adding separate examples * adding file in readme.md * adding at the end of properties * addressing comments * Update spec with MSI support for Galleries (Azure#30885) * Initial commit * Modify PUT/PATCH response * Fixes * Fixes * [cplat-2024-03-03] Add List soft-deleted resources api (Azure#31094) * Add List soft-deleted resources api and example * fix bugs * [cplat-2024-03-03] Update spec for ValidationProfile (Azure#30658) * Update spec with validationsProfile * Add examples for GetGalleryImageVersion with ValidationProfile * Run jq to format for prettier * LintDiff - add type:object for new definitions * Reorder validationsProfile to preserve param ordering * Make validations profile readonly * Update gallery.json --------- Co-authored-by: Theodore Chang <thchan@microsoft.com> * suppress lintDiff existing from last version * Move validationsProfile to GalleryImageVersionProperties (Azure#31310) * Move validationsProfile to GalleryImageVersionProperties * Revert "Move validationsProfile to GalleryImageVersionProperties" This reverts commit ae39672. * Move validationsProfile to GalleryImageVersionProperties * Remove validationsProfile * Revert "Remove validationsProfile" This reverts commit 36ca3e0. * fix lintDiff failure * update disclaimer (Azure#31430) * ARM review comment addressing * Make validation status an enum (Azure#31526) * Make validation status an enum * Run prettier * Update description of platformAttributes (Azure#31525) * Update description of platformAttributes * Run prettier * Add readOnly: true * update softDeletedArtifactType to enum * run prettier --------- Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com> Co-authored-by: lkumaar <168636550+lkumaar@users.noreply.github.com> Co-authored-by: kgulshan827 <56105750+kgulshan827@users.noreply.github.com> Co-authored-by: mayankdaruka-msft <133302048+mayankdaruka-msft@users.noreply.github.com> Co-authored-by: jackyChenAzure <131018173+jackyChenAzure@users.noreply.github.com>

Update description of platformAttributes

01d4d19

lkumaar requested review from Sandido, dkulkarni-ms, haagha, MS-syh2qs and grizzlytheodore as code owners November 13, 2024 07:58

microsoft-github-policy-service bot added the Compute label Nov 13, 2024

AzureRestAPISpecReview added the resource-manager label Nov 13, 2024

azure-sdk mentioned this pull request Nov 13, 2024

[AutoPR sdk/resourcemanager/compute/armcompute] Update description of platformAttributes azure-sdk/azure-sdk-for-go#12142

Closed

Run prettier

be2ecb3

grizzlytheodore reviewed Nov 13, 2024

View reviewed changes

...fication/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/gallery.json Outdated Show resolved Hide resolved

Add readOnly: true

c91d28b

grizzlytheodore merged commit b3db98a into Azure:feature/cplat-2024-03-03 Nov 14, 2024
25 of 26 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update description of platformAttributes #31525

Update description of platformAttributes #31525

lkumaar commented Nov 13, 2024

openapi-pipeline-app bot commented Nov 13, 2024 •

edited

Loading

openapi-pipeline-app bot commented Nov 13, 2024 •

edited

Loading

Update description of platformAttributes #31525

Update description of platformAttributes #31525

Conversation

lkumaar commented Nov 13, 2024

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Nov 13, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Nov 13, 2024 • edited Loading

Generated ApiView

openapi-pipeline-app bot commented Nov 13, 2024 •

edited

Loading

openapi-pipeline-app bot commented Nov 13, 2024 •

edited

Loading