DigitalTwinsEndpointResourceProperties interface

  • Reference
Package:
@azure/arm-digitaltwins

Properties related to Digital Twins Endpoint

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.
endpointType

Polymorphic discriminator, which specifies the different types this object can be
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

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

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

deadLetterSecret

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

deadLetterSecret?: string

Property Value

string

deadLetterUri

Dead letter storage URL for identity-based authentication.

deadLetterUri?: string

Property Value

string

endpointType

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

endpointType: "ServiceBus" | "EventHub" | "EventGrid"

Property Value

"ServiceBus" | "EventHub" | "EventGrid"

identity

Managed identity properties for the endpoint.

identity?: ManagedIdentityReference

Property Value

ManagedIdentityReference

provisioningState

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

provisioningState?: string

Property Value

string