Skip to content

[Hub Generated] Publish private branch 'rbandi124-maintenance-Microsoft.Maintenance-2023-10-01-preview' #26934

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

Conversation

rbandi124
Copy link
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this 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.

diagram

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason.
    Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes

Diagram footnotes

[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • 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 swagger 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
Swagger-Suppression-Process
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.
  • 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.
  • 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.

@rbandi124
Copy link
Contributor Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/15923

Copy link

openapi-pipeline-app bot commented Dec 4, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

Copy link

openapi-pipeline-app bot commented Dec 4, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
Maintenance.json 2023-10-01-preview(301e091) 2023-04-01(main)
Maintenance.json 2023-10-01-preview(301e091) 2023-09-01-preview(main)
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2023-10 package-preview-2023-10(301e091) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L30
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L30


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L105
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L1194
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L1266
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L1556
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L1606
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L1649
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L1699
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L1742
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L2251
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L2336
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L2408
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L94
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L94
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L137
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L137
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L185
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L185
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L185
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L275
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L275
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L275
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L349
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L349
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L349
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L443
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L443
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L443
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L532
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L532
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json#L532
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Dec 4, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking



️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 030e84f63f2ca6f401ae3f35d6e70832f835c1c8. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.4
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-maintenance [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation group ScheduledEventOperations
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 030e84f63f2ca6f401ae3f35d6e70832f835c1c8. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/maintenance/armmaintenance [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New value `UpdateStatusCancel`, `UpdateStatusCancelled`, `UpdateStatusNoUpdatesPending` added to enum type `UpdateStatus`
    info	[Changelog] - New function `*ApplyUpdatesClient.CreateOrUpdateOrCancel(context.Context, string, string, string, string, string, ApplyUpdate, *ApplyUpdatesClientCreateOrUpdateOrCancelOptions) (ApplyUpdatesClientCreateOrUpdateOrCancelResponse, error)`
    info	[Changelog] - New function `*ClientFactory.NewScheduledEventClient() *ScheduledEventClient`
    info	[Changelog] - New function `NewScheduledEventClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ScheduledEventClient, error)`
    info	[Changelog] - New function `*ScheduledEventClient.Acknowledge(context.Context, string, string, string, string, *ScheduledEventClientAcknowledgeOptions) (ScheduledEventClientAcknowledgeResponse, error)`
    info	[Changelog] - New struct `ScheduledEventApproveResponse`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 9 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from 030e84f63f2ca6f401ae3f35d6e70832f835c1c8. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.4
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️maintenance [View full logs]  [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from 030e84f63f2ca6f401ae3f35d6e70832f835c1c8. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ️✔️Az.maintenance.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.maintenance.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Dec 4, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/maintenance/armmaintenance https://apiview.dev/Assemblies/Review/d9ec436a20204c8c9f27ff10b2bb35bb

@visingla-ms
Copy link
Contributor

visingla-ms commented Dec 4, 2023

        "description": "OK"

If there is no response body, return 204 (No Content) response code. Otherwise, a response schema needs to be put here for 200. #Resolved


Refers to: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json:64 in 24e00c4. [](commit_id = 24e00c4, deletion_comment = False)

@visingla-ms visingla-ms added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Dec 4, 2023
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 4, 2023
@rbandi124 rbandi124 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Dec 6, 2023
@rbandi124 rbandi124 added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 6, 2023
@rbandi124 rbandi124 force-pushed the published/Azure/azure-rest-api-specs-pr/rbandi124-maintenance-Microsoft.Maintenance-2023-10-01-preview branch from 7104fce to 1fd2ffd Compare December 6, 2023 18:34
@rbandi124 rbandi124 force-pushed the published/Azure/azure-rest-api-specs-pr/rbandi124-maintenance-Microsoft.Maintenance-2023-10-01-preview branch from 1fd2ffd to 301e091 Compare December 6, 2023 18:47
@visingla-ms visingla-ms added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Dec 7, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 7, 2023
@visingla-ms visingla-ms merged commit 741b0c8 into main Dec 7, 2023
@visingla-ms visingla-ms deleted the published/Azure/azure-rest-api-specs-pr/rbandi124-maintenance-Microsoft.Maintenance-2023-10-01-preview branch December 7, 2023 14:46
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 new-api-version 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.

4 participants