Share via

Azure.ResourceManager.EventGrid.Models Namespace

  • Reference

Classes

AdvancedFilter

This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter. Please note AdvancedFilter 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 BoolEqualsAdvancedFilter, IsNotNullAdvancedFilter, IsNullOrUndefinedAdvancedFilter, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, NumberInRangeAdvancedFilter, NumberLessThanAdvancedFilter, NumberLessThanOrEqualsAdvancedFilter, NumberNotInAdvancedFilter, NumberNotInRangeAdvancedFilter, StringBeginsWithAdvancedFilter, StringContainsAdvancedFilter, StringEndsWithAdvancedFilter, StringInAdvancedFilter, StringNotBeginsWithAdvancedFilter, StringNotContainsAdvancedFilter, StringNotEndsWithAdvancedFilter and StringNotInAdvancedFilter.
ArmEventGridModelFactory

Model factory for models.
AzureADPartnerClientAuthentication

Azure Active Directory Partner Client Authentication.
AzureFunctionEventSubscriptionDestination

Information about the azure function destination for an event subscription.
BoolEqualsAdvancedFilter

BoolEquals Advanced Filter.
BoolEqualsFilter

BoolEquals Filter.
ClientCertificateAuthentication

The certificate authentication properties for the client.
DeadLetterDestination

Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class. Please note 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 StorageBlobDeadLetterDestination.
DeadLetterWithResourceIdentity

Information about the deadletter destination with resource identity.
DeliveryAttributeMapping

Delivery attribute mapping details. Please note DeliveryAttributeMapping 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 DynamicDeliveryAttributeMapping and StaticDeliveryAttributeMapping.
DeliveryConfiguration

Properties of the delivery configuration information of the event subscription.
DeliveryWithResourceIdentity

Information about the delivery for an event subscription with resource identity.
DynamicDeliveryAttributeMapping

Dynamic delivery attribute mapping details.
DynamicRoutingEnrichment

The DynamicRoutingEnrichment.
EventGridDomainPatch

Properties of the Domain update.
EventGridDomainRegenerateKeyContent

Domain regenerate share access key request.
EventGridDomainSharedAccessKeys

Shared access keys of the Domain.
EventGridFilter

This is the base type that represents a filter. To configure a filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsFilter, NumberInFilter, StringEqualsFilter etc depending on the type of the key based on which you want to filter. Please note EventGridFilter 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 BoolEqualsFilter, IsNotNullFilter, IsNullOrUndefinedFilter, NumberGreaterThanFilter, NumberGreaterThanOrEqualsFilter, NumberInFilter, NumberInRangeFilter, NumberLessThanFilter, NumberLessThanOrEqualsFilter, NumberNotInFilter, NumberNotInRangeFilter, StringBeginsWithFilter, StringContainsFilter, StringEndsWithFilter, StringInFilter, StringNotBeginsWithFilter, StringNotContainsFilter, StringNotEndsWithFilter and StringNotInFilter.
EventGridInboundIPRule

The EventGridInboundIPRule.
EventGridInputSchemaMapping

By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'. Please note EventGridInputSchemaMapping 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 EventGridJsonInputSchemaMapping.
EventGridJsonInputSchemaMapping

This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.
EventGridNamespacePatch

Properties to update namespace.
EventGridPartnerContent

Information about the partner.
EventGridPrivateEndpointConnectionState

ConnectionState information.
EventGridSubscriptionPatch

Properties of the Event Subscription update.
EventGridTopicPatch

Properties of the Topic update.
EventHubEventSubscriptionDestination

Information about the event hub destination for an event subscription.
EventSubscriptionDestination

Information about the destination for an event subscription. Please note 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 AzureFunctionEventSubscriptionDestination, EventHubEventSubscriptionDestination, HybridConnectionEventSubscriptionDestination, MonitorAlertEventSubscriptionDestination, NamespaceTopicEventSubscriptionDestination, PartnerEventSubscriptionDestination, ServiceBusQueueEventSubscriptionDestination, ServiceBusTopicEventSubscriptionDestination, StorageQueueEventSubscriptionDestination and WebHookEventSubscriptionDestination.
EventSubscriptionFilter

Filter for the Event Subscription.
EventSubscriptionFullUri

Full endpoint url of an event subscription.
EventSubscriptionIdentity

The identity information with the event subscription.
EventSubscriptionRetryPolicy

Information about the retry policy for an event subscription.
EventTypeUnderTopic

Event Type for a subject under a topic.
FiltersConfiguration

Filters configuration for the Event Subscription.
HybridConnectionEventSubscriptionDestination

Information about the HybridConnection destination for an event subscription.
InlineEventProperties

Additional information about every inline event.
IsNotNullAdvancedFilter

IsNotNull Advanced Filter.
IsNotNullFilter

IsNotNull Filter.
IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined Advanced Filter.
IsNullOrUndefinedFilter

IsNullOrUndefined Filter.
JsonFieldWithDefault

This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.
MonitorAlertEventSubscriptionDestination

Information about the Monitor Alert destination for an event subscription.
NamespaceRegenerateKeyContent

Namespace regenerate share access key request.
NamespaceSharedAccessKeys

Shared access keys of the Namespace.
NamespaceSku

Represents available Sku pricing tiers.
NamespaceTopicEventSubscriptionDestination

Information about the Namespace Topic destination for an event subscription.
NamespaceTopicEventSubscriptionPatch

Properties of the Event Subscription update.
NamespaceTopicPatch

Properties of the namespace topic update.
NetworkSecurityPerimeterConfigurationIssues

Network security perimeter configuration issues.
NetworkSecurityPerimeterConfigurationProfile

Nsp configuration with profile information.
NetworkSecurityPerimeterInfo

Network security perimeter info.
NetworkSecurityPerimeterProfileAccessRule

Network security perimeter profile access rule.
NumberGreaterThanAdvancedFilter

NumberGreaterThan Advanced Filter.
NumberGreaterThanFilter

NumberGreaterThan Filter.
NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals Advanced Filter.
NumberGreaterThanOrEqualsFilter

NumberGreaterThanOrEquals Filter.
NumberInAdvancedFilter

NumberIn Advanced Filter.
NumberInFilter

NumberIn Filter.
NumberInRangeAdvancedFilter

NumberInRange Advanced Filter.
NumberInRangeFilter

NumberInRange Filter.
NumberLessThanAdvancedFilter

NumberLessThan Advanced Filter.
NumberLessThanFilter

NumberLessThan Filter.
NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals Advanced Filter.
NumberLessThanOrEqualsFilter

NumberLessThanOrEquals Filter.
NumberNotInAdvancedFilter

NumberNotIn Advanced Filter.
NumberNotInFilter

NumberNotIn Filter.
NumberNotInRangeAdvancedFilter

NumberNotInRange Advanced Filter.
NumberNotInRangeFilter

NumberNotInRange Filter.
PartnerAuthorization

The partner authorization details.
PartnerClientAuthentication

Partner client authentication Please note PartnerClientAuthentication 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 AzureADPartnerClientAuthentication.
PartnerConfigurationPatch

Properties of the partner configuration update.
PartnerDestinationInfo

Properties of the corresponding partner destination of a Channel. Please note PartnerDestinationInfo 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 WebhookPartnerDestinationInfo.
PartnerDestinationPatch

Properties of the Partner Destination that can be updated.
PartnerDetails

Information about the partner.
PartnerEventSubscriptionDestination

The PartnerEventSubscriptionDestination.
PartnerNamespaceChannelPatch

Properties of the Channel update.
PartnerNamespacePatch

Properties of the Partner Namespace update.
PartnerNamespaceRegenerateKeyContent

PartnerNamespace regenerate shared access key request.
PartnerNamespaceSharedAccessKeys

Shared access keys of the partner namespace.
PartnerRegistrationPatch

Properties of the Partner Registration update.
PartnerTopicEventTypeInfo

The event type information for Channels.
PartnerTopicInfo

Properties of the corresponding partner topic of a Channel.
PartnerTopicPatch

Properties of the Partner Topic update.
PartnerUpdateDestinationInfo

Properties of the corresponding partner destination of a Channel. Please note PartnerUpdateDestinationInfo 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 WebhookUpdatePartnerDestinationInfo.
PushInfo

Properties of the destination info for event subscription supporting push.
QueueInfo

Properties of the Queue info for event subscription.
ResourceAssociation

Nsp resource association.
ResourceMoveChangeHistory

The change history of the resource move.
RoutingEnrichments

The RoutingEnrichments.
RoutingIdentityInfo

Routing identity info for topic spaces configuration.
ServiceBusQueueEventSubscriptionDestination

Information about the service bus destination for an event subscription.
ServiceBusTopicEventSubscriptionDestination

Information about the service bus topic destination for an event subscription.
StaticDeliveryAttributeMapping

Static delivery attribute mapping details.
StaticRoutingEnrichment

Static routing enrichment details. Please note StaticRoutingEnrichment 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 StaticStringRoutingEnrichment.
StaticStringRoutingEnrichment

The StaticStringRoutingEnrichment.
StorageBlobDeadLetterDestination

Information about the storage blob based dead letter destination.
StorageQueueEventSubscriptionDestination

Information about the storage queue destination for an event subscription.
StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter.
StringBeginsWithFilter

StringBeginsWith Filter.
StringContainsAdvancedFilter

StringContains Advanced Filter.
StringContainsFilter

StringContains Filter.
StringEndsWithAdvancedFilter

StringEndsWith Advanced Filter.
StringEndsWithFilter

StringEndsWith Filter.
StringInAdvancedFilter

StringIn Advanced Filter.
StringInFilter

StringIn Filter.
StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter.
StringNotBeginsWithFilter

StringNotBeginsWith Filter.
StringNotContainsAdvancedFilter

StringNotContains Advanced Filter.
StringNotContainsFilter

StringNotContains Filter.
StringNotEndsWithAdvancedFilter

StringNotEndsWith Advanced Filter.
StringNotEndsWithFilter

StringNotEndsWith Filter.
StringNotInAdvancedFilter

StringNotIn Advanced Filter.
StringNotInFilter

StringNotIn Filter.
SystemTopicPatch

Properties of the System Topic update.
TopicRegenerateKeyContent

Topic regenerate share access key request.
TopicSharedAccessKeys

Shared access keys of the Topic.
TopicSpacesConfiguration

Properties of the Topic Spaces Configuration.
TopicTypeAdditionalEnforcedPermission

The TopicTypeAdditionalEnforcedPermission.
UpdateTopicSpacesConfigurationInfo

Properties of the topic spaces configuration info of a namespace.
WebHookEventSubscriptionDestination

Information about the webhook destination for an event subscription.
WebhookPartnerDestinationInfo

Information about the WebHook of the partner destination.
WebhookUpdatePartnerDestinationInfo

Information about the update of the WebHook of the partner destination.

Structs

AlternativeAuthenticationNameSource

The AlternativeAuthenticationNameSource.
CaCertificateProvisioningState

Provisioning state of the CA Certificate resource.
ClientCertificateValidationScheme

The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
ClientGroupProvisioningState

Provisioning state of the ClientGroup resource.
DataResidencyBoundary

Data Residency Boundary of the resource.
DeliveryMode

Delivery mode of the event subscription.
DeliverySchema

The event delivery schema for the event subscription.
DomainTopicProvisioningState

Provisioning state of the domain topic.
EventDefinitionKind

The kind of event type used.
EventDeliverySchema

The event delivery schema for the event subscription.
EventGridDomainProvisioningState

Provisioning state of the Event Grid Domain Resource.
EventGridInputSchema

This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
EventGridIPActionType

Action to perform based on the match or no match of the IpMask.
EventGridNamespaceClientProvisioningState

Provisioning state of the Client resource.
EventGridNamespaceClientState

Indicates if the client is enabled or not. Default value is Enabled.
EventGridPrivateEndpointPersistedConnectionStatus

Status of the connection.
EventGridPublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />
EventGridResourceProvisioningState

Provisioning state of the Private Endpoint Connection.
EventGridResourceRegionType

Region type of the resource.
EventGridSku

The Sku name of the resource. The possible values are: Basic or Premium.
EventGridSkuName

The name of the SKU.
EventGridTopicProvisioningState

Provisioning state of the topic.
EventInputSchema

This determines the format that is expected for incoming events published to the topic.
EventSubscriptionIdentityType

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

Provisioning state of the event subscription.
MonitorAlertSeverity

The severity that will be attached to every Alert fired through this event subscription. This field must be provided.
NamespaceProvisioningState

Provisioning state of the namespace resource.
NamespaceTopicProvisioningState

Provisioning state of the namespace topic.
NetworkSecurityPerimeterAssociationAccessMode

Network security perimeter access mode.
NetworkSecurityPerimeterConfigProvisioningState

Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval.
NetworkSecurityPerimeterConfigurationIssueSeverity

Provisioning issue severity.
NetworkSecurityPerimeterConfigurationIssueType

Provisioning issue type.
NetworkSecurityPerimeterProfileAccessRuleDirection

NSP access rule direction.
PartnerConfigurationProvisioningState

Provisioning state of the partner configuration.
PartnerDestinationActivationState

Activation state of the partner destination.
PartnerDestinationProvisioningState

Provisioning state of the partner destination.
PartnerNamespaceChannelProvisioningState

Provisioning state of the channel.
PartnerNamespaceChannelType

The type of the event channel which represents the direction flow of events.
PartnerNamespaceProvisioningState

Provisioning state of the partner namespace.
PartnerRegistrationProvisioningState

Provisioning state of the partner registration.
PartnerTopicActivationState

Activation state of the partner topic.
PartnerTopicProvisioningState

Provisioning state of the partner topic.
PartnerTopicReadinessState

The readiness state of the corresponding partner topic.
PartnerTopicRoutingMode

This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.
PermissionBindingProvisioningState

Provisioning state of the PermissionBinding resource.
PermissionType

The allowed permission.
PublisherType

Publisher type of the namespace topic.
ResourceKind

Kind of the resource.
RoutingIdentityType

The RoutingIdentityType.
SubscriptionProvisioningState

Provisioning state of the event subscription.
TlsVersion

Minimum TLS version of the publisher allowed to publish to this domain.
TopicSpaceProvisioningState

Provisioning state of the TopicSpace resource.
TopicSpacesConfigurationState

Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled.
TopicTypeProvisioningState

Provisioning state of the topic type.
TopicTypeSourceScope

The TopicTypeSourceScope.
VerifiedPartnerProvisioningState

Provisioning state of the verified partner.