ChangeDataCapture interface
Interface representing a ChangeDataCapture.
Methods
| create |
Creates or updates a change data capture resource. |
| delete(string, string, string, Change |
Deletes a change data capture. |
| get(string, string, string, Change |
Gets a change data capture. |
| list |
Lists all resources of type change data capture. |
| start(string, string, string, Change |
Starts a change data capture. |
| status(string, string, string, Change |
Gets the current status for the change data capture resource. |
| stop(string, string, string, Change |
Stops a change data capture. |
Method Details
createOrUpdate(string, string, string, ChangeDataCaptureResource, ChangeDataCaptureCreateOrUpdateOptionalParams)
Creates or updates a change data capture resource.
function createOrUpdate(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, changeDataCapture: ChangeDataCaptureResource, options?: ChangeDataCaptureCreateOrUpdateOptionalParams): Promise<ChangeDataCaptureResource>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.
The options parameters.
Returns
Promise<ChangeDataCaptureResource>
delete(string, string, string, ChangeDataCaptureDeleteOptionalParams)
Deletes a change data capture.
function delete(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- changeDataCaptureName
-
string
The change data capture name.
The options parameters.
Returns
Promise<void>
get(string, string, string, ChangeDataCaptureGetOptionalParams)
Gets a change data capture.
function get(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureGetOptionalParams): Promise<ChangeDataCaptureResource>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- changeDataCaptureName
-
string
The change data capture name.
The options parameters.
Returns
Promise<ChangeDataCaptureResource>
listByFactory(string, string, ChangeDataCaptureListByFactoryOptionalParams)
Lists all resources of type change data capture.
function listByFactory(resourceGroupName: string, factoryName: string, options?: ChangeDataCaptureListByFactoryOptionalParams): PagedAsyncIterableIterator<ChangeDataCaptureResource, ChangeDataCaptureResource[], PageSettings>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
The options parameters.
Returns
start(string, string, string, ChangeDataCaptureStartOptionalParams)
Starts a change data capture.
function start(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- changeDataCaptureName
-
string
The change data capture name.
The options parameters.
Returns
Promise<void>
status(string, string, string, ChangeDataCaptureStatusOptionalParams)
Gets the current status for the change data capture resource.
function status(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureStatusOptionalParams): Promise<ChangeDataCaptureStatusResponse>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- changeDataCaptureName
-
string
The change data capture name.
The options parameters.
Returns
Promise<ChangeDataCaptureStatusResponse>
stop(string, string, string, ChangeDataCaptureStopOptionalParams)
Stops a change data capture.
function stop(resourceGroupName: string, factoryName: string, changeDataCaptureName: string, options?: ChangeDataCaptureStopOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- changeDataCaptureName
-
string
The change data capture name.
The options parameters.
Returns
Promise<void>