Skip to content

Commit 1ad7aa3

Browse files
authored
[@Azure/eventgrid] Adding new events for EG Version 5.0.0 (Azure#27679)
### Packages impacted by this PR @azure/eventgrid **API View To Approve** https://apiview.dev/Assemblies/Review/30d6488f3dd647a79d175e408d5d5303?diffRevisionId=20bf158c9f2341eba08c706d55a0aa4c&diffOnly=False&revisionId=f5dd29153bf946c0aa1d47886fcd5eaf&doc=true ### Issues associated with this PR NA ### Describe the problem that is addressed by this PR The EventGrid Service Team has added 2 new events. The SDK must be regenerated to include the code changes related to these 2 new events. The SDK minor version has been updated. - `Microsoft.ResourceNotifications.Resources.CreatedOrUpdated` - `Microsoft.ResourceNotifications.Resources.Deleted` ### 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? There are no specific/complex design scenarios for this task. It is a straightforward regenerate and some standard changes to the custom layer of the code. One of the important issues to note down is that this release does have a breaking change. The data type of `tags` property has been changed from `string` to object. So, this is a breaking change. Accordingly, the major version has been updated. ### Are there test cases added in this PR? _(If not, why?)_ No. This item is standard and we need not add test cases for every new events. The existing cases would be sufficient. ### Provide a list of related PRs _(if any)_ - Azure#27384 (This is the PR that adds similar events to the SDK in the 4.15.0 release) - Azure#26939 (This is the PR that adds similar events to the SDK in the 4.14.0 release) - Azure#26020 (This is the PR that adds similar events to the SDK in the 4.13.0 release) ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ `autorest --typescript swagger\README.md` ### 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 and API View. Thanks
1 parent 927b6a1 commit 1ad7aa3

File tree

12 files changed

+198
-14
lines changed

12 files changed

+198
-14
lines changed

sdk/appconfiguration/app-configuration/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
"devDependencies": {
9595
"@azure/dev-tool": "^1.0.0",
9696
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
97-
"@azure/eventgrid": "^4.9.0",
97+
"@azure/eventgrid": "^5.0.0",
9898
"@azure/identity": "^3.3.0",
9999
"@azure/keyvault-secrets": "^4.2.0",
100100
"@azure-tools/test-credential": "^1.0.0",

sdk/eventgrid/eventgrid/CHANGELOG.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Release History
22

3-
## 4.15.1 (Unreleased)
3+
## 5.0.0 (2023-11-07)
44

55
### Features Added
66

7-
### Breaking Changes
7+
- Added new System Events:
88

9-
### Bugs Fixed
9+
- `Microsoft.ResourceNotifications.Resources.CreatedOrUpdated`
10+
- `Microsoft.ResourceNotifications.Resources.Deleted`
1011

11-
### Other Changes
12+
### Breaking Changes
13+
14+
- In `ResourceNotificationsResourceUpdatedDetails` interface, the data type of property `tags` has been changed from `string` to object. Please refer [PR #27679](https://github.com/Azure/azure-sdk-for-js/pull/27679/) for further details.
1215

1316
## 4.15.0 (2023-10-12)
1417

sdk/eventgrid/eventgrid/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"sdk-type": "client",
44
"author": "Microsoft Corporation",
55
"description": "An isomorphic client library for the Azure Event Grid service.",
6-
"version": "4.15.1",
6+
"version": "5.0.0",
77
"keywords": [
88
"node",
99
"azure",

sdk/eventgrid/eventgrid/review/eventgrid.api.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,9 @@ export type AcsChatThreadCreatedWithUserEventData = AcsChatThreadEventBase & {
125125
properties: {
126126
[propertyName: string]: any;
127127
};
128+
metadata: {
129+
[propertyName: string]: string;
130+
};
128131
participants: AcsChatThreadParticipant[];
129132
};
130133

@@ -137,13 +140,19 @@ export type AcsChatThreadEventBase = AcsChatEventBase & {
137140
// @public
138141
export interface AcsChatThreadParticipant {
139142
displayName: string;
143+
metadata: {
144+
[propertyName: string]: string;
145+
};
140146
participantCommunicationIdentifier: CommunicationIdentifierModel;
141147
}
142148

143149
// @public
144150
export type AcsChatThreadPropertiesUpdatedPerUserEventData = AcsChatThreadEventBase & {
145151
editedByCommunicationIdentifier: CommunicationIdentifierModel;
146152
editTime: string;
153+
metadata: {
154+
[propertyName: string]: string;
155+
};
147156
properties: {
148157
[propertyName: string]: any;
149158
};
@@ -1810,6 +1819,25 @@ export interface ResourceNotificationsOperationalDetails {
18101819
resourceEventTime: string;
18111820
}
18121821

1822+
// @public
1823+
export interface ResourceNotificationsResourceDeletedDetails {
1824+
id: string;
1825+
name: string;
1826+
type: string;
1827+
}
1828+
1829+
// @public
1830+
export interface ResourceNotificationsResourceDeletedEventData {
1831+
operationalDetails: ResourceNotificationsOperationalDetails;
1832+
resourceDetails: ResourceNotificationsResourceDeletedDetails;
1833+
}
1834+
1835+
// @public
1836+
export type ResourceNotificationsResourceManagementCreatedOrUpdatedEventData = ResourceNotificationsResourceUpdatedEventData & {};
1837+
1838+
// @public
1839+
export type ResourceNotificationsResourceManagementDeletedEventData = ResourceNotificationsResourceDeletedEventData & {};
1840+
18131841
// @public
18141842
export interface ResourceNotificationsResourceUpdatedDetails {
18151843
id: string;
@@ -1818,7 +1846,9 @@ export interface ResourceNotificationsResourceUpdatedDetails {
18181846
properties: {
18191847
[propertyName: string]: any;
18201848
};
1821-
tags: string;
1849+
tags: {
1850+
[propertyName: string]: string;
1851+
};
18221852
type: string;
18231853
}
18241854

@@ -2242,6 +2272,8 @@ export interface SystemEventNameToEventData {
22422272
"Microsoft.PolicyInsights.PolicyStateDeleted": PolicyInsightsPolicyStateDeletedEventData;
22432273
"Microsoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged": ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData;
22442274
"Microsoft.ResourceNotifications.HealthResources.ResourceAnnotated": ResourceNotificationsHealthResourcesAnnotatedEventData;
2275+
"Microsoft.ResourceNotifications.Resources.CreatedOrUpdated": ResourceNotificationsResourceManagementCreatedOrUpdatedEventData;
2276+
"Microsoft.ResourceNotifications.Resources.Deleted": ResourceNotificationsResourceManagementDeletedEventData;
22452277
"Microsoft.Resources.ResourceActionCancel": ResourceActionCancelEventData;
22462278
"Microsoft.Resources.ResourceActionFailure": ResourceActionFailureEventData;
22472279
"Microsoft.Resources.ResourceActionSuccess": ResourceActionSuccessEventData;

sdk/eventgrid/eventgrid/src/generated/generatedClientContext.ts

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sdk/eventgrid/eventgrid/src/generated/models/index.ts

Lines changed: 33 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sdk/eventgrid/eventgrid/src/generated/models/mappers.ts

Lines changed: 108 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sdk/eventgrid/eventgrid/src/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,4 +302,8 @@ export {
302302
AcsRouterWorkerOfferIssuedEventData,
303303
AcsRouterWorkerOfferRevokedEventData,
304304
AcsRouterChannelConfiguration,
305+
ResourceNotificationsResourceManagementCreatedOrUpdatedEventData,
306+
ResourceNotificationsResourceManagementDeletedEventData,
307+
ResourceNotificationsResourceDeletedEventData,
308+
ResourceNotificationsResourceDeletedDetails,
305309
} from "./generated/models";

sdk/eventgrid/eventgrid/src/predicates.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,8 @@ import {
188188
AcsRouterWorkerOfferExpiredEventData,
189189
AcsRouterWorkerOfferIssuedEventData,
190190
AcsRouterWorkerOfferRevokedEventData,
191+
ResourceNotificationsResourceManagementCreatedOrUpdatedEventData,
192+
ResourceNotificationsResourceManagementDeletedEventData,
191193
} from "./generated/models";
192194

193195
import { CloudEvent, EventGridEvent } from "./models";
@@ -574,6 +576,10 @@ export interface SystemEventNameToEventData {
574576
"Microsoft.Communication.RouterWorkerOfferIssued": AcsRouterWorkerOfferIssuedEventData;
575577
/** An interface for the event data of a "Microsoft.Communication.RouterWorkerOfferRevoked" event. */
576578
"Microsoft.Communication.RouterWorkerOfferRevoked": AcsRouterWorkerOfferRevokedEventData;
579+
/** An interface for the event data of a "Microsoft.ResourceNotifications.Resources.CreatedOrUpdated" event. */
580+
"Microsoft.ResourceNotifications.Resources.CreatedOrUpdated": ResourceNotificationsResourceManagementCreatedOrUpdatedEventData;
581+
/** An interface for the event data of a "Microsoft.ResourceNotifications.Resources.Deleted" event. */
582+
"Microsoft.ResourceNotifications.Resources.Deleted": ResourceNotificationsResourceManagementDeletedEventData;
577583
}
578584

579585
/**

0 commit comments

Comments
 (0)