ChangeDataCaptureDestinationsOperations interface

Package:

@azure/arm-horizondb

Interface representing a ChangeDataCaptureDestinations operations.

Properties

activateIdentity	Atomically activates a validated identity assignment for this destination. If-Match is evaluated against the destination entity tag. Activating the already-active assignment succeeds idempotently.
beginActivateIdentity
beginActivateIdentityAndWait
beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrReplace	Creates or replaces a Microsoft Fabric change data capture destination.
delete	Deletes a change data capture destination after all referencing configurations and identity assignments have been removed.
get	Gets a change data capture destination.
list	Lists change data capture destinations in a HorizonDB cluster.
update	Updates mutable change data capture destination properties. Omitted properties preserve their current values.

Property Details

activateIdentity

Atomically activates a validated identity assignment for this destination. If-Match is evaluated against the destination entity tag. Activating the already-active assignment succeeds idempotently.

activateIdentity: (resourceGroupName: string, ifMatch: string, clusterName: string, destinationName: string, body: ActivateChangeDataCaptureIdentityRequest, options?: ChangeDataCaptureDestinationsActivateIdentityOptionalParams) => PollerLike<OperationState<ActivateChangeDataCaptureIdentityResult>, ActivateChangeDataCaptureIdentityResult>

Property Value

(resourceGroupName: string, ifMatch: string, clusterName: string, destinationName: string, body: ActivateChangeDataCaptureIdentityRequest, options?: ChangeDataCaptureDestinationsActivateIdentityOptionalParams) => PollerLike<OperationState<ActivateChangeDataCaptureIdentityResult>, ActivateChangeDataCaptureIdentityResult>

beginActivateIdentity

Warning

This API is now deprecated.

use activateIdentity instead

beginActivateIdentity: (resourceGroupName: string, ifMatch: string, clusterName: string, destinationName: string, body: ActivateChangeDataCaptureIdentityRequest, options?: ChangeDataCaptureDestinationsActivateIdentityOptionalParams) => Promise<SimplePollerLike<OperationState<ActivateChangeDataCaptureIdentityResult>, ActivateChangeDataCaptureIdentityResult>>

Property Value

(resourceGroupName: string, ifMatch: string, clusterName: string, destinationName: string, body: ActivateChangeDataCaptureIdentityRequest, options?: ChangeDataCaptureDestinationsActivateIdentityOptionalParams) => Promise<SimplePollerLike<OperationState<ActivateChangeDataCaptureIdentityResult>, ActivateChangeDataCaptureIdentityResult>>

beginActivateIdentityAndWait

Warning

This API is now deprecated.

use activateIdentity instead

beginActivateIdentityAndWait: (resourceGroupName: string, ifMatch: string, clusterName: string, destinationName: string, body: ActivateChangeDataCaptureIdentityRequest, options?: ChangeDataCaptureDestinationsActivateIdentityOptionalParams) => Promise<ActivateChangeDataCaptureIdentityResult>

Property Value

(resourceGroupName: string, ifMatch: string, clusterName: string, destinationName: string, body: ActivateChangeDataCaptureIdentityRequest, options?: ChangeDataCaptureDestinationsActivateIdentityOptionalParams) => Promise<ActivateChangeDataCaptureIdentityResult>

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, destinationName: string, resource: ChangeDataCaptureDestinationCreateOrUpdate, options?: ChangeDataCaptureDestinationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, resource: ChangeDataCaptureDestinationCreateOrUpdate, options?: ChangeDataCaptureDestinationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, destinationName: string, resource: ChangeDataCaptureDestinationCreateOrUpdate, options?: ChangeDataCaptureDestinationsCreateOrReplaceOptionalParams) => Promise<ChangeDataCaptureDestination>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, resource: ChangeDataCaptureDestinationCreateOrUpdate, options?: ChangeDataCaptureDestinationsCreateOrReplaceOptionalParams) => Promise<ChangeDataCaptureDestination>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, destinationName: string, properties: ChangeDataCaptureDestinationForPatchUpdateUpdate, options?: ChangeDataCaptureDestinationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, properties: ChangeDataCaptureDestinationForPatchUpdateUpdate, options?: ChangeDataCaptureDestinationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, destinationName: string, properties: ChangeDataCaptureDestinationForPatchUpdateUpdate, options?: ChangeDataCaptureDestinationsUpdateOptionalParams) => Promise<ChangeDataCaptureDestination>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, properties: ChangeDataCaptureDestinationForPatchUpdateUpdate, options?: ChangeDataCaptureDestinationsUpdateOptionalParams) => Promise<ChangeDataCaptureDestination>

createOrReplace

Creates or replaces a Microsoft Fabric change data capture destination.

createOrReplace: (resourceGroupName: string, clusterName: string, destinationName: string, resource: ChangeDataCaptureDestinationCreateOrUpdate, options?: ChangeDataCaptureDestinationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, resource: ChangeDataCaptureDestinationCreateOrUpdate, options?: ChangeDataCaptureDestinationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>

delete

Deletes a change data capture destination after all referencing configurations and identity assignments have been removed.

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

Property Value

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

get

Gets a change data capture destination.

get: (resourceGroupName: string, clusterName: string, destinationName: string, options?: ChangeDataCaptureDestinationsGetOptionalParams) => Promise<ChangeDataCaptureDestination>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, options?: ChangeDataCaptureDestinationsGetOptionalParams) => Promise<ChangeDataCaptureDestination>

list

Lists change data capture destinations in a HorizonDB cluster.

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

Property Value

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

update

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

update: (resourceGroupName: string, clusterName: string, destinationName: string, properties: ChangeDataCaptureDestinationForPatchUpdateUpdate, options?: ChangeDataCaptureDestinationsUpdateOptionalParams) => PollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, properties: ChangeDataCaptureDestinationForPatchUpdateUpdate, options?: ChangeDataCaptureDestinationsUpdateOptionalParams) => PollerLike<OperationState<ChangeDataCaptureDestination>, ChangeDataCaptureDestination>