EventSubscription Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models

Assembly:

Az.EventGrid.private.dll

Event Subscription.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.EventSubscriptionTypeConverter))]
public class EventSubscription : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IEventSubscription, Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.EventSubscriptionTypeConverter))>]
type EventSubscription = class
    interface IEventSubscription
    interface IJsonSerializable
    interface IResource
    interface IValidates

Public Class EventSubscription
Implements IEventSubscription, IValidates

Inheritance

Object

EventSubscription

Attributes

TypeConverterAttribute

Implements

IEventSubscription IResource IJsonSerializable IValidates

Constructors

EventSubscription()

Creates an new EventSubscription instance.

Properties

DeadLetterDestination	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.
DeadLetterWithResourceIdentityDeadLetterDestination	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.
DeadLetterWithResourceIdentityDeadLetterDestinationEndpointType	Type of the endpoint for the dead letter destination
DeadLetterWithResourceIdentityType	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.
DeadLetterWithResourceIdentityUserAssignedIdentity	The user identity associated with the resource.
DeliveryWithResourceIdentityDestination	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.
DeliveryWithResourceIdentityType	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.
DeliveryWithResourceIdentityUserAssignedIdentity	The user identity associated with the resource.
Destination	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.
EndpointType	Type of the endpoint for the dead letter destination
EventDeliverySchema	The event delivery schema for the event subscription.
ExpirationTimeUtc	Expiration time of the event subscription.
FilterAdvancedFilter	An array of advanced filters that are used for filtering event subscriptions.
FilterEnableAdvancedFilteringOnArray	Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.
FilterIncludedEventType	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.
FilterIsSubjectCaseSensitive	Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner.
FilterSubjectBeginsWith	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.
FilterSubjectEndsWith	An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.
Id	Fully qualified identifier of the resource.
Label	List of user defined labels.
Name	Name of the resource.
ProvisioningState	Provisioning state of the event subscription.
ResourceGroupName	Gets the resource group name
RetryPolicyEventTimeToLiveInMinute	Time To Live (in minutes) for events.
RetryPolicyMaxDeliveryAttempt	Maximum number of delivery retry attempts for events.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Topic	Name of the topic of the event subscription.
Type	Type of the resource.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of EventSubscription.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of EventSubscription.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IEventSubscription.
FromJsonString(String)	Creates a new instance of EventSubscription, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of EventSubscription into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.