Skip to content

Commit

Permalink
[@Azure/eventgrid] - Azure EventGrid Beta Release V4.13.0-beta.3 (#27666
Browse files Browse the repository at this point in the history
)

### Packages impacted by this PR

@Azure/eventgrid

### Issues associated with this PR

NA

### Describe the problem that is addressed by this PR

1. The EventGrid Service team has made changes to their [CADL
specification](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid/Azure.Messaging.EventGrid).
This PR regenerates the SDK using the latest CADL specification.
2. Important changes in this PR:
     i. A new API `renewCloudEventLocks` has been added.
ii. In the ` publishCloudEvent` API, a new option `binaryMode` has been
added. This enables the users to send in the binary encoded event.
iii. There are some other minor changes and some breaking changes also
in this PR.

### What are the possible designs available to address the problem? If
there are more than one possible design, why was the one in this PR
chosen?

One of the design decisions is around the `binaryMode`. Currently, the
API accepts only binary encoded data for this API. If there is a
requirement in the future that the user prefers that the encoding be
done by the SDK, we could consider it in future,

### Are there test cases added in this PR? _(If not, why?)_

Yes. New test cases have been added to test the `binaryMode` and the new
`renewCloudEventLocks` API.

### Provide a list of related PRs _(if any)_
1. #26307
2. #25906

### Checklists
- [X] Added impacted package name to the issue description
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so,
create an Issue in the
[Autorest/typescript](https://github.com/Azure/autorest.typescript)
repository and link it here)_
- [X] Added a changelog (if necessary)

@xirzec Please review and approve the PR & API Views.

## API View to approve

1. [Link
1](https://apiview.dev/Assemblies/Review/0ead6d0c15c64cd7a007a11f514cfc4c/b94b6c83619f4dcfb04e476365bf7e19?diffRevisionId=fb754e995af24441901461c1c6ada906&doc=False&diffOnly=True)
(This compares this Beta 3 version with Beta 2 version which gives you a
clear view of the changes)
2. [Link
2](https://apiview.dev/Assemblies/Review/b6a1a4040a1f46528f095df8589bfa3e/80e3111615cc47f49b25a4f16d9e1322?diffRevisionId=20bf158c9f2341eba08c706d55a0aa4c&doc=False&diffOnly=True)
(This is generated automatically by the PR Bot wgich compares the Beta 3
version with latest GA which is not correct. But, in order to release
the SDK, we need the approval for the same. So, kindly review the Link 1
and approve both). Thanks
  • Loading branch information
sarangan12 authored Nov 10, 2023
1 parent 8f78790 commit 3f35281
Show file tree
Hide file tree
Showing 66 changed files with 4,780 additions and 1,963 deletions.
9 changes: 5 additions & 4 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions sdk/eventgrid/eventgrid/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Release History

## 5.1.0-beta.1 (2023-11-13)

### Features Added

- In the `EventGridClient` class, a new API `renewCloudEventLocks` has been added.
- In the `EventGridClient` class, for the `publishCloudEvent` API, a new option `binaryMode` has been added. This enables the users to send in the binary encoded event.
- For the `ReleaseCloudEventsOptions` interface, a new property `releaseDelayInSeconds` has been added.

### Breaking Changes

- The interfaces `RequestOptions`, `ReleaseOptions`, `RejectOptions`, `ClientOptions`, `AcknowledgeOptions` have been removed.
- In the `FailedLockToken` interface, the properties `errorCode` & `errorDescription` have been removed and replaced with new property `error` of type `ErrorModel`.

Please refer [PR #27666](https://github.com/Azure/azure-sdk-for-js/pull/27666) for further details.

## 4.13.0-beta.2 (2023-06-26)

### Bugs Fixed
Expand Down
4 changes: 3 additions & 1 deletion sdk/eventgrid/eventgrid/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "client",
"author": "Microsoft Corporation",
"description": "An isomorphic client library for the Azure Event Grid service.",
"version": "4.13.0-beta.2",
"version": "5.1.0-beta.1",
"keywords": [
"node",
"azure",
Expand Down Expand Up @@ -97,6 +97,8 @@
"@azure-rest/core-client": "^1.1.3",
"@azure/core-tracing": "^1.0.0",
"@azure/logger": "^1.0.0",
"@azure/core-util": "^1.6.1",
"buffer": "^6.0.0",
"tslib": "^2.2.0",
"uuid": "^8.3.0"
},
Expand Down
Loading

0 comments on commit 3f35281

Please sign in to comment.