EventHub Class

Definition

Properties related to EventHub.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.EventHubTypeConverter))]
public class EventHub : Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.IEventHub, Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.Models.EventHubTypeConverter))>]
type EventHub = class
    interface IEventHub
    interface IJsonSerializable
    interface IDigitalTwinsEndpointResourceProperties
    interface IValidates
Public Class EventHub
Implements IEventHub, IValidates
Inheritance
EventHub
Attributes
Implements

Constructors

Name Description
EventHub()

Creates an new EventHub instance.

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.

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.

DeadLetterSecret

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

DeadLetterUri

Dead letter storage URL for identity-based authentication.

EndpointType

The type of Digital Twins endpoint

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.

Methods

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