ChangeDataCaptureConfigurationProperties interface

The properties of a Microsoft Fabric Mirroring configuration.

Properties

databaseName

The exact PostgreSQL database name enrolled in this logical stream. This value is immutable.

desiredState

The requested configuration state.

destinationResourceId

The immutable resource ID of an enabled change data capture destination under the same cluster.

effectiveState

The current effective configuration state.

extension

The change data capture extension state for the enrolled database.

logicalStreamId

A service-generated identifier for the logical stream, represented as an RFC 4122 GUID. This value remains stable when a writer role moves and the service materializes a replacement ARM resource under the new writer cluster.

provisioningState

The provisioning state of the latest configuration mutation.

replication

The known status of the destination-owned replication session.

status

Customer-safe health information for the configuration.

topology

The current writer-topology binding for this logical stream.

usageProfile

The immutable usage profile. API version 2026-10-01-preview accepts Mirroring only.

Property Details

databaseName

The exact PostgreSQL database name enrolled in this logical stream. This value is immutable.

databaseName: string

Property Value

string

desiredState

The requested configuration state.

desiredState: string

Property Value

string

destinationResourceId

The immutable resource ID of an enabled change data capture destination under the same cluster.

destinationResourceId: string

Property Value

string

effectiveState

The current effective configuration state.

effectiveState: string

Property Value

string

extension

The change data capture extension state for the enrolled database.

extension: ChangeDataCaptureExtensionStatus

Property Value

logicalStreamId

A service-generated identifier for the logical stream, represented as an RFC 4122 GUID. This value remains stable when a writer role moves and the service materializes a replacement ARM resource under the new writer cluster.

logicalStreamId: string

Property Value

string

provisioningState

The provisioning state of the latest configuration mutation.

provisioningState?: string

Property Value

string

replication

The known status of the destination-owned replication session.

replication: ChangeDataCaptureReplicationStatus

Property Value

status

Customer-safe health information for the configuration.

status: ChangeDataCaptureStatus

Property Value

topology

The current writer-topology binding for this logical stream.

topology: ChangeDataCaptureTopologyBindingStatus

Property Value

usageProfile

The immutable usage profile. API version 2026-10-01-preview accepts Mirroring only.

usageProfile: string

Property Value

string