ChangeDataCaptureCapabilitiesOperations interface

Package:

@azure/arm-horizondb

Interface representing a ChangeDataCaptureCapabilities operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrReplace	Creates or replaces the singleton change data capture capability and reconciles shared engine prerequisites.
delete	Deletes the change data capture capability after all change data capture destinations and configurations have been removed.
get	Gets the singleton change data capture capability for a HorizonDB cluster.
list	Lists the optional singleton change data capture capability for a cluster. The result contains zero or one item.
update	Updates mutable change data capture capability properties. Omitted properties preserve their current values.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, resource: ChangeDataCaptureCapabilityCreateOrUpdate, options?: ChangeDataCaptureCapabilitiesCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>>

Property Value

(resourceGroupName: string, clusterName: string, resource: ChangeDataCaptureCapabilityCreateOrUpdate, options?: ChangeDataCaptureCapabilitiesCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, resource: ChangeDataCaptureCapabilityCreateOrUpdate, options?: ChangeDataCaptureCapabilitiesCreateOrReplaceOptionalParams) => Promise<ChangeDataCaptureCapability>

Property Value

(resourceGroupName: string, clusterName: string, resource: ChangeDataCaptureCapabilityCreateOrUpdate, options?: ChangeDataCaptureCapabilitiesCreateOrReplaceOptionalParams) => Promise<ChangeDataCaptureCapability>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, properties: ChangeDataCaptureCapabilityForPatchUpdateUpdate, options?: ChangeDataCaptureCapabilitiesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>>

Property Value

(resourceGroupName: string, clusterName: string, properties: ChangeDataCaptureCapabilityForPatchUpdateUpdate, options?: ChangeDataCaptureCapabilitiesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, properties: ChangeDataCaptureCapabilityForPatchUpdateUpdate, options?: ChangeDataCaptureCapabilitiesUpdateOptionalParams) => Promise<ChangeDataCaptureCapability>

Property Value

(resourceGroupName: string, clusterName: string, properties: ChangeDataCaptureCapabilityForPatchUpdateUpdate, options?: ChangeDataCaptureCapabilitiesUpdateOptionalParams) => Promise<ChangeDataCaptureCapability>

createOrReplace

Creates or replaces the singleton change data capture capability and reconciles shared engine prerequisites.

createOrReplace: (resourceGroupName: string, clusterName: string, resource: ChangeDataCaptureCapabilityCreateOrUpdate, options?: ChangeDataCaptureCapabilitiesCreateOrReplaceOptionalParams) => PollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>

Property Value

(resourceGroupName: string, clusterName: string, resource: ChangeDataCaptureCapabilityCreateOrUpdate, options?: ChangeDataCaptureCapabilitiesCreateOrReplaceOptionalParams) => PollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>

delete

Deletes the change data capture capability after all change data capture destinations and configurations have been removed.

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

Property Value

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

get

Gets the singleton change data capture capability for a HorizonDB cluster.

get: (resourceGroupName: string, clusterName: string, options?: ChangeDataCaptureCapabilitiesGetOptionalParams) => Promise<ChangeDataCaptureCapability>

Property Value

(resourceGroupName: string, clusterName: string, options?: ChangeDataCaptureCapabilitiesGetOptionalParams) => Promise<ChangeDataCaptureCapability>

list

Lists the optional singleton change data capture capability for a cluster. The result contains zero or one item.

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

Property Value

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

update

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

update: (resourceGroupName: string, clusterName: string, properties: ChangeDataCaptureCapabilityForPatchUpdateUpdate, options?: ChangeDataCaptureCapabilitiesUpdateOptionalParams) => PollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>

Property Value

(resourceGroupName: string, clusterName: string, properties: ChangeDataCaptureCapabilityForPatchUpdateUpdate, options?: ChangeDataCaptureCapabilitiesUpdateOptionalParams) => PollerLike<OperationState<ChangeDataCaptureCapability>, ChangeDataCaptureCapability>