Change Data Capture - List By Factory
Een lijst met alle resources van het type wijzigingsgegevens vastleggen.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs?api-version=2018-06-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
factory
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ |
De naam van de fabriek. |
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
De naam van de resourcegroep. |
subscription
|
path | True |
string |
De abonnement-ID. |
api-version
|
query | True |
string |
De API-versie. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Er is een foutbericht ontvangen van de Azure Data Factory-service. |
Beveiliging
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
ChangeDataCapture_ListByFactory
Voorbeeldaanvraag
Voorbeeldrespons
Date: Wed, 22 Mar 2023 07:08:51 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11987
x-ms-request-id: a5826b1d-da46-4283-9784-c630392136ce
x-ms-correlation-request-id: a5826b1d-da46-4283-9784-c630392136ce
{
"value": [
{
"id": "/subscriptions/d3bb3b2e-9a7e-4194-9960-5171bd192117/resourceGroups/amja-rg-03/providers/Microsoft.DataFactory/factories/amja-adf-04/adfcdcs/exampleChangeDataCapture",
"name": "exampleChangeDataCapture",
"type": "Microsoft.DataFactory/factories/adfcdcs",
"properties": {
"description": "Sample demo change data capture to transfer data from delimited (csv) to Azure SQL Database with automapped and non-automapped mappings.",
"SourceConnectionsInfo": [
{
"SourceEntities": [
{
"name": "source/customer",
"properties": {
"schema": [],
"dslConnectorProperties": [
{
"name": "container",
"value": "source"
},
{
"name": "fileSystem",
"value": "source"
},
{
"name": "folderPath",
"value": "customer"
}
]
}
},
{
"name": "source/employee",
"properties": {
"schema": [],
"dslConnectorProperties": [
{
"name": "container",
"value": "source"
},
{
"name": "fileSystem",
"value": "source"
},
{
"name": "folderPath",
"value": "employee"
}
]
}
},
{
"name": "lookup",
"properties": {
"schema": [
{
"name": "EmpId",
"dataType": "short"
},
{
"name": "EmpName",
"dataType": "string"
},
{
"name": "HomeAddress",
"dataType": "string"
},
{
"name": "OfficeAddress",
"dataType": "string"
},
{
"name": "EmpPhoneNumber",
"dataType": "integer"
},
{
"name": "DepName",
"dataType": "string"
},
{
"name": "DepLoc",
"dataType": "string"
},
{
"name": "DecimalCol",
"dataType": "double"
}
],
"dslConnectorProperties": [
{
"name": "container",
"value": "lookup"
},
{
"name": "fileSystem",
"value": "lookup"
},
{
"name": "allowSchemaDrift",
"value": false
},
{
"name": "inferDriftedColumnTypes",
"value": false
}
]
}
},
{
"name": "source/justSchema",
"properties": {
"schema": [
{
"name": "CustId",
"dataType": "string"
},
{
"name": "CustName",
"dataType": "string"
},
{
"name": "CustAddres",
"dataType": "string"
},
{
"name": "CustDepName",
"dataType": "string"
},
{
"name": "CustDepLoc",
"dataType": "string"
}
],
"dslConnectorProperties": [
{
"name": "container",
"value": "source"
},
{
"name": "fileSystem",
"value": "source"
},
{
"name": "folderPath",
"value": "justSchema"
},
{
"name": "allowSchemaDrift",
"value": false
},
{
"name": "inferDriftedColumnTypes",
"value": false
}
]
}
}
],
"Connection": {
"linkedService": {
"referenceName": "amjaAdls03",
"type": "LinkedServiceReference"
},
"linkedServiceType": "AzureBlobFS",
"type": "linkedservicetype",
"isInlineDataset": true,
"commonDslConnectorProperties": [
{
"name": "allowSchemaDrift",
"value": true
},
{
"name": "inferDriftedColumnTypes",
"value": true
},
{
"name": "format",
"value": "delimited"
},
{
"name": "dateFormats",
"value": [
"MM/dd/yyyy",
"dd/MM/yyyy",
"yyyy/MM/dd",
"MM-dd-yyyy",
"dd-MM-yyyy",
"yyyy-MM-dd",
"dd.MM.yyyy",
"MM.dd.yyyy",
"yyyy.MM.dd"
]
},
{
"name": "timestampFormats",
"value": [
"yyyyMMddHHmm",
"yyyyMMdd HHmm",
"yyyyMMddHHmmss",
"yyyyMMdd HHmmss",
"dd-MM-yyyy HH:mm:ss",
"dd-MM-yyyy HH:mm",
"yyyy-M-d H:m:s",
"yyyy-MM-dd\\'T\\'HH:mm:ss\\'Z\\'",
"yyyy-M-d\\'T\\'H:m:s\\'Z\\'",
"yyyy-M-d\\'T\\'H:m:s",
"yyyy-MM-dd\\'T\\'HH:mm:ss",
"yyyy-MM-dd HH:mm:ss",
"yyyy-MM-dd HH:mm",
"yyyy.MM.dd HH:mm:ss",
"MM/dd/yyyy HH:mm:ss",
"M/d/yyyy H:m:s",
"yyyy/MM/dd HH:mm:ss",
"yyyy/M/d H:m:s",
"dd MMM yyyy HH:mm:ss",
"dd MMMM yyyy HH:mm:ss",
"d MMM yyyy H:m:s",
"d MMMM yyyy H:m:s",
"d-M-yyyy H:m:s",
"d-M-yyyy H:m",
"yyyy-M-d H:m",
"MM/dd/yyyy HH:mm",
"M/d/yyyy H:m",
"yyyy/MM/dd HH:mm",
"yyyy/M/d H:m",
"dd MMMM yyyy HH:mm",
"dd MMM yyyy HH:mm",
"d MMMM yyyy H:m",
"d MMM yyyy H:m",
"MM-dd-yyyy hh:mm:ss a",
"MM-dd-yyyy HH:mm:ss",
"MM/dd/yyyy hh:mm:ss a",
"yyyy.MM.dd hh:mm:ss a",
"MM/dd/yyyy",
"dd/MM/yyyy",
"yyyy/MM/dd",
"MM-dd-yyyy",
"dd-MM-yyyy",
"yyyy-MM-dd",
"dd.MM.yyyy",
"MM.dd.yyyy",
"yyyy.MM.dd"
]
},
{
"name": "enableCdc",
"value": true
},
{
"name": "skipInitialLoad",
"value": true
},
{
"name": "columnNamesAsHeader",
"value": true
},
{
"name": "columnDelimiter",
"value": ","
},
{
"name": "escapeChar",
"value": "\\\\"
},
{
"name": "quoteChar",
"value": "\\\""
}
]
}
}
],
"TargetConnectionsInfo": [
{
"TargetEntities": [
{
"name": "dbo.employee",
"properties": {
"schema": [],
"dslConnectorProperties": [
{
"name": "schemaName",
"value": "dbo"
},
{
"name": "tableName",
"value": "employee"
}
]
}
},
{
"name": "dbo.justSchema",
"properties": {
"schema": [],
"dslConnectorProperties": [
{
"name": "schemaName",
"value": "dbo"
},
{
"name": "tableName",
"value": "justSchema"
},
{
"name": "allowSchemaDrift",
"value": true
},
{
"name": "inferDriftedColumnTypes",
"value": true
}
]
}
},
{
"name": "dbo.customer",
"properties": {
"schema": [],
"dslConnectorProperties": [
{
"name": "schemaName",
"value": "dbo"
},
{
"name": "tableName",
"value": "customer"
}
]
}
},
{
"name": "dbo.data_source_table",
"properties": {
"schema": [
{
"name": "PersonID",
"dataType": "integer"
},
{
"name": "Name",
"dataType": "string"
},
{
"name": "LastModifytime",
"dataType": "timestamp"
}
],
"dslConnectorProperties": [
{
"name": "schemaName",
"value": "dbo"
},
{
"name": "tableName",
"value": "data_source_table"
},
{
"name": "allowSchemaDrift",
"value": false
},
{
"name": "inferDriftedColumnTypes",
"value": false
},
{
"name": "defaultToUpsert",
"value": false
}
]
}
}
],
"Connection": {
"linkedService": {
"referenceName": "amjaSql",
"type": "LinkedServiceReference"
},
"linkedServiceType": "AzureSqlDatabase",
"type": "linkedservicetype",
"isInlineDataset": true,
"commonDslConnectorProperties": [
{
"name": "allowSchemaDrift",
"value": true
},
{
"name": "inferDriftedColumnTypes",
"value": true
},
{
"name": "format",
"value": "table"
},
{
"name": "store",
"value": "sqlserver"
},
{
"name": "databaseType",
"value": "databaseType"
},
{
"name": "database",
"value": "database"
},
{
"name": "deletable",
"value": false
},
{
"name": "insertable",
"value": true
},
{
"name": "updateable",
"value": false
},
{
"name": "upsertable",
"value": false
},
{
"name": "skipDuplicateMapInputs",
"value": true
},
{
"name": "skipDuplicateMapOutputs",
"value": true
}
]
},
"DataMapperMappings": [
{
"targetEntityName": "dbo.customer",
"sourceEntityName": "source/customer",
"sourceConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
},
"attributeMappingInfo": {
"attributeMappings": []
}
},
{
"targetEntityName": "dbo.data_source_table",
"sourceEntityName": "lookup",
"sourceConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
},
"attributeMappingInfo": {
"attributeMappings": [
{
"name": "Name",
"type": "Derived",
"functionName": "upper",
"expression": "upper(EmpName)",
"attributeReferences": [
{
"name": "EmpName",
"entity": "lookup",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
}
]
},
{
"name": "PersonID",
"type": "Direct",
"functionName": "",
"attributeReference": {
"name": "EmpId",
"entity": "lookup",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
}
}
]
}
},
{
"targetEntityName": "dbo.employee",
"sourceEntityName": "source/employee",
"sourceConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
},
"attributeMappingInfo": {
"attributeMappings": []
}
},
{
"targetEntityName": "dbo.justSchema",
"sourceEntityName": "source/justSchema",
"sourceConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
},
"attributeMappingInfo": {
"attributeMappings": [
{
"name": "CustAddres",
"type": "Derived",
"functionName": "trim",
"expression": "trim(CustAddres)",
"attributeReferences": [
{
"name": "CustAddres",
"entity": "source/justSchema",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
}
]
},
{
"name": "CustDepLoc",
"type": "Direct",
"attributeReference": {
"name": "CustDepLoc",
"entity": "source/justSchema",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
}
},
{
"name": "CustDepName",
"type": "Derived",
"functionName": "",
"expression": "concat(CustName, \" -> \", CustDepName)",
"attributeReferences": [
{
"name": "CustName",
"entity": "source/justSchema",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
},
{
"name": "CustDepName",
"entity": "source/justSchema",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
}
]
},
{
"name": "CustId",
"type": "Direct",
"functionName": "",
"attributeReference": {
"name": "CustId",
"entity": "source/justSchema",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
}
},
{
"name": "CustName",
"type": "Direct",
"attributeReference": {
"name": "CustName",
"entity": "source/justSchema",
"entityConnectionReference": {
"connectionName": "amjaAdls03",
"type": "linkedservicetype"
}
}
}
]
}
}
],
"Relationships": []
}
],
"Policy": {
"recurrence": {
"frequency": "Minute",
"interval": 15
},
"mode": "Microbatch"
},
"status": "Stopped",
"allowVNetOverride": false
},
"etag": "4200eefe-0000-0100-0000-641aa97a0000"
}
]
}
Definities
Name | Description |
---|---|
Change |
Een lijst met resources voor het vastleggen van gegevens wijzigen. |
Change |
Resourcetype voor gegevensopname wijzigen. |
Cloud |
Het object dat de structuur van een Azure Data Factory-foutreactie definieert. |
Connection |
Type verbinding via gekoppelde service of gegevensset. |
Data |
Details van bron- en doeltabeltoewijzing. |
Folder |
De map waarin deze CDC zich bevindt. Als dit niet is opgegeven, wordt CDC weergegeven op het hoofdniveau. |
Frequency |
Frequentie van de periode in termen van 'Uur', 'Minuut' of 'Seconde'. |
Linked |
Verwijzingstype voor gekoppelde service. |
Mapper |
Details van bron- en doelkolomtoewijzing. |
Mapper |
Details van kenmerktoewijzing. |
Mapper |
Details van kenmerkreferenties voor de kolom waarnaar wordt verwezen. |
Mapper |
Details van bronverbinding. |
Mapper |
Referentiegegevens voor bron- of doelverbinding. |
Mapper |
Connectoreigenschappen van een CDC-tabel in termen van naam-/waardeparen. |
Mapper |
CDC-beleid. |
Mapper |
Details van terugkeerpatroon cdc-beleid. |
Mapper |
Een object met een lijst met tabellen en verbindingsgegevens voor een bronverbinding. |
Mapper |
Details van CDC-tabellen. |
Mapper |
Schema van een CDC-tabel in termen van kolomnamen en de bijbehorende gegevenstypen. |
Mapper |
Een object met een lijst met tabellen en verbindingsgegevens voor een doelverbinding. |
Mapping |
Type van de toewijzing van cdc-kenmerken. Opmerking: het toewijzingstype Geavanceerd wordt ook opgeslagen als 'Afgeleid'. |
Type |
Verwijzingstype voor gekoppelde service. |
ChangeDataCaptureListResponse
Een lijst met resources voor het vastleggen van gegevens wijzigen.
Name | Type | Description |
---|---|---|
nextLink |
string |
De koppeling naar de volgende pagina met resultaten, als er nog resterende resultaten bestaan. |
value |
Een lijst met alle resources van het type wijzigingsgegevens vastleggen. |
ChangeDataCaptureResource
Resourcetype voor gegevensopname wijzigen.
Name | Type | Description |
---|---|---|
etag |
string |
Etag identificeert de wijziging in de resource. |
id |
string |
De resource-id. |
name |
string |
De resourcenaam. |
properties.allowVNetOverride |
boolean |
Een Booleaanse waarde om te bepalen of de vnet-configuratie moet worden overschreven. |
properties.description |
string |
De beschrijving van de wijzigingsgegevensopname. |
properties.folder |
De map waarin deze CDC zich bevindt. Als dit niet is opgegeven, wordt CDC weergegeven op het hoofdniveau. |
|
properties.policy |
CDC-beleid |
|
properties.sourceConnectionsInfo |
Lijst met bronnenverbindingen die kunnen worden gebruikt als bronnen in het CDC. |
|
properties.status |
string |
Status van het CDC alsof deze wordt uitgevoerd of gestopt. |
properties.targetConnectionsInfo |
Lijst met doelverbindingen die kunnen worden gebruikt als bronnen in het CDC. |
|
type |
string |
Het resourcetype. |
CloudError
Het object dat de structuur van een Azure Data Factory-foutreactie definieert.
Name | Type | Description |
---|---|---|
error.code |
string |
Foutcode. |
error.details |
Matrix met aanvullende foutdetails. |
|
error.message |
string |
Foutmelding. |
error.target |
string |
Eigenschapsnaam/pad in aanvraag die is gekoppeld aan een fout. |
ConnectionType
Type verbinding via gekoppelde service of gegevensset.
Waarde | Description |
---|---|
linkedservicetype |
DataMapperMapping
Details van bron- en doeltabeltoewijzing.
Name | Type | Description |
---|---|---|
attributeMappingInfo |
Dit bevat de door de gebruiker verstrekte kenmerktoewijzingsgegevens. |
|
sourceConnectionReference |
De verbindingsreferentie voor de bronverbinding. |
|
sourceDenormalizeInfo |
object |
Dit bevat de brondenormalisatie-informatie die wordt gebruikt tijdens het samenvoegen van meerdere bronnen. |
sourceEntityName |
string |
Naam van de brontabel |
targetEntityName |
string |
Naam van de doeltabel |
Folder
De map waarin deze CDC zich bevindt. Als dit niet is opgegeven, wordt CDC weergegeven op het hoofdniveau.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de map waarin deze CDC zich bevindt. |
FrequencyType
Frequentie van de periode in termen van 'Uur', 'Minuut' of 'Seconde'.
Waarde | Description |
---|---|
Hour | |
Minute | |
Second |
LinkedServiceReference
Verwijzingstype voor gekoppelde service.
Name | Type | Description |
---|---|---|
parameters |
object |
Argumenten voor LinkedService. |
referenceName |
string |
Verwijzing naar de naam van LinkedService. |
type |
Verwijzingstype voor gekoppelde service. |
MapperAttributeMapping
Details van bron- en doelkolomtoewijzing.
Name | Type | Description |
---|---|---|
attributeReference |
Verwijzing naar de bronkolom die in de toewijzing wordt gebruikt. Het wordt alleen gebruikt voor het toewijzingstype Direct. |
|
attributeReferences |
Lijst met verwijzingen voor bronkolommen. Het wordt alleen gebruikt voor toewijzingen van het type 'Afgeleide' en 'Aggregatie'. |
|
expression |
string |
Expressie die wordt gebruikt voor de toewijzing van het type 'Aggregate' en 'Derived'. |
functionName |
string |
Naam van de functie die wordt gebruikt voor de toewijzing van het type Aggregatie en Afgeleide (met uitzondering van Geavanceerd). |
name |
string |
Naam van de doelkolom. |
type |
Type van de toewijzing van cdc-kenmerken. Opmerking: het toewijzingstype Geavanceerd wordt ook opgeslagen als 'Afgeleid'. |
MapperAttributeMappings
Details van kenmerktoewijzing.
Name | Type | Description |
---|---|---|
attributeMappings |
Lijst met kenmerktoewijzingen. |
MapperAttributeReference
Details van kenmerkreferenties voor de kolom waarnaar wordt verwezen.
Name | Type | Description |
---|---|---|
entity |
string |
Naam van de tabel. |
entityConnectionReference |
De verbindingsreferentie voor de verbinding. |
|
name |
string |
Naam van de kolom. |
MapperConnection
Details van bronverbinding.
Name | Type | Description |
---|---|---|
commonDslConnectorProperties |
Lijst met naam-/waardeparen voor verbindingseigenschappen. |
|
isInlineDataset |
boolean |
Een Booleaanse waarde die aangeeft of de gekoppelde service van het type inlinegegevensset is. Momenteel worden alleen inlinegegevenssets ondersteund. |
linkedService |
Naslaginformatie over gekoppelde services. |
|
linkedServiceType |
string |
Type van de gekoppelde service, bijvoorbeeld: AzureBlobFS. |
type |
Type verbinding via gekoppelde service of gegevensset. |
MapperConnectionReference
Referentiegegevens voor bron- of doelverbinding.
Name | Type | Description |
---|---|---|
connectionName |
string |
Naam van de verbinding |
type |
Type verbinding via gekoppelde service of gegevensset. |
MapperDslConnectorProperties
Connectoreigenschappen van een CDC-tabel in termen van naam-/waardeparen.
Name | Type | Description |
---|---|---|
name |
string |
Naam van de eigenschap. |
value |
object |
Waarde van de eigenschap. |
MapperPolicy
CDC-beleid.
Name | Type | Description |
---|---|---|
mode |
string |
Modus van het uitvoeren van de CDC: batch versus continue. |
recurrence |
Hiermee definieert u de frequentie en het interval voor het uitvoeren van de CDC voor de batchmodus. |
MapperPolicyRecurrence
Details van terugkeerpatroon cdc-beleid.
Name | Type | Description |
---|---|---|
frequency |
Frequentie van de periode in termen van 'Uur', 'Minuut' of 'Seconde'. |
|
interval |
integer (int32) |
De werkelijke intervalwaarde volgens de gekozen frequentie. |
MapperSourceConnectionsInfo
Een object met een lijst met tabellen en verbindingsgegevens voor een bronverbinding.
Name | Type | Description |
---|---|---|
connection |
Details van bronverbinding. |
|
sourceEntities |
Lijst met brontabellen voor een bronverbinding. |
MapperTable
Details van CDC-tabellen.
Name | Type | Description |
---|---|---|
name |
string |
Naam van de tabel. |
properties.dslConnectorProperties |
Lijst met naam-/waardeparen voor verbindingseigenschappen. |
|
properties.schema |
Lijst met kolommen voor de brontabel. |
MapperTableSchema
Schema van een CDC-tabel in termen van kolomnamen en de bijbehorende gegevenstypen.
Name | Type | Description |
---|---|---|
dataType |
string |
Gegevenstype van de kolom. |
name |
string |
Naam van de kolom. |
MapperTargetConnectionsInfo
Een object met een lijst met tabellen en verbindingsgegevens voor een doelverbinding.
Name | Type | Description |
---|---|---|
connection |
Details van bronverbinding. |
|
dataMapperMappings |
Lijst met tabeltoewijzingen. |
|
relationships |
object[] |
Lijst met relatiegegevens tussen de tabellen. |
targetEntities |
Lijst met brontabellen voor een doelverbinding. |
MappingType
Type van de toewijzing van cdc-kenmerken. Opmerking: het toewijzingstype Geavanceerd wordt ook opgeslagen als 'Afgeleid'.
Waarde | Description |
---|---|
Aggregate | |
Derived | |
Direct |
Type
Verwijzingstype voor gekoppelde service.
Waarde | Description |
---|---|
LinkedServiceReference |