Onboard as an Azure Event Grid partner using the Azure portal

This article describes the way third-party SaaS providers, also known as event publishers or partners, are onboarded to Event Grid to be able to publish events from their services and how those events are consumed by end users.

Important

If you are not familiar with Partner Events, see Partner Events overview for a detailed introduction of key concepts that are critical to understand and follow the steps in this article.

Onboarding process for event publishers (partners)

In a nutshell, enabling your service’s events to be consumed by users typically involves the following process:

  1. Communicate your interest in becoming a partner to the Event Grid service team before proceeding with the next steps.
  2. Create a partner topic type by creating a registration.
  3. Create a namespace.
  4. Create an event channel and partner topic (single step).
  5. Test the Partner Events functionality end to end.

For step #4, you should decide what kind of user experience you want to provide. You have the following options:

  • Provide your own solution, typically a web graphical user interface (GUI) experience, hosted under your domain using our SDK and/or REST API to create an event channel and its corresponding partner topic. With this option, you can ask the user for the subscription and resource group under which you'll create a partner topic.
  • Use Azure portal or CLI to create the event channel and associated partner topic. With this option, you must have get in the user’s Azure subscription some way and resource group under which you'll create a partner topic.

This article shows you how to onboard as an Azure Event Grid partner using the Azure portal.

Note

Registering a partner topic type is an optional step. To help you decide if you should create a partner topic type, see Resources managed by event publisher.

Communicate your interest in becoming a partner

Fill out this form and contact the Event Grid team at GridPartner@microsoft.com. We'll have a conversation with you providing detailed information on Partner Events’ use cases, personas, onboarding process, functionality, pricing, and more.

Prerequisites

To complete the remaining steps, make sure you have:

Register a partner topic type (optional)

  1. Sign in to the Azure portal.

  2. Select All services from the left navigation pane, then type in Event Grid Partner Registrations in the search bar, and select it.

  3. On the Event Grid Partner Registrations page, select + Add on the toolbar.

    Add partner registration link

  4. On the Create Partner Topic Type Registrations - Basics page, enter the following information:

    1. In the Project details section, follow these steps:
      1. Select your Azure subscription.
      2. Select an existing Azure resource group or create a new resource group.
    2. In the Registration details section, follow these steps:
      1. For Registration name, enter a name for the registration.
      2. For Organization name, enter the name of your organization.
    3. In the Partner resource type section, enter details about your resource type that will be displayed on the partner topic create page:
      1. For Partner resource type name, enter the name for the resource type. This will be the type of partner topic that will be created in your Azure subscription.

      2. For Display name, enter a user-friendly display name for the partner topic (resource) type.

      3. Enter a description for the resource type.

      4. Enter a description for the scenario. It should explain the ways or scenarios in which the partner topics for your resources can be used.

        Create partner registration

  5. Select Next: Custom Service at the bottom of the page. On the Customer Service tab of the Create Partner Registration page, enter information that subscriber users will use to contact you in case of a problem with the event source:

    1. Enter the Phone number.

    2. Enter extension for the phone number.

    3. Enter a support web site URL.

      Create partner registration - customer service

  6. Select Next: Tags at the bottom of the page.

  7. On the Tags page, configure the following values.

    1. Enter a name and a value for the tag you want to add. This step is optional.
    2. Select Review + create at the bottom of the page to create the registration (partner topic type).

Create a partner namespace

  1. In the Azure portal, select All services from the left navigational menu, then type Event Grid Partner Namespaces in the search bar, and then select it from the list.

  2. On the Event Grid Partner Namespaces page, select + Add on the toolbar.

    Partner namespaces - Add link

  3. On the Create Partner Namespace - Basics page, specify the following information.

    1. In the Project details section, do the following steps:

      1. Select an Azure subscription.
      2. Select an existing resource group or create a resource group.
    2. In the Namespace details section, do the following steps:

      1. Enter a name for the namespace.
      2. Select a location for the namespace.
    3. In the Registration details section, do the following steps to associate the namespace with a partner registration.

      1. Select the subscription in which the partner registration exists.
      2. Select the resource group that contains the partner registration.
      3. Select the partner registration from the drop-down list.
    4. Select Next: Tags at the bottom of the page.

      Create partner namespace - basics page

  4. On the Tags page, add tags (optional).

    1. Enter a name and a value for the tag you want to add. This step is optional.
    2. Select Review + create at the bottom of the page.
  5. On the Review + create page, review the details, and select Create.

Create an event channel

Important

You'll need to request from your user an Azure subscription, resource group, location, and partner topic name to create a partner topic that your user will own and manage.

  1. Go to the Overview page of the namespace you created.

    Partner namespace - overview page partner-namespace-overview.png

  2. Select + Event Channel on the toolbar.

  3. On the Create Event Channel - Basics page, specify the following information.

    1. In the Channel details section, do these steps:

      1. For Event channel name, enter a name for the event channel.
      2. Enter the source. See Cloud Events 1.0 specifications to get an idea of a suitable value for the source. Also, see this Cloud Events schema example.
    2. In the Destination details section, enter details for the destination partner topic that will be created for this event channel.

      1. Enter the ID of the subscription in which the partner topic will be created.
      2. Enter the name of the resource group in which the partner topic resource will be created.
      3. Enter a name for the partner topic.
    3. Select Next: Filters at the bottom of the page.

      Create event channel - basics page

  4. On the Filters page, add filters. do the following steps:

    1. Filter on attributes of each event. Only events that match all filters get delivered. Up to 25 filters can be specified. Comparisons are case-insensitive. Valid keys used for filters vary based on the event schema. In the following example, eventid, source, eventtype, and eventtypeversioin can be used for keys. You can also use custom properties inside the data payload, using the . as the nesting operator. For example: data, data.key, data.key1.key2.

    2. Select Next: Additional features at the bottom of the page.

      Create event channel - filters page create-event-channel-filters-page.png

  5. On the Additional features page, you can set an expiration time and description for the partner topic.

    1. The expiration time is the time at which the topic and its associated event channel will be automatically deleted if not activated by the customer. A default of seven days is used in case a time isn't provided. Select the checkbox to specify your own expiration time.

    2. As this topic is a resource that's not created by the user, a description can help the user with understanding the nature of this topic. A generic description will be provided if none is set. Select the checkbox to set your own partner topic description.

    3. Select Next: Review + create.

      Create event channel - additional features page

  6. On the Review + create, review the settings, and select Create to create the event channel.

Next steps