Partilhar via


Eventhub Class

Definition

Single item in List or Get Event Hub operation

[Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.EventhubTypeConverter))]
public class Eventhub : Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IEventhub, Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.IValidates
[<Microsoft.Azure.PowerShell.Cmdlets.EventHub.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.EventhubTypeConverter))>]
type Eventhub = class
    interface IEventhub
    interface IJsonSerializable
    interface IProxyResource
    interface IValidates
Public Class Eventhub
Implements IEventhub, IValidates
Inheritance
Eventhub
Attributes
Implements

Constructors

Eventhub()

Creates an new Eventhub instance.

Properties

ArchiveNameFormat

Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order

BlobContainer

Blob container Name

CaptureEnabled

A value that indicates whether capture description is enabled.

CleanupPolicy

Enumerates the possible values for cleanup policy

CreatedAt

Exact time the Event Hub was created.

DataLakeAccountName

The Azure Data Lake Store name for the captured events

DataLakeFolderPath

The destination folder path for the captured events

DataLakeSubscriptionId

Subscription Id of Azure Data Lake Store

DestinationName

Name for capture destination

Encoding

Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version

Id

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

IdentityType

Type of Azure Active Directory Managed Identity.

IntervalInSeconds

The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds

Location

The geo-location where the resource lives

MessageRetentionInDay

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

Name

The name of the resource

PartitionCount

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

PartitionId

Current number of shards on the Event Hub.

ResourceGroupName

Gets the resource group name

RetentionTimeInHour

Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue

SizeLimitInBytes

The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes

SkipEmptyArchive

A value that indicates whether to Skip Empty Archives

Status

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

StorageAccountResourceId

Resource id of the storage account to be used to create the blobs

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The type of identity that last modified the resource.

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

TombstoneRetentionTimeInHour

Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub

Type

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

UpdatedAt

The exact time the message was updated.

UserAssignedIdentityId

ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Eventhub.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Eventhub.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IEventhub.

FromJsonString(String)

Creates a new instance of Eventhub, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Eventhub into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to