Package version:

Interface ChangeDataCapture

Interface representing a ChangeDataCapture.

interface ChangeDataCapture {
    createOrUpdate(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, changeDataCapture: ChangeDataCaptureResource, options?: ChangeDataCaptureCreateOrUpdateOptionalParams): Promise<ChangeDataCaptureResource>;
    delete(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureGetOptionalParams): Promise<ChangeDataCaptureResource>;
    listByFactory(resourceGroupName: string, factoryName: string, options?: ChangeDataCaptureListByFactoryOptionalParams): PagedAsyncIterableIterator<ChangeDataCaptureResource>;
    start(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureStartOptionalParams): Promise<void>;
    status(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureStatusOptionalParams): Promise<ChangeDataCaptureStatusResponse>;
    stop(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureStopOptionalParams): Promise<void>;
}

Methods

createOrUpdate(resourceGroupName, factoryName, changeDataCaptureName, changeDataCapture, options?): Promise<ChangeDataCaptureResource>
Creates or updates a change data capture resource.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- changeDataCaptureName: string
  The change data capture name.
- changeDataCapture: ChangeDataCaptureResource
  Change data capture resource definition.
- Optionaloptions: ChangeDataCaptureCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<ChangeDataCaptureResource>
- Defined in operationsInterfaces/changeDataCapture.ts:46

delete(resourceGroupName, factoryName, changeDataCaptureName, options?): Promise<void>
Deletes a change data capture.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- changeDataCaptureName: string
  The change data capture name.
- Optionaloptions: ChangeDataCaptureDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/changeDataCapture.ts:73

get(resourceGroupName, factoryName, changeDataCaptureName, options?): Promise<ChangeDataCaptureResource>
Gets a change data capture.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- changeDataCaptureName: string
  The change data capture name.
- Optionaloptions: ChangeDataCaptureGetOptionalParams
  The options parameters.
Returns Promise<ChangeDataCaptureResource>
- Defined in operationsInterfaces/changeDataCapture.ts:60

listByFactory(resourceGroupName, factoryName, options?): PagedAsyncIterableIterator<ChangeDataCaptureResource>
Lists all resources of type change data capture.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- Optionaloptions: ChangeDataCaptureListByFactoryOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<ChangeDataCaptureResource>
- Defined in operationsInterfaces/changeDataCapture.ts:33

start(resourceGroupName, factoryName, changeDataCaptureName, options?): Promise<void>
Starts a change data capture.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- changeDataCaptureName: string
  The change data capture name.
- Optionaloptions: ChangeDataCaptureStartOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/changeDataCapture.ts:86

status(resourceGroupName, factoryName, changeDataCaptureName, options?): Promise<ChangeDataCaptureStatusResponse>
Gets the current status for the change data capture resource.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- changeDataCaptureName: string
  The change data capture name.
- Optionaloptions: ChangeDataCaptureStatusOptionalParams
  The options parameters.
Returns Promise<ChangeDataCaptureStatusResponse>
- Defined in operationsInterfaces/changeDataCapture.ts:112

stop(resourceGroupName, factoryName, changeDataCaptureName, options?): Promise<void>
Stops a change data capture.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- changeDataCaptureName: string
  The change data capture name.
- Optionaloptions: ChangeDataCaptureStopOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/changeDataCapture.ts:99