EventhubProperties Class

Properties supplied to the Create Or Update Event Hub operation.

Constructor

EventhubProperties()

Variables

Name Description
partition_ids
list[str]

Current number of shards on the Event Hub.
created_at
str

Exact time the Event Hub was created.
updated_at
str

The exact time the message was updated.
message_retention_in_days
int

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

Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.
status
Union[str, <xref:"EntityStatus">]

Enumerates the possible values for the status of the Event Hub. Known values are: "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", and "Unknown".
capture_description
<xref:<xref:"CaptureDescription">>

Properties of capture description.
retention_description
<xref:<xref:"RetentionDescription">>

Event Hub retention settings.
message_timestamp_description
<xref:<xref:"MessageTimestampDescription">>

Properties of MessageTimestamp Description.
identifier
str

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.
user_metadata
str

Gets and Sets Metadata of User.

Attributes

captureDescription

Properties of capture description.

captureDescription: CaptureDescription

createdAt

Exact time the Event Hub was created.

createdAt: str

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: str

messageRetentionInDays

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

messageRetentionInDays: int

messageTimestampDescription

Properties of MessageTimestamp Description.

messageTimestampDescription: MessageTimestampDescription

partitionCount

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

partitionCount: int

partitionIds

Current number of shards on the Event Hub.

partitionIds: list[str]

retentionDescription

Event Hub retention settings.

retentionDescription: RetentionDescription

status

"Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", and "Unknown".

status: str | EntityStatus

updatedAt

The exact time the message was updated.

updatedAt: str

userMetadata

Gets and Sets Metadata of User.

userMetadata: str