Add new events for Storage StorageTasks by shulinwang33 · Pull Request #23280 · Azure/azure-rest-api-specs

shulinwang33 · 2023-03-24T15:51:37Z

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

Link to engagement record issue:

Is this review for (select one):

a private preview
[ X] a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.}

Design Document: Storage Tasks Event Schema
Previous Open API Doc:
Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

openapi-workflow-bot · 2023-03-24T15:51:41Z

Hi, @shulinwang33 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-03-24T15:51:42Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
Storage.json	2018-01-01(24105eb)	2018-01-01(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2018-01	package-2018-01(24105eb)	package-2018-01(main)

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView 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.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-03-24T15:51:44Z

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-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 0981d74. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.Messaging.EventGrid [View full logs] [Release SDK Changes]
- Azure.Messaging.EventGrid.4.15.0-alpha.20230412.1.nupkg
```
info	[Changelog]
```

_{Posted by Swagger Pipeline | How to fix these errors?}

ghost · 2023-03-24T15:51:44Z

Thank you for your contribution shulinwang33! We will review the pull request and get back to you soon.

openapi-pipeline-app · 2023-03-24T15:51:44Z

Generated ApiView

Language	Package Name	ApiView Link
.Net	Azure.Messaging.EventGrid	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json

JoshLove-msft · 2023-03-27T19:34:45Z

Please add examples for the new events.

shulinwang33 · 2023-03-28T17:57:24Z

Please add examples for the new events.

Sample event in production as of today (no customer information)

{ "topic":"/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shulin- rg/providers/Microsoft.Storage/storageAccounts/shulinstcanest2", "subject":"DataManagement/StorageTasks", "eventType":"Microsoft.Storage.StorageTaskQueued", "id":"7fddaf06-24e8-4d57-9b66-5b7ab920a626", "data":{ "queuedDateTime":"2023-03-23T16:43:50Z", "taskExecutionId":"deletetest-2023-03-23T16:42:33.8658256Z_2023-03-23T16:42:58.8983000Z" }, "dataVersion":"1.0", "metadataVersion":"1", "eventTime": "2023-03-23T16:43:50Z" }

{ "topic":"/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shulin-rg/providers/Microsoft.Storage/storageAccounts/shulinstcanest2", "subject":"DataManagement/StorageTasks", "eventType":"Microsoft.Storage.StorageTaskCompleted", "id":"b34b3b93-a64d-41ea-aba4-d55f2d29190b", "data":{ "status":"Succeeded", "completedDateTime":"2023-03-23T16:52:58Z", "taskExecutionId":"deletetest-2023-03-23T16:42:33.8658256Z_2023-03-23T16:42:58.8983000Z", "taskName":"delete123", "summaryReportBlobUrl":"https://shulinstcanest2.blob.core.windows.net/report/delete123_deletetest_2023-03-23T16:43:50/SummaryReport.json" }, "dataVersion":"1.0", "metadataVersion":"1", "eventTime":"2023-03-23T16:52:58Z" }

JoshLove-msft · 2023-03-28T17:58:48Z

Please add examples for the new events.

Sample event in production as of today (no customer information)

{ "topic":"/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shulin- rg/providers/Microsoft.Storage/storageAccounts/shulinstcanest2", "subject":"DataManagement/StorageTasks", "eventType":"Microsoft.Storage.StorageTaskQueued", "id":"7fddaf06-24e8-4d57-9b66-5b7ab920a626", "data":{ "queuedDateTime":"2023-03-23T16:43:50Z", "taskExecutionId":"deletetest-2023-03-23T16:42:33.8658256Z_2023-03-23T16:42:58.8983000Z" }, "dataVersion":"1.0", "metadataVersion":"1", "eventTime": "2023-03-23T16:43:50Z" }

{ "topic":"/subscriptions/c86a9c18-8373-41fa-92d4-1d7bdc16977b/resourceGroups/shulin-rg/providers/Microsoft.Storage/storageAccounts/shulinstcanest2", "subject":"DataManagement/StorageTasks", "eventType":"Microsoft.Storage.StorageTaskCompleted", "id":"b34b3b93-a64d-41ea-aba4-d55f2d29190b", "data":{ "status":"Succeeded", "completedDateTime":"2023-03-23T16:52:58Z", "taskExecutionId":"deletetest-2023-03-23T16:42:33.8658256Z_2023-03-23T16:42:58.8983000Z", "taskName":"delete123", "summaryReportBlobUrl":"https://shulinstcanest2.blob.core.windows.net/report/delete123_deletetest_2023-03-23T16:43:50/SummaryReport.json" }, "dataVersion":"1.0", "metadataVersion":"1", "eventTime":"2023-03-23T16:52:58Z" }

Can you please add the examples as discussed here - https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/data-plane#guidelines-for-defining-a-new-event

openapi-workflow-bot · 2023-03-28T18:19:39Z

Hi @shulinwang33, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json

…18-01-01/Storage.json Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

shulinwang33 · 2023-04-11T19:40:50Z

@shulinwang33 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.

Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.

Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.

Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree company="Microsoft"

* Add new events for Storage StorageTasks * Create storage_task_queued.json * Create storage_task_completed.json * Add files via upload * Add files via upload * Update storage_task_queued.json * Update storage_task_completed.json * Update Storage.json * Update Storage.json * Update Storage.json * Update specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * Update example ref --------- Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

Add new events for Storage StorageTasks

c287226

shulinwang33 requested review from Kishp01 and ahamad-MS as code owners March 24, 2023 15:51

openapi-assignment-bot bot assigned lmazuel Mar 24, 2023

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Mar 24, 2023

ghost added the Event Grid label Mar 24, 2023

AzureRestAPISpecReview added the data-plane label Mar 24, 2023

azure-sdk mentioned this pull request Mar 24, 2023

[AutoPR Azure.Messaging.EventGrid] Add new events for Storage StorageTasks azure-sdk/azure-sdk-for-net#3373

Closed

JoshLove-msft reviewed Mar 27, 2023

View reviewed changes

specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json Outdated Show resolved Hide resolved

JoshLove-msft mentioned this pull request Mar 27, 2023

Board Review: Event Grid System Events Azure/azure-sdk#5835

Closed

shulinwang33 added 2 commits March 28, 2023 13:12

Create storage_task_queued.json

5555d95

Create storage_task_completed.json

6c9cfe5

AzureRestAPISpecReview added the CI-FixRequiredOnFailure label Mar 28, 2023

shulinwang33 added 5 commits March 28, 2023 13:32

Add files via upload

48e0fe1

Add files via upload

057b8d0

Update storage_task_queued.json

800e2ab

Update storage_task_completed.json

85be2cc

Update Storage.json

99d9321

JoshLove-msft reviewed Apr 5, 2023

View reviewed changes

specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json Show resolved Hide resolved

JoshLove-msft reviewed Apr 6, 2023

View reviewed changes

specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json Show resolved Hide resolved

Update Storage.json

04becc5

Update Storage.json

4ace190

JoshLove-msft reviewed Apr 10, 2023

View reviewed changes

specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json Outdated Show resolved Hide resolved

Update specification/eventgrid/data-plane/Microsoft.Storage/stable/20…

b7d2e63

…18-01-01/Storage.json Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com>

JoshLove-msft approved these changes Apr 11, 2023

View reviewed changes

jsquire approved these changes Apr 11, 2023

View reviewed changes

Update example ref

24105eb

AzureRestAPISpecReview removed the CI-FixRequiredOnFailure label Apr 12, 2023

jsquire merged commit 0981d74 into Azure:main Apr 12, 2023

azure-sdk mentioned this pull request Apr 12, 2023

[ReleasePR Azure.Messaging.EventGrid] change the event type of tags from string to object Azure/azure-sdk-for-net#28153

Closed

Conversation

shulinwang33 commented Mar 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Data Plane API - Pull Request

API Info: The Basics

Change Scope

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Uh oh!

openapi-workflow-bot bot commented Mar 24, 2023

Uh oh!

openapi-pipeline-app bot commented Mar 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Mar 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

ghost commented Mar 24, 2023

Uh oh!

openapi-pipeline-app bot commented Mar 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

Uh oh!

JoshLove-msft commented Mar 27, 2023

Uh oh!

shulinwang33 commented Mar 28, 2023

Uh oh!

JoshLove-msft commented Mar 28, 2023

Uh oh!

openapi-workflow-bot bot commented Mar 28, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shulinwang33 commented Apr 11, 2023

Contribution License Agreement

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

shulinwang33 commented Mar 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 24, 2023 •

edited

Loading