IEventHub Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.EventHubTypeConverter))]
public interface IEventHub : Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.IDigitalTwinsEndpointResourceProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.Api20220531.EventHubTypeConverter))>]
type IEventHub = interface
    interface IJsonSerializable
    interface IDigitalTwinsEndpointResourceProperties
Public Interface IEventHub
Implements IDigitalTwinsEndpointResourceProperties
Derived
Attributes
Implements

Properties

Name Description
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.

(Inherited from IDigitalTwinsEndpointResourceProperties)
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.

CreatedTime

Time when the Endpoint was added to DigitalTwinsInstance.

(Inherited from IDigitalTwinsEndpointResourceProperties)
DeadLetterSecret

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

(Inherited from IDigitalTwinsEndpointResourceProperties)
DeadLetterUri

Dead letter storage URL for identity-based authentication.

(Inherited from IDigitalTwinsEndpointResourceProperties)
EndpointType

The type of Digital Twins endpoint

(Inherited from IDigitalTwinsEndpointResourceProperties)
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.

ProvisioningState

The provisioning state.

(Inherited from IDigitalTwinsEndpointResourceProperties)

Methods

Name Description
ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to