Share via

Eventhub interface

  • Reference
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. NOTE: This property will not be serialized. It can only be populated by the server.
messageRetentionInDays

Number of days to retain the events for this Event Hub, value should be 1 to 7 days
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. NOTE: This property will not be serialized. It can only be populated by the server.
retentionDescription

Event Hub retention settings
status

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

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
updatedAt

The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.
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} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

captureDescription

Properties of capture description

captureDescription?: CaptureDescription

Property Value

CaptureDescription

createdAt

Exact time the Event Hub was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdAt?: Date

Property Value

Date

messageRetentionInDays

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

messageRetentionInDays?: number

Property Value

number

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

systemData

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

updatedAt

The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.

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} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

location

The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From ProxyResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type