change_data_capture

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

Overview

Name	change_data_capture
Type	Resource
Id	azure.data_factory.change_data_capture

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowVNetOverride	boolean	A boolean to determine if the vnet configuration needs to be overwritten.
description	string	The description of the change data capture.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
folder	object	The folder that this CDC is in. If not specified, CDC will appear at the root level.
policy	object	CDC policy. Required.
sourceConnectionsInfo	array	List of sources connections that can be used as sources in the CDC. Required.
status	string	Status of the CDC as to if it is running or stopped.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetConnectionsInfo	array	List of target connections that can be used as sources in the CDC. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_factory

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowVNetOverride	boolean	A boolean to determine if the vnet configuration needs to be overwritten.
description	string	The description of the change data capture.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
folder	object	The folder that this CDC is in. If not specified, CDC will appear at the root level.
policy	object	CDC policy. Required.
sourceConnectionsInfo	array	List of sources connections that can be used as sources in the CDC. Required.
status	string	Status of the CDC as to if it is running or stopped.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetConnectionsInfo	array	List of target connections that can be used as sources in the CDC. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, factory_name, change_data_capture_name, subscription_id		Gets a change data capture.
list_by_factory	select	resource_group_name, factory_name, subscription_id		Lists all resources of type change data capture.
create_or_update	insert	resource_group_name, factory_name, change_data_capture_name, subscription_id, properties		Creates or updates a change data capture resource.
create_or_update	replace	resource_group_name, factory_name, change_data_capture_name, subscription_id, properties		Creates or updates a change data capture resource.
delete	delete	resource_group_name, factory_name, change_data_capture_name, subscription_id		Deletes a change data capture.
start	exec	resource_group_name, factory_name, change_data_capture_name, subscription_id		Starts a change data capture.
stop	exec	resource_group_name, factory_name, change_data_capture_name, subscription_id		Stops a change data capture.
status	exec	resource_group_name, factory_name, change_data_capture_name, subscription_id		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
change_data_capture_name	string	The change data capture name. Required.
factory_name	string	The factory name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a change data capture.

SELECT
id,
name,
allowVNetOverride,
description,
etag,
folder,
policy,
sourceConnectionsInfo,
status,
systemData,
targetConnectionsInfo,
type
FROM azure.data_factory.change_data_capture
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND change_data_capture_name = '{{ change_data_capture_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_factory

Lists all resources of type change data capture.

SELECT
id,
name,
allowVNetOverride,
description,
etag,
folder,
policy,
sourceConnectionsInfo,
status,
systemData,
targetConnectionsInfo,
type
FROM azure.data_factory.change_data_capture
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a change data capture resource.

INSERT INTO azure.data_factory.change_data_capture (
properties,
resource_group_name,
factory_name,
change_data_capture_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ change_data_capture_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: change_data_capture
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the change_data_capture resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the change_data_capture resource.
  - name: change_data_capture_name
    value: "{{ change_data_capture_name }}"
    description: Required parameter for the change_data_capture resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the change_data_capture resource.
  - name: properties
    description: |
      Properties of the change data capture. Required.
    value:
      folder:
        name: "{{ name }}"
      description: "{{ description }}"
      sourceConnectionsInfo:
        - sourceEntities: "{{ sourceEntities }}"
          connection:
            linkedService:
              type: "{{ type }}"
              referenceName: "{{ referenceName }}"
              parameters: "{{ parameters }}"
            linkedServiceType: "{{ linkedServiceType }}"
            type: "{{ type }}"
            isInlineDataset: {{ isInlineDataset }}
            commonDslConnectorProperties:
              - name: "{{ name }}"
                value: "{{ value }}"
      targetConnectionsInfo:
        - targetEntities: "{{ targetEntities }}"
          connection:
            linkedService:
              type: "{{ type }}"
              referenceName: "{{ referenceName }}"
              parameters: "{{ parameters }}"
            linkedServiceType: "{{ linkedServiceType }}"
            type: "{{ type }}"
            isInlineDataset: {{ isInlineDataset }}
            commonDslConnectorProperties:
              - name: "{{ name }}"
                value: "{{ value }}"
          dataMapperMappings: "{{ dataMapperMappings }}"
          relationships: "{{ relationships }}"
      policy:
        mode: "{{ mode }}"
        recurrence:
          frequency: "{{ frequency }}"
          interval: {{ interval }}
      allowVNetOverride: {{ allowVNetOverride }}
      status: "{{ status }}"

REPLACE examples

create_or_update

Creates or updates a change data capture resource.

REPLACE azure.data_factory.change_data_capture
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND change_data_capture_name = '{{ change_data_capture_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a change data capture.

DELETE FROM azure.data_factory.change_data_capture
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND change_data_capture_name = '{{ change_data_capture_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts a change data capture.

EXEC azure.data_factory.change_data_capture.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@change_data_capture_name='{{ change_data_capture_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops a change data capture.

EXEC azure.data_factory.change_data_capture.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@change_data_capture_name='{{ change_data_capture_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

status

Gets the current status for the change data capture resource.

EXEC azure.data_factory.change_data_capture.status 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@change_data_capture_name='{{ change_data_capture_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;