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

sdkautomation breaking change, mgmt typespec #3381

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

XiaofeiCao
Copy link

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.
  • 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.

Copy link

openapi-pipeline-app-test bot commented Jun 28, 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-test bot commented Jun 28, 2024

Swagger Generation Artifacts

️️✔️[ignore this check status; not blocking PR merge] ApiDocPreview succeeded [Detail] [Expand]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 5341694. SDK Automation 14.0.0
    command	./eng/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-scvmm [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] * `ScvmmManager$Configurable` was removed
    info	[Changelog]
    info	[Changelog] * `models.InventoryItemListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.VmInstanceHybridIdentityMetadataListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.VirtualMachineTemplateListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.VirtualNetworkListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.AvailabilitySetListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.OperationListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.VmmServerListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.CloudListResult` was removed
    info	[Changelog]
    info	[Changelog] * `ScvmmManager` was removed
    info	[Changelog]
    info	[Changelog] * `models.VirtualMachineInstanceListResult` was removed
    info	[Changelog]
    info	[Changelog] * `models.GuestAgentListResult` was removed
    info	[Changelog]
    info	[Changelog] #### `models.Checkpoint` was modified
    info	[Changelog]
    info	[Changelog] * `withCheckpointId(java.lang.String)` was removed
    info	[Changelog] * `withDescription(java.lang.String)` was removed
    info	[Changelog] * `withName(java.lang.String)` was removed
    info	[Changelog] * `withParentCheckpointId(java.lang.String)` was removed
    info	[Changelog]
    info	[Changelog] #### `models.StorageQosPolicy` was modified
    info	[Changelog]
    info	[Changelog] * `withIopsMinimum(java.lang.Long)` was removed
    info	[Changelog] * `withBandwidthLimit(java.lang.Long)` was removed
    info	[Changelog] * `withIopsMaximum(java.lang.Long)` was removed
    info	[Changelog] * `withName(java.lang.String)` was removed
    info	[Changelog] * `withPolicyId(java.lang.String)` was removed
    info	[Changelog] * `withId(java.lang.String)` was removed
    info	[Changelog]
    info	[Changelog] #### `models.VmInstanceHybridIdentityMetadataProperties` was modified
    info	[Changelog]
    info	[Changelog] * `withPublicKey(java.lang.String)` was removed
    info	[Changelog] * `withResourceUid(java.lang.String)` was removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] * `implementation.models.VirtualMachineInstanceListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.VmmServerListResult` was added
    info	[Changelog]
    info	[Changelog] * `SCVMMManager` was added
    info	[Changelog]
    info	[Changelog] * `SCVMMManager$Configurable` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.VirtualNetworkListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.InventoryItemListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.GuestAgentListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.VirtualMachineTemplateListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.AvailabilitySetListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.VmInstanceHybridIdentityMetadataListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.OperationListResult` was added
    info	[Changelog]
    info	[Changelog] * `implementation.models.CloudListResult` was added
    info	[Changelog]
    info	[Changelog]
    Parse Suppression File Errors
    No suppression file added.
    Please refer to the guidance for suppressing SDK breaking changes.
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app-test bot commented Jun 28, 2024

Generated ApiView

Language Package Name ApiView Link
Java azure-resourcemanager-scvmm https://apiviewstagingtest.com/Assemblies/Review/d4498fa603164775b5f98ccacae549d8?revisionId=a84e7192ef03472eadfc9f0945e74b54

Copy link

openapi-pipeline-app-test bot commented Jun 28, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️[ignore this check status; not blocking PR merge] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[ignore this check status; not blocking PR merge] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@XiaofeiCao
Copy link
Author

/azp run

Copy link

No pipelines are associated with this pull request.

@XiaofeiCao
Copy link
Author

/azp run

Copy link

No pipelines are associated with this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants