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

vw_change_data_captures

Name	Datatype	Description
id	text	The resource identifier.
name	text	The resource name.
description	text	field from the properties object
allow_v_net_override	text	field from the properties object
changeDataCaptureName	text	field from the properties object
etag	text	Etag identifies change in the resource.
factoryName	text	field from the properties object
folder	text	field from the properties object
policy	text	field from the properties object
resourceGroupName	text	field from the properties object
source_connections_info	text	field from the properties object
status	text	field from the properties object
subscriptionId	text	field from the properties object
target_connections_info	text	field from the properties object
type	text	The resource type.

change_data_captures

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	A Azure Data Factory object which automatically detects data changes at the source and then sends the updated data to the destination.
type	string	The resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	changeDataCaptureName, factoryName, resourceGroupName, subscriptionId	Gets a change data capture.
list_by_factory	SELECT	factoryName, resourceGroupName, subscriptionId	Lists all resources of type change data capture.
create_or_update	INSERT	changeDataCaptureName, factoryName, resourceGroupName, subscriptionId, data__properties	Creates or updates a change data capture resource.
delete	DELETE	changeDataCaptureName, factoryName, resourceGroupName, subscriptionId	Deletes a change data capture.
start	EXEC	changeDataCaptureName, factoryName, resourceGroupName, subscriptionId	Starts a change data capture.
status	EXEC	changeDataCaptureName, factoryName, resourceGroupName, subscriptionId	Gets the current status for the change data capture resource.
stop	EXEC	changeDataCaptureName, factoryName, resourceGroupName, subscriptionId	Stops a change data capture.

SELECT examples

Lists all resources of type change data capture.

vw_change_data_captures

SELECT
id,
name,
description,
allow_v_net_override,
changeDataCaptureName,
etag,
factoryName,
folder,
policy,
resourceGroupName,
source_connections_info,
status,
subscriptionId,
target_connections_info,
type
FROM azure.data_factory.vw_change_data_captures
WHERE factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

change_data_captures

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

INSERT example

Use the following StackQL query and manifest file to create a new change_data_captures resource.

All Properties

/*+ create */
INSERT INTO azure.data_factory.change_data_captures (
changeDataCaptureName,
factoryName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ changeDataCaptureName }}',
'{{ factoryName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: etag
      value: string
    - name: properties
      value:
        - name: folder
          value:
            - name: name
              value: string
        - name: description
          value: string
        - name: sourceConnectionsInfo
          value:
            - - name: sourceEntities
                value:
                  - - name: name
                      value: string
                    - name: properties
                      value:
                        - name: schema
                          value:
                            - - name: name
                                value: string
                              - name: dataType
                                value: string
                        - name: dslConnectorProperties
                          value:
                            - - name: name
                                value: string
                              - name: value
                                value: object
              - name: connection
                value:
                  - name: linkedService
                    value:
                      - name: type
                        value: string
                      - name: referenceName
                        value: string
                      - name: parameters
                        value: []
                  - name: linkedServiceType
                    value: string
                  - name: type
                    value: string
                  - name: isInlineDataset
                    value: boolean
                  - name: commonDslConnectorProperties
                    value:
                      - - name: name
                          value: string
                        - name: value
                          value: object
        - name: targetConnectionsInfo
          value:
            - - name: targetEntities
                value:
                  - - name: name
                      value: string
              - name: dataMapperMappings
                value:
                  - - name: targetEntityName
                      value: string
                    - name: sourceEntityName
                      value: string
                    - name: sourceConnectionReference
                      value:
                        - name: connectionName
                          value: string
                        - name: type
                          value: string
                    - name: attributeMappingInfo
                      value:
                        - name: attributeMappings
                          value:
                            - - name: name
                                value: string
                              - name: type
                                value: string
                              - name: functionName
                                value: string
                              - name: expression
                                value: string
                              - name: attributeReference
                                value:
                                  - name: name
                                    value: string
                                  - name: entity
                                    value: string
                              - name: attributeReferences
                                value:
                                  - - name: name
                                      value: string
                                    - name: entity
                                      value: string
                    - name: sourceDenormalizeInfo
                      value: object
              - name: relationships
                value:
                  - object
        - name: policy
          value:
            - name: mode
              value: string
            - name: recurrence
              value:
                - name: frequency
                  value: string
                - name: interval
                  value: integer
        - name: allowVNetOverride
          value: boolean
        - name: status
          value: string

DELETE example

Deletes the specified change_data_captures resource.

/*+ delete */
DELETE FROM azure.data_factory.change_data_captures
WHERE changeDataCaptureName = '{{ changeDataCaptureName }}'
AND factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';