@azure/arm-eventgrid package

Classes

EventGridManagementClient

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.
AzureFunctionEventSubscriptionDestination	Information about the azure function destination for an event subscription.
BoolEqualsAdvancedFilter	BoolEquals Advanced Filter.
Channel	Channel info.
ChannelUpdateParameters	Properties of the Channel update.
Channels	Interface representing a Channels.
ChannelsCreateOrUpdateOptionalParams	Optional parameters.
ChannelsDeleteOptionalParams	Optional parameters.
ChannelsGetFullUrlOptionalParams	Optional parameters.
ChannelsGetOptionalParams	Optional parameters.
ChannelsListByPartnerNamespaceNextOptionalParams	Optional parameters.
ChannelsListByPartnerNamespaceOptionalParams	Optional parameters.
ChannelsListResult	Result of the List Channels operation
ChannelsUpdateOptionalParams	Optional parameters.
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.
DeadLetterWithResourceIdentity	Information about the deadletter destination with resource identity.
DeliveryAttributeListResult	Result of the Get delivery attributes operation.
DeliveryAttributeMapping	Delivery attribute mapping details.
DeliveryWithResourceIdentity	Information about the delivery for an event subscription with resource identity.
Domain	EventGrid Domain.
DomainEventSubscriptions	Interface representing a DomainEventSubscriptions.
DomainEventSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
DomainEventSubscriptionsDeleteOptionalParams	Optional parameters.
DomainEventSubscriptionsGetDeliveryAttributesOptionalParams	Optional parameters.
DomainEventSubscriptionsGetFullUrlOptionalParams	Optional parameters.
DomainEventSubscriptionsGetOptionalParams	Optional parameters.
DomainEventSubscriptionsListNextOptionalParams	Optional parameters.
DomainEventSubscriptionsListOptionalParams	Optional parameters.
DomainEventSubscriptionsUpdateOptionalParams	Optional parameters.
DomainRegenerateKeyRequest	Domain regenerate share access key request.
DomainSharedAccessKeys	Shared access keys of the Domain.
DomainTopic	Domain Topic.
DomainTopicEventSubscriptions	Interface representing a DomainTopicEventSubscriptions.
DomainTopicEventSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
DomainTopicEventSubscriptionsDeleteOptionalParams	Optional parameters.
DomainTopicEventSubscriptionsGetDeliveryAttributesOptionalParams	Optional parameters.
DomainTopicEventSubscriptionsGetFullUrlOptionalParams	Optional parameters.
DomainTopicEventSubscriptionsGetOptionalParams	Optional parameters.
DomainTopicEventSubscriptionsListNextOptionalParams	Optional parameters.
DomainTopicEventSubscriptionsListOptionalParams	Optional parameters.
DomainTopicEventSubscriptionsUpdateOptionalParams	Optional parameters.
DomainTopics	Interface representing a DomainTopics.
DomainTopicsCreateOrUpdateOptionalParams	Optional parameters.
DomainTopicsDeleteOptionalParams	Optional parameters.
DomainTopicsGetOptionalParams	Optional parameters.
DomainTopicsListByDomainNextOptionalParams	Optional parameters.
DomainTopicsListByDomainOptionalParams	Optional parameters.
DomainTopicsListResult	Result of the List Domain Topics operation.
DomainUpdateParameters	Properties of the Domain update.
Domains	Interface representing a Domains.
DomainsCreateOrUpdateOptionalParams	Optional parameters.
DomainsDeleteOptionalParams	Optional parameters.
DomainsGetOptionalParams	Optional parameters.
DomainsListByResourceGroupNextOptionalParams	Optional parameters.
DomainsListByResourceGroupOptionalParams	Optional parameters.
DomainsListBySubscriptionNextOptionalParams	Optional parameters.
DomainsListBySubscriptionOptionalParams	Optional parameters.
DomainsListResult	Result of the List Domains operation.
DomainsListSharedAccessKeysOptionalParams	Optional parameters.
DomainsRegenerateKeyOptionalParams	Optional parameters.
DomainsUpdateOptionalParams	Optional parameters.
DynamicDeliveryAttributeMapping	Dynamic delivery attribute mapping details.
EventGridManagementClientOptionalParams	Optional parameters.
EventHubEventSubscriptionDestination	Information about the event hub destination for an event subscription.
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.
EventSubscriptionUpdateParameters	Properties of the Event Subscription update.
EventSubscriptions	Interface representing a EventSubscriptions.
EventSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
EventSubscriptionsDeleteOptionalParams	Optional parameters.
EventSubscriptionsGetDeliveryAttributesOptionalParams	Optional parameters.
EventSubscriptionsGetFullUrlOptionalParams	Optional parameters.
EventSubscriptionsGetOptionalParams	Optional parameters.
EventSubscriptionsListByDomainTopicNextOptionalParams	Optional parameters.
EventSubscriptionsListByDomainTopicOptionalParams	Optional parameters.
EventSubscriptionsListByResourceNextOptionalParams	Optional parameters.
EventSubscriptionsListByResourceOptionalParams	Optional parameters.
EventSubscriptionsListGlobalByResourceGroupForTopicTypeNextOptionalParams	Optional parameters.
EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams	Optional parameters.
EventSubscriptionsListGlobalByResourceGroupNextOptionalParams	Optional parameters.
EventSubscriptionsListGlobalByResourceGroupOptionalParams	Optional parameters.
EventSubscriptionsListGlobalBySubscriptionForTopicTypeNextOptionalParams	Optional parameters.
EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams	Optional parameters.
EventSubscriptionsListGlobalBySubscriptionNextOptionalParams	Optional parameters.
EventSubscriptionsListGlobalBySubscriptionOptionalParams	Optional parameters.
EventSubscriptionsListRegionalByResourceGroupForTopicTypeNextOptionalParams	Optional parameters.
EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams	Optional parameters.
EventSubscriptionsListRegionalByResourceGroupNextOptionalParams	Optional parameters.
EventSubscriptionsListRegionalByResourceGroupOptionalParams	Optional parameters.
EventSubscriptionsListRegionalBySubscriptionForTopicTypeNextOptionalParams	Optional parameters.
EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams	Optional parameters.
EventSubscriptionsListRegionalBySubscriptionNextOptionalParams	Optional parameters.
EventSubscriptionsListRegionalBySubscriptionOptionalParams	Optional parameters.
EventSubscriptionsListResult	Result of the List EventSubscriptions operation
EventSubscriptionsUpdateOptionalParams	Optional parameters.
EventType	Event Type for a subject under a topic
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.
ExtensionTopics	Interface representing a ExtensionTopics.
ExtensionTopicsGetOptionalParams	Optional parameters.
HybridConnectionEventSubscriptionDestination	Information about the HybridConnection destination for an event subscription.
IdentityInfo	The identity information for the resource.
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.
IsNullOrUndefinedAdvancedFilter	IsNullOrUndefined Advanced Filter.
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.
NumberGreaterThanAdvancedFilter	NumberGreaterThan Advanced Filter.
NumberGreaterThanOrEqualsAdvancedFilter	NumberGreaterThanOrEquals Advanced Filter.
NumberInAdvancedFilter	NumberIn Advanced Filter.
NumberInRangeAdvancedFilter	NumberInRange Advanced Filter.
NumberLessThanAdvancedFilter	NumberLessThan Advanced Filter.
NumberLessThanOrEqualsAdvancedFilter	NumberLessThanOrEquals Advanced Filter.
NumberNotInAdvancedFilter	NumberNotIn Advanced Filter.
NumberNotInRangeAdvancedFilter	NumberNotInRange Advanced Filter.
Operation	Represents an operation returned by the GetOperations request.
OperationInfo	Information about an operation
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
OperationsListResult	Result of the List Operations operation
Partner	Information about the partner.
PartnerAuthorization	The partner authorization details.
PartnerConfiguration	Partner configuration information
PartnerConfigurationUpdateParameters	Properties of the partner configuration update.
PartnerConfigurations	Interface representing a PartnerConfigurations.
PartnerConfigurationsAuthorizePartnerOptionalParams	Optional parameters.
PartnerConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
PartnerConfigurationsDeleteOptionalParams	Optional parameters.
PartnerConfigurationsGetOptionalParams	Optional parameters.
PartnerConfigurationsListByResourceGroupOptionalParams	Optional parameters.
PartnerConfigurationsListBySubscriptionNextOptionalParams	Optional parameters.
PartnerConfigurationsListBySubscriptionOptionalParams	Optional parameters.
PartnerConfigurationsListResult	Result of the List partner configurations operation
PartnerConfigurationsUnauthorizePartnerOptionalParams	Optional parameters.
PartnerConfigurationsUpdateOptionalParams	Optional parameters.
PartnerDetails	Information about the partner.
PartnerNamespace	EventGrid Partner Namespace.
PartnerNamespaceRegenerateKeyRequest	PartnerNamespace regenerate shared access key request.
PartnerNamespaceSharedAccessKeys	Shared access keys of the partner namespace.
PartnerNamespaceUpdateParameters	Properties of the Partner Namespace update.
PartnerNamespaces	Interface representing a PartnerNamespaces.
PartnerNamespacesCreateOrUpdateOptionalParams	Optional parameters.
PartnerNamespacesDeleteOptionalParams	Optional parameters.
PartnerNamespacesGetOptionalParams	Optional parameters.
PartnerNamespacesListByResourceGroupNextOptionalParams	Optional parameters.
PartnerNamespacesListByResourceGroupOptionalParams	Optional parameters.
PartnerNamespacesListBySubscriptionNextOptionalParams	Optional parameters.
PartnerNamespacesListBySubscriptionOptionalParams	Optional parameters.
PartnerNamespacesListResult	Result of the List Partner Namespaces operation
PartnerNamespacesListSharedAccessKeysOptionalParams	Optional parameters.
PartnerNamespacesRegenerateKeyOptionalParams	Optional parameters.
PartnerNamespacesUpdateOptionalParams	Optional parameters.
PartnerRegistration	Information about a partner registration.
PartnerRegistrationUpdateParameters	Properties of the Partner Registration update.
PartnerRegistrations	Interface representing a PartnerRegistrations.
PartnerRegistrationsCreateOrUpdateOptionalParams	Optional parameters.
PartnerRegistrationsDeleteOptionalParams	Optional parameters.
PartnerRegistrationsGetOptionalParams	Optional parameters.
PartnerRegistrationsListByResourceGroupNextOptionalParams	Optional parameters.
PartnerRegistrationsListByResourceGroupOptionalParams	Optional parameters.
PartnerRegistrationsListBySubscriptionNextOptionalParams	Optional parameters.
PartnerRegistrationsListBySubscriptionOptionalParams	Optional parameters.
PartnerRegistrationsListResult	Result of the List Partner Registrations operation.
PartnerRegistrationsUpdateOptionalParams	Optional parameters.
PartnerTopic	Event Grid Partner Topic.
PartnerTopicEventSubscriptions	Interface representing a PartnerTopicEventSubscriptions.
PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
PartnerTopicEventSubscriptionsDeleteOptionalParams	Optional parameters.
PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams	Optional parameters.
PartnerTopicEventSubscriptionsGetFullUrlOptionalParams	Optional parameters.
PartnerTopicEventSubscriptionsGetOptionalParams	Optional parameters.
PartnerTopicEventSubscriptionsListByPartnerTopicNextOptionalParams	Optional parameters.
PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams	Optional parameters.
PartnerTopicEventSubscriptionsUpdateOptionalParams	Optional parameters.
PartnerTopicInfo	Properties of the corresponding partner topic of a Channel.
PartnerTopicUpdateParameters	Properties of the Partner Topic update.
PartnerTopics	Interface representing a PartnerTopics.
PartnerTopicsActivateOptionalParams	Optional parameters.
PartnerTopicsCreateOrUpdateOptionalParams	Optional parameters.
PartnerTopicsDeactivateOptionalParams	Optional parameters.
PartnerTopicsDeleteOptionalParams	Optional parameters.
PartnerTopicsGetOptionalParams	Optional parameters.
PartnerTopicsListByResourceGroupNextOptionalParams	Optional parameters.
PartnerTopicsListByResourceGroupOptionalParams	Optional parameters.
PartnerTopicsListBySubscriptionNextOptionalParams	Optional parameters.
PartnerTopicsListBySubscriptionOptionalParams	Optional parameters.
PartnerTopicsListResult	Result of the List Partner Topics operation.
PartnerTopicsUpdateOptionalParams	Optional parameters.
PartnerUpdateTopicInfo	Update properties for the corresponding partner topic of a channel.
PrivateEndpoint	PrivateEndpoint information.
PrivateEndpointConnection	Definition of a Resource.
PrivateEndpointConnectionListResult	Result of the list of all private endpoint connections operation.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByResourceNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByResourceOptionalParams	Optional parameters.
PrivateEndpointConnectionsUpdateOptionalParams	Optional parameters.
PrivateLinkResource	Information of the private link resource.
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByResourceNextOptionalParams	Optional parameters.
PrivateLinkResourcesListByResourceOptionalParams	Optional parameters.
PrivateLinkResourcesListResult	Result of the List private link resources operation.
Resource	Definition of a Resource.
RetryPolicy	Information about the retry policy for an event subscription.
ServiceBusQueueEventSubscriptionDestination	Information about the service bus destination for an event subscription.
ServiceBusTopicEventSubscriptionDestination	Information about the service bus topic destination for an event subscription.
StaticDeliveryAttributeMapping	Static delivery attribute mapping details.
StorageBlobDeadLetterDestination	Information about the storage blob based dead letter destination.
StorageQueueEventSubscriptionDestination	Information about the storage queue destination for an event subscription.
StringBeginsWithAdvancedFilter	StringBeginsWith Advanced Filter.
StringContainsAdvancedFilter	StringContains Advanced Filter.
StringEndsWithAdvancedFilter	StringEndsWith Advanced Filter.
StringInAdvancedFilter	StringIn Advanced Filter.
StringNotBeginsWithAdvancedFilter	StringNotBeginsWith Advanced Filter.
StringNotContainsAdvancedFilter	StringNotContains Advanced Filter.
StringNotEndsWithAdvancedFilter	StringNotEndsWith Advanced Filter.
StringNotInAdvancedFilter	StringNotIn Advanced Filter.
SystemData	Metadata pertaining to creation and last modification of the resource.
SystemTopic	EventGrid System Topic.
SystemTopicEventSubscriptions	Interface representing a SystemTopicEventSubscriptions.
SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
SystemTopicEventSubscriptionsDeleteOptionalParams	Optional parameters.
SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams	Optional parameters.
SystemTopicEventSubscriptionsGetFullUrlOptionalParams	Optional parameters.
SystemTopicEventSubscriptionsGetOptionalParams	Optional parameters.
SystemTopicEventSubscriptionsListBySystemTopicNextOptionalParams	Optional parameters.
SystemTopicEventSubscriptionsListBySystemTopicOptionalParams	Optional parameters.
SystemTopicEventSubscriptionsUpdateOptionalParams	Optional parameters.
SystemTopicUpdateParameters	Properties of the System Topic update.
SystemTopics	Interface representing a SystemTopics.
SystemTopicsCreateOrUpdateOptionalParams	Optional parameters.
SystemTopicsDeleteOptionalParams	Optional parameters.
SystemTopicsGetOptionalParams	Optional parameters.
SystemTopicsListByResourceGroupNextOptionalParams	Optional parameters.
SystemTopicsListByResourceGroupOptionalParams	Optional parameters.
SystemTopicsListBySubscriptionNextOptionalParams	Optional parameters.
SystemTopicsListBySubscriptionOptionalParams	Optional parameters.
SystemTopicsListResult	Result of the List System topics operation.
SystemTopicsUpdateOptionalParams	Optional parameters.
Topic	EventGrid Topic
TopicEventSubscriptions	Interface representing a TopicEventSubscriptions.
TopicEventSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
TopicEventSubscriptionsDeleteOptionalParams	Optional parameters.
TopicEventSubscriptionsGetDeliveryAttributesOptionalParams	Optional parameters.
TopicEventSubscriptionsGetFullUrlOptionalParams	Optional parameters.
TopicEventSubscriptionsGetOptionalParams	Optional parameters.
TopicEventSubscriptionsListNextOptionalParams	Optional parameters.
TopicEventSubscriptionsListOptionalParams	Optional parameters.
TopicEventSubscriptionsUpdateOptionalParams	Optional parameters.
TopicRegenerateKeyRequest	Topic regenerate share access key request
TopicSharedAccessKeys	Shared access keys of the Topic
TopicTypeInfo	Properties of a topic type info.
TopicTypes	Interface representing a TopicTypes.
TopicTypesGetOptionalParams	Optional parameters.
TopicTypesListEventTypesOptionalParams	Optional parameters.
TopicTypesListOptionalParams	Optional parameters.
TopicTypesListResult	Result of the List Topic Types operation
TopicUpdateParameters	Properties of the Topic update
Topics	Interface representing a Topics.
TopicsCreateOrUpdateOptionalParams	Optional parameters.
TopicsDeleteOptionalParams	Optional parameters.
TopicsGetOptionalParams	Optional parameters.
TopicsListByResourceGroupNextOptionalParams	Optional parameters.
TopicsListByResourceGroupOptionalParams	Optional parameters.
TopicsListBySubscriptionNextOptionalParams	Optional parameters.
TopicsListBySubscriptionOptionalParams	Optional parameters.
TopicsListEventTypesOptionalParams	Optional parameters.
TopicsListResult	Result of the List Topics operation
TopicsListSharedAccessKeysOptionalParams	Optional parameters.
TopicsRegenerateKeyOptionalParams	Optional parameters.
TopicsUpdateOptionalParams	Optional parameters.
TrackedResource	Definition of a Tracked Resource.
UserIdentityProperties	The information about the user identity.
VerifiedPartner	Verified partner information
VerifiedPartners	Interface representing a VerifiedPartners.
VerifiedPartnersGetOptionalParams	Optional parameters.
VerifiedPartnersListNextOptionalParams	Optional parameters.
VerifiedPartnersListOptionalParams	Optional parameters.
VerifiedPartnersListResult	Result of the List verified partners operation
WebHookEventSubscriptionDestination	Information about the webhook destination for an event subscription.

Type Aliases

AdvancedFilterOperatorType	Defines values for AdvancedFilterOperatorType. KnownAdvancedFilterOperatorType can be used interchangeably with AdvancedFilterOperatorType, this enum contains the known values that the service supports. Known values supported by the service NumberIn NumberNotIn NumberLessThan NumberGreaterThan NumberLessThanOrEquals NumberGreaterThanOrEquals BoolEquals StringIn StringNotIn StringBeginsWith StringEndsWith StringContains NumberInRange NumberNotInRange StringNotBeginsWith StringNotEndsWith StringNotContains IsNullOrUndefined IsNotNull
AdvancedFilterUnion
ChannelProvisioningState	Defines values for ChannelProvisioningState. KnownChannelProvisioningState can be used interchangeably with ChannelProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed IdleDueToMirroredPartnerTopicDeletion
ChannelType	Defines values for ChannelType. KnownChannelType can be used interchangeably with ChannelType, this enum contains the known values that the service supports. Known values supported by the service PartnerTopic
ChannelsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ChannelsGetFullUrlResponse	Contains response data for the getFullUrl operation.
ChannelsGetResponse	Contains response data for the get operation.
ChannelsListByPartnerNamespaceNextResponse	Contains response data for the listByPartnerNamespaceNext operation.
ChannelsListByPartnerNamespaceResponse	Contains response data for the listByPartnerNamespace operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DataResidencyBoundary	Defines values for DataResidencyBoundary. KnownDataResidencyBoundary can be used interchangeably with DataResidencyBoundary, this enum contains the known values that the service supports. Known values supported by the service WithinGeopair WithinRegion
DeadLetterDestinationUnion
DeadLetterEndPointType	Defines values for DeadLetterEndPointType. KnownDeadLetterEndPointType can be used interchangeably with DeadLetterEndPointType, this enum contains the known values that the service supports. Known values supported by the service StorageBlob
DeliveryAttributeMappingType	Defines values for DeliveryAttributeMappingType. KnownDeliveryAttributeMappingType can be used interchangeably with DeliveryAttributeMappingType, this enum contains the known values that the service supports. Known values supported by the service Static Dynamic
DeliveryAttributeMappingUnion
DomainEventSubscriptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DomainEventSubscriptionsGetDeliveryAttributesResponse	Contains response data for the getDeliveryAttributes operation.
DomainEventSubscriptionsGetFullUrlResponse	Contains response data for the getFullUrl operation.
DomainEventSubscriptionsGetResponse	Contains response data for the get operation.
DomainEventSubscriptionsListNextResponse	Contains response data for the listNext operation.
DomainEventSubscriptionsListResponse	Contains response data for the list operation.
DomainEventSubscriptionsUpdateResponse	Contains response data for the update operation.
DomainProvisioningState	Defines values for DomainProvisioningState. KnownDomainProvisioningState can be used interchangeably with DomainProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
DomainTopicEventSubscriptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DomainTopicEventSubscriptionsGetDeliveryAttributesResponse	Contains response data for the getDeliveryAttributes operation.
DomainTopicEventSubscriptionsGetFullUrlResponse	Contains response data for the getFullUrl operation.
DomainTopicEventSubscriptionsGetResponse	Contains response data for the get operation.
DomainTopicEventSubscriptionsListNextResponse	Contains response data for the listNext operation.
DomainTopicEventSubscriptionsListResponse	Contains response data for the list operation.
DomainTopicEventSubscriptionsUpdateResponse	Contains response data for the update operation.
DomainTopicProvisioningState	Defines values for DomainTopicProvisioningState. KnownDomainTopicProvisioningState can be used interchangeably with DomainTopicProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
DomainTopicsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DomainTopicsGetResponse	Contains response data for the get operation.
DomainTopicsListByDomainNextResponse	Contains response data for the listByDomainNext operation.
DomainTopicsListByDomainResponse	Contains response data for the listByDomain operation.
DomainsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DomainsGetResponse	Contains response data for the get operation.
DomainsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
DomainsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
DomainsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
DomainsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
DomainsListSharedAccessKeysResponse	Contains response data for the listSharedAccessKeys operation.
DomainsRegenerateKeyResponse	Contains response data for the regenerateKey operation.
EndpointType	Defines values for EndpointType. KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports. Known values supported by the service WebHook EventHub StorageQueue HybridConnection ServiceBusQueue ServiceBusTopic AzureFunction
EventDefinitionKind	Defines values for EventDefinitionKind. KnownEventDefinitionKind can be used interchangeably with EventDefinitionKind, this enum contains the known values that the service supports. Known values supported by the service Inline
EventDeliverySchema	Defines values for EventDeliverySchema. KnownEventDeliverySchema can be used interchangeably with EventDeliverySchema, this enum contains the known values that the service supports. Known values supported by the service EventGridSchema CustomInputSchema CloudEventSchemaV1_0
EventSubscriptionDestinationUnion
EventSubscriptionIdentityType	Defines values for EventSubscriptionIdentityType. KnownEventSubscriptionIdentityType can be used interchangeably with EventSubscriptionIdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned UserAssigned
EventSubscriptionProvisioningState	Defines values for EventSubscriptionProvisioningState. KnownEventSubscriptionProvisioningState can be used interchangeably with EventSubscriptionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed AwaitingManualAction
EventSubscriptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
EventSubscriptionsGetDeliveryAttributesResponse	Contains response data for the getDeliveryAttributes operation.
EventSubscriptionsGetFullUrlResponse	Contains response data for the getFullUrl operation.
EventSubscriptionsGetResponse	Contains response data for the get operation.
EventSubscriptionsListByDomainTopicNextResponse	Contains response data for the listByDomainTopicNext operation.
EventSubscriptionsListByDomainTopicResponse	Contains response data for the listByDomainTopic operation.
EventSubscriptionsListByResourceNextResponse	Contains response data for the listByResourceNext operation.
EventSubscriptionsListByResourceResponse	Contains response data for the listByResource operation.
EventSubscriptionsListGlobalByResourceGroupForTopicTypeNextResponse	Contains response data for the listGlobalByResourceGroupForTopicTypeNext operation.
EventSubscriptionsListGlobalByResourceGroupForTopicTypeResponse	Contains response data for the listGlobalByResourceGroupForTopicType operation.
EventSubscriptionsListGlobalByResourceGroupNextResponse	Contains response data for the listGlobalByResourceGroupNext operation.
EventSubscriptionsListGlobalByResourceGroupResponse	Contains response data for the listGlobalByResourceGroup operation.
EventSubscriptionsListGlobalBySubscriptionForTopicTypeNextResponse	Contains response data for the listGlobalBySubscriptionForTopicTypeNext operation.
EventSubscriptionsListGlobalBySubscriptionForTopicTypeResponse	Contains response data for the listGlobalBySubscriptionForTopicType operation.
EventSubscriptionsListGlobalBySubscriptionNextResponse	Contains response data for the listGlobalBySubscriptionNext operation.
EventSubscriptionsListGlobalBySubscriptionResponse	Contains response data for the listGlobalBySubscription operation.
EventSubscriptionsListRegionalByResourceGroupForTopicTypeNextResponse	Contains response data for the listRegionalByResourceGroupForTopicTypeNext operation.
EventSubscriptionsListRegionalByResourceGroupForTopicTypeResponse	Contains response data for the listRegionalByResourceGroupForTopicType operation.
EventSubscriptionsListRegionalByResourceGroupNextResponse	Contains response data for the listRegionalByResourceGroupNext operation.
EventSubscriptionsListRegionalByResourceGroupResponse	Contains response data for the listRegionalByResourceGroup operation.
EventSubscriptionsListRegionalBySubscriptionForTopicTypeNextResponse	Contains response data for the listRegionalBySubscriptionForTopicTypeNext operation.
EventSubscriptionsListRegionalBySubscriptionForTopicTypeResponse	Contains response data for the listRegionalBySubscriptionForTopicType operation.
EventSubscriptionsListRegionalBySubscriptionNextResponse	Contains response data for the listRegionalBySubscriptionNext operation.
EventSubscriptionsListRegionalBySubscriptionResponse	Contains response data for the listRegionalBySubscription operation.
EventSubscriptionsUpdateResponse	Contains response data for the update operation.
ExtensionTopicsGetResponse	Contains response data for the get operation.
IdentityType	Defines values for IdentityType. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned SystemAssigned, UserAssigned
InputSchema	Defines values for InputSchema. KnownInputSchema can be used interchangeably with InputSchema, this enum contains the known values that the service supports. Known values supported by the service EventGridSchema CustomEventSchema CloudEventSchemaV1_0
InputSchemaMappingType	Defines values for InputSchemaMappingType. KnownInputSchemaMappingType can be used interchangeably with InputSchemaMappingType, this enum contains the known values that the service supports. Known values supported by the service Json
InputSchemaMappingUnion
IpActionType	Defines values for IpActionType. KnownIpActionType can be used interchangeably with IpActionType, this enum contains the known values that the service supports. Known values supported by the service Allow
OperationsListResponse	Contains response data for the list operation.
PartnerConfigurationProvisioningState	Defines values for PartnerConfigurationProvisioningState. KnownPartnerConfigurationProvisioningState can be used interchangeably with PartnerConfigurationProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
PartnerConfigurationsAuthorizePartnerResponse	Contains response data for the authorizePartner operation.
PartnerConfigurationsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PartnerConfigurationsGetResponse	Contains response data for the get operation.
PartnerConfigurationsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
PartnerConfigurationsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
PartnerConfigurationsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
PartnerConfigurationsUnauthorizePartnerResponse	Contains response data for the unauthorizePartner operation.
PartnerConfigurationsUpdateResponse	Contains response data for the update operation.
PartnerNamespaceProvisioningState	Defines values for PartnerNamespaceProvisioningState. KnownPartnerNamespaceProvisioningState can be used interchangeably with PartnerNamespaceProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
PartnerNamespacesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PartnerNamespacesGetResponse	Contains response data for the get operation.
PartnerNamespacesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
PartnerNamespacesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
PartnerNamespacesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
PartnerNamespacesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
PartnerNamespacesListSharedAccessKeysResponse	Contains response data for the listSharedAccessKeys operation.
PartnerNamespacesRegenerateKeyResponse	Contains response data for the regenerateKey operation.
PartnerRegistrationProvisioningState	Defines values for PartnerRegistrationProvisioningState. KnownPartnerRegistrationProvisioningState can be used interchangeably with PartnerRegistrationProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
PartnerRegistrationsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PartnerRegistrationsGetResponse	Contains response data for the get operation.
PartnerRegistrationsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
PartnerRegistrationsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
PartnerRegistrationsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
PartnerRegistrationsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
PartnerTopicActivationState	Defines values for PartnerTopicActivationState. KnownPartnerTopicActivationState can be used interchangeably with PartnerTopicActivationState, this enum contains the known values that the service supports. Known values supported by the service NeverActivated Activated Deactivated
PartnerTopicEventSubscriptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PartnerTopicEventSubscriptionsGetDeliveryAttributesResponse	Contains response data for the getDeliveryAttributes operation.
PartnerTopicEventSubscriptionsGetFullUrlResponse	Contains response data for the getFullUrl operation.
PartnerTopicEventSubscriptionsGetResponse	Contains response data for the get operation.
PartnerTopicEventSubscriptionsListByPartnerTopicNextResponse	Contains response data for the listByPartnerTopicNext operation.
PartnerTopicEventSubscriptionsListByPartnerTopicResponse	Contains response data for the listByPartnerTopic operation.
PartnerTopicEventSubscriptionsUpdateResponse	Contains response data for the update operation.
PartnerTopicProvisioningState	Defines values for PartnerTopicProvisioningState. KnownPartnerTopicProvisioningState can be used interchangeably with PartnerTopicProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed IdleDueToMirroredChannelResourceDeletion
PartnerTopicRoutingMode	Defines values for PartnerTopicRoutingMode. KnownPartnerTopicRoutingMode can be used interchangeably with PartnerTopicRoutingMode, this enum contains the known values that the service supports. Known values supported by the service SourceEventAttribute ChannelNameHeader
PartnerTopicsActivateResponse	Contains response data for the activate operation.
PartnerTopicsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PartnerTopicsDeactivateResponse	Contains response data for the deactivate operation.
PartnerTopicsGetResponse	Contains response data for the get operation.
PartnerTopicsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
PartnerTopicsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
PartnerTopicsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
PartnerTopicsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
PartnerTopicsUpdateResponse	Contains response data for the update operation.
PersistedConnectionStatus	Defines values for PersistedConnectionStatus. KnownPersistedConnectionStatus can be used interchangeably with PersistedConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByResourceNextResponse	Contains response data for the listByResourceNext operation.
PrivateEndpointConnectionsListByResourceResponse	Contains response data for the listByResource operation.
PrivateEndpointConnectionsParentType	Defines values for PrivateEndpointConnectionsParentType. KnownPrivateEndpointConnectionsParentType can be used interchangeably with PrivateEndpointConnectionsParentType, this enum contains the known values that the service supports. Known values supported by the service topics domains partnerNamespaces
PrivateEndpointConnectionsUpdateResponse	Contains response data for the update operation.
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListByResourceNextResponse	Contains response data for the listByResourceNext operation.
PrivateLinkResourcesListByResourceResponse	Contains response data for the listByResource operation.
PublicNetworkAccess	Defines values for PublicNetworkAccess. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ReadinessState	Defines values for ReadinessState. KnownReadinessState can be used interchangeably with ReadinessState, this enum contains the known values that the service supports. Known values supported by the service NeverActivated Activated
ResourceProvisioningState	Defines values for ResourceProvisioningState. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
ResourceRegionType	Defines values for ResourceRegionType. KnownResourceRegionType can be used interchangeably with ResourceRegionType, this enum contains the known values that the service supports. Known values supported by the service RegionalResource GlobalResource
SystemTopicEventSubscriptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SystemTopicEventSubscriptionsGetDeliveryAttributesResponse	Contains response data for the getDeliveryAttributes operation.
SystemTopicEventSubscriptionsGetFullUrlResponse	Contains response data for the getFullUrl operation.
SystemTopicEventSubscriptionsGetResponse	Contains response data for the get operation.
SystemTopicEventSubscriptionsListBySystemTopicNextResponse	Contains response data for the listBySystemTopicNext operation.
SystemTopicEventSubscriptionsListBySystemTopicResponse	Contains response data for the listBySystemTopic operation.
SystemTopicEventSubscriptionsUpdateResponse	Contains response data for the update operation.
SystemTopicsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SystemTopicsGetResponse	Contains response data for the get operation.
SystemTopicsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
SystemTopicsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
SystemTopicsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
SystemTopicsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
SystemTopicsUpdateResponse	Contains response data for the update operation.
TopicEventSubscriptionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
TopicEventSubscriptionsGetDeliveryAttributesResponse	Contains response data for the getDeliveryAttributes operation.
TopicEventSubscriptionsGetFullUrlResponse	Contains response data for the getFullUrl operation.
TopicEventSubscriptionsGetResponse	Contains response data for the get operation.
TopicEventSubscriptionsListNextResponse	Contains response data for the listNext operation.
TopicEventSubscriptionsListResponse	Contains response data for the list operation.
TopicEventSubscriptionsUpdateResponse	Contains response data for the update operation.
TopicProvisioningState	Defines values for TopicProvisioningState. KnownTopicProvisioningState can be used interchangeably with TopicProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
TopicTypeProvisioningState	Defines values for TopicTypeProvisioningState. KnownTopicTypeProvisioningState can be used interchangeably with TopicTypeProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
TopicTypeSourceScope	Defines values for TopicTypeSourceScope. KnownTopicTypeSourceScope can be used interchangeably with TopicTypeSourceScope, this enum contains the known values that the service supports. Known values supported by the service Resource ResourceGroup AzureSubscription ManagementGroup
TopicTypesGetResponse	Contains response data for the get operation.
TopicTypesListEventTypesResponse	Contains response data for the listEventTypes operation.
TopicTypesListResponse	Contains response data for the list operation.
TopicsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
TopicsGetResponse	Contains response data for the get operation.
TopicsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
TopicsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
TopicsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
TopicsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
TopicsListEventTypesResponse	Contains response data for the listEventTypes operation.
TopicsListSharedAccessKeysResponse	Contains response data for the listSharedAccessKeys operation.
TopicsRegenerateKeyResponse	Contains response data for the regenerateKey operation.
VerifiedPartnerProvisioningState	Defines values for VerifiedPartnerProvisioningState. KnownVerifiedPartnerProvisioningState can be used interchangeably with VerifiedPartnerProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
VerifiedPartnersGetResponse	Contains response data for the get operation.
VerifiedPartnersListNextResponse	Contains response data for the listNext operation.
VerifiedPartnersListResponse	Contains response data for the list operation.

Enums

KnownAdvancedFilterOperatorType	Known values of AdvancedFilterOperatorType that the service accepts.
KnownChannelProvisioningState	Known values of ChannelProvisioningState that the service accepts.
KnownChannelType	Known values of ChannelType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDataResidencyBoundary	Known values of DataResidencyBoundary that the service accepts.
KnownDeadLetterEndPointType	Known values of DeadLetterEndPointType that the service accepts.
KnownDeliveryAttributeMappingType	Known values of DeliveryAttributeMappingType that the service accepts.
KnownDomainProvisioningState	Known values of DomainProvisioningState that the service accepts.
KnownDomainTopicProvisioningState	Known values of DomainTopicProvisioningState that the service accepts.
KnownEndpointType	Known values of EndpointType that the service accepts.
KnownEventDefinitionKind	Known values of EventDefinitionKind that the service accepts.
KnownEventDeliverySchema	Known values of EventDeliverySchema that the service accepts.
KnownEventSubscriptionIdentityType	Known values of EventSubscriptionIdentityType that the service accepts.
KnownEventSubscriptionProvisioningState	Known values of EventSubscriptionProvisioningState that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownInputSchema	Known values of InputSchema that the service accepts.
KnownInputSchemaMappingType	Known values of InputSchemaMappingType that the service accepts.
KnownIpActionType	Known values of IpActionType that the service accepts.
KnownPartnerConfigurationProvisioningState	Known values of PartnerConfigurationProvisioningState that the service accepts.
KnownPartnerNamespaceProvisioningState	Known values of PartnerNamespaceProvisioningState that the service accepts.
KnownPartnerRegistrationProvisioningState	Known values of PartnerRegistrationProvisioningState that the service accepts.
KnownPartnerTopicActivationState	Known values of PartnerTopicActivationState that the service accepts.
KnownPartnerTopicProvisioningState	Known values of PartnerTopicProvisioningState that the service accepts.
KnownPartnerTopicRoutingMode	Known values of PartnerTopicRoutingMode that the service accepts.
KnownPersistedConnectionStatus	Known values of PersistedConnectionStatus that the service accepts.
KnownPrivateEndpointConnectionsParentType	Known values of PrivateEndpointConnectionsParentType that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownReadinessState	Known values of ReadinessState that the service accepts.
KnownResourceProvisioningState	Known values of ResourceProvisioningState that the service accepts.
KnownResourceRegionType	Known values of ResourceRegionType that the service accepts.
KnownTopicProvisioningState	Known values of TopicProvisioningState that the service accepts.
KnownTopicTypeProvisioningState	Known values of TopicTypeProvisioningState that the service accepts.
KnownTopicTypeSourceScope	Known values of TopicTypeSourceScope that the service accepts.
KnownVerifiedPartnerProvisioningState	Known values of VerifiedPartnerProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.