models Package

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.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BoolEqualsAdvancedFilter, IsNotNullAdvancedFilter, IsNullOrUndefinedAdvancedFilter, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, NumberInRangeAdvancedFilter, NumberLessThanAdvancedFilter, NumberLessThanOrEqualsAdvancedFilter, NumberNotInAdvancedFilter, NumberNotInRangeAdvancedFilter, StringBeginsWithAdvancedFilter, StringContainsAdvancedFilter, StringEndsWithAdvancedFilter, StringInAdvancedFilter, StringNotBeginsWithAdvancedFilter, StringNotContainsAdvancedFilter, StringNotEndsWithAdvancedFilter, StringNotInAdvancedFilter

Microsoft Entra ID Partner Client Authentication.

Properties of a Microsoft Entra ID Partner Client Authentication.

Information about the azure function destination for an event subscription.

The properties that represent the Azure Function destination of an event subscription.

BoolEquals Advanced Filter.

BoolEquals Filter.

The CA Certificate resource.

The properties of CA certificate.

Channel info.

Properties of the Channel.

Properties of the Channel update.

Properties of the channel update parameters.

The Client resource.

Client authentication settings for namespace resource.

The certificate authentication properties for the client.

The Client group resource.

The properties of client group.

The properties of client.

Azure Confidential Compute properties of the resource.

ConnectionState information.

A custom domain configuration that allows users to publish to their own domain name.

The identity information for retrieving the certificate for the custom domain.

Namespace custom domain ownership validation result.

The identity information for retrieving the certificate for custom JWT authentication.

Custom JWT authentication settings for namespace resource.

The identity configuration required for authenticating a custom webhook.

All Customer-managed key encryption properties for the resource.

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.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: StorageBlobDeadLetterDestination

Information about the deadletter destination with resource identity.

Result of the Get delivery attributes operation.

Delivery attribute mapping details.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DynamicDeliveryAttributeMapping, StaticDeliveryAttributeMapping

Properties of the delivery configuration information of the event subscription.

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

EventGrid Domain.

Properties of the Event Grid Domain Resource.

Domain regenerate share access key request.

Shared access keys of the Domain.

Domain Topic.

Properties of the Domain Topic.

Information of domain update parameter properties.

Properties of the Domain update.

Dynamic delivery attribute mapping details.

Properties of dynamic delivery attribute mapping.

DynamicRoutingEnrichment.

Information about the public certificate that is used for custom authentication.

The resource management error additional info.

The error detail.

Error response.

Information about the event hub destination for an event subscription.

The properties for a event hub destination.

Event Subscription.

Information about the destination for an event subscription.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFunctionEventSubscriptionDestination, EventHubEventSubscriptionDestination, HybridConnectionEventSubscriptionDestination, MonitorAlertEventSubscriptionDestination, NamespaceTopicEventSubscriptionDestination, PartnerEventSubscriptionDestination, ServiceBusQueueEventSubscriptionDestination, ServiceBusTopicEventSubscriptionDestination, StorageQueueEventSubscriptionDestination, WebHookEventSubscriptionDestination

Filter for the Event Subscription.

Full endpoint URL of an event subscription.

The identity information with the event subscription.

Properties of the Event Subscription.

Properties of the Event Subscription update.

Event Type for a subject under a topic.

The event type information for Channels.

Properties of the event type.

Definition of an Extended Location.

The base extension resource.

Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.

Properties of the Extension Topic.

The details of the Federated Identity Credential (FIC) used with the resource.

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 etc depending on the type of the key based on which you want to filter.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BoolEqualsFilter, IsNotNullFilter, IsNullOrUndefinedFilter, NumberGreaterThanFilter, NumberGreaterThanOrEqualsFilter, NumberInFilter, NumberInRangeFilter, NumberLessThanFilter, NumberLessThanOrEqualsFilter, NumberNotInFilter, NumberNotInRangeFilter, StringBeginsWithFilter, StringContainsFilter, StringEndsWithFilter, StringInFilter, StringNotBeginsWithFilter, StringNotContainsFilter, StringNotEndsWithFilter, StringNotInFilter

Filters configuration for the Event Subscription.

Information about the HybridConnection destination for an event subscription.

The properties for a hybrid connection destination.

The identity information for the resource.

InboundIpRule.

Additional information about every inline event.

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: JsonInputSchemaMapping

IsNotNull Advanced Filter.

IsNotNull Filter.

IsNullOrUndefined Advanced Filter.

IsNullOrUndefined Filter.

Information about the certificate that is used for token validation.

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 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.

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.

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.

This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.

Properties of the Encryption settings.

KeyEncryptionKeyIdentity.

Information about the Monitor Alert destination for an event subscription.

The properties that represent the Monitor Alert destination of an event subscription.

Namespace resource.

Properties of the namespace resource.

Namespace regenerate share access key request.

Shared access keys of the Namespace.

Represents available Sku pricing tiers.

Namespace topic details.

Information about the Namespace Topic destination for an event subscription.

The properties that represent the Event Grid Namespace Topic destination of an event subscription.

Properties of the namespace topic.

Information of namespace topic update parameter properties.

Properties of the namespace topic update.

Information of namespace update parameter properties.

Properties to update namespace.

Network security perimeter configuration.

Network security perimeter configuration issues.

Network security perimeter configuration issues properties.

Nsp configuration with profile information.

Network security perimeter configuration information to reflect latest association and nsp profile configuration.

Network security perimeter info.

Network security perimeter profile access rule.

Network security perimeter profile access rule properties.

Network security perimeter subscription inbound access rule.

NumberGreaterThan Advanced Filter.

NumberGreaterThan Filter.

NumberGreaterThanOrEquals Advanced Filter.

NumberGreaterThanOrEquals Filter.

NumberIn Advanced Filter.

NumberIn Filter.

NumberInRange Advanced Filter.

NumberInRange Filter.

NumberLessThan Advanced Filter.

NumberLessThan Filter.

NumberLessThanOrEquals Advanced Filter.

NumberLessThanOrEquals Filter.

NumberNotIn Advanced Filter.

NumberNotIn Filter.

NumberNotInRange Advanced Filter.

NumberNotInRange Filter.

Represents an operation returned by the GetOperations request.

Information about an operation.

Information about the partner.

The partner authorization details.

Partner client authentication.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureADPartnerClientAuthentication

Partner configuration information.

Properties of the partner configuration.

Information of partner configuration update parameter properties.

Properties of the partner configuration update.

Event Grid Partner Destination.

Properties of the corresponding partner destination of a Channel.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebhookPartnerDestinationInfo

Properties of the Partner Destination.

Properties of the Partner Destination that can be updated.

Information about the partner.

PartnerEventSubscriptionDestination.

PartnerEventSubscriptionDestinationProperties.

EventGrid Partner Namespace.

Properties of the partner namespace.

PartnerNamespace regenerate shared access key request.

Shared access keys of the partner namespace.

Information of Partner Namespace update parameter properties.

Properties of the Partner Namespace update.

Information about a partner registration.

Properties of the partner registration.

Properties of the Partner Registration update.

Event Grid Partner Topic.

Properties of the corresponding partner topic of a Channel.

Properties of the Partner Topic.

Properties of the Partner Topic update.

Properties of the corresponding partner destination of a Channel.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebhookUpdatePartnerDestinationInfo

Update properties for the corresponding partner topic of a channel.

The Permission binding resource.

The properties of permission binding.

Platform capabilities properties of the resource.

PrivateEndpoint information.

Concrete proxy resource types can be created by aliasing this type using a specific property type.

Properties of the private endpoint connection resource.

Information of the private link resource.

PrivateLinkResourceProperties.

Proxy Resource.

Properties of the destination info for event subscription supporting push.

Properties of the Queue info for event subscription.

Resource.

Nsp resource association.

The change history of the resource move.

Describes an EventGrid Resource Sku.

Information about the retry policy for an event subscription.

RoutingEnrichments.

Routing identity info for topic spaces configuration.

Information about the service bus destination for an event subscription.

The properties that represent the Service Bus destination of an event subscription.

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

The properties that represent the Service Bus Topic destination of an event subscription.

Static delivery attribute mapping details.

Properties of static delivery attribute mapping.

Static routing enrichment details.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: StaticStringRoutingEnrichment

StaticStringRoutingEnrichment.

Information about the storage blob based dead letter destination.

Properties of the storage blob based dead letter destination.

Information about the storage queue destination for an event subscription.

The properties for a storage queue destination.

StringBeginsWith Advanced Filter.

StringBeginsWith Filter.

StringContains Advanced Filter.

StringContains Filter.

StringEndsWith Advanced Filter.

StringEndsWith Filter.

StringIn Advanced Filter.

StringIn Filter.

StringNotBeginsWith Advanced Filter.

StringNotBeginsWith Filter.

StringNotContains Advanced Filter.

StringNotContains Filter.

StringNotEndsWith Advanced Filter.

StringNotEndsWith Filter.

StringNotIn Advanced Filter.

StringNotIn Filter.

Event Subscription.

Full endpoint URL of an event subscription.

Properties of the event subscription.

Properties of the Event Subscription update.

Properties of the Event Subscription update parameters.

Metadata pertaining to creation and last modification of the resource.

EventGrid System Topic.

Properties of the System Topic.

Properties of the System Topic update.

EventGrid Topic.

Properties of the Topic.

Topic regenerate share access key request.

Shared access keys of the Topic.

The Topic space resource.

The properties of topic space.

Properties of the Topic Spaces Configuration.

TopicTypeAdditionalEnforcedPermission.

Properties of a topic type info.

Properties of a topic type.

Information of topic update parameter properties.

Properties of the Topic update.

Properties of the Topics Configuration.

Tracked Resource.

Properties of the topic spaces configuration info of a namespace.

Properties of the topics configuration info of a namespace.

The information about the user identity.

Verified partner information.

Properties of the verified partner.

Information about the webhook destination for an event subscription.

Information about the webhook destination properties for an event subscription.

Authentication settings for a webhook endpoint within a Namespace resource.

Information about the WebHook of the partner destination.

Properties of a partner destination webhook.

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

The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.

Alternative authentication name sources related to client authentication settings for namespace resource.

Provisioning state of the CA Certificate resource.

Provisioning state of the channel.

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

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

Provisioning state of the ClientGroup resource.

Provisioning state of the Client resource.

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

This property specifies the mode of the Azure Confidential Compute configuration. Possible values are 'Disabled' or 'Enabled'. This is an immutable property set at the time of resource creation and cannot be modified later. Enabling this property ensures that messages are processed and stored in a Azure Confidential Compute environment.

The kind of entity that created the resource.

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.

Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated.

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.

Data Residency Boundary of the resource.

Type of the endpoint for the dead letter destination.

Type of the delivery attribute or header name.

Delivery mode of the event subscription.

The event delivery schema for the event subscription.

Provisioning state of the Event Grid Domain Resource.

Provisioning state of the domain topic.

Type of the endpoint for the event subscription destination.

The kind of event type used.

The event delivery schema for the event subscription.

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

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.

Provisioning state of the event subscription.

The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.

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.

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

Type of the custom mapping.

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

The type of managed identity used. Only UserAssigned or SystemAssigned Identity are supported.

The state of the Customer Managed Key (CMK) encryption. This is a read-only property which determines if the associated key is active and valid and used actively by runtime as expected. When the associated CMK becomes invalid (e.g., if it is deleted, or if versioned CMK is not current anymore), Event Grid Service will set this state to disabled to indicate that this key is not valid anymore and requires action from user.

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

Provisioning state of the namespace resource.

Provisioning state of the namespace topic.

Network security perimeter access mode.

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

Provisioning issue severity.

Provisioning issue type.

NSP access rule direction.

Type of NetworkSecurityPerimeterResourceType.

Type of client authentication.

Provisioning state of the partner configuration.

Activation state of the partner destination.

Provisioning state of the partner destination.

Type of the endpoint for the partner destination.

Provisioning state of the partner namespace.

Provisioning state of the partner registration.

Activation state of the partner topic.

Provisioning state of the partner topic.

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.

Provisioning state of the PermissionBinding resource.

The allowed permission.

Status of the connection.

Type of PrivateEndpointConnectionsParentType.

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" />.

Publisher type of the namespace topic.

The readiness state of the corresponding partner topic.

Kind of the resource.

Provisioning state of the Private Endpoint Connection.

Region type of the resource.

Routing identity type for topic spaces configuration.

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

The name of the SKU.

Static routing enrichment value type. For e.g. this property value can be 'String'.

Provisioning state of the event subscription.

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

Provisioning state of the topic.

Provisioning state of the TopicSpace resource.

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

Provisioning state of the topic type.

Type of TopicTypeSourceScope.

Provisioning state of the verified partner.