Share via

ISubscription Interface

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models
Assembly:
Az.EventGrid.private.dll
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.SubscriptionTypeConverter))]
public interface ISubscription : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.SubscriptionTypeConverter))>]
type ISubscription = interface
    interface IJsonSerializable
    interface IResource
Public Interface ISubscription
Implements IResource
Derived
Attributes
TypeConverterAttribute
Implements
IResource IJsonSerializable

Properties

DeadLetterDestinationEndpointType

Type of the endpoint for the dead letter destination
DeliveryConfigurationDeliveryMode

Delivery mode of the event subscription.
EventDeliverySchema

The event delivery schema for the event subscription.
FilterConfigurationFilter

An array of filters that are used for filtering event subscriptions.
FilterConfigurationIncludedEventType

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.
Id

Fully qualified identifier of the resource.

(Inherited from IResource)
IdentityType

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.
IdentityUserAssignedIdentity

The user identity associated with the resource.
Name

Name of the resource.

(Inherited from IResource)
ProvisioningState

Provisioning state of the event subscription.
QueueEventTimeToLive

Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. This duration value is expressed using the following format: 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', where:

  • (n) is replaced by the value of each time element that follows the (n).
  • P is the duration (or Period) designator and is always placed at the beginning of the duration.
  • Y is the year designator, and it follows the value for the number of years.
  • M is the month designator, and it follows the value for the number of months.
  • W is the week designator, and it follows the value for the number of weeks.
  • D is the day designator, and it follows the value for the number of days.
  • T is the time designator, and it precedes the time components.
  • H is the hour designator, and it follows the value for the number of hours.
  • M is the minute designator, and it follows the value for the number of minutes.
  • S is the second designator, and it follows the value for the number of seconds. This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined by topic’s EventRetentionInDays value. The followings are examples of valid values:
  • 'P0DT23H12M' or 'PT23H12M': for duration of 23 hours and 12 minutes.
  • 'P1D' or 'P1DT0H0M0S': for duration of 1 day.
QueueMaxDeliveryCount

The maximum delivery count of the events.
QueueReceiveLockDurationInSecond

Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds.
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.
Type

Type of the resource.

(Inherited from IResource)

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to