@azure/arm-eventhub package

Classes

Interfaces

AccessKeys	Namespace/EventHub Connection String
ApplicationGroup	The Application Group object
ApplicationGroupOperationsCreateOrUpdateApplicationGroupOptionalParams	Optional parameters.
ApplicationGroupOperationsDeleteOptionalParams	Optional parameters.
ApplicationGroupOperationsGetOptionalParams	Optional parameters.
ApplicationGroupOperationsListByNamespaceOptionalParams	Optional parameters.
ApplicationGroupOperationsOperations	Interface representing a ApplicationGroupOperations operations.
ApplicationGroupPolicy	Properties of the Application Group policy
ApplicationGroupProperties	model interface ApplicationGroupProperties
ArmDisasterRecovery	Single item in List or Get Alias(Disaster Recovery configuration) operation
ArmDisasterRecoveryProperties	Properties required to the Create Or Update Alias(Disaster Recovery configurations)
AuthorizationRule	Single item in a List or Get AuthorizationRule operation
AuthorizationRuleProperties	Properties supplied to create or update AuthorizationRule
AvailableCluster	Pre-provisioned and readily available Event Hubs Cluster count per region.
AvailableClustersList	The response of the List Available Clusters operation.
CaptureDescription	Properties to configure capture description for eventhub
CaptureIdentity	A value that indicates whether capture description is enabled.
CheckNameAvailabilityParameter	Parameter supplied to check Namespace name availability operation
CheckNameAvailabilityResult	The Result of the CheckNameAvailability operation
Cluster	Single Event Hubs Cluster resource in List or Get operations.
ClusterProperties	Event Hubs Cluster properties supplied in responses in List or Get operations.
ClusterQuotaConfigurationProperties	Contains all settings for the cluster.
ClusterSku	SKU parameters particular to a cluster instance.
ClustersCreateOrUpdateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListAvailableClusterRegionOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListBySubscriptionOptionalParams	Optional parameters.
ClustersListNamespacesOptionalParams	Optional parameters.
ClustersOperations	Interface representing a Clusters operations.
ClustersUpdateOptionalParams	Optional parameters.
ConfidentialCompute	model interface ConfidentialCompute
ConfigurationGetOptionalParams	Optional parameters.
ConfigurationOperations	Interface representing a Configuration operations.
ConfigurationPatchOptionalParams	Optional parameters.
ConnectionState	ConnectionState information.
ConsumerGroup	Single item in List or Get Consumer group operation
ConsumerGroupProperties	Single item in List or Get Consumer group operation
ConsumerGroupsCreateOrUpdateOptionalParams	Optional parameters.
ConsumerGroupsDeleteOptionalParams	Optional parameters.
ConsumerGroupsGetOptionalParams	Optional parameters.
ConsumerGroupsListByEventHubOptionalParams	Optional parameters.
ConsumerGroupsOperations	Interface representing a ConsumerGroups operations.
Destination	Capture storage details for capture description
DestinationProperties	Properties describing the storage account, blob container and archive name format for capture destination
DisasterRecoveryConfigsBreakPairingOptionalParams	Optional parameters.
DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams	Optional parameters.
DisasterRecoveryConfigsCreateOrUpdateOptionalParams	Optional parameters.
DisasterRecoveryConfigsDeleteOptionalParams	Optional parameters.
DisasterRecoveryConfigsFailOverOptionalParams	Optional parameters.
DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams	Optional parameters.
DisasterRecoveryConfigsGetOptionalParams	Optional parameters.
DisasterRecoveryConfigsListAuthorizationRulesOptionalParams	Optional parameters.
DisasterRecoveryConfigsListKeysOptionalParams	Optional parameters.
DisasterRecoveryConfigsListOptionalParams	Optional parameters.
DisasterRecoveryConfigsOperations	Interface representing a DisasterRecoveryConfigs operations.
EHNamespace	Single Namespace item in List or Get Operation
EHNamespaceIdContainer	The full ARM ID of an Event Hubs Namespace
EHNamespaceIdListResult	The response of the List Namespace IDs operation
EHNamespaceProperties	Namespace properties supplied for create namespace operation.
Encryption	Properties to configure Encryption
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.
EventHubManagementClientOptionalParams	Optional parameters for the client.
EventHubsCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
EventHubsCreateOrUpdateOptionalParams	Optional parameters.
EventHubsDeleteAuthorizationRuleOptionalParams	Optional parameters.
EventHubsDeleteOptionalParams	Optional parameters.
EventHubsGetAuthorizationRuleOptionalParams	Optional parameters.
EventHubsGetOptionalParams	Optional parameters.
EventHubsListAuthorizationRulesOptionalParams	Optional parameters.
EventHubsListByNamespaceOptionalParams	Optional parameters.
EventHubsListKeysOptionalParams	Optional parameters.
EventHubsOperations	Interface representing a EventHubs operations.
EventHubsRegenerateKeysOptionalParams	Optional parameters.
Eventhub	Single item in List or Get Event Hub operation
EventhubProperties	Properties supplied to the Create Or Update Event Hub operation.
FailOver	model interface FailOver
FailOverProperties	model interface FailOverProperties
GeoDataReplicationProperties	GeoDR Replication properties
Identity	Properties to configure Identity for Bring your Own Keys
KeyVaultProperties	Properties to configure keyVault Properties
MessageTimestampDescription	Properties of MessageTimestamp Description
NWRuleSetIpRules	The response from the List namespace operation.
NWRuleSetVirtualNetworkRules	The response from the List namespace operation.
NamespaceReplicaLocation	Namespace replication properties
NamespacesCheckNameAvailabilityOptionalParams	Optional parameters.
NamespacesCreateOrUpdateAuthorizationRuleOptionalParams	Optional parameters.
NamespacesCreateOrUpdateNetworkRuleSetOptionalParams	Optional parameters.
NamespacesCreateOrUpdateOptionalParams	Optional parameters.
NamespacesDeleteAuthorizationRuleOptionalParams	Optional parameters.
NamespacesDeleteOptionalParams	Optional parameters.
NamespacesFailoverOptionalParams	Optional parameters.
NamespacesGetAuthorizationRuleOptionalParams	Optional parameters.
NamespacesGetNetworkRuleSetOptionalParams	Optional parameters.
NamespacesGetOptionalParams	Optional parameters.
NamespacesListAuthorizationRulesOptionalParams	Optional parameters.
NamespacesListByResourceGroupOptionalParams	Optional parameters.
NamespacesListKeysOptionalParams	Optional parameters.
NamespacesListNetworkRuleSetOptionalParams	Optional parameters.
NamespacesListOptionalParams	Optional parameters.
NamespacesOperations	Interface representing a Namespaces operations.
NamespacesRegenerateKeysOptionalParams	Optional parameters.
NamespacesUpdateOptionalParams	Optional parameters.
NetworkRuleSet	Description of topic resource.
NetworkRuleSetListResult	Paged collection of NetworkRuleSet items
NetworkRuleSetProperties	NetworkRuleSet properties
NetworkSecurityPerimeter	NetworkSecurityPerimeter related information
NetworkSecurityPerimeterConfiguration	Network Security Perimeter related configurations of a given namespace
NetworkSecurityPerimeterConfigurationList	Result of the List NetworkSecurityPerimeterConfiguration operation.
NetworkSecurityPerimeterConfigurationOperationsListOptionalParams	Optional parameters.
NetworkSecurityPerimeterConfigurationOperationsOperations	Interface representing a NetworkSecurityPerimeterConfigurationOperations operations.
NetworkSecurityPerimeterConfigurationProperties	Properties of NetworkSecurityPerimeterConfiguration
NetworkSecurityPerimeterConfigurationPropertiesProfile	Information about current network profile
NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation	Information about resource association
NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams	Optional parameters.
NetworkSecurityPerimeterConfigurationsOperations	Interface representing a NetworkSecurityPerimeterConfigurations operations.
NspAccessRule	Information of Access Rule in Network Profile
NspAccessRuleProperties	Properties of Access Rule
NspAccessRulePropertiesSubscriptionsItem	Subscription for inbound rule
Operation	A Event Hub REST API operation
OperationDisplay	Operation display payload
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.
PlatformCapabilities	model interface PlatformCapabilities
PrivateEndpoint	PrivateEndpoint information.
PrivateEndpointConnection	Properties of the PrivateEndpointConnection.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection resource.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	Information of the private link resource.
PrivateLinkResourceProperties	Properties of PrivateLinkResource
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListResult	Paged collection of PrivateLinkResource items
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
ProvisioningIssue	Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration
ProvisioningIssueProperties	Properties of Provisioning Issue
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegenerateAccessKeyParameters	Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
RetentionDescription	Properties to configure retention settings for the eventhub
SchemaGroup	Single item in List or Get Schema Group operation
SchemaGroupProperties	model interface SchemaGroupProperties
SchemaRegistryCreateOrUpdateOptionalParams	Optional parameters.
SchemaRegistryDeleteOptionalParams	Optional parameters.
SchemaRegistryGetOptionalParams	Optional parameters.
SchemaRegistryListByNamespaceOptionalParams	Optional parameters.
SchemaRegistryOperations	Interface representing a SchemaRegistry operations.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	SKU parameters supplied to the create namespace operation
Subnet	Properties supplied for Subnet
SystemData	Metadata pertaining to creation and last modification of the resource.
ThrottlingPolicy	Properties of the throttling policy
UserAssignedIdentity	Recognized Dictionary value.
UserAssignedIdentityProperties	model interface UserAssignedIdentityProperties

Type Aliases

AccessRights	Type of AccessRights
ApplicationGroupPolicyType	Application Group Policy types KnownApplicationGroupPolicyType can be used interchangeably with ApplicationGroupPolicyType, this enum contains the known values that the service supports. Known values supported by the service ThrottlingPolicy
ApplicationGroupPolicyUnion	Alias for ApplicationGroupPolicyUnion
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CaptureIdentityType	Type of Azure Active Directory Managed Identity.
CleanupPolicyRetentionDescription	Enumerates the possible values for cleanup policy KnownCleanupPolicyRetentionDescription can be used interchangeably with CleanupPolicyRetentionDescription, this enum contains the known values that the service supports. Known values supported by the service Delete Compact DeleteOrCompact
ClusterSkuName	Name of this SKU. KnownClusterSkuName can be used interchangeably with ClusterSkuName, this enum contains the known values that the service supports. Known values supported by the service Dedicated
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.
DefaultAction	Default Action for Network Rule Set KnownDefaultAction can be used interchangeably with DefaultAction, this enum contains the known values that the service supports. Known values supported by the service Allow Deny
EncodingCaptureDescription	Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version
EndPointProvisioningState	Provisioning state of the Private Endpoint Connection. KnownEndPointProvisioningState can be used interchangeably with EndPointProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Canceled Failed
EntityStatus	Enumerates the possible values for the status of the Event Hub.
GeoDRRoleType	GeoDR Role Types KnownGeoDRRoleType can be used interchangeably with GeoDRRoleType, this enum contains the known values that the service supports. Known values supported by the service Primary Secondary
KeyType	The access key to regenerate. KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports. Known values supported by the service PrimaryKey SecondaryKey
ManagedServiceIdentityType	Type of managed service identity.
MetricId	Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal KnownMetricId can be used interchangeably with MetricId, this enum contains the known values that the service supports. Known values supported by the service IncomingBytes OutgoingBytes IncomingMessages OutgoingMessages
Mode	Setting to Enable or Disable Confidential Compute KnownMode can be used interchangeably with Mode, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
NetworkRuleIPAction	The IP Filter Action KnownNetworkRuleIPAction can be used interchangeably with NetworkRuleIPAction, this enum contains the known values that the service supports. Known values supported by the service Allow
NetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of NetworkSecurityPerimeter configuration propagation KnownNetworkSecurityPerimeterConfigurationProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigurationProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Creating Updating Accepted InvalidResponse Succeeded SucceededWithIssues Failed Deleting Deleted Canceled
NspAccessRuleDirection	Direction of Access Rule KnownNspAccessRuleDirection can be used interchangeably with NspAccessRuleDirection, this enum contains the known values that the service supports. Known values supported by the service Inbound Outbound
PrivateLinkConnectionStatus	Status of the connection. KnownPrivateLinkConnectionStatus can be used interchangeably with PrivateLinkConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
ProvisioningState	Provisioning state of the Cluster. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Creating Deleting Scaling Active Failed Succeeded Canceled
ProvisioningStateDR	Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'
PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. 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 SecuredByPerimeter
PublicNetworkAccessFlag	This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. KnownPublicNetworkAccessFlag can be used interchangeably with PublicNetworkAccessFlag, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled SecuredByPerimeter
ResourceAssociationAccessMode	Access Mode of the resource association KnownResourceAssociationAccessMode can be used interchangeably with ResourceAssociationAccessMode, this enum contains the known values that the service supports. Known values supported by the service NoAssociationMode EnforcedMode LearningMode AuditMode UnspecifiedMode
RoleDisasterRecovery	role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'
SchemaCompatibility	Type of SchemaCompatibility
SchemaType	Type of SchemaType
SkuName	Name of this SKU. KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports. Known values supported by the service Basic Standard Premium
SkuTier	The billing tier of this particular SKU. KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports. Known values supported by the service Basic Standard Premium
TimestampType	Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same. KnownTimestampType can be used interchangeably with TimestampType, this enum contains the known values that the service supports. Known values supported by the service LogAppend Create
TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2' 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.1 1.2 1.3
UnavailableReason	Specifies the reason for the unavailability of the service.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessRights	Known values of AccessRights that the service accepts.
KnownApplicationGroupPolicyType	Application Group Policy types
KnownCleanupPolicyRetentionDescription	Enumerates the possible values for cleanup policy
KnownClusterSkuName	Name of this SKU.
KnownCreatedByType	The kind of entity that created the resource.
KnownDefaultAction	Default Action for Network Rule Set
KnownEndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
KnownGeoDRRoleType	GeoDR Role Types
KnownKeyType	The access key to regenerate.
KnownMetricId	Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal
KnownMode	Setting to Enable or Disable Confidential Compute
KnownNetworkRuleIPAction	The IP Filter Action
KnownNetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of NetworkSecurityPerimeter configuration propagation
KnownNspAccessRuleDirection	Direction of Access Rule
KnownPrivateLinkConnectionStatus	Status of the connection.
KnownProvisioningState	Provisioning state of the Cluster.
KnownPublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled.
KnownPublicNetworkAccessFlag	This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.
KnownResourceAssociationAccessMode	Access Mode of the resource association
KnownSchemaCompatibility	Known values of SchemaCompatibility that the service accepts.
KnownSchemaType	Known values of SchemaType that the service accepts.
KnownSkuName	Name of this SKU.
KnownSkuTier	The billing tier of this particular SKU.
KnownTimestampType	Denotes the type of timestamp the message will hold.Two types of timestamp types - "AppendTime" and "CreateTime". AppendTime refers the time in which message got appended inside broker log. CreateTime refers to the time in which the message was generated on source side and producers can set this timestamp while sending the message. Default value is AppendTime. If you are using AMQP protocol, CreateTime equals AppendTime and its behavior remains the same.
KnownTlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(EventHubManagementClient, 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.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(EventHubManagementClient, 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: EventHubManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: EventHubManagementClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-eventhub package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

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

Parameters

Returns

Variable Details

RestError

Type

Feedback