@azure/arm-eventgrid package

Interfaces

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.

AzureADPartnerClientAuthentication

Microsoft Entra ID Partner Client Authentication

AzureADPartnerClientAuthenticationProperties

Properties of a Microsoft Entra ID Partner Client Authentication.

AzureFunctionEventSubscriptionDestination

Information about the azure function destination for an event subscription.

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

BoolEquals Advanced Filter.

BoolEqualsFilter

BoolEquals Filter.

CaCertificate

The CA Certificate resource.

CaCertificateProperties

The properties of CA certificate.

CaCertificatesCreateOrUpdateOptionalParams

Optional parameters.

CaCertificatesDeleteOptionalParams

Optional parameters.

CaCertificatesGetOptionalParams

Optional parameters.

CaCertificatesListByNamespaceOptionalParams

Optional parameters.

CaCertificatesOperations

Interface representing a CaCertificates operations.

Channel

Channel info.

ChannelProperties

Properties of the Channel.

ChannelUpdateParameters

Properties of the Channel update.

ChannelUpdateParametersProperties

Properties of the channel update parameters.

ChannelsCreateOrUpdateOptionalParams

Optional parameters.

ChannelsDeleteOptionalParams

Optional parameters.

ChannelsGetFullUrlOptionalParams

Optional parameters.

ChannelsGetOptionalParams

Optional parameters.

ChannelsListByPartnerNamespaceOptionalParams

Optional parameters.

ChannelsOperations

Interface representing a Channels operations.

ChannelsUpdateOptionalParams

Optional parameters.

Client

The Client resource.

ClientAuthenticationSettings

Client authentication settings for namespace resource.

ClientCertificateAuthentication

The certificate authentication properties for the client.

ClientGroup

The Client group resource.

ClientGroupProperties

The properties of client group.

ClientGroupsCreateOrUpdateOptionalParams

Optional parameters.

ClientGroupsDeleteOptionalParams

Optional parameters.

ClientGroupsGetOptionalParams

Optional parameters.

ClientGroupsListByNamespaceOptionalParams

Optional parameters.

ClientGroupsOperations

Interface representing a ClientGroups operations.

ClientProperties

The properties of client.

ClientsCreateOrUpdateOptionalParams

Optional parameters.

ClientsDeleteOptionalParams

Optional parameters.

ClientsGetOptionalParams

Optional parameters.

ClientsListByNamespaceOptionalParams

Optional parameters.

ClientsOperations

Interface representing a Clients operations.

ConfidentialCompute

Azure Confidential Compute properties of the resource.

ConnectionState

ConnectionState information.

CustomDomainConfiguration

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

CustomDomainIdentity

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

CustomDomainOwnershipValidationResult

Namespace custom domain ownership validation result.

CustomJwtAuthenticationManagedIdentity

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

CustomJwtAuthenticationSettings

Custom JWT authentication settings for namespace resource.

CustomWebhookAuthenticationManagedIdentity

The identity configuration required for authenticating a custom webhook.

CustomerManagedKeyEncryption

All Customer-managed key encryption properties for the resource.

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.

DeadLetterWithResourceIdentity

Information about the deadletter destination with resource identity.

DeliveryAttributeListResult

Result of the Get delivery attributes operation.

DeliveryAttributeMapping

Delivery attribute mapping details.

DeliveryConfiguration

Properties of the delivery configuration information of the event subscription.

DeliveryWithResourceIdentity

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

Domain

EventGrid Domain.

DomainEventSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

DomainEventSubscriptionsDeleteOptionalParams

Optional parameters.

DomainEventSubscriptionsGetDeliveryAttributesOptionalParams

Optional parameters.

DomainEventSubscriptionsGetFullUrlOptionalParams

Optional parameters.

DomainEventSubscriptionsGetOptionalParams

Optional parameters.

DomainEventSubscriptionsListOptionalParams

Optional parameters.

DomainEventSubscriptionsOperations

Interface representing a DomainEventSubscriptions operations.

DomainEventSubscriptionsUpdateOptionalParams

Optional parameters.

DomainProperties

Properties of the Event Grid Domain Resource.

DomainRegenerateKeyRequest

Domain regenerate share access key request.

DomainSharedAccessKeys

Shared access keys of the Domain.

DomainTopic

Domain Topic.

DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

DomainTopicEventSubscriptionsDeleteOptionalParams

Optional parameters.

DomainTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Optional parameters.

DomainTopicEventSubscriptionsGetFullUrlOptionalParams

Optional parameters.

DomainTopicEventSubscriptionsGetOptionalParams

Optional parameters.

DomainTopicEventSubscriptionsListOptionalParams

Optional parameters.

DomainTopicEventSubscriptionsOperations

Interface representing a DomainTopicEventSubscriptions operations.

DomainTopicEventSubscriptionsUpdateOptionalParams

Optional parameters.

DomainTopicProperties

Properties of the Domain Topic.

DomainTopicsCreateOrUpdateOptionalParams

Optional parameters.

DomainTopicsDeleteOptionalParams

Optional parameters.

DomainTopicsGetOptionalParams

Optional parameters.

DomainTopicsListByDomainOptionalParams

Optional parameters.

DomainTopicsOperations

Interface representing a DomainTopics operations.

DomainUpdateParameterProperties

Information of domain update parameter properties.

DomainUpdateParameters

Properties of the Domain update.

DomainsCreateOrUpdateOptionalParams

Optional parameters.

DomainsDeleteOptionalParams

Optional parameters.

DomainsGetOptionalParams

Optional parameters.

DomainsListByResourceGroupOptionalParams

Optional parameters.

DomainsListBySubscriptionOptionalParams

Optional parameters.

DomainsListSharedAccessKeysOptionalParams

Optional parameters.

DomainsOperations

Interface representing a Domains operations.

DomainsRegenerateKeyOptionalParams

Optional parameters.

DomainsUpdateOptionalParams

Optional parameters.

DynamicDeliveryAttributeMapping

Dynamic delivery attribute mapping details.

DynamicDeliveryAttributeMappingProperties

Properties of dynamic delivery attribute mapping.

DynamicRoutingEnrichment

model interface DynamicRoutingEnrichment

EncodedIssuerCertificateInfo

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

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

EventGridManagementClientOptionalParams

Optional parameters for the client.

EventHubEventSubscriptionDestination

Information about the event hub destination for an event subscription.

EventHubEventSubscriptionDestinationProperties

The properties for a event hub destination.

EventSubscription

Event Subscription.

EventSubscriptionDestination

Information about the destination for an event subscription.

EventSubscriptionFilter

Filter for the Event Subscription.

EventSubscriptionFullUrl

Full endpoint URL of an event subscription

EventSubscriptionIdentity

The identity information with the event subscription.

EventSubscriptionProperties

Properties of the Event Subscription.

EventSubscriptionUpdateParameters

Properties of the Event Subscription update.

EventSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

EventSubscriptionsDeleteOptionalParams

Optional parameters.

EventSubscriptionsGetDeliveryAttributesOptionalParams

Optional parameters.

EventSubscriptionsGetFullUrlOptionalParams

Optional parameters.

EventSubscriptionsGetOptionalParams

Optional parameters.

EventSubscriptionsListByDomainTopicOptionalParams

Optional parameters.

EventSubscriptionsListByResourceOptionalParams

Optional parameters.

EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams

Optional parameters.

EventSubscriptionsListGlobalByResourceGroupOptionalParams

Optional parameters.

EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams

Optional parameters.

EventSubscriptionsListGlobalBySubscriptionOptionalParams

Optional parameters.

EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams

Optional parameters.

EventSubscriptionsListRegionalByResourceGroupOptionalParams

Optional parameters.

EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams

Optional parameters.

EventSubscriptionsListRegionalBySubscriptionOptionalParams

Optional parameters.

EventSubscriptionsOperations

Interface representing a EventSubscriptions operations.

EventSubscriptionsUpdateOptionalParams

Optional parameters.

EventType

Event Type for a subject under a topic

EventTypeInfo

The event type information for Channels.

EventTypeProperties

Properties of the event type

ExtendedLocation

Definition of an Extended Location

ExtensionResource

The base extension resource.

ExtensionTopic

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

ExtensionTopicProperties

Properties of the Extension Topic

ExtensionTopicsGetOptionalParams

Optional parameters.

ExtensionTopicsOperations

Interface representing a ExtensionTopics operations.

FederatedIdentityCredentialInfo

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

Filter

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.

FiltersConfiguration

Filters configuration for the Event Subscription.

HybridConnectionEventSubscriptionDestination

Information about the HybridConnection destination for an event subscription.

HybridConnectionEventSubscriptionDestinationProperties

The properties for a hybrid connection destination.

IdentityInfo

The identity information for the resource.

InboundIpRule

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

IsNotNullAdvancedFilter

IsNotNull Advanced Filter.

IsNotNullFilter

IsNotNull Filter.

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined Advanced Filter.

IsNullOrUndefinedFilter

IsNullOrUndefined Filter.

IssuerCertificateInfo

Information about the certificate that is used for token validation.

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.

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.

JsonInputSchemaMappingProperties

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

KeyEncryption

Properties of the Encryption settings.

KeyEncryptionKeyIdentity

model interface KeyEncryptionKeyIdentity

MonitorAlertEventSubscriptionDestination

Information about the Monitor Alert destination for an event subscription.

MonitorAlertEventSubscriptionDestinationProperties

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

Namespace

Namespace resource.

NamespaceProperties

Properties of the namespace resource.

NamespaceRegenerateKeyRequest

Namespace regenerate share access key request.

NamespaceSharedAccessKeys

Shared access keys of the Namespace.

NamespaceSku

Represents available Sku pricing tiers.

NamespaceTopic

Namespace topic details.

NamespaceTopicEventSubscriptionDestination

Information about the Namespace Topic destination for an event subscription.

NamespaceTopicEventSubscriptionDestinationProperties

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

NamespaceTopicEventSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

NamespaceTopicEventSubscriptionsDeleteOptionalParams

Optional parameters.

NamespaceTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Optional parameters.

NamespaceTopicEventSubscriptionsGetFullUrlOptionalParams

Optional parameters.

NamespaceTopicEventSubscriptionsGetOptionalParams

Optional parameters.

NamespaceTopicEventSubscriptionsListByNamespaceTopicOptionalParams

Optional parameters.

NamespaceTopicEventSubscriptionsOperations

Interface representing a NamespaceTopicEventSubscriptions operations.

NamespaceTopicEventSubscriptionsUpdateOptionalParams

Optional parameters.

NamespaceTopicProperties

Properties of the namespace topic.

NamespaceTopicUpdateParameterProperties

Information of namespace topic update parameter properties.

NamespaceTopicUpdateParameters

Properties of the namespace topic update.

NamespaceTopicsCreateOrUpdateOptionalParams

Optional parameters.

NamespaceTopicsDeleteOptionalParams

Optional parameters.

NamespaceTopicsGetOptionalParams

Optional parameters.

NamespaceTopicsListByNamespaceOptionalParams

Optional parameters.

NamespaceTopicsListSharedAccessKeysOptionalParams

Optional parameters.

NamespaceTopicsOperations

Interface representing a NamespaceTopics operations.

NamespaceTopicsRegenerateKeyOptionalParams

Optional parameters.

NamespaceTopicsUpdateOptionalParams

Optional parameters.

NamespaceUpdateParameterProperties

Information of namespace update parameter properties.

NamespaceUpdateParameters

Properties to update namespace.

NamespacesCreateOrUpdateOptionalParams

Optional parameters.

NamespacesDeleteOptionalParams

Optional parameters.

NamespacesGetOptionalParams

Optional parameters.

NamespacesListByResourceGroupOptionalParams

Optional parameters.

NamespacesListBySubscriptionOptionalParams

Optional parameters.

NamespacesListSharedAccessKeysOptionalParams

Optional parameters.

NamespacesOperations

Interface representing a Namespaces operations.

NamespacesRegenerateKeyOptionalParams

Optional parameters.

NamespacesUpdateOptionalParams

Optional parameters.

NamespacesValidateCustomDomainOwnershipOptionalParams

Optional parameters.

NetworkSecurityPerimeterConfiguration

Network security perimeter configuration.

NetworkSecurityPerimeterConfigurationIssues

Network security perimeter configuration issues.

NetworkSecurityPerimeterConfigurationIssuesProperties

Network security perimeter configuration issues properties.

NetworkSecurityPerimeterConfigurationProfile

Nsp configuration with profile information.

NetworkSecurityPerimeterConfigurationProperties

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

NetworkSecurityPerimeterConfigurationsGetOptionalParams

Optional parameters.

NetworkSecurityPerimeterConfigurationsListOptionalParams

Optional parameters.

NetworkSecurityPerimeterConfigurationsOperations

Interface representing a NetworkSecurityPerimeterConfigurations operations.

NetworkSecurityPerimeterConfigurationsReconcileOptionalParams

Optional parameters.

NetworkSecurityPerimeterInfo

Network security perimeter info.

NetworkSecurityPerimeterProfileAccessRule

Network security perimeter profile access rule.

NetworkSecurityPerimeterProfileAccessRuleProperties

Network security perimeter profile access rule properties.

NetworkSecurityPerimeterSubscription

Network security perimeter subscription inbound 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.

Operation

Represents an operation returned by the GetOperations request.

OperationInfo

Information about an operation

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

Partner

Information about the partner.

PartnerAuthorization

The partner authorization details.

PartnerClientAuthentication

Partner client authentication

PartnerConfiguration

Partner configuration information

PartnerConfigurationProperties

Properties of the partner configuration.

PartnerConfigurationUpdateParameterProperties

Information of partner configuration update parameter properties.

PartnerConfigurationUpdateParameters

Properties of the partner configuration update.

PartnerConfigurationsAuthorizePartnerOptionalParams

Optional parameters.

PartnerConfigurationsCreateOrUpdateOptionalParams

Optional parameters.

PartnerConfigurationsDeleteOptionalParams

Optional parameters.

PartnerConfigurationsGetOptionalParams

Optional parameters.

PartnerConfigurationsListByResourceGroupOptionalParams

Optional parameters.

PartnerConfigurationsListBySubscriptionOptionalParams

Optional parameters.

PartnerConfigurationsOperations

Interface representing a PartnerConfigurations operations.

PartnerConfigurationsUnauthorizePartnerOptionalParams

Optional parameters.

PartnerConfigurationsUpdateOptionalParams

Optional parameters.

PartnerDestination

Event Grid Partner Destination.

PartnerDestinationInfo

Properties of the corresponding partner destination of a Channel.

PartnerDestinationProperties

Properties of the Partner Destination.

PartnerDestinationUpdateParameters

Properties of the Partner Destination that can be updated.

PartnerDestinationsActivateOptionalParams

Optional parameters.

PartnerDestinationsCreateOrUpdateOptionalParams

Optional parameters.

PartnerDestinationsDeleteOptionalParams

Optional parameters.

PartnerDestinationsGetOptionalParams

Optional parameters.

PartnerDestinationsListByResourceGroupOptionalParams

Optional parameters.

PartnerDestinationsListBySubscriptionOptionalParams

Optional parameters.

PartnerDestinationsOperations

Interface representing a PartnerDestinations operations.

PartnerDestinationsUpdateOptionalParams

Optional parameters.

PartnerDetails

Information about the partner.

PartnerEventSubscriptionDestination

model interface PartnerEventSubscriptionDestination

PartnerEventSubscriptionDestinationProperties

model interface PartnerEventSubscriptionDestinationProperties

PartnerNamespace

EventGrid Partner Namespace.

PartnerNamespaceProperties

Properties of the partner namespace.

PartnerNamespaceRegenerateKeyRequest

PartnerNamespace regenerate shared access key request.

PartnerNamespaceSharedAccessKeys

Shared access keys of the partner namespace.

PartnerNamespaceUpdateParameterProperties

Information of Partner Namespace update parameter properties.

PartnerNamespaceUpdateParameters

Properties of the Partner Namespace update.

PartnerNamespacesCreateOrUpdateOptionalParams

Optional parameters.

PartnerNamespacesDeleteOptionalParams

Optional parameters.

PartnerNamespacesGetOptionalParams

Optional parameters.

PartnerNamespacesListByResourceGroupOptionalParams

Optional parameters.

PartnerNamespacesListBySubscriptionOptionalParams

Optional parameters.

PartnerNamespacesListSharedAccessKeysOptionalParams

Optional parameters.

PartnerNamespacesOperations

Interface representing a PartnerNamespaces operations.

PartnerNamespacesRegenerateKeyOptionalParams

Optional parameters.

PartnerNamespacesUpdateOptionalParams

Optional parameters.

PartnerRegistration

Information about a partner registration.

PartnerRegistrationProperties

Properties of the partner registration.

PartnerRegistrationUpdateParameters

Properties of the Partner Registration update.

PartnerRegistrationsCreateOrUpdateOptionalParams

Optional parameters.

PartnerRegistrationsDeleteOptionalParams

Optional parameters.

PartnerRegistrationsGetOptionalParams

Optional parameters.

PartnerRegistrationsListByResourceGroupOptionalParams

Optional parameters.

PartnerRegistrationsListBySubscriptionOptionalParams

Optional parameters.

PartnerRegistrationsOperations

Interface representing a PartnerRegistrations operations.

PartnerRegistrationsUpdateOptionalParams

Optional parameters.

PartnerTopic

Event Grid Partner Topic.

PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

PartnerTopicEventSubscriptionsDeleteOptionalParams

Optional parameters.

PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Optional parameters.

PartnerTopicEventSubscriptionsGetFullUrlOptionalParams

Optional parameters.

PartnerTopicEventSubscriptionsGetOptionalParams

Optional parameters.

PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams

Optional parameters.

PartnerTopicEventSubscriptionsOperations

Interface representing a PartnerTopicEventSubscriptions operations.

PartnerTopicEventSubscriptionsUpdateOptionalParams

Optional parameters.

PartnerTopicInfo

Properties of the corresponding partner topic of a Channel.

PartnerTopicProperties

Properties of the Partner Topic.

PartnerTopicUpdateParameters

Properties of the Partner Topic update.

PartnerTopicsActivateOptionalParams

Optional parameters.

PartnerTopicsCreateOrUpdateOptionalParams

Optional parameters.

PartnerTopicsDeactivateOptionalParams

Optional parameters.

PartnerTopicsDeleteOptionalParams

Optional parameters.

PartnerTopicsGetOptionalParams

Optional parameters.

PartnerTopicsListByResourceGroupOptionalParams

Optional parameters.

PartnerTopicsListBySubscriptionOptionalParams

Optional parameters.

PartnerTopicsOperations

Interface representing a PartnerTopics operations.

PartnerTopicsUpdateOptionalParams

Optional parameters.

PartnerUpdateDestinationInfo

Properties of the corresponding partner destination of a Channel.

PartnerUpdateTopicInfo

Update properties for the corresponding partner topic of a channel.

PermissionBinding

The Permission binding resource.

PermissionBindingProperties

The properties of permission binding.

PermissionBindingsCreateOrUpdateOptionalParams

Optional parameters.

PermissionBindingsDeleteOptionalParams

Optional parameters.

PermissionBindingsGetOptionalParams

Optional parameters.

PermissionBindingsListByNamespaceOptionalParams

Optional parameters.

PermissionBindingsOperations

Interface representing a PermissionBindings operations.

PlatformCapabilities

Platform capabilities properties of the resource.

PrivateEndpoint

PrivateEndpoint information.

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

Properties of the private endpoint connection resource.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByResourceOptionalParams

Optional parameters.

PrivateEndpointConnectionsOperations

Interface representing a PrivateEndpointConnections operations.

PrivateEndpointConnectionsUpdateOptionalParams

Optional parameters.

PrivateLinkResource

Information of the private link resource.

PrivateLinkResourceProperties

model interface PrivateLinkResourceProperties

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListByResourceOptionalParams

Optional parameters.

PrivateLinkResourcesOperations

Interface representing a PrivateLinkResources operations.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

PushInfo

Properties of the destination info for event subscription supporting push.

QueueInfo

Properties of the Queue info for event subscription.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceAssociation

Nsp resource association

ResourceMoveChangeHistory

The change history of the resource move.

ResourceSku

Describes an EventGrid Resource Sku.

RestorePollerOptions
RetryPolicy

Information about the retry policy for an event subscription.

RoutingEnrichments

model interface RoutingEnrichments

RoutingIdentityInfo

Routing identity info for topic spaces configuration.

ServiceBusQueueEventSubscriptionDestination

Information about the service bus destination for an event subscription.

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationProperties

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

SimplePollerLike

A simple poller that can be used to poll a long running operation.

StaticDeliveryAttributeMapping

Static delivery attribute mapping details.

StaticDeliveryAttributeMappingProperties

Properties of static delivery attribute mapping.

StaticRoutingEnrichment

Static routing enrichment details.

StaticStringRoutingEnrichment

model interface StaticStringRoutingEnrichment

StorageBlobDeadLetterDestination

Information about the storage blob based dead letter destination.

StorageBlobDeadLetterDestinationProperties

Properties of the storage blob based dead letter destination.

StorageQueueEventSubscriptionDestination

Information about the storage queue destination for an event subscription.

StorageQueueEventSubscriptionDestinationProperties

The properties for a storage queue destination.

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.

Subscription

Event Subscription.

SubscriptionFullUrl

Full endpoint URL of an event subscription

SubscriptionProperties

Properties of the event subscription.

SubscriptionUpdateParameters

Properties of the Event Subscription update.

SubscriptionUpdateParametersProperties

Properties of the Event Subscription update parameters.

SystemData

Metadata pertaining to creation and last modification of the resource.

SystemTopic

EventGrid System Topic.

SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

SystemTopicEventSubscriptionsDeleteOptionalParams

Optional parameters.

SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Optional parameters.

SystemTopicEventSubscriptionsGetFullUrlOptionalParams

Optional parameters.

SystemTopicEventSubscriptionsGetOptionalParams

Optional parameters.

SystemTopicEventSubscriptionsListBySystemTopicOptionalParams

Optional parameters.

SystemTopicEventSubscriptionsOperations

Interface representing a SystemTopicEventSubscriptions operations.

SystemTopicEventSubscriptionsUpdateOptionalParams

Optional parameters.

SystemTopicProperties

Properties of the System Topic.

SystemTopicUpdateParameters

Properties of the System Topic update.

SystemTopicsCreateOrUpdateOptionalParams

Optional parameters.

SystemTopicsDeleteOptionalParams

Optional parameters.

SystemTopicsGetOptionalParams

Optional parameters.

SystemTopicsListByResourceGroupOptionalParams

Optional parameters.

SystemTopicsListBySubscriptionOptionalParams

Optional parameters.

SystemTopicsOperations

Interface representing a SystemTopics operations.

SystemTopicsUpdateOptionalParams

Optional parameters.

Topic

EventGrid Topic

TopicEventSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

TopicEventSubscriptionsDeleteOptionalParams

Optional parameters.

TopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Optional parameters.

TopicEventSubscriptionsGetFullUrlOptionalParams

Optional parameters.

TopicEventSubscriptionsGetOptionalParams

Optional parameters.

TopicEventSubscriptionsListOptionalParams

Optional parameters.

TopicEventSubscriptionsOperations

Interface representing a TopicEventSubscriptions operations.

TopicEventSubscriptionsUpdateOptionalParams

Optional parameters.

TopicProperties

Properties of the Topic.

TopicRegenerateKeyRequest

Topic regenerate share access key request

TopicSharedAccessKeys

Shared access keys of the Topic

TopicSpace

The Topic space resource.

TopicSpaceProperties

The properties of topic space.

TopicSpacesConfiguration

Properties of the Topic Spaces Configuration.

TopicSpacesCreateOrUpdateOptionalParams

Optional parameters.

TopicSpacesDeleteOptionalParams

Optional parameters.

TopicSpacesGetOptionalParams

Optional parameters.

TopicSpacesListByNamespaceOptionalParams

Optional parameters.

TopicSpacesOperations

Interface representing a TopicSpaces operations.

TopicTypeAdditionalEnforcedPermission

model interface TopicTypeAdditionalEnforcedPermission

TopicTypeInfo

Properties of a topic type info.

TopicTypeProperties

Properties of a topic type.

TopicTypesGetOptionalParams

Optional parameters.

TopicTypesListEventTypesOptionalParams

Optional parameters.

TopicTypesListOptionalParams

Optional parameters.

TopicTypesOperations

Interface representing a TopicTypes operations.

TopicUpdateParameterProperties

Information of topic update parameter properties.

TopicUpdateParameters

Properties of the Topic update

TopicsConfiguration

Properties of the Topics Configuration.

TopicsCreateOrUpdateOptionalParams

Optional parameters.

TopicsDeleteOptionalParams

Optional parameters.

TopicsGetOptionalParams

Optional parameters.

TopicsListByResourceGroupOptionalParams

Optional parameters.

TopicsListBySubscriptionOptionalParams

Optional parameters.

TopicsListEventTypesOptionalParams

Optional parameters.

TopicsListSharedAccessKeysOptionalParams

Optional parameters.

TopicsOperations

Interface representing a Topics operations.

TopicsRegenerateKeyOptionalParams

Optional parameters.

TopicsUpdateOptionalParams

Optional parameters.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

UpdateTopicSpacesConfigurationInfo

Properties of the topic spaces configuration info of a namespace.

UpdateTopicsConfigurationInfo

Properties of the topics configuration info of a namespace.

UserIdentityProperties

The information about the user identity.

VerifiedPartner

Verified partner information

VerifiedPartnerProperties

Properties of the verified partner.

VerifiedPartnersGetOptionalParams

Optional parameters.

VerifiedPartnersListOptionalParams

Optional parameters.

VerifiedPartnersOperations

Interface representing a VerifiedPartners operations.

WebHookEventSubscriptionDestination

Information about the webhook destination for an event subscription.

WebHookEventSubscriptionDestinationProperties

Information about the webhook destination properties for an event subscription.

WebhookAuthenticationSettings

Authentication settings for a webhook endpoint within a Namespace resource.

WebhookPartnerDestinationInfo

Information about the WebHook of the partner destination.

WebhookPartnerDestinationProperties

Properties of a partner destination webhook.

WebhookUpdatePartnerDestinationInfo

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

Type Aliases

AdvancedFilterOperatorType

The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
KnownAdvancedFilterOperatorType can be used interchangeably with AdvancedFilterOperatorType, this enum contains the known values that the service supports.

Known values supported by the service

NumberIn: NumberIn
NumberNotIn: NumberNotIn
NumberLessThan: NumberLessThan
NumberGreaterThan: NumberGreaterThan
NumberLessThanOrEquals: NumberLessThanOrEquals
NumberGreaterThanOrEquals: NumberGreaterThanOrEquals
BoolEquals: BoolEquals
StringIn: StringIn
StringNotIn: StringNotIn
StringBeginsWith: StringBeginsWith
StringEndsWith: StringEndsWith
StringContains: StringContains
NumberInRange: NumberInRange
NumberNotInRange: NumberNotInRange
StringNotBeginsWith: StringNotBeginsWith
StringNotEndsWith: StringNotEndsWith
StringNotContains: StringNotContains
IsNullOrUndefined: IsNullOrUndefined
IsNotNull: IsNotNull

AdvancedFilterUnion

Alias for AdvancedFilterUnion

AlternativeAuthenticationNameSource

Alternative authentication name sources related to client authentication settings for namespace resource.
KnownAlternativeAuthenticationNameSource can be used interchangeably with AlternativeAuthenticationNameSource, this enum contains the known values that the service supports.

Known values supported by the service

ClientCertificateSubject: ClientCertificateSubject
ClientCertificateDns: ClientCertificateDns
ClientCertificateUri: ClientCertificateUri
ClientCertificateIp: ClientCertificateIp
ClientCertificateEmail: ClientCertificateEmail

AzureSupportedClouds

The supported values for cloud setting as a string literal type

CaCertificateProvisioningState

Provisioning state of the CA Certificate resource.
KnownCaCertificateProvisioningState can be used interchangeably with CaCertificateProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted

ChannelProvisioningState

Provisioning state of the channel.
KnownChannelProvisioningState can be used interchangeably with ChannelProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
IdleDueToMirroredPartnerTopicDeletion: IdleDueToMirroredPartnerTopicDeletion
IdleDueToMirroredPartnerDestinationDeletion: IdleDueToMirroredPartnerDestinationDeletion

ChannelType

The type of the event channel which represents the direction flow of events.
KnownChannelType can be used interchangeably with ChannelType, this enum contains the known values that the service supports.

Known values supported by the service

PartnerTopic: PartnerTopic
PartnerDestination: PartnerDestination

ClientCertificateValidationScheme

The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
KnownClientCertificateValidationScheme can be used interchangeably with ClientCertificateValidationScheme, this enum contains the known values that the service supports.

Known values supported by the service

SubjectMatchesAuthenticationName: SubjectMatchesAuthenticationName
DnsMatchesAuthenticationName: DnsMatchesAuthenticationName
UriMatchesAuthenticationName: UriMatchesAuthenticationName
IpMatchesAuthenticationName: IpMatchesAuthenticationName
EmailMatchesAuthenticationName: EmailMatchesAuthenticationName
ThumbprintMatch: ThumbprintMatch

ClientGroupProvisioningState

Provisioning state of the ClientGroup resource.
KnownClientGroupProvisioningState can be used interchangeably with ClientGroupProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted

ClientProvisioningState

Provisioning state of the Client resource.
KnownClientProvisioningState can be used interchangeably with ClientProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted

ClientState

Indicates if the client is enabled or not. Default value is Enabled.
KnownClientState can be used interchangeably with ClientState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enabled
Disabled: Disabled

ConfidentialComputeMode

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.
KnownConfidentialComputeMode can be used interchangeably with ConfidentialComputeMode, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Disabled
Enabled: Enabled

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

CustomDomainIdentityType

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.
KnownCustomDomainIdentityType can be used interchangeably with CustomDomainIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: SystemAssigned
UserAssigned: UserAssigned

CustomDomainValidationState

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.
KnownCustomDomainValidationState can be used interchangeably with CustomDomainValidationState, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Pending
Approved: Approved
ErrorRetrievingDnsRecord: ErrorRetrievingDnsRecord

CustomJwtAuthenticationManagedIdentityType

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.
KnownCustomJwtAuthenticationManagedIdentityType can be used interchangeably with CustomJwtAuthenticationManagedIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: SystemAssigned
UserAssigned: UserAssigned

CustomWebhookAuthenticationManagedIdentityType

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.
KnownCustomWebhookAuthenticationManagedIdentityType can be used interchangeably with CustomWebhookAuthenticationManagedIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: SystemAssigned
UserAssigned: UserAssigned

DataResidencyBoundary

Data Residency Boundary of the resource.
KnownDataResidencyBoundary can be used interchangeably with DataResidencyBoundary, this enum contains the known values that the service supports.

Known values supported by the service

WithinGeopair: WithinGeopair
WithinRegion: WithinRegion

DeadLetterDestinationUnion

Alias for DeadLetterDestinationUnion

DeadLetterEndPointType

Type of the endpoint for the dead letter destination
KnownDeadLetterEndPointType can be used interchangeably with DeadLetterEndPointType, this enum contains the known values that the service supports.

Known values supported by the service

StorageBlob: StorageBlob

DeliveryAttributeMappingType

Type of the delivery attribute or header name.
KnownDeliveryAttributeMappingType can be used interchangeably with DeliveryAttributeMappingType, this enum contains the known values that the service supports.

Known values supported by the service

Static: Static
Dynamic: Dynamic

DeliveryAttributeMappingUnion

Alias for DeliveryAttributeMappingUnion

DeliveryMode

Delivery mode of the event subscription.
KnownDeliveryMode can be used interchangeably with DeliveryMode, this enum contains the known values that the service supports.

Known values supported by the service

Queue: Queue
Push: Push

DeliverySchema

The event delivery schema for the event subscription.
KnownDeliverySchema can be used interchangeably with DeliverySchema, this enum contains the known values that the service supports.

Known values supported by the service

CloudEventSchemaV1_0: CloudEventSchemaV1_0

DomainProvisioningState

Provisioning state of the Event Grid Domain Resource.
KnownDomainProvisioningState can be used interchangeably with DomainProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

DomainTopicProvisioningState

Provisioning state of the domain topic.
KnownDomainTopicProvisioningState can be used interchangeably with DomainTopicProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

EndpointType

Type of the endpoint for the event subscription destination.
KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports.

Known values supported by the service

WebHook: WebHook
EventHub: EventHub
StorageQueue: StorageQueue
HybridConnection: HybridConnection
ServiceBusQueue: ServiceBusQueue
ServiceBusTopic: ServiceBusTopic
AzureFunction: AzureFunction
PartnerDestination: PartnerDestination
MonitorAlert: MonitorAlert
NamespaceTopic: NamespaceTopic

EventDefinitionKind

The kind of event type used.
KnownEventDefinitionKind can be used interchangeably with EventDefinitionKind, this enum contains the known values that the service supports.

Known values supported by the service

Inline: Inline

EventDeliverySchema

The event delivery schema for the event subscription.
KnownEventDeliverySchema can be used interchangeably with EventDeliverySchema, this enum contains the known values that the service supports.

Known values supported by the service

EventGridSchema: EventGridSchema
CustomInputSchema: CustomInputSchema
CloudEventSchemaV1_0: CloudEventSchemaV1_0

EventInputSchema

This determines the format that is expected for incoming events published to the topic.
KnownEventInputSchema can be used interchangeably with EventInputSchema, this enum contains the known values that the service supports.

Known values supported by the service

CloudEventSchemaV1_0: CloudEventSchemaV1_0

EventSubscriptionDestinationUnion

Alias for EventSubscriptionDestinationUnion

EventSubscriptionIdentityType

The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'.
KnownEventSubscriptionIdentityType can be used interchangeably with EventSubscriptionIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: SystemAssigned
UserAssigned: UserAssigned

EventSubscriptionProvisioningState

Provisioning state of the event subscription.
KnownEventSubscriptionProvisioningState can be used interchangeably with EventSubscriptionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
AwaitingManualAction: AwaitingManualAction

FilterOperatorType

The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.
KnownFilterOperatorType can be used interchangeably with FilterOperatorType, this enum contains the known values that the service supports.

Known values supported by the service

NumberIn: NumberIn
NumberNotIn: NumberNotIn
NumberLessThan: NumberLessThan
NumberGreaterThan: NumberGreaterThan
NumberLessThanOrEquals: NumberLessThanOrEquals
NumberGreaterThanOrEquals: NumberGreaterThanOrEquals
BoolEquals: BoolEquals
StringIn: StringIn
StringNotIn: StringNotIn
StringBeginsWith: StringBeginsWith
StringEndsWith: StringEndsWith
StringContains: StringContains
NumberInRange: NumberInRange
NumberNotInRange: NumberNotInRange
StringNotBeginsWith: StringNotBeginsWith
StringNotEndsWith: StringNotEndsWith
StringNotContains: StringNotContains
IsNullOrUndefined: IsNullOrUndefined
IsNotNull: IsNotNull

FilterUnion

Alias for FilterUnion

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.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: None
SystemAssigned: SystemAssigned
UserAssigned: UserAssigned
SystemAssigned, UserAssigned: SystemAssigned, UserAssigned

InputSchema

This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
KnownInputSchema can be used interchangeably with InputSchema, this enum contains the known values that the service supports.

Known values supported by the service

EventGridSchema: EventGridSchema
CustomEventSchema: CustomEventSchema
CloudEventSchemaV1_0: CloudEventSchemaV1_0

InputSchemaMappingType

Type of the custom mapping
KnownInputSchemaMappingType can be used interchangeably with InputSchemaMappingType, this enum contains the known values that the service supports.

Known values supported by the service

Json: Json

InputSchemaMappingUnion

Alias for InputSchemaMappingUnion

IpActionType

Action to perform based on the match or no match of the IpMask.
KnownIpActionType can be used interchangeably with IpActionType, this enum contains the known values that the service supports.

Known values supported by the service

Allow: Allow

KeyEncryptionIdentityType

The type of managed identity used. Only UserAssigned or SystemAssigned Identity are supported.
KnownKeyEncryptionIdentityType can be used interchangeably with KeyEncryptionIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: SystemAssigned
UserAssigned: UserAssigned

KeyEncryptionKeyStatus

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.
KnownKeyEncryptionKeyStatus can be used interchangeably with KeyEncryptionKeyStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: Active
Revoked: Revoked

MonitorAlertSeverity

The severity that will be attached to every Alert fired through this event subscription. This field must be provided.
KnownMonitorAlertSeverity can be used interchangeably with MonitorAlertSeverity, this enum contains the known values that the service supports.

Known values supported by the service

Sev0: Sev0
Sev1: Sev1
Sev2: Sev2
Sev3: Sev3
Sev4: Sev4

NamespaceProvisioningState

Provisioning state of the namespace resource.
KnownNamespaceProvisioningState can be used interchangeably with NamespaceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted
DeleteFailed: DeleteFailed
CreateFailed: CreateFailed
UpdatedFailed: UpdatedFailed

NamespaceTopicProvisioningState

Provisioning state of the namespace topic.
KnownNamespaceTopicProvisioningState can be used interchangeably with NamespaceTopicProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted
DeleteFailed: DeleteFailed
CreateFailed: CreateFailed
UpdatedFailed: UpdatedFailed

NetworkSecurityPerimeterAssociationAccessMode

Network security perimeter access mode.
KnownNetworkSecurityPerimeterAssociationAccessMode can be used interchangeably with NetworkSecurityPerimeterAssociationAccessMode, this enum contains the known values that the service supports.

Known values supported by the service

Learning: Learning
Enforced: Enforced
Audit: Audit

NetworkSecurityPerimeterConfigProvisioningState

Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval.
KnownNetworkSecurityPerimeterConfigProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted
Accepted: Accepted

NetworkSecurityPerimeterConfigurationIssueSeverity

Provisioning issue severity.
KnownNetworkSecurityPerimeterConfigurationIssueSeverity can be used interchangeably with NetworkSecurityPerimeterConfigurationIssueSeverity, this enum contains the known values that the service supports.

Known values supported by the service

Warning: Warning
Error: Error

NetworkSecurityPerimeterConfigurationIssueType

Provisioning issue type.
KnownNetworkSecurityPerimeterConfigurationIssueType can be used interchangeably with NetworkSecurityPerimeterConfigurationIssueType, this enum contains the known values that the service supports.

Known values supported by the service

MissingPerimeterConfiguration: MissingPerimeterConfiguration
MissingIdentityConfiguration: MissingIdentityConfiguration
ConfigurationPropagationFailure: ConfigurationPropagationFailure
Other: Other

NetworkSecurityPerimeterProfileAccessRuleDirection

NSP access rule direction.
KnownNetworkSecurityPerimeterProfileAccessRuleDirection can be used interchangeably with NetworkSecurityPerimeterProfileAccessRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Inbound
Outbound: Outbound

NetworkSecurityPerimeterResourceType

Type of NetworkSecurityPerimeterResourceType

PartnerClientAuthenticationType

Type of client authentication
KnownPartnerClientAuthenticationType can be used interchangeably with PartnerClientAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

AzureAD: AzureAD

PartnerClientAuthenticationUnion

Alias for PartnerClientAuthenticationUnion

PartnerConfigurationProvisioningState

Provisioning state of the partner configuration.
KnownPartnerConfigurationProvisioningState can be used interchangeably with PartnerConfigurationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

PartnerDestinationActivationState

Activation state of the partner destination.
KnownPartnerDestinationActivationState can be used interchangeably with PartnerDestinationActivationState, this enum contains the known values that the service supports.

Known values supported by the service

NeverActivated: NeverActivated
Activated: Activated

PartnerDestinationInfoUnion

Alias for PartnerDestinationInfoUnion

PartnerDestinationProvisioningState

Provisioning state of the partner destination.
KnownPartnerDestinationProvisioningState can be used interchangeably with PartnerDestinationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
IdleDueToMirroredChannelResourceDeletion: IdleDueToMirroredChannelResourceDeletion

PartnerEndpointType

Type of the endpoint for the partner destination
KnownPartnerEndpointType can be used interchangeably with PartnerEndpointType, this enum contains the known values that the service supports.

Known values supported by the service

WebHook: WebHook

PartnerNamespaceProvisioningState

Provisioning state of the partner namespace.
KnownPartnerNamespaceProvisioningState can be used interchangeably with PartnerNamespaceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

PartnerRegistrationProvisioningState

Provisioning state of the partner registration.
KnownPartnerRegistrationProvisioningState can be used interchangeably with PartnerRegistrationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

PartnerTopicActivationState

Activation state of the partner topic.
KnownPartnerTopicActivationState can be used interchangeably with PartnerTopicActivationState, this enum contains the known values that the service supports.

Known values supported by the service

NeverActivated: NeverActivated
Activated: Activated
Deactivated: Deactivated

PartnerTopicProvisioningState

Provisioning state of the partner topic.
KnownPartnerTopicProvisioningState can be used interchangeably with PartnerTopicProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
IdleDueToMirroredChannelResourceDeletion: IdleDueToMirroredChannelResourceDeletion

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.
KnownPartnerTopicRoutingMode can be used interchangeably with PartnerTopicRoutingMode, this enum contains the known values that the service supports.

Known values supported by the service

SourceEventAttribute: SourceEventAttribute
ChannelNameHeader: ChannelNameHeader

PartnerUpdateDestinationInfoUnion

Alias for PartnerUpdateDestinationInfoUnion

PermissionBindingProvisioningState

Provisioning state of the PermissionBinding resource.
KnownPermissionBindingProvisioningState can be used interchangeably with PermissionBindingProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted

PermissionType

The allowed permission.
KnownPermissionType can be used interchangeably with PermissionType, this enum contains the known values that the service supports.

Known values supported by the service

Publisher: Publisher
Subscriber: Subscriber

PersistedConnectionStatus

Status of the connection.
KnownPersistedConnectionStatus can be used interchangeably with PersistedConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Pending
Approved: Approved
Rejected: Rejected
Disconnected: Disconnected

PrivateEndpointConnectionsParentType

Type of 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 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enabled
Disabled: Disabled
SecuredByPerimeter: SecuredByPerimeter

PublisherType

Publisher type of the namespace topic.
KnownPublisherType can be used interchangeably with PublisherType, this enum contains the known values that the service supports.

Known values supported by the service

Custom: Custom

ReadinessState

The readiness state of the corresponding partner topic.
KnownReadinessState can be used interchangeably with ReadinessState, this enum contains the known values that the service supports.

Known values supported by the service

NeverActivated: NeverActivated
Activated: Activated

ResourceKind

Kind of the resource.
KnownResourceKind can be used interchangeably with ResourceKind, this enum contains the known values that the service supports.

Known values supported by the service

Azure: Azure
AzureArc: AzureArc

ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.
KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

ResourceRegionType

Region type of the resource.
KnownResourceRegionType can be used interchangeably with ResourceRegionType, this enum contains the known values that the service supports.

Known values supported by the service

RegionalResource: RegionalResource
GlobalResource: GlobalResource

RoutingIdentityType

Routing identity type for topic spaces configuration.
KnownRoutingIdentityType can be used interchangeably with RoutingIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: None
SystemAssigned: SystemAssigned
UserAssigned: UserAssigned

Sku

The Sku name of the resource. The possible values are: Basic or Premium.
KnownSku can be used interchangeably with Sku, this enum contains the known values that the service supports.

Known values supported by the service

Basic: Basic
Premium: Premium

SkuName

The name of the SKU.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Standard

StaticRoutingEnrichmentType

Static routing enrichment value type. For e.g. this property value can be 'String'.
KnownStaticRoutingEnrichmentType can be used interchangeably with StaticRoutingEnrichmentType, this enum contains the known values that the service supports.

Known values supported by the service

String: String

StaticRoutingEnrichmentUnion

Alias for StaticRoutingEnrichmentUnion

SubscriptionProvisioningState

Provisioning state of the event subscription.
KnownSubscriptionProvisioningState can be used interchangeably with SubscriptionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
AwaitingManualAction: AwaitingManualAction
Deleted: Deleted
DeleteFailed: DeleteFailed
CreateFailed: CreateFailed
UpdatedFailed: UpdatedFailed

TlsVersion

Minimum TLS version of the publisher allowed to publish to this domain
KnownTlsVersion can be used interchangeably with TlsVersion, this enum contains the known values that the service supports.

Known values supported by the service

1.0: 1.0
1.1: 1.1
1.2: 1.2

TopicProvisioningState

Provisioning state of the topic.
KnownTopicProvisioningState can be used interchangeably with TopicProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

TopicSpaceProvisioningState

Provisioning state of the TopicSpace resource.
KnownTopicSpaceProvisioningState can be used interchangeably with TopicSpaceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
Deleted: Deleted

TopicSpacesConfigurationState

Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled.
KnownTopicSpacesConfigurationState can be used interchangeably with TopicSpacesConfigurationState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Disabled
Enabled: Enabled

TopicTypeProvisioningState

Provisioning state of the topic type.
KnownTopicTypeProvisioningState can be used interchangeably with TopicTypeProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

TopicTypeSourceScope

Type of TopicTypeSourceScope

VerifiedPartnerProvisioningState

Provisioning state of the verified partner.
KnownVerifiedPartnerProvisioningState can be used interchangeably with VerifiedPartnerProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAdvancedFilterOperatorType

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

KnownAlternativeAuthenticationNameSource

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

KnownCaCertificateProvisioningState

Provisioning state of the CA Certificate resource.

KnownChannelProvisioningState

Provisioning state of the channel.

KnownChannelType

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

KnownClientCertificateValidationScheme

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

KnownClientGroupProvisioningState

Provisioning state of the ClientGroup resource.

KnownClientProvisioningState

Provisioning state of the Client resource.

KnownClientState

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

KnownConfidentialComputeMode

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.

KnownCreatedByType

The kind of entity that created the resource.

KnownCustomDomainIdentityType

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

KnownCustomDomainValidationState

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.

KnownCustomJwtAuthenticationManagedIdentityType

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

KnownCustomWebhookAuthenticationManagedIdentityType

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

KnownDataResidencyBoundary

Data Residency Boundary of the resource.

KnownDeadLetterEndPointType

Type of the endpoint for the dead letter destination

KnownDeliveryAttributeMappingType

Type of the delivery attribute or header name.

KnownDeliveryMode

Delivery mode of the event subscription.

KnownDeliverySchema

The event delivery schema for the event subscription.

KnownDomainProvisioningState

Provisioning state of the Event Grid Domain Resource.

KnownDomainTopicProvisioningState

Provisioning state of the domain topic.

KnownEndpointType

Type of the endpoint for the event subscription destination.

KnownEventDefinitionKind

The kind of event type used.

KnownEventDeliverySchema

The event delivery schema for the event subscription.

KnownEventInputSchema

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

KnownEventSubscriptionIdentityType

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

KnownEventSubscriptionProvisioningState

Provisioning state of the event subscription.

KnownFilterOperatorType

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

KnownIdentityType

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.

KnownInputSchema

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

KnownInputSchemaMappingType

Type of the custom mapping

KnownIpActionType

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

KnownKeyEncryptionIdentityType

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

KnownKeyEncryptionKeyStatus

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.

KnownMonitorAlertSeverity

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

KnownNamespaceProvisioningState

Provisioning state of the namespace resource.

KnownNamespaceTopicProvisioningState

Provisioning state of the namespace topic.

KnownNetworkSecurityPerimeterAssociationAccessMode

Network security perimeter access mode.

KnownNetworkSecurityPerimeterConfigProvisioningState

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

KnownNetworkSecurityPerimeterConfigurationIssueSeverity

Provisioning issue severity.

KnownNetworkSecurityPerimeterConfigurationIssueType

Provisioning issue type.

KnownNetworkSecurityPerimeterProfileAccessRuleDirection

NSP access rule direction.

KnownNetworkSecurityPerimeterResourceType

Known values of NetworkSecurityPerimeterResourceType that the service accepts.

KnownPartnerClientAuthenticationType

Type of client authentication

KnownPartnerConfigurationProvisioningState

Provisioning state of the partner configuration.

KnownPartnerDestinationActivationState

Activation state of the partner destination.

KnownPartnerDestinationProvisioningState

Provisioning state of the partner destination.

KnownPartnerEndpointType

Type of the endpoint for the partner destination

KnownPartnerNamespaceProvisioningState

Provisioning state of the partner namespace.

KnownPartnerRegistrationProvisioningState

Provisioning state of the partner registration.

KnownPartnerTopicActivationState

Activation state of the partner topic.

KnownPartnerTopicProvisioningState

Provisioning state of the partner topic.

KnownPartnerTopicRoutingMode

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.

KnownPermissionBindingProvisioningState

Provisioning state of the PermissionBinding resource.

KnownPermissionType

The allowed permission.

KnownPersistedConnectionStatus

Status of the connection.

KnownPrivateEndpointConnectionsParentType

Known values of PrivateEndpointConnectionsParentType that the service accepts.

KnownPublicNetworkAccess

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

KnownPublisherType

Publisher type of the namespace topic.

KnownReadinessState

The readiness state of the corresponding partner topic.

KnownResourceKind

Kind of the resource.

KnownResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

KnownResourceRegionType

Region type of the resource.

KnownRoutingIdentityType

Routing identity type for topic spaces configuration.

KnownSku

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

KnownSkuName

The name of the SKU.

KnownStaticRoutingEnrichmentType

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

KnownSubscriptionProvisioningState

Provisioning state of the event subscription.

KnownTlsVersion

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

KnownTopicProvisioningState

Provisioning state of the topic.

KnownTopicSpaceProvisioningState

Provisioning state of the TopicSpace resource.

KnownTopicSpacesConfigurationState

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

KnownTopicTypeProvisioningState

Provisioning state of the topic type.

KnownTopicTypeSourceScope

Known values of TopicTypeSourceScope that the service accepts.

KnownVerifiedPartnerProvisioningState

Provisioning state of the verified partner.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(EventGridManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(EventGridManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: EventGridManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>