@azure/eventgrid-namespaces 1.0.0-beta.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +45 -19
  2. package/dist/index.js +403 -196
  3. package/dist/index.js.map +1 -1
  4. package/dist-esm/src/cadl-generated/EventGridClient.js +20 -28
  5. package/dist-esm/src/cadl-generated/EventGridClient.js.map +1 -1
  6. package/dist-esm/src/cadl-generated/api/EventGridContext.js +2 -2
  7. package/dist-esm/src/cadl-generated/api/EventGridContext.js.map +1 -1
  8. package/dist-esm/src/cadl-generated/api/operations.js +25 -29
  9. package/dist-esm/src/cadl-generated/api/operations.js.map +1 -1
  10. package/dist-esm/src/cadl-generated/index.js.map +1 -1
  11. package/dist-esm/src/cadl-generated/models/index.js.map +1 -1
  12. package/dist-esm/src/cadl-generated/models/models.js.map +1 -1
  13. package/dist-esm/src/cadl-generated/models/options.js.map +1 -1
  14. package/dist-esm/src/cadl-generated/rest/clientDefinitions.js.map +1 -1
  15. package/dist-esm/src/cadl-generated/rest/eventGridClient.js +9 -9
  16. package/dist-esm/src/cadl-generated/rest/eventGridClient.js.map +1 -1
  17. package/dist-esm/src/cadl-generated/rest/isUnexpected.js.map +1 -1
  18. package/dist-esm/src/cadl-generated/rest/models.js.map +1 -1
  19. package/dist-esm/src/cadl-generated/rest/parameters.js.map +1 -1
  20. package/dist-esm/src/cloudEventDistrubtedTracingEnricherPolicy.js +53 -0
  21. package/dist-esm/src/cloudEventDistrubtedTracingEnricherPolicy.js.map +1 -0
  22. package/dist-esm/src/consumer.js +73 -0
  23. package/dist-esm/src/consumer.js.map +1 -0
  24. package/dist-esm/src/eventGridNamespacesPublishBinaryMode.js.map +1 -1
  25. package/dist-esm/src/eventGridReceiverClient.js +98 -0
  26. package/dist-esm/src/eventGridReceiverClient.js.map +1 -0
  27. package/dist-esm/src/eventGridSenderClient.js +72 -0
  28. package/dist-esm/src/eventGridSenderClient.js.map +1 -0
  29. package/dist-esm/src/index.js +3 -1
  30. package/dist-esm/src/index.js.map +1 -1
  31. package/dist-esm/src/models.js +3 -3
  32. package/dist-esm/src/models.js.map +1 -1
  33. package/dist-esm/src/util.js +155 -0
  34. package/dist-esm/src/util.js.map +1 -0
  35. package/package.json +10 -10
  36. package/types/eventgrid-namespaces.d.ts +127 -97
  37. package/dist-esm/src/constants.js +0 -5
  38. package/dist-esm/src/constants.js.map +0 -1
  39. package/dist-esm/src/eventGridNamespacesClient.js +0 -147
  40. package/dist-esm/src/eventGridNamespacesClient.js.map +0 -1
package/README.md CHANGED
@@ -6,11 +6,11 @@ Use the client library to Send events to Event Grid Namespaces
6
6
 
7
7
  Key links:
8
8
 
9
- - [Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/eventgrid/eventgrid/)
9
+ - [Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/eventgrid/eventgrid-namespaces/)
10
10
  - [Package (NPM)](https://www.npmjs.com/package/@azure/eventgrid-namespaces)
11
- - [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/eventgrid/)
11
+ - [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/eventgrid-namespaces/)
12
12
  - [Product documentation](https://docs.microsoft.com/azure/event-grid/)
13
- - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventgrid/eventgrid/samples)
13
+ - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventgrid/eventgrid-namespaces/samples)
14
14
 
15
15
  ## Getting started
16
16
 
@@ -48,9 +48,9 @@ Install the Azure Event Grid Namespaces client library for JavaScript with `npm`
48
48
  npm install @azure/eventgrid-namespaces
49
49
  ```
50
50
 
51
- ### Create and authenticate a `EventGridNamespacesClient`
51
+ ### Create and authenticate Namespace clients
52
52
 
53
- To create a client object to access the Event Grid Namespaces API, you will need the `endpoint` of your Event Grid topic and a `credential`. The Event Grid client can use an Access Key.
53
+ To create a client object to access the Event Grid Namespaces API, you will need the `endpoint` of your Event Grid topic and a `credential`. The Event Grid Namespaces clients can use an Access Key.
54
54
 
55
55
  You can find the endpoint for your Event Grid topic either in the [Azure Portal][azure_portal] or by using the [Azure CLI][azure_cli] snippet below:
56
56
 
@@ -69,9 +69,14 @@ az eventgrid topic key list --resource-group <your-resource-group-name> --name <
69
69
  Once you have an API key and endpoint, you can use the `AzureKeyCredential` class to authenticate the client as follows:
70
70
 
71
71
  ```js
72
- const { EventGridNamespacesClient, AzureKeyCredential } = require("@azure/eventgrid-namespaces");
72
+ const { EventGridSenderClient, EventGridReceiverClient, AzureKeyCredential } = require("@azure/eventgrid-namespaces");
73
73
 
74
- const client = new EventGridNamespacesClient(
74
+ const eventGridSenderClient = new EventGridSenderClient(
75
+ "<endpoint>",
76
+ new AzureKeyCredential("<Access Key>")
77
+ );
78
+
79
+ const eventGridReceiverClient = new EventGridReceiverClient(
75
80
  "<endpoint>",
76
81
  new AzureKeyCredential("<Access Key>")
77
82
  );
@@ -86,25 +91,45 @@ With the `@azure/identity` package, you can seamlessly authorize requests in bot
86
91
  For example, use can use `DefaultAzureCredential` to construct a client which will authenticate using Azure Active Directory:
87
92
 
88
93
  ```js
89
- const { EventGridNamespacesClient } = require("@azure/eventgrid-namespaces");
94
+ const { EventGridSenderClient, EventGridReceiverClient } = require("@azure/eventgrid-namespaces");
90
95
  const { DefaultAzureCredential } = require("@azure/identity");
91
96
 
92
- const client = new EventGridNamespacesClient(
97
+ const eventGridSenderClient = new EventGridSenderClient(
98
+ "<endpoint>",
99
+ new DefaultAzureCredential(),
100
+ "<topicName>"
101
+ );
102
+
103
+ const eventGridReceiverClient = new EventGridReceiverClient(
93
104
  "<endpoint>",
94
- new DefaultAzureCredential()
105
+ new DefaultAzureCredential(),
106
+ "<topicName>",
107
+ "<subscriptionName>"
95
108
  );
96
109
  ```
97
110
 
98
111
  ## Key concepts
99
112
 
100
- ### EventGridNamespacesClient
113
+ ### Sending and Receiving Events
114
+
115
+ `EventGridSenderClient` can be used for sending events to an Event Grid. You can initialize it as:
116
+
117
+ ```js
118
+ const eventGridSenderClient = new EventGridSenderClient(
119
+ "<endpoint>",
120
+ new AzureKeyCredential("<API Key>"),
121
+ "<topicName>"
122
+ );
123
+ ```
101
124
 
102
- `EventGridNamespacesClient` is used sending events to an Event Grid. You can initialize it as:
125
+ `EventGridReceiverClient` can be used for receiving events from an Event Grid. You can initialize it as:
103
126
 
104
127
  ```js
105
- const client = new EventGridNamespacesClient(
128
+ const eventGridReceiverClient = new EventGridReceiverClient(
106
129
  "<endpoint>",
107
- new AzureKeyCredential("<API Key>")
130
+ new AzureKeyCredential("<API Key>"),
131
+ "<topicName>",
132
+ "<subscriptionName>"
108
133
  );
109
134
  ```
110
135
 
@@ -121,11 +146,12 @@ This library has been tested and validated on [Kubernetes using Azure Arc][event
121
146
  ### Publish an Event to an Event Grid Topic
122
147
 
123
148
  ```js
124
- const { EventGridNamespacesClient, AzureKeyCredential } = require("@azure/eventgrid-namespaces");
149
+ const { EventGridSenderClient, AzureKeyCredential } = require("@azure/eventgrid-namespaces");
125
150
 
126
- const client = new EventGridNamespacesClient(
151
+ const client = new EventGridSenderClient(
127
152
  "<endpoint>",
128
- new AzureKeyCredential("<API key>")
153
+ new AzureKeyCredential("<API key>"),
154
+ "<topicName>"
129
155
  );
130
156
 
131
157
  const cloudEvent: CloudEvent = {
@@ -139,7 +165,7 @@ const cloudEvent: CloudEvent = {
139
165
  specversion: "1.0",
140
166
  };
141
167
  // Publish the Cloud Event
142
- await client.publishCloudEvent(cloudEvent, topicName);
168
+ await client.sendEvents(cloudEvent);
143
169
  ```
144
170
 
145
171
  ## Troubleshooting
@@ -159,7 +185,7 @@ For more detailed instructions on how to enable the logs, you can look at the [@
159
185
  ## Next steps
160
186
 
161
187
  Please take a look at the
162
- [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventgrid/eventgrid/samples)
188
+ [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventgrid/eventgrid-namespaces/samples)
163
189
  directory for detailed examples on how to use this library.
164
190
 
165
191
  ## Contributing