ProfileType interface

The connection string profile to allow clients to group, filter and select connection string values based on structured metadata.

Properties

consumerGroup

Consumer group used by the connection.

displayName

A user-friendly name for the connection.

hostFormat

Host format used in connection string.

isRegional

True for a regional connection string, applicable to cross-region DG only.

protocol

Protocol used by the connection.

sessionMode

Specifies whether the listener performs a direct hand-off of the session, or redirects the session.

syntaxFormat

Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format.

tlsAuthentication

Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication.

value

Connection string value.

Property Details

consumerGroup

Consumer group used by the connection.

consumerGroup?: string

Property Value

string

displayName

A user-friendly name for the connection.

displayName: string

Property Value

string

hostFormat

Host format used in connection string.

hostFormat: string

Property Value

string

isRegional

True for a regional connection string, applicable to cross-region DG only.

isRegional?: boolean

Property Value

boolean

protocol

Protocol used by the connection.

protocol: string

Property Value

string

sessionMode

Specifies whether the listener performs a direct hand-off of the session, or redirects the session.

sessionMode: string

Property Value

string

syntaxFormat

Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format.

syntaxFormat: string

Property Value

string

tlsAuthentication

Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication.

tlsAuthentication?: string

Property Value

string

value

Connection string value.

value: string

Property Value

string