change_data_captures

Creates, updates, deletes, gets or lists a change_data_captures resource.

Overview

Name	change_data_captures
Type	Resource
Id	azure.data_factory.change_data_captures

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Properties of the change data capture.
type	string	The resource type.

list_by_factory

OK.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Properties of the change data capture.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName, changeDataCaptureName	api-version, If-None-Match	Gets a change data capture.
list_by_factory	select	subscriptionId, resourceGroupName, factoryName	api-version	Lists all resources of type change data capture.
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, changeDataCaptureName, data__properties	api-version, If-Match	Creates or updates a change data capture resource.
delete	delete	subscriptionId, resourceGroupName, factoryName, changeDataCaptureName	api-version	Deletes a change data capture.
start	exec	subscriptionId, resourceGroupName, factoryName, changeDataCaptureName	api-version	Starts a change data capture.
stop	exec	subscriptionId, resourceGroupName, factoryName, changeDataCaptureName	api-version	Stops a change data capture.
status	exec	subscriptionId, resourceGroupName, factoryName, changeDataCaptureName	api-version	Gets the current status for the change data capture resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
changeDataCaptureName	string	The change data capture name.
factoryName	string	The factory name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
If-Match	string	ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
If-None-Match	string	ETag of the change data capture entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
api-version	string	The API version.

SELECT examples

get

Gets a change data capture.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.change_data_captures
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND changeDataCaptureName = '{{ changeDataCaptureName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_factory

Lists all resources of type change data capture.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.change_data_captures
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates a change data capture resource.

INSERT INTO azure.data_factory.change_data_captures (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
changeDataCaptureName,
api-version,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ changeDataCaptureName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: change_data_captures
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the change_data_captures resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the change_data_captures resource.
    - name: factoryName
      value: string
      description: Required parameter for the change_data_captures resource.
    - name: changeDataCaptureName
      value: string
      description: Required parameter for the change_data_captures resource.
    - name: properties
      value: object
      description: |
        Properties of the change data capture.
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      description: ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

DELETE examples

delete

Deletes a change data capture.

DELETE FROM azure.data_factory.change_data_captures
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND changeDataCaptureName = '{{ changeDataCaptureName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

start

Starts a change data capture.

EXEC azure.data_factory.change_data_captures.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@changeDataCaptureName='{{ changeDataCaptureName }}' --required, 
@api-version='{{ api-version }}'
;

stop

Stops a change data capture.

EXEC azure.data_factory.change_data_captures.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@changeDataCaptureName='{{ changeDataCaptureName }}' --required, 
@api-version='{{ api-version }}'
;

status

Gets the current status for the change data capture resource.

EXEC azure.data_factory.change_data_captures.status 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@changeDataCaptureName='{{ changeDataCaptureName }}' --required, 
@api-version='{{ api-version }}'
;