QueueInfo Class

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models
Assembly:
Az.EventGrid.private.dll

Properties of the Queue info for event subscription.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.QueueInfoTypeConverter))]
public class QueueInfo : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IQueueInfo
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.QueueInfoTypeConverter))>]
type QueueInfo = class
    interface IQueueInfo
    interface IJsonSerializable
Public Class QueueInfo
Implements IQueueInfo
Inheritance
Object
QueueInfo
Attributes
TypeConverterAttribute
Implements
IQueueInfo IJsonSerializable

Constructors

QueueInfo()

Creates an new QueueInfo instance.

Properties

DeadLetterDestinationEndpointType

Type of the endpoint for the dead letter destination
DeadLetterDestinationWithResourceIdentityDeadLetterDestination

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

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

The maximum delivery count of the events.
ReceiveLockDurationInSecond

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.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of QueueInfo.
DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of QueueInfo.
FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IQueueInfo.
FromJsonString(String)

Creates a new instance of QueueInfo, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)

Serializes this instance of QueueInfo into a JsonNode.
ToJsonString()

Serializes this instance to a json string.
ToString()

Applies to