TopicEventSubscription 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.
TopicEventSubscription.
public class TopicEventSubscription : Azure.Provisioning.Primitives.ProvisionableResource
public class TopicEventSubscription : Azure.Provisioning.Primitives.Resource
type TopicEventSubscription = class
inherit ProvisionableResource
type TopicEventSubscription = class
inherit Resource
Public Class TopicEventSubscription
Inherits ProvisionableResource
Public Class TopicEventSubscription
Inherits Resource
- Inheritance
-
TopicEventSubscription
- Inheritance
-
TopicEventSubscription
Constructors
TopicEventSubscription(String, String) |
Creates a new TopicEventSubscription. |
Properties
BicepIdentifier |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct) |
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. Please note Azure.ResourceManager.EventGrid.Models.DeadLetterDestination is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include Azure.ResourceManager.EventGrid.Models.StorageBlobDeadLetterDestination. |
DeadLetterWithResourceIdentity |
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 the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering. |
DeliveryWithResourceIdentity |
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. |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from ProvisionableResource) |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from 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. Please note Azure.ResourceManager.EventGrid.Models.EventSubscriptionDestination is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include Azure.ResourceManager.EventGrid.Models.AzureFunctionEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.EventHubEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.HybridConnectionEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.MonitorAlertEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.NamespaceTopicEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.PartnerEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.ServiceBusQueueEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.ServiceBusTopicEventSubscriptionDestination, Azure.ResourceManager.EventGrid.Models.StorageQueueEventSubscriptionDestination and Azure.ResourceManager.EventGrid.Models.WebHookEventSubscriptionDestination. |
EventDeliverySchema |
The event delivery schema for the event subscription. |
ExpireOn |
Expiration time of the event subscription. |
Filter |
Information about the filter for the event subscription. |
Id |
Gets the Id. |
IdentifierName |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisioningConstruct) |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource) |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from Resource) |
Labels |
List of user defined labels. |
Name |
Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. |
Parent |
Gets or sets a reference to the parent EventGridTopic. |
ProvisioningState |
Provisioning state of the event subscription. |
ResourceType |
Gets the type of the resource. (Inherited from ProvisionableResource) |
ResourceType |
Gets the type of the resource. (Inherited from Resource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from ProvisionableResource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from Resource) |
RetryPolicy |
The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events. |
SystemData |
Gets the SystemData. |
Topic |
Name of the topic of the event subscription. |
Methods
AssignOrReplace<T>(T, T) | (Inherited from ProvisionableConstruct) |
Build(ProvisioningBuildOptions) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource) |
Build(ProvisioningContext) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from Resource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from Resource) |
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineListProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) | (Inherited from ProvisionableConstruct) |
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) | (Inherited from ProvisionableConstruct) |
DefineProvisionableProperties() |
Define all the provisionable properties of TopicEventSubscription. |
DefineResource<T>(String, String[], Boolean, Boolean, T) | (Inherited from ProvisionableResource) |
FromExisting(String, String) |
Creates a reference to an existing TopicEventSubscription. |
GetProvisionableResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
GetResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
Initialize() |
Initialize this construct. (Inherited from ProvisionableConstruct) |
OverrideWithExpression(BicepExpression) | (Inherited from ProvisionableConstruct) |
OverrideWithExpression(Expression) |
Set this construct to represent the result of an expression. This is
primarily meant to be called via |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct) |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisioningConstruct) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from ProvisionableResource) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Resource) |
Explicit Interface Implementations
IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |