You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/event-grid/partner-onboarding-overview.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Onboard as a Event Grid Partner
2
+
title: Onboard as an Event Grid Partner
3
3
description: Onboard as an Azure Event Grid Partner Topic Type. Understand the resource model and publishing flow for Partner Topics.
4
4
services: event-grid
5
5
author: banisadr
@@ -12,16 +12,16 @@ ms.author: babanisa
12
12
13
13
# Become and Event Grid partner
14
14
15
-
This article describes how to privately use the Event Grid partner resources as well as how to become a publicly available Partner Topic Type.
15
+
This article describes how to privately use the Event Grid partner resources and how to become a publicly available Partner Topic Type.
16
16
17
-
You do not need special permission to begin using the Event Grid resource types associated with publishing events as an Event Grid partner. In fact, you can use them today both to publish events privately to your own Azure Subscriptions, as well as to test out the resource model if you are considering becoming a partner.
17
+
You don't need special permission to begin using the Event Grid resource types associated with publishing events as an Event Grid partner. In fact, you can use them today both to publish events privately to your own Azure Subscriptions, and to test out the resource model if you're considering becoming a partner.
18
18
19
19
## Becoming an Event Grid partner
20
20
21
-
If you are interested in becoming a public Event Grid partner, please begin by filling out [this form](https://aka.ms/gridpartnerform), and then contacting the Event Grid team at [[email protected]](mailto:[email protected]).
21
+
If you're interested in becoming a public Event Grid partner, begin by filling out [this form](https://aka.ms/gridpartnerform), and then contacting the Event Grid team at [[email protected]](mailto:[email protected]).
22
22
23
23
## How partner topics work
24
-
Partner Topics take the existing architecture that Event Grid already uses in to publish events from Azure resoruces such as Storage and IoT Hub, and makes those tools publicly available for anyone to use. Using these tools is by default private to your Azure Subscription only. In order to make your events publicly available, please fill out the above form and [contact the Event Grid team](mailto:[email protected]).
24
+
Partner Topics take the existing architecture that Event Grid already uses in to publish events from Azure resoruces such as Storage and IoT Hub, and makes those tools publicly available for anyone to use. Using these tools is by default private to your Azure Subscription only. To make your events publicly available, fill out the above form and [contact the Event Grid team](mailto:[email protected]).
25
25
26
26
Partner topics allow you to publish events to Azure Event Grid for multitenant consumption.
27
27
@@ -30,17 +30,17 @@ Partner topics allow you to publish events to Azure Event Grid for multitenant c
30
30
#### Partner flow
31
31
32
32
1. Create an Azure tenant if you don't already have one.
33
-
1. Using CLI create a new Event Grid `partnerRegistration`. This includes information such as display name, description, setup URI etc.
33
+
1. Using CLI create a new Event Grid `partnerRegistration`. This resource includes information such as display name, description, setup URI and so on.
1. Create one or more `partnerNamespaces` in each region you want to publish events. As part of this, Event Grid service will provision a publishing endpoint (e.g.https://contoso.westus-1.eventgrid.azure.net/api/events) and access keys.
35
+
1. Create one or more `partnerNamespaces` in each region you want to publish events. As part of this, Event Grid service will provision a publishing endpoint (for example,https://contoso.westus-1.eventgrid.azure.net/api/events) and access keys.
1. The customer activates the Partner Topic via the Azure Portal. Events may now flow from your service to the customer's Azure Subscription.
@@ -53,9 +53,9 @@ Below is the resource model for Partner Topics.
53
53
### Partner Registrations
54
54
* Resource: `partnerRegistrations`
55
55
* Used by: Partners
56
-
* Description: Captures the global metadata of the SaaS partner (e.g. name, display name, description, setup URI).
56
+
* Description: Captures the global metadata of the SaaS partner (for example, name, display name, description, setup URI).
57
57
58
-
Creating/updating a partner registration is a self-serve operation for the partners. This enables partners to build and test the complete end to end flow.
58
+
Creating/updating a partner registration is a self-serve operation for the partners. This self-serve ability enables partners to build and test the complete end to end flow.
59
59
60
60
Only Microsoft approved partnerRegistrations are discoverable by customers.
61
61
* Scope: Created in partner's Azure Subscription. Metadata visible to customers once public.
@@ -70,41 +70,41 @@ Below is the resource model for Partner Topics.
70
70
### Partner Namespaces
71
71
* Resource: partnerNamespaces
72
72
* Used by: Partners
73
-
* Description: Provides a regional resource for publishing customer events to. Each Partner Namespace has a publishing endpoint and auth keys. The namespace is also how the partner requests a Partner Topic for a given customer as well as lists active customers.
73
+
* Description: Provides a regional resource for publishing customer events to. Each Partner Namespace has a publishing endpoint and auth keys. The namespace is also how the partner requests a Partner Topic for a given customer and lists active customers.
74
74
* Scope: Lives in partner’s subscription.
75
75
76
76
### Event Tunnels
77
77
* Resource: `partnerNamespaces/eventTunnels`
78
78
* Used by: Partners
79
-
* Description: The Event Tunnels are a mirror of the customer's Partner Topic. By creating an Event Tunnel and specifying the customer's Azure Subscription and resource Group in the metadata, you are signaling to Event Grid to create a Partner Topic on behalf of the customer. Event Grid will issue an ARM call to create a corresponding partnerTopic in the customer’s subscription. The partner topic will be created in a "pending" state. There’s a 1-1 link between each eventTunnel and a partnerTopic.
79
+
* Description: The Event Tunnels are a mirror of the customer's Partner Topic. By creating an Event Tunnel and specifying the customer's Azure Subscription and resource Group in the metadata, you're signaling to Event Grid to create a Partner Topic for the customer. Event Grid will issue an ARM call to create a corresponding partnerTopic in the customer’s subscription. The partner topic will be created in a "pending" state. There’s a 1-1 link between each eventTunnel and a partnerTopic.
80
80
* Scope: Lives in partner’s subscription.
81
81
82
82
### Partner Topics
83
83
* Resource: `partnerTopics`
84
84
* Used by: Customers
85
-
* Description: Partner Topics are similar to Custom Topic and System topic in Event Grid. Each Partner Topic is associated with a specific “source” (e.g. “Contoso:myaccount”) and a specific partner topic type (e.g. “Contoso”). Customers create Event Subscriptions on the Partner Topic to route events to various event handlers.
85
+
* Description: Partner Topics are similar to Custom Topic and System topic in Event Grid. Each Partner Topic is associated with a specific “source” (for example, `Contoso:myaccount`) and a specific partner topic type (for example, “Contoso”). Customers create Event Subscriptions on the Partner Topic to route events to various event handlers.
86
86
87
-
Note that customers cannot directly create this resource. The only way to create this is be through a partner operation creating an Event Tunnel.
87
+
Customers can't directly create this resource. The only way to create a Partner Topic is through a partner operation creating an Event Tunnel.
88
88
* Scope: Lives in customer’s subscription.
89
89
90
90
### Partner Topic Types
91
91
* Resource: `partnerTopicTypes`
92
92
* Used by: Customers
93
-
* Description: This is a tenant wide resource type to enable customers to discover the list of approved partner topic types. The URL will look as follows: https://management.azure.com/providers/Microsoft.EventGrid/partnerTopicTypes)
93
+
* Description: Partner Topic Types are tenant-wide resource types that enable customers to discover the list of approved partner topic types. The URL will look as follows: https://management.azure.com/providers/Microsoft.EventGrid/partnerTopicTypes)
94
94
* Scope: Global
95
95
96
96
## Publishing Events to Event Grid
97
-
When a you create a partnerNamespace in an Azure region, you will get a regional endpoint and corresponding auth keys. Publish batches of events to this endpoint for all customer Event Tunnels in that namespace. Based on the “source” field in the event, Azure Event Grid will map each event with the corresponding partner topic(s).
97
+
When you create a partnerNamespace in an Azure region, you'll get a regional endpoint and corresponding auth keys. Publish batches of events to this endpoint for all customer Event Tunnels in that namespace. Based on the “source” field in the event, Azure Event Grid will map each event with the corresponding partner topic(s).
98
98
99
99
### Event Schema: CloudEvents v1.0
100
100
Publish events to Azure Event Grid using the CloudEvents 1.0 schema. Event Grid supports both structured mode and batched mode. CloudEvents 1.0 is the only supported event schema for Partner Namespaces.
101
101
102
102
### Example Flow
103
103
104
-
1. The publishing service does a HTTP POST to https://contoso.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01.
105
-
2. In the request, include a header value named aeg-sas-key that contains a key for authentication. This is the key provisioned during the creation of the partnerNamespace. For example, a valid header value is aeg-sas-key: VXbGWce53249Mt8wuotr0GPmyJ/nDT4hgdEj9DpBeRr38arnnm5OFg==.
104
+
1. The publishing service does an HTTP POST to https://contoso.westus2-1.eventgrid.azure.net/api/events?api-version=2018-01-01.
105
+
2. In the request, include a header value named aeg-sas-key that contains a key for authentication. This key is provisioned during the creation of the partnerNamespace. For example, a valid header value is aeg-sas-key: VXbGWce53249Mt8wuotr0GPmyJ/nDT4hgdEj9DpBeRr38arnnm5OFg==.
106
106
3. Set the Content-Type header to “application/cloudevents-batch+json; charset=UTF-8”.
107
-
4. Perform a HTTP POST to the above publish URL with a batch of events corresponding to that region. For example:
107
+
4. Perform an HTTP POST to the above publish URL with a batch of events corresponding to that region. For example:
108
108
109
109
```json
110
110
[
@@ -139,7 +139,7 @@ Publish events to Azure Event Grid using the CloudEvents 1.0 schema. Event Grid
139
139
]
140
140
```
141
141
142
-
After posting to the partnerNamespace endpoint, you will receive a response. The response is a standard HTTP response code. Some common responses are:
142
+
After posting to the partnerNamespace endpoint, you'll receive a response. The response is a standard HTTP response code. Some common responses are:
0 commit comments