Eventhub interface

Package:

@azure/arm-eventhub

Single item in List or Get Event Hub operation

Extends

ProxyResource

Properties

captureDescription	Properties of capture description
createdAt	Exact time the Event Hub was created.
identifier	Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet.
location	The geo-location where the resource lives
messageRetentionInDays	Number of days to retain the events for this Event Hub, value should be 1 to 7 days
messageTimestampDescription	Properties of MessageTimestamp Description
partitionCount	Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
partitionIds	Current number of shards on the Event Hub.
retentionDescription	Event Hub retention settings
status	Enumerates the possible values for the status of the Event Hub.
updatedAt	The exact time the message was updated.
userMetadata	Gets and Sets Metadata of User.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

captureDescription

Properties of capture description

captureDescription?: CaptureDescription

Property Value

CaptureDescription

createdAt

Exact time the Event Hub was created.

createdAt?: Date

Property Value

Date

identifier

Denotes the unique identifier for event hub and is generated by service while creating topic. This identifier can be used in kafka runtime apis wherever a UUID is required e.g Fetch & Delete Topic. This identifier is not supported in AMQP runtime operations yet.

identifier?: string

Property Value

string

location

The geo-location where the resource lives

location?: string

Property Value

string

messageRetentionInDays

Number of days to retain the events for this Event Hub, value should be 1 to 7 days

messageRetentionInDays?: number

Property Value

number

messageTimestampDescription

Properties of MessageTimestamp Description

messageTimestampDescription?: MessageTimestampDescription

Property Value

MessageTimestampDescription

partitionCount

Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.

partitionCount?: number

Property Value

number

partitionIds

Current number of shards on the Event Hub.

partitionIds?: string[]

Property Value

string[]

retentionDescription

Event Hub retention settings

retentionDescription?: RetentionDescription

Property Value

RetentionDescription

status

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

status?: EntityStatus

Property Value

EntityStatus

updatedAt

The exact time the message was updated.

updatedAt?: Date

Property Value

Date

userMetadata

Gets and Sets Metadata of User.

userMetadata?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type