azure-native.datafactory.getChangeDataCapture
Explore with Pulumi AI
Gets a change data capture. Azure REST API version: 2018-06-01.
Using getChangeDataCapture
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getChangeDataCapture(args: GetChangeDataCaptureArgs, opts?: InvokeOptions): Promise<GetChangeDataCaptureResult>
function getChangeDataCaptureOutput(args: GetChangeDataCaptureOutputArgs, opts?: InvokeOptions): Output<GetChangeDataCaptureResult>
def get_change_data_capture(change_data_capture_name: Optional[str] = None,
factory_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetChangeDataCaptureResult
def get_change_data_capture_output(change_data_capture_name: Optional[pulumi.Input[str]] = None,
factory_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetChangeDataCaptureResult]
func LookupChangeDataCapture(ctx *Context, args *LookupChangeDataCaptureArgs, opts ...InvokeOption) (*LookupChangeDataCaptureResult, error)
func LookupChangeDataCaptureOutput(ctx *Context, args *LookupChangeDataCaptureOutputArgs, opts ...InvokeOption) LookupChangeDataCaptureResultOutput
> Note: This function is named LookupChangeDataCapture
in the Go SDK.
public static class GetChangeDataCapture
{
public static Task<GetChangeDataCaptureResult> InvokeAsync(GetChangeDataCaptureArgs args, InvokeOptions? opts = null)
public static Output<GetChangeDataCaptureResult> Invoke(GetChangeDataCaptureInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetChangeDataCaptureResult> getChangeDataCapture(GetChangeDataCaptureArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:datafactory:getChangeDataCapture
arguments:
# arguments dictionary
The following arguments are supported:
- Change
Data stringCapture Name The change data capture name.
- Factory
Name string The factory name.
- Resource
Group stringName The resource group name.
- Change
Data stringCapture Name The change data capture name.
- Factory
Name string The factory name.
- Resource
Group stringName The resource group name.
- change
Data StringCapture Name The change data capture name.
- factory
Name String The factory name.
- resource
Group StringName The resource group name.
- change
Data stringCapture Name The change data capture name.
- factory
Name string The factory name.
- resource
Group stringName The resource group name.
- change_
data_ strcapture_ name The change data capture name.
- factory_
name str The factory name.
- resource_
group_ strname The resource group name.
- change
Data StringCapture Name The change data capture name.
- factory
Name String The factory name.
- resource
Group StringName The resource group name.
getChangeDataCapture Result
The following output properties are available:
- Etag string
Etag identifies change in the resource.
- Id string
The resource identifier.
- Name string
The resource name.
- Policy
Pulumi.
Azure Native. Data Factory. Outputs. Mapper Policy Response CDC policy
- Source
Connections List<Pulumi.Info Azure Native. Data Factory. Outputs. Mapper Source Connections Info Response> List of sources connections that can be used as sources in the CDC.
- Target
Connections List<Pulumi.Info Azure Native. Data Factory. Outputs. Mapper Target Connections Info Response> List of target connections that can be used as sources in the CDC.
- Type string
The resource type.
- Allow
VNet boolOverride A boolean to determine if the vnet configuration needs to be overwritten.
- Description string
The description of the change data capture.
- Folder
Pulumi.
Azure Native. Data Factory. Outputs. Change Data Capture Response Folder The folder that this CDC is in. If not specified, CDC will appear at the root level.
- Status string
Status of the CDC as to if it is running or stopped.
- Etag string
Etag identifies change in the resource.
- Id string
The resource identifier.
- Name string
The resource name.
- Policy
Mapper
Policy Response CDC policy
- Source
Connections []MapperInfo Source Connections Info Response List of sources connections that can be used as sources in the CDC.
- Target
Connections []MapperInfo Target Connections Info Response List of target connections that can be used as sources in the CDC.
- Type string
The resource type.
- Allow
VNet boolOverride A boolean to determine if the vnet configuration needs to be overwritten.
- Description string
The description of the change data capture.
- Folder
Change
Data Capture Response Folder The folder that this CDC is in. If not specified, CDC will appear at the root level.
- Status string
Status of the CDC as to if it is running or stopped.
- etag String
Etag identifies change in the resource.
- id String
The resource identifier.
- name String
The resource name.
- policy
Mapper
Policy Response CDC policy
- source
Connections List<MapperInfo Source Connections Info Response> List of sources connections that can be used as sources in the CDC.
- target
Connections List<MapperInfo Target Connections Info Response> List of target connections that can be used as sources in the CDC.
- type String
The resource type.
- allow
VNet BooleanOverride A boolean to determine if the vnet configuration needs to be overwritten.
- description String
The description of the change data capture.
- folder
Change
Data Capture Response Folder The folder that this CDC is in. If not specified, CDC will appear at the root level.
- status String
Status of the CDC as to if it is running or stopped.
- etag string
Etag identifies change in the resource.
- id string
The resource identifier.
- name string
The resource name.
- policy
Mapper
Policy Response CDC policy
- source
Connections MapperInfo Source Connections Info Response[] List of sources connections that can be used as sources in the CDC.
- target
Connections MapperInfo Target Connections Info Response[] List of target connections that can be used as sources in the CDC.
- type string
The resource type.
- allow
VNet booleanOverride A boolean to determine if the vnet configuration needs to be overwritten.
- description string
The description of the change data capture.
- folder
Change
Data Capture Response Folder The folder that this CDC is in. If not specified, CDC will appear at the root level.
- status string
Status of the CDC as to if it is running or stopped.
- etag str
Etag identifies change in the resource.
- id str
The resource identifier.
- name str
The resource name.
- policy
Mapper
Policy Response CDC policy
- source_
connections_ Sequence[Mapperinfo Source Connections Info Response] List of sources connections that can be used as sources in the CDC.
- target_
connections_ Sequence[Mapperinfo Target Connections Info Response] List of target connections that can be used as sources in the CDC.
- type str
The resource type.
- allow_
v_ boolnet_ override A boolean to determine if the vnet configuration needs to be overwritten.
- description str
The description of the change data capture.
- folder
Change
Data Capture Response Folder The folder that this CDC is in. If not specified, CDC will appear at the root level.
- status str
Status of the CDC as to if it is running or stopped.
- etag String
Etag identifies change in the resource.
- id String
The resource identifier.
- name String
The resource name.
- policy Property Map
CDC policy
- source
Connections List<Property Map>Info List of sources connections that can be used as sources in the CDC.
- target
Connections List<Property Map>Info List of target connections that can be used as sources in the CDC.
- type String
The resource type.
- allow
VNet BooleanOverride A boolean to determine if the vnet configuration needs to be overwritten.
- description String
The description of the change data capture.
- folder Property Map
The folder that this CDC is in. If not specified, CDC will appear at the root level.
- status String
Status of the CDC as to if it is running or stopped.
Supporting Types
ChangeDataCaptureResponseFolder
- Name string
The name of the folder that this CDC is in.
- Name string
The name of the folder that this CDC is in.
- name String
The name of the folder that this CDC is in.
- name string
The name of the folder that this CDC is in.
- name str
The name of the folder that this CDC is in.
- name String
The name of the folder that this CDC is in.
DataMapperMappingResponse
- Attribute
Mapping Pulumi.Info Azure Native. Data Factory. Inputs. Mapper Attribute Mappings Response This holds the user provided attribute mapping information.
- Source
Connection Pulumi.Reference Azure Native. Data Factory. Inputs. Mapper Connection Reference Response The connection reference for the source connection.
- Source
Denormalize objectInfo This holds the source denormalization information used while joining multiple sources.
- Source
Entity stringName Name of the source table
- Target
Entity stringName Name of the target table
- Attribute
Mapping MapperInfo Attribute Mappings Response This holds the user provided attribute mapping information.
- Source
Connection MapperReference Connection Reference Response The connection reference for the source connection.
- Source
Denormalize interface{}Info This holds the source denormalization information used while joining multiple sources.
- Source
Entity stringName Name of the source table
- Target
Entity stringName Name of the target table
- attribute
Mapping MapperInfo Attribute Mappings Response This holds the user provided attribute mapping information.
- source
Connection MapperReference Connection Reference Response The connection reference for the source connection.
- source
Denormalize ObjectInfo This holds the source denormalization information used while joining multiple sources.
- source
Entity StringName Name of the source table
- target
Entity StringName Name of the target table
- attribute
Mapping MapperInfo Attribute Mappings Response This holds the user provided attribute mapping information.
- source
Connection MapperReference Connection Reference Response The connection reference for the source connection.
- source
Denormalize anyInfo This holds the source denormalization information used while joining multiple sources.
- source
Entity stringName Name of the source table
- target
Entity stringName Name of the target table
- attribute_
mapping_ Mapperinfo Attribute Mappings Response This holds the user provided attribute mapping information.
- source_
connection_ Mapperreference Connection Reference Response The connection reference for the source connection.
- source_
denormalize_ Anyinfo This holds the source denormalization information used while joining multiple sources.
- source_
entity_ strname Name of the source table
- target_
entity_ strname Name of the target table
- attribute
Mapping Property MapInfo This holds the user provided attribute mapping information.
- source
Connection Property MapReference The connection reference for the source connection.
- source
Denormalize AnyInfo This holds the source denormalization information used while joining multiple sources.
- source
Entity StringName Name of the source table
- target
Entity StringName Name of the target table
LinkedServiceReferenceResponse
- Reference
Name string Reference LinkedService name.
- Type string
Linked service reference type.
- Parameters Dictionary<string, object>
Arguments for LinkedService.
- Reference
Name string Reference LinkedService name.
- Type string
Linked service reference type.
- Parameters map[string]interface{}
Arguments for LinkedService.
- reference
Name String Reference LinkedService name.
- type String
Linked service reference type.
- parameters Map<String,Object>
Arguments for LinkedService.
- reference
Name string Reference LinkedService name.
- type string
Linked service reference type.
- parameters {[key: string]: any}
Arguments for LinkedService.
- reference_
name str Reference LinkedService name.
- type str
Linked service reference type.
- parameters Mapping[str, Any]
Arguments for LinkedService.
- reference
Name String Reference LinkedService name.
- type String
Linked service reference type.
- parameters Map<Any>
Arguments for LinkedService.
MapperAttributeMappingResponse
- Attribute
Reference Pulumi.Azure Native. Data Factory. Inputs. Mapper Attribute Reference Response Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.
- Attribute
References List<Pulumi.Azure Native. Data Factory. Inputs. Mapper Attribute Reference Response> List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.
- Expression string
Expression used for 'Aggregate' and 'Derived' type mapping.
- Function
Name string Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.
- Name string
Name of the target column.
- Type string
Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.
- Attribute
Reference MapperAttribute Reference Response Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.
- Attribute
References []MapperAttribute Reference Response List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.
- Expression string
Expression used for 'Aggregate' and 'Derived' type mapping.
- Function
Name string Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.
- Name string
Name of the target column.
- Type string
Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.
- attribute
Reference MapperAttribute Reference Response Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.
- attribute
References List<MapperAttribute Reference Response> List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.
- expression String
Expression used for 'Aggregate' and 'Derived' type mapping.
- function
Name String Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.
- name String
Name of the target column.
- type String
Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.
- attribute
Reference MapperAttribute Reference Response Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.
- attribute
References MapperAttribute Reference Response[] List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.
- expression string
Expression used for 'Aggregate' and 'Derived' type mapping.
- function
Name string Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.
- name string
Name of the target column.
- type string
Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.
- attribute_
reference MapperAttribute Reference Response Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.
- attribute_
references Sequence[MapperAttribute Reference Response] List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.
- expression str
Expression used for 'Aggregate' and 'Derived' type mapping.
- function_
name str Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.
- name str
Name of the target column.
- type str
Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.
- attribute
Reference Property Map Reference of the source column used in the mapping. It is used for 'Direct' mapping type only.
- attribute
References List<Property Map> List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only.
- expression String
Expression used for 'Aggregate' and 'Derived' type mapping.
- function
Name String Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping.
- name String
Name of the target column.
- type String
Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'.
MapperAttributeMappingsResponse
- Attribute
Mappings List<Pulumi.Azure Native. Data Factory. Inputs. Mapper Attribute Mapping Response> List of attribute mappings.
- Attribute
Mappings []MapperAttribute Mapping Response List of attribute mappings.
- attribute
Mappings List<MapperAttribute Mapping Response> List of attribute mappings.
- attribute
Mappings MapperAttribute Mapping Response[] List of attribute mappings.
- attribute_
mappings Sequence[MapperAttribute Mapping Response] List of attribute mappings.
- attribute
Mappings List<Property Map> List of attribute mappings.
MapperAttributeReferenceResponse
- Entity string
Name of the table.
- Entity
Connection Pulumi.Reference Azure Native. Data Factory. Inputs. Mapper Connection Reference Response The connection reference for the connection.
- Name string
Name of the column.
- Entity string
Name of the table.
- Entity
Connection MapperReference Connection Reference Response The connection reference for the connection.
- Name string
Name of the column.
- entity String
Name of the table.
- entity
Connection MapperReference Connection Reference Response The connection reference for the connection.
- name String
Name of the column.
- entity string
Name of the table.
- entity
Connection MapperReference Connection Reference Response The connection reference for the connection.
- name string
Name of the column.
- entity str
Name of the table.
- entity_
connection_ Mapperreference Connection Reference Response The connection reference for the connection.
- name str
Name of the column.
- entity String
Name of the table.
- entity
Connection Property MapReference The connection reference for the connection.
- name String
Name of the column.
MapperConnectionReferenceResponse
- Connection
Name string Name of the connection
- Type string
Type of connection via linked service or dataset.
- Connection
Name string Name of the connection
- Type string
Type of connection via linked service or dataset.
- connection
Name String Name of the connection
- type String
Type of connection via linked service or dataset.
- connection
Name string Name of the connection
- type string
Type of connection via linked service or dataset.
- connection_
name str Name of the connection
- type str
Type of connection via linked service or dataset.
- connection
Name String Name of the connection
- type String
Type of connection via linked service or dataset.
MapperConnectionResponse
- Type string
Type of connection via linked service or dataset.
- Common
Dsl List<Pulumi.Connector Properties Azure Native. Data Factory. Inputs. Mapper Dsl Connector Properties Response> List of name/value pairs for connection properties.
- Is
Inline boolDataset A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.
- Linked
Service Pulumi.Azure Native. Data Factory. Inputs. Linked Service Reference Response Linked service reference.
- Linked
Service stringType Type of the linked service e.g.: AzureBlobFS.
- Type string
Type of connection via linked service or dataset.
- Common
Dsl []MapperConnector Properties Dsl Connector Properties Response List of name/value pairs for connection properties.
- Is
Inline boolDataset A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.
- Linked
Service LinkedService Reference Response Linked service reference.
- Linked
Service stringType Type of the linked service e.g.: AzureBlobFS.
- type String
Type of connection via linked service or dataset.
- common
Dsl List<MapperConnector Properties Dsl Connector Properties Response> List of name/value pairs for connection properties.
- is
Inline BooleanDataset A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.
- linked
Service LinkedService Reference Response Linked service reference.
- linked
Service StringType Type of the linked service e.g.: AzureBlobFS.
- type string
Type of connection via linked service or dataset.
- common
Dsl MapperConnector Properties Dsl Connector Properties Response[] List of name/value pairs for connection properties.
- is
Inline booleanDataset A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.
- linked
Service LinkedService Reference Response Linked service reference.
- linked
Service stringType Type of the linked service e.g.: AzureBlobFS.
- type str
Type of connection via linked service or dataset.
- common_
dsl_ Sequence[Mapperconnector_ properties Dsl Connector Properties Response] List of name/value pairs for connection properties.
- is_
inline_ booldataset A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.
- linked_
service LinkedService Reference Response Linked service reference.
- linked_
service_ strtype Type of the linked service e.g.: AzureBlobFS.
- type String
Type of connection via linked service or dataset.
- common
Dsl List<Property Map>Connector Properties List of name/value pairs for connection properties.
- is
Inline BooleanDataset A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported.
- linked
Service Property Map Linked service reference.
- linked
Service StringType Type of the linked service e.g.: AzureBlobFS.
MapperDslConnectorPropertiesResponse
MapperPolicyRecurrenceResponse
MapperPolicyResponse
- Mode string
Mode of running the CDC: batch vs continuous.
- Recurrence
Pulumi.
Azure Native. Data Factory. Inputs. Mapper Policy Recurrence Response Defines the frequency and interval for running the CDC for batch mode.
- Mode string
Mode of running the CDC: batch vs continuous.
- Recurrence
Mapper
Policy Recurrence Response Defines the frequency and interval for running the CDC for batch mode.
- mode String
Mode of running the CDC: batch vs continuous.
- recurrence
Mapper
Policy Recurrence Response Defines the frequency and interval for running the CDC for batch mode.
- mode string
Mode of running the CDC: batch vs continuous.
- recurrence
Mapper
Policy Recurrence Response Defines the frequency and interval for running the CDC for batch mode.
- mode str
Mode of running the CDC: batch vs continuous.
- recurrence
Mapper
Policy Recurrence Response Defines the frequency and interval for running the CDC for batch mode.
- mode String
Mode of running the CDC: batch vs continuous.
- recurrence Property Map
Defines the frequency and interval for running the CDC for batch mode.
MapperSourceConnectionsInfoResponse
- Connection
Pulumi.
Azure Native. Data Factory. Inputs. Mapper Connection Response Source connection details.
- Source
Entities List<Pulumi.Azure Native. Data Factory. Inputs. Mapper Table Response> List of source tables for a source connection.
- Connection
Mapper
Connection Response Source connection details.
- Source
Entities []MapperTable Response List of source tables for a source connection.
- connection
Mapper
Connection Response Source connection details.
- source
Entities List<MapperTable Response> List of source tables for a source connection.
- connection
Mapper
Connection Response Source connection details.
- source
Entities MapperTable Response[] List of source tables for a source connection.
- connection
Mapper
Connection Response Source connection details.
- source_
entities Sequence[MapperTable Response] List of source tables for a source connection.
- connection Property Map
Source connection details.
- source
Entities List<Property Map> List of source tables for a source connection.
MapperTableResponse
- Dsl
Connector List<Pulumi.Properties Azure Native. Data Factory. Inputs. Mapper Dsl Connector Properties Response> List of name/value pairs for connection properties.
- Name string
Name of the table.
- Schema
List<Pulumi.
Azure Native. Data Factory. Inputs. Mapper Table Schema Response> List of columns for the source table.
- Dsl
Connector []MapperProperties Dsl Connector Properties Response List of name/value pairs for connection properties.
- Name string
Name of the table.
- Schema
[]Mapper
Table Schema Response List of columns for the source table.
- dsl
Connector List<MapperProperties Dsl Connector Properties Response> List of name/value pairs for connection properties.
- name String
Name of the table.
- schema
List<Mapper
Table Schema Response> List of columns for the source table.
- dsl
Connector MapperProperties Dsl Connector Properties Response[] List of name/value pairs for connection properties.
- name string
Name of the table.
- schema
Mapper
Table Schema Response[] List of columns for the source table.
- dsl_
connector_ Sequence[Mapperproperties Dsl Connector Properties Response] List of name/value pairs for connection properties.
- name str
Name of the table.
- schema
Sequence[Mapper
Table Schema Response] List of columns for the source table.
- dsl
Connector List<Property Map>Properties List of name/value pairs for connection properties.
- name String
Name of the table.
- schema List<Property Map>
List of columns for the source table.
MapperTableSchemaResponse
MapperTargetConnectionsInfoResponse
- Connection
Pulumi.
Azure Native. Data Factory. Inputs. Mapper Connection Response Source connection details.
- Data
Mapper List<Pulumi.Mappings Azure Native. Data Factory. Inputs. Data Mapper Mapping Response> List of table mappings.
- Relationships List<object>
List of relationship info among the tables.
- Target
Entities List<Pulumi.Azure Native. Data Factory. Inputs. Mapper Table Response> List of source tables for a target connection.
- Connection
Mapper
Connection Response Source connection details.
- Data
Mapper []DataMappings Mapper Mapping Response List of table mappings.
- Relationships []interface{}
List of relationship info among the tables.
- Target
Entities []MapperTable Response List of source tables for a target connection.
- connection
Mapper
Connection Response Source connection details.
- data
Mapper List<DataMappings Mapper Mapping Response> List of table mappings.
- relationships List<Object>
List of relationship info among the tables.
- target
Entities List<MapperTable Response> List of source tables for a target connection.
- connection
Mapper
Connection Response Source connection details.
- data
Mapper DataMappings Mapper Mapping Response[] List of table mappings.
- relationships any[]
List of relationship info among the tables.
- target
Entities MapperTable Response[] List of source tables for a target connection.
- connection
Mapper
Connection Response Source connection details.
- data_
mapper_ Sequence[Datamappings Mapper Mapping Response] List of table mappings.
- relationships Sequence[Any]
List of relationship info among the tables.
- target_
entities Sequence[MapperTable Response] List of source tables for a target connection.
- connection Property Map
Source connection details.
- data
Mapper List<Property Map>Mappings List of table mappings.
- relationships List<Any>
List of relationship info among the tables.
- target
Entities List<Property Map> List of source tables for a target connection.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0