Connectors Reference

Azure Event Grid

Azure Event Grid is an eventing backplane that enables event based programing with pub/sub semantics and reliable distribution & delivery for all services in Azure as well as third parties.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

TopicTypes_List ([internal]string x-ms-api-version)

 

ResourceNames (string subscriptionId, [internal]string x-ms-api-version, string resourceType)

 

Subscriptions_List ([internal][Optional]string x-ms-api-version)

List subscriptions

Unsubscribe ([internal]string x-ms-api-version, [internal]string resource)

Remove an event subscription

 

Triggers:

Name

Summary

CreateSubscription ([internal]string x-ms-api-version, string subscriptionId, string resourceType, [advanced][Optional]string subscriptionName, EventRequest body)

When a resource event occurs

 

Objects:

Name

Summary

EventRequest

 

ResourceNameResponse

 

Subscription

 

SubscriptionListResult

 

TopicTypesResponse

 

 

Actions:

TopicTypes_List

Summary:

Description:

 

Syntax:

AzureEventGrid.TopicTypes_List ([internal]string x-ms-api-version)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

 

True

 

Returns:

          Type:TopicTypesResponse

 

ResourceNames

Summary:

Description:

 

Syntax:

AzureEventGrid.ResourceNames (string subscriptionId, [internal]string x-ms-api-version, string resourceType)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription)

The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

 

True

resourceType

string

(Resource Provider)

 

True

 

Returns:

          Type:ResourceNameResponse

 

Subscriptions_List

Summary: List subscriptions

Description: Gets a list of all the subscriptions to which the principal has access.

 

Syntax:

AzureEventGrid.Subscriptions_List ([internal][Optional]string x-ms-api-version)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

 

False

 

Returns:

          Type:SubscriptionListResult

          Description: Subscription list operation response.

 

Unsubscribe

Summary: Remove an event subscription

Description: Deletes an event subscription.

 

Syntax:

AzureEventGrid.Unsubscribe ([internal]string x-ms-api-version, [internal]string resource)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

 

True

resource

string

(Destination URL template)

URL template to make the DELETE request to.

True

 

Returns:

 

Triggers:

Trigger CreateSubscription

Summary: When a resource event occurs

Description: When an Azure Event Grid subscription fires an event.

 

Syntax:

AzureEventGrid.CreateSubscription ([internal]string x-ms-api-version, string subscriptionId, string resourceType, [advanced][Optional]string subscriptionName, EventRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

 

True

subscriptionId

string

(Subscription)

The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

True

Subscriptions_List

resourceType

string

(Resource Type)

Type of resource to create event subscription on.

True

TopicTypes_List

subscriptionName

string

(Subscription Name)

Name to use for the new Event Grid subscription.

False

body

EventRequest

 

 

True

 

Returns:

 


 

EventRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

properties

Properties

 

 

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

topic

string

Resource Name

Name of the resource to listen to for events.

destination

Destination

 

 

filter

Filter

 

 

 

Destination

Summary:

Description:

 

          Properties:

Name

Type

Summary

endpointType

string

 

The type of endpoint to notify on events.

properties

Properties

 

Properties for the Event Grid subscription.

 

Properties

Summary:

Description: Properties for the Event Grid subscription.

 

          Properties:

Name

Type

Summary

endpointUrl

string

Endpoint URL

The URL to notify on events for this subscription.

 

Filter

Summary:

Description:

 

          Properties:

Name

Type

Summary

subjectBeginsWith

string

Prefix Filter

A filter like: Sample-workitems/{name}

subjectEndsWith

string

Suffix Filter

A filter like: .jpg

 


 

ResourceNameResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

 


 

Subscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.

subscriptionId

string

Subscription Id

The subscription Id.

displayName

string

Display Name

The subscription display name.


 

SubscriptionListResult

Summary:

Description: Subscription list operation response.

 

          Properties:

Name

Type

Summary

value

array of (Subscription)

 

The subscriptions available to the user.


 

TopicTypesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (ValueItem)

 

 

 

ValueItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

Supported topic type resource.