models Package

Classes

AccessKeys

Namespace/EventHub Connection String.

ApplicationGroup

The Application Group object.

ApplicationGroupPolicy

Properties of the Application Group policy.

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

ApplicationGroupProperties

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.

ConfidentialCompute

ConfidentialCompute.

ConnectionState

ConnectionState information.

ConsumerGroup

Single item in List or Get Consumer group operation.

ConsumerGroupProperties

Single item in List or Get Consumer group operation.

Destination

Capture storage details for capture description.

DestinationProperties

Properties describing the storage account, blob container and archive name format for capture destination.

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.

Eventhub

Single item in List or Get Event Hub operation.

EventhubProperties

Properties supplied to the Create Or Update Event Hub operation.

FailOver

FailOver.

FailOverProperties

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.

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.

NetworkSecurityPerimeterConfigurationProperties

Properties of NetworkSecurityPerimeterConfiguration.

NetworkSecurityPerimeterConfigurationPropertiesProfile

Information about current network profile.

NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation

Information about resource association.

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.

PlatformCapabilities

PlatformCapabilities.

PrivateEndpoint

PrivateEndpoint information.

PrivateEndpointConnection

Properties of the PrivateEndpointConnection.

PrivateEndpointConnectionProperties

Properties of the private endpoint connection resource.

PrivateLinkResource

Information of the private link resource.

PrivateLinkResourceProperties

Properties of PrivateLinkResource.

PrivateLinkResourcesListResult

Paged collection of PrivateLinkResource items.

ProvisioningIssue

Describes Provisioning issue for given NetworkSecurityPerimeterConfiguration.

ProvisioningIssueProperties

Properties of Provisioning Issue.

ProxyResource

Proxy Resource.

RegenerateAccessKeyParameters

Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset.

Resource

Resource.

RetentionDescription

Properties to configure retention settings for the eventhub.

SchemaGroup

Single item in List or Get Schema Group operation.

SchemaGroupProperties

SchemaGroupProperties.

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

UserAssignedIdentityProperties.

Enums

AccessRights

Type of AccessRights.

ApplicationGroupPolicyType

Application Group Policy types.

CaptureIdentityType

Type of Azure Active Directory Managed Identity.

CleanupPolicyRetentionDescription

Enumerates the possible values for cleanup policy.

ClusterSkuName

Name of this SKU.

CreatedByType

The kind of entity that created the resource.

DefaultAction

Default Action for Network Rule Set.

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.

EntityStatus

Enumerates the possible values for the status of the Event Hub.

GeoDRRoleType

GeoDR Role Types.

IpAddressType

The IP address type for the namespace. Determines whether the namespace supports IPv4 only or both IPv4 and IPv6 (dual stack).

KeyType

The access key to regenerate.

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.

Mode

Setting to Enable or Disable Confidential Compute.

NetworkRuleIPAction

The IP Filter Action.

NetworkSecurityPerimeterConfigurationProvisioningState

Provisioning state of NetworkSecurityPerimeter configuration propagation.

NspAccessRuleDirection

Direction of Access Rule.

PrivateLinkConnectionStatus

Status of the connection.

ProvisioningState

Provisioning state of the Cluster.

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.

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.

ResourceAssociationAccessMode

Access Mode of the resource association.

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.

SkuTier

The billing tier of this particular SKU.

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.

TlsVersion

The minimum TLS version for the cluster to support, e.g. '1.2'.

UnavailableReason

Specifies the reason for the unavailability of the service.