Class EventSubscription

Manages an EventGrid Event Subscription

Inheritance

System.Object

Resource

CustomResource

EventSubscription

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.EventGrid

Assembly: Pulumi.Azure.dll

Syntax

public class EventSubscription : CustomResource

Constructors

View Source

EventSubscription(String, EventSubscriptionArgs, CustomResourceOptions)

Create a EventSubscription resource with the given unique name, arguments, and options.

Declaration

public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EventSubscriptionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

EventDeliverySchema

Specifies the event delivery schema for the event subscription. Possible values include: EventGridSchema, CloudEventSchemaV1_0, CustomInputSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.

Declaration

public Output<string> EventDeliverySchema { get; }

Property Value

Type	Description
Output<System.String>

View Source

EventhubEndpoint

A eventhub_endpoint block as defined below.

Declaration

public Output<EventSubscriptionEventhubEndpoint> EventhubEndpoint { get; }

Property Value

Type	Description
Output<EventSubscriptionEventhubEndpoint>

View Source

EventhubEndpointId

Specifies the id where the Event Hub is located.

Declaration

public Output<string> EventhubEndpointId { get; }

Property Value

Type	Description
Output<System.String>

View Source

ExpirationTimeUtc

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

Declaration

public Output<string> ExpirationTimeUtc { get; }

Property Value

Type	Description
Output<System.String>

View Source

HybridConnectionEndpoint

A hybrid_connection_endpoint block as defined below.

Declaration

public Output<EventSubscriptionHybridConnectionEndpoint> HybridConnectionEndpoint { get; }

Property Value

Type	Description
Output<EventSubscriptionHybridConnectionEndpoint>

View Source

HybridConnectionEndpointId

Specifies the id where the Hybrid Connection is located.

Declaration

public Output<string> HybridConnectionEndpointId { get; }

Property Value

Type	Description
Output<System.String>

View Source

IncludedEventTypes

A list of applicable event types that need to be part of the event subscription.

Declaration

public Output<ImmutableArray<string>> IncludedEventTypes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Labels

A list of labels to assign to the event subscription.

Declaration

public Output<ImmutableArray<string>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Name

Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

RetryPolicy

A retry_policy block as defined below.

Declaration

public Output<EventSubscriptionRetryPolicy> RetryPolicy { get; }

Property Value

Type	Description
Output<EventSubscriptionRetryPolicy>

View Source

Scope

Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> Scope { get; }

Property Value

Type	Description
Output<System.String>

View Source

ServiceBusQueueEndpointId

Specifies the id where the Service Bus Queue is located.

Declaration

public Output<string> ServiceBusQueueEndpointId { get; }

Property Value

Type	Description
Output<System.String>

View Source

ServiceBusTopicEndpointId

Specifies the id where the Service Bus Topic is located.

Declaration

public Output<string> ServiceBusTopicEndpointId { get; }

Property Value

Type	Description
Output<System.String>

View Source

StorageBlobDeadLetterDestination

A storage_blob_dead_letter_destination block as defined below.

Declaration

public Output<EventSubscriptionStorageBlobDeadLetterDestination> StorageBlobDeadLetterDestination { get; }

Property Value

Type	Description
Output<EventSubscriptionStorageBlobDeadLetterDestination>

View Source

StorageQueueEndpoint

A storage_queue_endpoint block as defined below.

Declaration

public Output<EventSubscriptionStorageQueueEndpoint> StorageQueueEndpoint { get; }

Property Value

Type	Description
Output<EventSubscriptionStorageQueueEndpoint>

View Source

SubjectFilter

A subject_filter block as defined below.

Declaration

public Output<EventSubscriptionSubjectFilter> SubjectFilter { get; }

Property Value

Type	Description
Output<EventSubscriptionSubjectFilter>

View Source

TopicName

(Optional) Specifies the name of the topic to associate with the event subscription.

Declaration

public Output<string> TopicName { get; }

Property Value

Type	Description
Output<System.String>

View Source

WebhookEndpoint

A webhook_endpoint block as defined below.

Declaration

public Output<EventSubscriptionWebhookEndpoint> WebhookEndpoint { get; }

Property Value

Type	Description
Output<EventSubscriptionWebhookEndpoint>

Methods

View Source

Get(String, Input<String>, EventSubscriptionState, CustomResourceOptions)

Get an existing EventSubscription resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static EventSubscription Get(string name, Input<string> id, EventSubscriptionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EventSubscriptionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
EventSubscription