EventSubscriptionUpdateParameters Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Properties of the Event Subscription update.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.EventSubscriptionUpdateParametersTypeConverter))]
public class EventSubscriptionUpdateParameters : Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IEventSubscriptionUpdateParameters
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.EventSubscriptionUpdateParametersTypeConverter))>]
type EventSubscriptionUpdateParameters = class
interface IEventSubscriptionUpdateParameters
interface IJsonSerializable
Public Class EventSubscriptionUpdateParameters
Implements IEventSubscriptionUpdateParameters
- Inheritance
-
EventSubscriptionUpdateParameters
- Attributes
- Implements
Constructors
EventSubscriptionUpdateParameters() |
Creates an new EventSubscriptionUpdateParameters 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 |
Information about the expiration time for 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. |
Label |
List of user defined labels. |
RetryPolicyEventTimeToLiveInMinute |
Time To Live (in minutes) for events. |
RetryPolicyMaxDeliveryAttempt |
Maximum number of delivery retry attempts for events. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of EventSubscriptionUpdateParameters. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of EventSubscriptionUpdateParameters. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IEventSubscriptionUpdateParameters. |
FromJsonString(String) |
Creates a new instance of EventSubscriptionUpdateParameters, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of EventSubscriptionUpdateParameters into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
ToString() |