Share via

EventHub interface

  • Reference
Package:
@azure/arm-digitaltwins

Properties related to EventHub.

Extends
DigitalTwinsEndpointResourceProperties

Properties

connectionStringPrimaryKey

PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
connectionStringSecondaryKey

SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.
endpointType

Polymorphic discriminator, which specifies the different types this object can be
endpointUri

The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.
entityPath

The EventHub name in the EventHub namespace for identity-based authentication.

Inherited Properties

authenticationType

Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.
createdTime

Time when the Endpoint was added to DigitalTwinsInstance. NOTE: This property will not be serialized. It can only be populated by the server.
deadLetterSecret

Dead letter storage secret for key-based authentication. Will be obfuscated during read.
deadLetterUri

Dead letter storage URL for identity-based authentication.
identity

Managed identity properties for the endpoint.
provisioningState

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

connectionStringPrimaryKey

PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

connectionStringPrimaryKey?: string

Property Value

string

connectionStringSecondaryKey

SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read.

connectionStringSecondaryKey?: string

Property Value

string

endpointType

Polymorphic discriminator, which specifies the different types this object can be

endpointType: "EventHub"

Property Value

"EventHub"

endpointUri

The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'.

endpointUri?: string

Property Value

string

entityPath

The EventHub name in the EventHub namespace for identity-based authentication.

entityPath?: string

Property Value

string

Inherited Property Details

authenticationType

Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified.

authenticationType?: string

Property Value

string

Inherited From DigitalTwinsEndpointResourceProperties.authenticationType

createdTime

Time when the Endpoint was added to DigitalTwinsInstance. NOTE: This property will not be serialized. It can only be populated by the server.

createdTime?: Date

Property Value

Date

Inherited From DigitalTwinsEndpointResourceProperties.createdTime

deadLetterSecret

Dead letter storage secret for key-based authentication. Will be obfuscated during read.

deadLetterSecret?: string

Property Value

string

Inherited From DigitalTwinsEndpointResourceProperties.deadLetterSecret

deadLetterUri

Dead letter storage URL for identity-based authentication.

deadLetterUri?: string

Property Value

string

Inherited From DigitalTwinsEndpointResourceProperties.deadLetterUri

identity

Managed identity properties for the endpoint.

identity?: ManagedIdentityReference

Property Value

ManagedIdentityReference

Inherited From DigitalTwinsEndpointResourceProperties.identity

provisioningState

The provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From DigitalTwinsEndpointResourceProperties.provisioningState