models Package
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. 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. All required parameters must be populated in order to send to Azure. |
AzureFunctionEventSubscriptionDestination |
Information about the azure function destination for an event subscription. All required parameters must be populated in order to send to Azure. |
BoolEqualsAdvancedFilter |
BoolEquals Advanced Filter. All required parameters must be populated in order to send to Azure. |
Channel |
Channel info. Variables are only populated by the server, and will be ignored when sending a request. |
ChannelUpdateParameters |
Properties of the Channel update. |
ChannelsListResult |
Result of the List Channels operation. |
ConnectionState |
ConnectionState information. |
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. You probably want to use the sub-classes and not this class directly. Known sub-classes are: StorageBlobDeadLetterDestination. All required parameters must be populated in order to send to Azure. |
DeadLetterWithResourceIdentity |
Information about the deadletter destination with resource identity. |
DeliveryAttributeListResult |
Result of the Get delivery attributes operation. |
DeliveryAttributeMapping |
Delivery attribute mapping details. You probably want to use the sub-classes and not this class directly. Known sub-classes are: DynamicDeliveryAttributeMapping, StaticDeliveryAttributeMapping. All required parameters must be populated in order to send to Azure. |
DeliveryWithResourceIdentity |
Information about the delivery for an event subscription with resource identity. |
Domain |
EventGrid Domain. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
DomainRegenerateKeyRequest |
Domain regenerate share access key request. All required parameters must be populated in order to send to Azure. |
DomainSharedAccessKeys |
Shared access keys of the Domain. |
DomainTopic |
Domain Topic. Variables are only populated by the server, and will be ignored when sending a request. |
DomainTopicsListResult |
Result of the List Domain Topics operation. |
DomainUpdateParameters |
Properties of the Domain update. |
DomainsListResult |
Result of the List Domains operation. |
DynamicDeliveryAttributeMapping |
Dynamic delivery attribute mapping details. All required parameters must be populated in order to send to Azure. |
EventHubEventSubscriptionDestination |
Information about the event hub destination for an event subscription. All required parameters must be populated in order to send to Azure. |
EventSubscription |
Event Subscription. Variables are only populated by the server, and will be ignored when sending a request. |
EventSubscriptionDestination |
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, ServiceBusQueueEventSubscriptionDestination, ServiceBusTopicEventSubscriptionDestination, StorageQueueEventSubscriptionDestination, WebHookEventSubscriptionDestination. All required parameters must be populated in order to send to Azure. |
EventSubscriptionFilter |
Filter for the Event Subscription. |
EventSubscriptionFullUrl |
Full endpoint url of an event subscription. |
EventSubscriptionIdentity |
The identity information with the event subscription. |
EventSubscriptionUpdateParameters |
Properties of the Event Subscription update. |
EventSubscriptionsListResult |
Result of the List EventSubscriptions operation. |
EventType |
Event Type for a subject under a topic. Variables are only populated by the server, and will be ignored when sending a request. |
EventTypeInfo |
The event type information for Channels. |
EventTypesListResult |
Result of the List Event Types operation. |
ExtensionTopic |
Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources. Variables are only populated by the server, and will be ignored when sending a request. |
HybridConnectionEventSubscriptionDestination |
Information about the HybridConnection destination for an event subscription. All required parameters must be populated in order to send to Azure. |
IdentityInfo |
The identity information for the resource. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. This property is currently not used and reserved for future usage. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. This property is currently not used and reserved for future usage. |
InboundIpRule |
InboundIpRule. |
InlineEventProperties |
Additional information about every inline event. |
InputSchemaMapping |
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. All required parameters must be populated in order to send to Azure. |
IsNotNullAdvancedFilter |
IsNotNull Advanced Filter. All required parameters must be populated in order to send to Azure. |
IsNullOrUndefinedAdvancedFilter |
IsNullOrUndefined Advanced Filter. All required parameters must be populated in order to send to Azure. |
JsonField |
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. |
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. ivar source_field: Name of a field in the input event schema that's to be used as the source of a mapping. vartype source_field: str ivar default_value: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload. vartype default_value: str |
JsonInputSchemaMapping |
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. All required parameters must be populated in order to send to Azure. |
NumberGreaterThanAdvancedFilter |
NumberGreaterThan Advanced Filter. All required parameters must be populated in order to send to Azure. |
NumberGreaterThanOrEqualsAdvancedFilter |
NumberGreaterThanOrEquals Advanced Filter. All required parameters must be populated in order to send to Azure. |
NumberInAdvancedFilter |
NumberIn Advanced Filter. All required parameters must be populated in order to send to Azure. |
NumberInRangeAdvancedFilter |
NumberInRange Advanced Filter. All required parameters must be populated in order to send to Azure. |
NumberLessThanAdvancedFilter |
NumberLessThan Advanced Filter. All required parameters must be populated in order to send to Azure. |
NumberLessThanOrEqualsAdvancedFilter |
NumberLessThanOrEquals Advanced Filter. All required parameters must be populated in order to send to Azure. |
NumberNotInAdvancedFilter |
NumberNotIn Advanced Filter. All required parameters must be populated in order to send to Azure. |
NumberNotInRangeAdvancedFilter |
NumberNotInRange Advanced Filter. All required parameters must be populated in order to send to Azure. |
Operation |
Represents an operation returned by the GetOperations request. |
OperationInfo |
Information about an operation. |
OperationsListResult |
Result of the List Operations operation. |
Partner |
Information about the partner. |
PartnerAuthorization |
The partner authorization details. |
PartnerConfiguration |
Partner configuration information. Variables are only populated by the server, and will be ignored when sending a request. |
PartnerConfigurationUpdateParameters |
Properties of the partner configuration update. |
PartnerConfigurationsListResult |
Result of the List partner configurations operation. |
PartnerDetails |
Information about the partner. |
PartnerNamespace |
EventGrid Partner Namespace. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. :vartype partner_registration_fully_qualified_id: str :ivar endpoint: Endpoint for the partner namespace. :vartype endpoint: str :ivar public_network_access: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. :paramtype partner_registration_fully_qualified_id: str :keyword public_network_access: This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
PartnerNamespaceRegenerateKeyRequest |
PartnerNamespace regenerate shared access key request. All required parameters must be populated in order to send to Azure. |
PartnerNamespaceSharedAccessKeys |
Shared access keys of the partner namespace. |
PartnerNamespaceUpdateParameters |
Properties of the Partner Namespace update. |
PartnerNamespacesListResult |
Result of the List Partner Namespaces operation. |
PartnerRegistration |
Information about a partner registration. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
PartnerRegistrationUpdateParameters |
Properties of the Partner Registration update. |
PartnerRegistrationsListResult |
Result of the List Partner Registrations operation. |
PartnerTopic |
Event Grid Partner Topic. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
PartnerTopicInfo |
Properties of the corresponding partner topic of a Channel. |
PartnerTopicUpdateParameters |
Properties of the Partner Topic update. |
PartnerTopicsListResult |
Result of the List Partner Topics operation. |
PartnerUpdateTopicInfo |
Update properties for the corresponding partner topic of a channel. |
PrivateEndpoint |
PrivateEndpoint information. |
PrivateEndpointConnection |
PrivateEndpointConnection. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateEndpointConnectionListResult |
Result of the list of all private endpoint connections operation. |
PrivateLinkResource |
Information of the private link resource. |
PrivateLinkResourcesListResult |
Result of the List private link resources operation. |
Resource |
Definition of a Resource. Variables are only populated by the server, and will be ignored when sending a request. |
RetryPolicy |
Information about the retry policy for an event subscription. |
ServiceBusQueueEventSubscriptionDestination |
Information about the service bus destination for an event subscription. All required parameters must be populated in order to send to Azure. |
ServiceBusTopicEventSubscriptionDestination |
Information about the service bus topic destination for an event subscription. All required parameters must be populated in order to send to Azure. |
StaticDeliveryAttributeMapping |
Static delivery attribute mapping details. All required parameters must be populated in order to send to Azure. |
StorageBlobDeadLetterDestination |
Information about the storage blob based dead letter destination. All required parameters must be populated in order to send to Azure. |
StorageQueueEventSubscriptionDestination |
Information about the storage queue destination for an event subscription. All required parameters must be populated in order to send to Azure. |
StringBeginsWithAdvancedFilter |
StringBeginsWith Advanced Filter. All required parameters must be populated in order to send to Azure. |
StringContainsAdvancedFilter |
StringContains Advanced Filter. All required parameters must be populated in order to send to Azure. |
StringEndsWithAdvancedFilter |
StringEndsWith Advanced Filter. All required parameters must be populated in order to send to Azure. |
StringInAdvancedFilter |
StringIn Advanced Filter. All required parameters must be populated in order to send to Azure. |
StringNotBeginsWithAdvancedFilter |
StringNotBeginsWith Advanced Filter. All required parameters must be populated in order to send to Azure. |
StringNotContainsAdvancedFilter |
StringNotContains Advanced Filter. All required parameters must be populated in order to send to Azure. |
StringNotEndsWithAdvancedFilter |
StringNotEndsWith Advanced Filter. All required parameters must be populated in order to send to Azure. |
StringNotInAdvancedFilter |
StringNotIn Advanced Filter. All required parameters must be populated in order to send to Azure. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
SystemTopic |
EventGrid System Topic. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SystemTopicUpdateParameters |
Properties of the System Topic update. |
SystemTopicsListResult |
Result of the List System topics operation. |
Topic |
EventGrid Topic. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
TopicRegenerateKeyRequest |
Topic regenerate share access key request. All required parameters must be populated in order to send to Azure. |
TopicSharedAccessKeys |
Shared access keys of the Topic. |
TopicTypeInfo |
Properties of a topic type info. Variables are only populated by the server, and will be ignored when sending a request. |
TopicTypesListResult |
Result of the List Topic Types operation. |
TopicUpdateParameters |
Properties of the Topic update. |
TopicsListResult |
Result of the List Topics operation. |
TrackedResource |
Definition of a Tracked Resource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
UserIdentityProperties |
The information about the user identity. |
VerifiedPartner |
Verified partner information. Variables are only populated by the server, and will be ignored when sending a request. |
VerifiedPartnersListResult |
Result of the List verified partners operation. |
WebHookEventSubscriptionDestination |
Information about the webhook destination for an event subscription. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
Enums
AdvancedFilterOperatorType |
The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. |
ChannelProvisioningState |
Provisioning state of the channel. |
ChannelType |
The type of the event channel which represents the direction flow of events. |
CreatedByType |
The type of identity that created the resource. |
DataResidencyBoundary |
Data Residency Boundary of the resource. |
DeadLetterEndPointType |
Type of the endpoint for the dead letter destination |
DeliveryAttributeMappingType |
Type of the delivery attribute or header name. |
DomainProvisioningState |
Provisioning state of the Event Grid Domain Resource. |
DomainTopicProvisioningState |
Provisioning state of the domain topic. |
EndpointType |
Type of the endpoint for the event subscription destination. |
EventDefinitionKind |
The kind of event type used. |
EventDeliverySchema |
The event delivery schema for the event subscription. |
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. |
IdentityType |
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. |
InputSchema |
This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. |
InputSchemaMappingType |
Type of the custom mapping |
IpActionType |
Action to perform based on the match or no match of the IpMask. |
PartnerConfigurationProvisioningState |
Provisioning state of the partner configuration. |
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. |
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. |
PersistedConnectionStatus |
Status of the connection. |
PrivateEndpointConnectionsParentType | |
PublicNetworkAccess |
This determines if traffic is allowed over public network. By default it is enabled.
You can further restrict to specific IPs by configuring |
ReadinessState |
The readiness state of the corresponding partner topic. |
ResourceProvisioningState |
Provisioning state of the Private Endpoint Connection. |
ResourceRegionType |
Region type of the resource. |
TopicProvisioningState |
Provisioning state of the topic. |
TopicTypeProvisioningState |
Provisioning state of the topic type |
TopicTypeSourceScope | |
VerifiedPartnerProvisioningState |
Provisioning state of the verified partner. |
Azure SDK for Python