Skip to content

Commit 20fc133

Browse files
authored
Merge pull request #204337 from robece/robece-inline-event-types
Added inline event types
2 parents 939b77a + c3bada2 commit 20fc133

8 files changed

+25
-9
lines changed
102 KB
Loading
579 KB
Loading
61.4 KB
Loading
19.9 KB
Loading
26.8 KB
Loading
19.9 KB
Loading

articles/event-grid/onboard-partner.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,13 @@ If you selected **Channel name header** for **Partner topic routing mode**, crea
130130
1. Specify **source** information for the partner topic. Source is contextual information on the source of events provided by the partner that the end user can see. This information is helpful when end user is considering activating a partner topic, for example.
131131

132132
:::image type="content" source="./media/onboard-partner/channel-partner-topic-basics.png" alt-text="Image showing the Create Channel - Basics page.":::
133+
1. Select **Add event type definitions** to declare the kind of events that are sent to the channel and to its associated partner topic. Event types are shown to customers when creating event subscriptions on the partner topic and are used to select the specific event types to send to an event handler destination.
134+
135+
:::image type="content" source="./media/onboard-partner/event-type-definition-1.png" alt-text="Screenshot that shows the Event Types Definitions section with Add event types definitions option selected.":::
136+
137+
:::image type="content" source="./media/onboard-partner/event-type-definition-2.png" alt-text="Screenshot that shows the definition of a sample event type.":::
138+
139+
:::image type="content" source="./media/onboard-partner/event-type-definition-3.png" alt-text="Screenshot that shows a list with the event type definition that was added.":::
133140
1. If you selected **Partner Destination**, enter the following details:
134141
1. **ID of the subscription** in which the partner topic will be created.
135142
1. **Resource group** in which the partner topic will be created.
@@ -156,7 +163,16 @@ If you selected **Channel name header** for **Partner topic routing mode**, crea
156163
**Partner destination** option:
157164
:::image type="content" source="./media/onboard-partner/create-channel-review-create-destination.png" alt-text="Image showing the Create Channel - Review + create page when the Partner Destination option is selected.":::
158165

159-
166+
## Manage a channel
167+
168+
If you created a channel you may be interested to update the configuration once the resource has been created.
169+
170+
1. Go to the **Configuration** on the channel. You may update message for partner topic activation, expiration time if not activated, and event type definitions.
171+
172+
:::image type="content" source="./media/onboard-partner/channel-configuration.png" alt-text="Screenshot that shows the Configuration page of a channel.":::
173+
174+
> [!IMPORTANT]
175+
> Don't forget to save changes before leaving the configuration page.
160176
161177
## Create an event channel
162178

articles/event-grid/partner-events-overview-for-partners.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ You may want to use the Partner Events feature if you've one or more of the foll
4444

4545
### For partners as a subscriber
4646

47-
- You want your service to react to customer events that originate in Microsoft/Azure.
48-
- You want your customer to react to Microsoft/Azure service events using their applications hosted by your platform. You use your platform's event routing capabilities to deliver events to the right customer solution.
47+
- You want your service to react to customer events that originate in Microsoft Azure.
48+
- You want your customer to react to Microsoft Azure service events using their applications hosted by your platform. You use your platform's event routing capabilities to deliver events to the right customer solution.
4949
- You want a simple model where your customers just select your service name as a destination without the need for them to know technical details like your platform endpoints.
5050
- Your system/platform supports [Cloud Events 1.0](https://cloudevents.io/) schema.
5151

@@ -59,22 +59,22 @@ Registrations are global. That is, they aren't associated with a particular Azur
5959

6060
### Channel
6161
A Channel is a nested resource to a Partner Namespace. A channel has two main purposes:
62-
- It's the resource type that allows you to create partner resources on a customer's Azure subscription. When you create a channel of type `partner topic`, a partner topic is created on a customer's Azure subscription. A partner topic is the customer's resource where events from a partner system. Similarly, when a channel of type `partner destination` is created, a partner destination is created on a customer's Azure subscription. Partner destinations are resources that represent a partner system endpoint to where events are delivered. A channel is the kind of resource, along with partner topics and partner destinations that enable bi-directional event integration.
62+
- It's the resource type that allows you to create partner resources on a customer's Azure subscription. When you create a channel of type `partner topic`, a partner topic is created on a customer's Azure subscription. A partner topic is a customer's resource to which events are routed when a partner system publishes events. Similarly, when a channel of type `partner destination` is created, a partner destination is created on a customer's Azure subscription. Partner destinations are resources that represent a partner system endpoint to where events are delivered. A channel is the kind of resource, along with partner topics and partner destinations that enable bi-directional event integration.
6363

6464
A channel has the same lifecycle as its associated customer partner topic or destination. When a channel of type `partner topic` is deleted, for example, the associated customer's partner topic is deleted. Similarly, if the partner topic is deleted by the customer, the associated channel on your Azure subscription is deleted.
6565
- It's a resource that is used to route events. A channel of type ``partner topic`` is used to route events to a customer's partner topic. It supports two types of routing modes.
6666
- **Channel name routing**. With this kind of routing, you publish events using an http header called `aeg-channel-name` where you provide the name of the channel to which events should be routed. As channels are a partner's representation of partner topics, the events routed to the channel show on the customer's parter topic. This kind of routing is a new capability not present in `event channels`, which support only source-based routing. Channel name routing enables more use cases than the source-based routing and it's the recommended routing mode to choose. For example, with channel name routing a customer can request events that originate in different event sources to land on a single partner topic.
6767
- **Source-based routing**. This routing approach is based on the value of the `source` context attribute in the event. Sources are mapped to channels and when an event comes with a source, say, of value "A" that event is routed to the partner topic associated to the channel that contains "A" in its source property.
6868

69+
You may want to declare the event types that are routed to the channel and to its associated partner topic. Event types are shown to customers when creating event subscriptions on the partner topic and are used to select the specific event types to send to an event handler destination. [Learn more](onboard-partner.md#create-a-channel).
70+
71+
>[!IMPORTANT]
72+
>Event types can be managed on the channel and once the values are updated, changes are reflected immediately on the associated partner topic.
73+
6974
A channel of type ``partner destination`` is used to route events to a partner system. When creating a channel of this type, you provide your webhook URL where you receive the events published by Azure Event Grid. Once the channel is created, a customer can use the partner destination resource when creating an [event subscription](subscribe-through-portal.md) as the destination to deliver events to the partner system. Event Grid publishes events with the request including an http header `aeg-channel-name` too. Its value can be used to associate the incoming events with a specific user who in the first place requested the partner destination.
7075

7176
A customer can use your partner destination to send your service any kind of events available to [Event Grid](overview.md).
7277

73-
- A channel can store definitions for event types. These definitions can be added during the creation of a channel or once the channel is created in the configuration. The event type definitions allow a customer to subscribe to these events when using partner topics. [Learn more](concepts.md#inline-event-type-definitions).
74-
75-
>[!IMPORTANT]
76-
>Event types can be managed in the channel and once the values are updated, changes will be reflected immediately in the associated partner topic.
77-
7878
### Partner namespace
7979
A partner namespace is a regional resource that has an endpoint to publish events to Azure Event Grid. Partner namespaces contain either channels or event channels (legacy resource). You must create partner namespaces in regions where customers request partner topics or destinations because channels and their corresponding partner resources must reside in the same region. You can't have a channel in a given region with its related partner topic, for example, located in a different region.
8080

0 commit comments

Comments
 (0)