Microsoft.EventGrid partnerTopics/eventSubscriptions 2020-04-01-preview

  • 4 minutes to read

Template format

To create a Microsoft.EventGrid/partnerTopics/eventSubscriptions resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.EventGrid/partnerTopics/eventSubscriptions",
  "apiVersion": "2020-04-01-preview",
  "properties": {
    "destination": {
      "endpointType": "string"
    },
    "deliveryWithResourceIdentity": {
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      },
      "destination": {
        "endpointType": "string"
      }
    },
    "filter": {
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string",
      "includedEventTypes": [
        "string"
      ],
      "isSubjectCaseSensitive": "boolean",
      "advancedFilters": [
        {
          "key": "string",
          "operatorType": "string"
        }
      ]
    },
    "labels": [
      "string"
    ],
    "expirationTimeUtc": "string",
    "eventDeliverySchema": "string",
    "retryPolicy": {
      "maxDeliveryAttempts": "integer",
      "eventTimeToLiveInMinutes": "integer"
    },
    "deadLetterDestination": {
      "endpointType": "string"
    },
    "deadLetterWithResourceIdentity": {
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      },
      "deadLetterDestination": {
        "endpointType": "string"
      }
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.EventGrid/partnerTopics/eventSubscriptions object

Name Type Required Value
name string Yes Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.
type enum Yes eventSubscriptions
-or-
Microsoft.EventGrid/partnerTopics/eventSubscriptions

See Set name and type for child resources.
apiVersion enum Yes 2020-04-01-preview
properties object Yes Properties of the event subscription. - EventSubscriptionProperties object

EventSubscriptionProperties object

Name Type Required Value
destination object No Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. - EventSubscriptionDestination object
deliveryWithResourceIdentity object No Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. - DeliveryWithResourceIdentity object
filter object No Information about the filter for the event subscription. - EventSubscriptionFilter object
labels array No List of user defined labels. - string
expirationTimeUtc string No Expiration time of the event subscription.
eventDeliverySchema enum No The event delivery schema for the event subscription. - EventGridSchema, CustomInputSchema, CloudEventSchemaV1_0
retryPolicy object No The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. - RetryPolicy object
deadLetterDestination object No The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. - DeadLetterDestination object
deadLetterWithResourceIdentity object No The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. - DeadLetterWithResourceIdentity object

EventSubscriptionDestination object

Name Type Required Value
endpointType string Yes

DeliveryWithResourceIdentity object

Name Type Required Value
identity object No The identity to use when delivering events. - EventSubscriptionIdentity object
destination object No Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering. - EventSubscriptionDestination object

EventSubscriptionFilter object

Name Type Required Value
subjectBeginsWith string No An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.
subjectEndsWith string No An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.
includedEventTypes array No A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null. - string
isSubjectCaseSensitive boolean No Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.
advancedFilters array No An array of advanced filters that are used for filtering event subscriptions. - AdvancedFilter object

RetryPolicy object

Name Type Required Value
maxDeliveryAttempts integer No Maximum number of delivery retry attempts for events.
eventTimeToLiveInMinutes integer No Time To Live (in minutes) for events.

DeadLetterDestination object

Name Type Required Value
endpointType string Yes

DeadLetterWithResourceIdentity object

Name Type Required Value
identity object No The identity to use when dead-lettering events. - EventSubscriptionIdentity object
deadLetterDestination object No Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. - DeadLetterDestination object

EventSubscriptionIdentity object

Name Type Required Value
type enum No The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. - SystemAssigned or UserAssigned
userAssignedIdentity string No The user identity associated with the resource.

AdvancedFilter object

Name Type Required Value
key string No The field/property in the event based on which you want to filter.
operatorType string Yes