ChangeDataCaptureConfigurationsOperations interface

Interface representing a ChangeDataCaptureConfigurations operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrReplace

Creates or replaces a change data capture configuration that enrolls a PostgreSQL database for Microsoft Fabric Mirroring.

delete

Deletes a change data capture configuration after destination-side replication has been stopped or detached. This operation never deletes the Microsoft Fabric mirrored-database item.

get

Gets a change data capture configuration.

list

Lists change data capture configurations in a HorizonDB cluster.

update

Updates mutable change data capture configuration properties. Omitted properties preserve their current values.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, configurationName: string, resource: ChangeDataCaptureConfigurationCreateOrUpdate, options?: ChangeDataCaptureConfigurationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, resource: ChangeDataCaptureConfigurationCreateOrUpdate, options?: ChangeDataCaptureConfigurationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, configurationName: string, resource: ChangeDataCaptureConfigurationCreateOrUpdate, options?: ChangeDataCaptureConfigurationsCreateOrReplaceOptionalParams) => Promise<ChangeDataCaptureConfiguration>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, resource: ChangeDataCaptureConfigurationCreateOrUpdate, options?: ChangeDataCaptureConfigurationsCreateOrReplaceOptionalParams) => Promise<ChangeDataCaptureConfiguration>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsDeleteOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, configurationName: string, properties: ChangeDataCaptureConfigurationForPatchUpdateUpdate, options?: ChangeDataCaptureConfigurationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, properties: ChangeDataCaptureConfigurationForPatchUpdateUpdate, options?: ChangeDataCaptureConfigurationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, configurationName: string, properties: ChangeDataCaptureConfigurationForPatchUpdateUpdate, options?: ChangeDataCaptureConfigurationsUpdateOptionalParams) => Promise<ChangeDataCaptureConfiguration>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, properties: ChangeDataCaptureConfigurationForPatchUpdateUpdate, options?: ChangeDataCaptureConfigurationsUpdateOptionalParams) => Promise<ChangeDataCaptureConfiguration>

createOrReplace

Creates or replaces a change data capture configuration that enrolls a PostgreSQL database for Microsoft Fabric Mirroring.

createOrReplace: (resourceGroupName: string, clusterName: string, configurationName: string, resource: ChangeDataCaptureConfigurationCreateOrUpdate, options?: ChangeDataCaptureConfigurationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, resource: ChangeDataCaptureConfigurationCreateOrUpdate, options?: ChangeDataCaptureConfigurationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>

delete

Deletes a change data capture configuration after destination-side replication has been stopped or detached. This operation never deletes the Microsoft Fabric mirrored-database item.

delete: (resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a change data capture configuration.

get: (resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsGetOptionalParams) => Promise<ChangeDataCaptureConfiguration>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, options?: ChangeDataCaptureConfigurationsGetOptionalParams) => Promise<ChangeDataCaptureConfiguration>

list

Lists change data capture configurations in a HorizonDB cluster.

list: (resourceGroupName: string, clusterName: string, options?: ChangeDataCaptureConfigurationsListOptionalParams) => PagedAsyncIterableIterator<ChangeDataCaptureConfiguration, ChangeDataCaptureConfiguration[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, options?: ChangeDataCaptureConfigurationsListOptionalParams) => PagedAsyncIterableIterator<ChangeDataCaptureConfiguration, ChangeDataCaptureConfiguration[], PageSettings>

update

Updates mutable change data capture configuration properties. Omitted properties preserve their current values.

update: (resourceGroupName: string, clusterName: string, configurationName: string, properties: ChangeDataCaptureConfigurationForPatchUpdateUpdate, options?: ChangeDataCaptureConfigurationsUpdateOptionalParams) => PollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>

Property Value

(resourceGroupName: string, clusterName: string, configurationName: string, properties: ChangeDataCaptureConfigurationForPatchUpdateUpdate, options?: ChangeDataCaptureConfigurationsUpdateOptionalParams) => PollerLike<OperationState<ChangeDataCaptureConfiguration>, ChangeDataCaptureConfiguration>