KafkaConnectionDetails interface

Package:

@azure/arm-oracledatabase

The metadata of a Kafka Connection.

Extends

ConnectionBaseProperties

Properties

bootstrapServers	The list of KafkaBootstrapServer objects specified by host/port.
clusterId	The OCID of the Kafka cluster being referenced.
connectionType	The discriminator possible values: KAFKA, MICROSOFT_FABRIC, ORACLE
consumerProperties	The additional consumer properties in string format.
keyStorePasswordSecretId	The OCID of the Secret where the keystore password is stored.
keyStoreSecretId	The OCID of the Secret where the keystore is stored.
passwordSecretId	The OCID of the Secret where the password is stored.
producerProperties	The additional producer properties in string format.
securityProtocol	The Kafka security protocol used to connect to the broker.
shouldUseResourcePrincipal	Indicates if resource principal should be used for authentication.
sslKeyPasswordSecretId	The OCID of the Secret where the SSL key password is stored.
streamPoolId	The OCID of the stream pool being referenced.
technologyType	The Kafka technology type.
trustStorePasswordSecretId	The OCID of the Secret where the truststore password is stored.
trustStoreSecretId	The OCID of the Secret where the truststore is stored.
username	The username used to authenticate to Kafka.

Inherited Properties

compartmentId	The OCID of the compartment being referenced.
displayName	The connection display name.
doesUseSecretIds	Indicates whether secret OCIDs are used for credential fields.
keyId	The customer's master key OCID.
lifecycleDetails	The description of lifecycle state in detail.
lifecycleState	The connection lifecycle state.
networkAnchorId	The corresponding network anchor Azure ID.
ocid	The OCID of the connection being referenced.
provisioningState	Connection provisioning state.
resourceAnchorId	The corresponding resource anchor Azure ID.
routingMethod	Controls the network traffic direction to the target.
timeCreated	The date time the resource was created in OCI.
timeUpdated	The date time the resource was last updated in OCI.
vaultId	The customer's vault OCID.

Property Details

bootstrapServers

The list of KafkaBootstrapServer objects specified by host/port.

bootstrapServers?: KafkaBootstrapServer[]

Property Value

KafkaBootstrapServer[]

clusterId

The OCID of the Kafka cluster being referenced.

clusterId?: string

Property Value

string

connectionType

The discriminator possible values: KAFKA, MICROSOFT_FABRIC, ORACLE

connectionType: "KAFKA"

Property Value

"KAFKA"

consumerProperties

The additional consumer properties in string format.

consumerProperties?: string

Property Value

string

keyStorePasswordSecretId

The OCID of the Secret where the keystore password is stored.

keyStorePasswordSecretId?: string

Property Value

string

keyStoreSecretId

The OCID of the Secret where the keystore is stored.

keyStoreSecretId?: string

Property Value

string

passwordSecretId

The OCID of the Secret where the password is stored.

passwordSecretId?: string

Property Value

string

producerProperties

The additional producer properties in string format.

producerProperties?: string

Property Value

string

securityProtocol

The Kafka security protocol used to connect to the broker.

securityProtocol?: string

Property Value

string

shouldUseResourcePrincipal

Indicates if resource principal should be used for authentication.

shouldUseResourcePrincipal?: boolean

Property Value

boolean

sslKeyPasswordSecretId

The OCID of the Secret where the SSL key password is stored.

sslKeyPasswordSecretId?: string

Property Value

string

streamPoolId

The OCID of the stream pool being referenced.

streamPoolId?: string

Property Value

string

technologyType

The Kafka technology type.

technologyType: string

Property Value

string

trustStorePasswordSecretId

The OCID of the Secret where the truststore password is stored.

trustStorePasswordSecretId?: string

Property Value

string

trustStoreSecretId

The OCID of the Secret where the truststore is stored.

trustStoreSecretId?: string

Property Value

string

username

The username used to authenticate to Kafka.

username?: string

Property Value

string

Inherited Property Details

compartmentId

The OCID of the compartment being referenced.

compartmentId?: string

Property Value

string

Inherited From ConnectionBaseProperties.compartmentId

displayName

The connection display name.

displayName: string

Property Value

string

Inherited From ConnectionBaseProperties.displayName

doesUseSecretIds

Indicates whether secret OCIDs are used for credential fields.

doesUseSecretIds?: boolean

Property Value

boolean

Inherited From ConnectionBaseProperties.doesUseSecretIds

keyId

The customer's master key OCID.

keyId?: string

Property Value

string

Inherited From ConnectionBaseProperties.keyId

lifecycleDetails

The description of lifecycle state in detail.

lifecycleDetails?: string

Property Value

string

Inherited From ConnectionBaseProperties.lifecycleDetails

lifecycleState

The connection lifecycle state.

lifecycleState?: string

Property Value

string

Inherited From ConnectionBaseProperties.lifecycleState

networkAnchorId

The corresponding network anchor Azure ID.

networkAnchorId: string

Property Value

string

Inherited From ConnectionBaseProperties.networkAnchorId

ocid

The OCID of the connection being referenced.

ocid?: string

Property Value

string

Inherited From ConnectionBaseProperties.ocid

provisioningState

Connection provisioning state.

provisioningState?: string

Property Value

string

Inherited From ConnectionBaseProperties.provisioningState

resourceAnchorId

The corresponding resource anchor Azure ID.

resourceAnchorId: string

Property Value

string

Inherited From ConnectionBaseProperties.resourceAnchorId

routingMethod

Controls the network traffic direction to the target.

routingMethod?: string

Property Value

string

Inherited From ConnectionBaseProperties.routingMethod

timeCreated

The date time the resource was created in OCI.

timeCreated?: string

Property Value

string

Inherited From ConnectionBaseProperties.timeCreated

timeUpdated

The date time the resource was last updated in OCI.

timeUpdated?: string

Property Value

string

Inherited From ConnectionBaseProperties.timeUpdated

vaultId

The customer's vault OCID.

vaultId?: string

Property Value

string

Inherited From ConnectionBaseProperties.vaultId