EventhubProperties Class

Properties supplied to the Create Or Update Event Hub operation.

Constructor

EventhubProperties(*args: Any, **kwargs: Any)

Variables

Name Description
partition_ids
list[str]

Current number of shards on the Event Hub.
created_at
datetime

Exact time the Event Hub was created.
updated_at
datetime

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
str or 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
CaptureDescription

Properties of capture description.
retention_description
RetentionDescription

Event Hub retention settings.
message_timestamp_description
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

capture_description

Properties of capture description.

capture_description: _models.CaptureDescription | None

created_at

Exact time the Event Hub was created.

created_at: datetime | None

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 | None

message_retention_in_days

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

message_retention_in_days: int | None

message_timestamp_description

Properties of MessageTimestamp Description.

message_timestamp_description: _models.MessageTimestampDescription | None

partition_count

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

partition_count: int | None

partition_ids

Current number of shards on the Event Hub.

partition_ids: list[str] | None

retention_description

Event Hub retention settings.

retention_description: _models.RetentionDescription | None

status

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

status: str | _models.EntityStatus | None

updated_at

The exact time the message was updated.

updated_at: datetime | None

user_metadata

Gets and Sets Metadata of User.

user_metadata: str | None