EventProcessorHost class
Bir EventHub'dan olayları işlemek için Olay İşlemcisi Ana Bilgisayarı'nı açıklar.
Oluşturucular
| Event |
Olay Hub'ından olayları işlemek için yeni bir konak oluşturur. |
Özellikler
| consumer |
Olay işlemcisi konağı için tüketici grubu adını sağlar. |
| host |
Olay işlemcisi konağı için ana bilgisayar adını sağlar. |
| receiving |
EPH'nin şu anda ileti aldığı bölümlerin listesini sağlar. EPH, her (yapılandırılmış) kiralama yenileme saniyesinde gerçekleşen her tarama sırasında daha fazla bölüm için kira almayı dener. Bir olay hub'ının içindeki aynı tüketici grubundan ileti almak için aynı anda çalıştırılan EPH örneklerinin sayısı, bu EPH örneğinin etkin olarak ileti aldığı bölüm sayısını da etkiler. |
Yöntemler
Oluşturucu Ayrıntıları
EventProcessorHost(string, EventProcessorHostOptions)
Olay Hub'ından olayları işlemek için yeni bir konak oluşturur.
new EventProcessorHost(hostName: string, options?: EventProcessorHostOptions)Parametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- options
- EventProcessorHostOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Özellik Ayrıntıları
consumerGroup
Olay işlemcisi konağı için tüketici grubu adını sağlar.
consumerGroup: stringÖzellik Değeri
string
hostName
Olay işlemcisi konağı için ana bilgisayar adını sağlar.
hostName: stringÖzellik Değeri
string
receivingFromPartitions
EPH'nin şu anda ileti aldığı bölümlerin listesini sağlar.
EPH, her (yapılandırılmış) kiralama yenileme saniyesinde gerçekleşen her tarama sırasında daha fazla bölüm için kira almayı dener. Bir olay hub'ının içindeki aynı tüketici grubundan ileti almak için aynı anda çalıştırılan EPH örneklerinin sayısı, bu EPH örneğinin etkin olarak ileti aldığı bölüm sayısını da etkiler.
receivingFromPartitions: string[]Özellik Değeri
string[]
Bu EPH örneğinin şu anda ileti aldığı bölümlerin Dizi Listesi.
Yöntem Ayrıntıları
createFromAadTokenCredentials(string, string, string, string, string, ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials, FromTokenProviderOptions)
AAD belirteci kimlik bilgilerinden bir EventProcessorHost örneği oluşturur.
static function createFromAadTokenCredentials(hostName: string, storageConnectionString: string, storageContainerName: string, namespace: string, eventHubPath: string, credentials: ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials, options?: FromTokenProviderOptions): EventProcessorHostParametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- storageConnectionString
-
string
Kiralar ve denetim noktası oluşturma için kullanılan Azure Depolama hesabına bağlantı dizesi. Örnek DefaultEndpointsProtocol=https; AccountName=; AccountKey=; EndpointSuffix=core.windows.net
- storageContainerName
-
string
Yerleşik kira ve denetim noktası yöneticisi tarafından kullanılmak üzere Azure Depolama kapsayıcı adı.
- namespace
-
string
Event Hubs için tam etki alanı adı. Örnek: "{your-sb-namespace}.servicebus.windows.net"
- eventHubPath
-
string
EventHub adı.
- credentials
-
ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials
AAD Belirteci kimlik bilgileri. Aşağıdakilerden biri olabilir: ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials.
- options
- FromTokenProviderOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
EventProcessorHost
createFromAadTokenCredentialsWithCustomCheckpointAndLeaseManager(string, string, string, ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials, CheckpointManager, LeaseManager, FromTokenProviderOptions)
Verilen denetim noktası yöneticisi ve kira yöneticisi ile AAD belirteci kimlik bilgilerinden bir EventProcessorHost örneği oluşturur.
static function createFromAadTokenCredentialsWithCustomCheckpointAndLeaseManager(hostName: string, namespace: string, eventHubPath: string, credentials: ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials, checkpointManager: CheckpointManager, leaseManager: LeaseManager, options?: FromTokenProviderOptions): EventProcessorHostParametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- namespace
-
string
Event Hubs için tam etki alanı adı. Örnek: "{your-sb-namespace}.servicebus.windows.net"
- eventHubPath
-
string
EventHub adı.
- credentials
-
ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials
AAD Belirteci kimlik bilgileri. Aşağıdakilerden biri olabilir: ApplicationTokenCredentials | UserTokenCredentials | DeviceTokenCredentials | MSITokenCredentials.
- checkpointManager
- CheckpointManager
Denetim noktalarını yönetmek için bir yönetici.
- leaseManager
- LeaseManager
Kiraları yönetmek için bir yönetici.
- options
- FromTokenProviderOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
EventProcessorHost
createFromConnectionString(string, string, string, string, FromConnectionStringOptions)
EventHub bağlantı dizesinden bir EventProcessorHost örneği oluşturur.
static function createFromConnectionString(hostName: string, storageConnectionString: string, storageContainerName: string, eventHubConnectionString: string, options?: FromConnectionStringOptions): EventProcessorHostParametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- storageConnectionString
-
string
Kiralar ve denetim noktası oluşturma için kullanılan Azure Depolama hesabına bağlantı dizesi. Örnek DefaultEndpointsProtocol=https; AccountName=; AccountKey=; EndpointSuffix=core.windows.net
- storageContainerName
-
string
Yerleşik kira ve denetim noktası yöneticisi tarafından kullanılmak üzere Azure Depolama kapsayıcı adı.
- eventHubConnectionString
-
string
Olay Hub'ına ait bağlantı dizesi alınacak. Örnek: 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key'
- options
- FromConnectionStringOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
EventProcessorHost
createFromConnectionStringWithCustomCheckpointAndLeaseManager(string, string, CheckpointManager, LeaseManager, FromConnectionStringOptions)
Sağlanan denetim noktası yöneticisi ve kira yöneticisi ile EventHub bağlantı dizesinden bir EventProcessorHost örneği oluşturur.
static function createFromConnectionStringWithCustomCheckpointAndLeaseManager(hostName: string, eventHubConnectionString: string, checkpointManager: CheckpointManager, leaseManager: LeaseManager, options?: FromConnectionStringOptions): EventProcessorHostParametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- eventHubConnectionString
-
string
Olay Hub'ına ait bağlantı dizesi alınacak. Örnek: 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key'
- checkpointManager
- CheckpointManager
Denetim noktalarını yönetmek için bir yönetici.
- leaseManager
- LeaseManager
Kiraları yönetmek için bir yönetici.
- options
- FromConnectionStringOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
EventProcessorHost
createFromIotHubConnectionString(string, string, string, string, FromTokenProviderOptions)
IotHub bağlantı dizesinden bir EventProcessorHost örneği oluşturur.
static function createFromIotHubConnectionString(hostName: string, storageConnectionString: string, storageContainerName: string, iotHubConnectionString: string, options?: FromTokenProviderOptions): Promise<EventProcessorHost>Parametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- storageConnectionString
-
string
Kiralar ve denetim noktası oluşturma için kullanılan Azure Depolama hesabına bağlantı dizesi. Örnek DefaultEndpointsProtocol=https; AccountName=; AccountKey=; EndpointSuffix=core.windows.net
- storageContainerName
-
string
Yerleşik kira ve denetim noktası yöneticisi tarafından kullanılmak üzere Azure Depolama kapsayıcı adı.
- iotHubConnectionString
-
string
IotHub için bağlantı dizesi. Örnek: 'Endpoint=iot-host-name; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key'
- options
- FromTokenProviderOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
Promise<EventProcessorHost>
EventProcessorHost
createFromIotHubConnectionStringWithCustomCheckpointAndLeaseManager(string, string, CheckpointManager, LeaseManager, FromTokenProviderOptions)
Verilen denetim noktası yöneticisi ve kira yöneticisi ile IotHub bağlantı dizesinden bir EventProcessorHost örneği oluşturur.
static function createFromIotHubConnectionStringWithCustomCheckpointAndLeaseManager(hostName: string, iotHubConnectionString: string, checkpointManager: CheckpointManager, leaseManager: LeaseManager, options?: FromTokenProviderOptions): Promise<EventProcessorHost>Parametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- iotHubConnectionString
-
string
IotHub için bağlantı dizesi. Örnek: 'Endpoint=iot-host-name; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key'
- checkpointManager
- CheckpointManager
Denetim noktalarını yönetmek için bir yönetici.
- leaseManager
- LeaseManager
Kiraları yönetmek için bir yönetici.
- options
- FromTokenProviderOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
Promise<EventProcessorHost>
EventProcessorHost
createFromTokenProvider(string, string, string, string, string, TokenProvider, FromTokenProviderOptions)
TokenProvider'dan EventProcessorHost örneği oluşturur.
static function createFromTokenProvider(hostName: string, storageConnectionString: string, storageContainerName: string, namespace: string, eventHubPath: string, tokenProvider: TokenProvider, options?: FromTokenProviderOptions): EventProcessorHostParametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- storageConnectionString
-
string
Kiralar ve denetim noktası oluşturma için kullanılan Azure Depolama hesabına bağlantı dizesi. Örnek DefaultEndpointsProtocol=https; AccountName=; AccountKey=; EndpointSuffix=core.windows.net
- storageContainerName
-
string
Yerleşik kira ve denetim noktası yöneticisi tarafından kullanılmak üzere Azure Depolama kapsayıcı adı.
- namespace
-
string
Event Hubs için tam etki alanı adı. Örnek: "{your-sb-namespace}.servicebus.windows.net"
- eventHubPath
-
string
EventHub adı.
- tokenProvider
- TokenProvider
TokenProvider arabirimini uygulayan belirteç sağlayıcınız.
- options
- FromTokenProviderOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
EventProcessorHost
createFromTokenProviderWithCustomCheckpointAndLeaseManager(string, string, string, TokenProvider, CheckpointManager, LeaseManager, FromTokenProviderOptions)
Sağlanan denetim noktası yöneticisi ve kira yöneticisi ile TokenProvider'dan eventProcessorHost örneği oluşturur.
static function createFromTokenProviderWithCustomCheckpointAndLeaseManager(hostName: string, namespace: string, eventHubPath: string, tokenProvider: TokenProvider, checkpointManager: CheckpointManager, leaseManager: LeaseManager, options?: FromTokenProviderOptions): EventProcessorHostParametreler
- hostName
-
string
İşlemci konağı adı. BENZERSIZ OLMALıDıR.
Benzersiz olduğundan emin olmak için guid veya guid içeren bir ön ek eklemenizi kesinlikle öneririz. kullanabilirsiniz EventProcessorHost.createHostName("your-prefix"); Varsayılan: js-host-${uuid()}.
- namespace
-
string
Event Hubs için tam etki alanı adı. Örnek: "{your-sb-namespace}.servicebus.windows.net"
- eventHubPath
-
string
EventHub adı.
- tokenProvider
- TokenProvider
TokenProvider arabirimini uygulayan belirteç sağlayıcınız.
- checkpointManager
- CheckpointManager
Denetim noktalarını yönetmek için bir yönetici.
- leaseManager
- LeaseManager
Kiraları yönetmek için bir yönetici.
- options
- FromTokenProviderOptions
EventProcessorHost oluşturmak için isteğe bağlı parametreler.
Döndürülenler
EventProcessorHost
createHostName(string)
Benzersiz ana bilgisayar adı oluşturmak için kolaylık yöntemi.
static function createHostName(prefix?: string): stringParametreler
- prefix
-
string
Adın başlangıcı olarak kullanılacak dize. Varsayılan değer: "js-host".
Döndürülenler
string
Benzersiz bir konak adı
getHubRuntimeInformation()
eventhub çalışma zamanı bilgilerini sağlar.
function getHubRuntimeInformation(): Promise<EventHubRuntimeInformation>Döndürülenler
Promise<EventHubRuntimeInformation>
getPartitionIds()
Bir partitionId dizisi sağlar.
function getPartitionIds(): Promise<string[]>Döndürülenler
Promise<string[]>
getPartitionInformation(string | number)
Belirtilen bölüm hakkında bilgi sağlar.
function getPartitionInformation(partitionId: string | number): Promise<EventHubPartitionRuntimeInformation>Parametreler
- partitionId
-
string | number
Bölüm bilgilerinin gerekli olduğu bölüm kimliği.
Döndürülenler
Promise<EventHubPartitionRuntimeInformation>
EventHubPartitionRuntimeInformation
start(OnReceivedMessage, OnReceivedError)
Olay işlemcisi ana bilgisayarını başlatır, bölümlerin listesini getirir ve kiralamaları almayı dener Her başarılı kiralama için ayrıntıları blobdan alır ve daha önce bıraktığı noktada bir alıcı başlatır.
function start(onMessage: OnReceivedMessage, onError: OnReceivedError): Promise<void>Parametreler
- onMessage
- OnReceivedMessage
- onError
- OnReceivedError
Döndürülenler
Promise<void>
stop()
EventProcessorHost'un iletileri işlemesini durdurur.
function stop(): Promise<void>Döndürülenler
Promise<void>
Azure SDK for JavaScript