Change Data Capture - List By Factory
Lista todos os recursos da captura de dados de alteração de tipo.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs?api-version=2018-06-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
factory
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ |
O nome da fábrica. |
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
O nome do grupo de recursos. |
subscription
|
path | True |
string |
O identificador da assinatura. |
api-version
|
query | True |
string |
A versão da API. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OKEY. |
|
Other Status Codes |
Uma resposta de erro recebida do serviço Azure Data Factory. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
ChangeDataCapture_ListByFactory
Solicitação de exemplo
Resposta de exemplo
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"
}
]
}
Definições
Nome | Description |
---|---|
Change |
Uma lista de recursos de captura de dados de alteração. |
Change |
Alterar o tipo de recurso de captura de dados. |
Cloud |
O objeto que define a estrutura de uma resposta de erro do Azure Data Factory. |
Connection |
Tipo de conexão por meio de serviço vinculado ou conjunto de dados. |
Data |
Detalhes de mapeamento de tabela de origem e de destino. |
Folder |
A pasta na qual este CDC está. Se não for especificado, CDC aparecerá no nível raiz. |
Frequency |
Frequência do período em termos de 'Hora', 'Minuto' ou 'Segundo'. |
Linked |
Tipo de referência de serviço vinculado. |
Mapper |
Detalhes do mapeamento de coluna de origem e de destino. |
Mapper |
Detalhes do mapeamento de atributo. |
Mapper |
Detalhes de referência de atributo para a coluna referenciada. |
Mapper |
Detalhes da conexão de origem. |
Mapper |
Detalhes de referência de conexão de origem ou de destino. |
Mapper |
Propriedades do conector de uma tabela CDC em termos de pares nome/valor. |
Mapper |
Política CDC. |
Mapper |
Detalhes de recorrência da política CDC. |
Mapper |
Um objeto que contém uma lista de tabelas e detalhes de conexão para uma conexão de origem. |
Mapper |
Detalhes da tabela CDC. |
Mapper |
Esquema de uma tabela CDC em termos de nomes de coluna e seus tipos de dados correspondentes. |
Mapper |
Um objeto que contém uma lista de tabelas e detalhes de conexão para uma conexão de destino. |
Mapping |
Tipo do mapeamento de atributo CDC. Observação: o tipo de mapeamento 'Avançado' também é salvo como 'Derivado'. |
Type |
Tipo de referência de serviço vinculado. |
ChangeDataCaptureListResponse
Uma lista de recursos de captura de dados de alteração.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
O link para a próxima página de resultados, se houver resultados restantes. |
value |
Lista todos os recursos da captura de dados de alteração de tipo. |
ChangeDataCaptureResource
Alterar o tipo de recurso de captura de dados.
Nome | Tipo | Description |
---|---|---|
etag |
string |
A etag identifica a alteração no recurso. |
id |
string |
O identificador de recurso. |
name |
string |
O nome do recurso. |
properties.allowVNetOverride |
boolean |
Um booliano para determinar se a configuração da vnet precisa ser substituída. |
properties.description |
string |
A descrição da captura de dados de alteração. |
properties.folder |
A pasta na qual este CDC está. Se não for especificado, CDC aparecerá no nível raiz. |
|
properties.policy |
Política CDC |
|
properties.sourceConnectionsInfo |
Lista de conexões de fontes que podem ser usadas como fontes no CDC. |
|
properties.status |
string |
Status do CDC sobre se ele está em execução ou parado. |
properties.targetConnectionsInfo |
Lista de conexões de destino que podem ser usadas como fontes no CDC. |
|
type |
string |
O tipo de recurso. |
CloudError
O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.
Nome | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro. |
error.details |
Matriz com detalhes de erro adicionais. |
|
error.message |
string |
Mensagem de erro. |
error.target |
string |
Nome/caminho da propriedade na solicitação associada ao erro. |
ConnectionType
Tipo de conexão por meio de serviço vinculado ou conjunto de dados.
Valor | Description |
---|---|
linkedservicetype |
DataMapperMapping
Detalhes de mapeamento de tabela de origem e de destino.
Nome | Tipo | Description |
---|---|---|
attributeMappingInfo |
Isso contém as informações de mapeamento de atributo fornecidas pelo usuário. |
|
sourceConnectionReference |
A referência de conexão para a conexão de origem. |
|
sourceDenormalizeInfo |
object |
Isso contém as informações de desnormalização de origem usadas durante a junção de várias fontes. |
sourceEntityName |
string |
Nome da tabela de origem |
targetEntityName |
string |
Nome da tabela de destino |
Folder
A pasta na qual este CDC está. Se não for especificado, CDC aparecerá no nível raiz.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome da pasta na qual este CDC está. |
FrequencyType
Frequência do período em termos de 'Hora', 'Minuto' ou 'Segundo'.
Valor | Description |
---|---|
Hour | |
Minute | |
Second |
LinkedServiceReference
Tipo de referência de serviço vinculado.
Nome | Tipo | Description |
---|---|---|
parameters |
object |
Argumentos para LinkedService. |
referenceName |
string |
Nome do LinkedService de referência. |
type |
Tipo de referência de serviço vinculado. |
MapperAttributeMapping
Detalhes do mapeamento de coluna de origem e de destino.
Nome | Tipo | Description |
---|---|---|
attributeReference |
Referência da coluna de origem usada no mapeamento. Ele é usado somente para tipo de mapeamento 'Direct'. |
|
attributeReferences |
Lista de referências para colunas de origem. Ele é usado apenas para mapeamentos de tipo 'Derivado' e 'Agregação'. |
|
expression |
string |
Expressão usada para mapeamento de tipo 'Aggregate' e 'Derivado'. |
functionName |
string |
Nome da função usada para mapeamento de tipo 'Aggregate' e 'Derivado' (exceto 'Avançado'). |
name |
string |
Nome da coluna de destino. |
type |
Tipo do mapeamento de atributo CDC. Observação: o tipo de mapeamento 'Avançado' também é salvo como 'Derivado'. |
MapperAttributeMappings
Detalhes do mapeamento de atributo.
Nome | Tipo | Description |
---|---|---|
attributeMappings |
Lista de mapeamentos de atributo. |
MapperAttributeReference
Detalhes de referência de atributo para a coluna referenciada.
Nome | Tipo | Description |
---|---|---|
entity |
string |
Nome da tabela. |
entityConnectionReference |
A referência de conexão para a conexão. |
|
name |
string |
Nome da coluna. |
MapperConnection
Detalhes da conexão de origem.
Nome | Tipo | Description |
---|---|---|
commonDslConnectorProperties |
Lista de pares nome/valor para propriedades de conexão. |
|
isInlineDataset |
boolean |
Um booliano que indica se o serviço vinculado é do tipo conjunto de dados embutido. Atualmente, há suporte apenas para conjuntos de dados embutidos. |
linkedService |
Referência de serviço vinculado. |
|
linkedServiceType |
string |
Tipo do serviço vinculado, por exemplo: AzureBlobFS. |
type |
Tipo de conexão por meio de serviço vinculado ou conjunto de dados. |
MapperConnectionReference
Detalhes de referência de conexão de origem ou de destino.
Nome | Tipo | Description |
---|---|---|
connectionName |
string |
Nome da conexão |
type |
Tipo de conexão por meio de serviço vinculado ou conjunto de dados. |
MapperDslConnectorProperties
Propriedades do conector de uma tabela CDC em termos de pares nome/valor.
Nome | Tipo | Description |
---|---|---|
name |
string |
Nome da propriedade. |
value |
object |
Valor da propriedade. |
MapperPolicy
Política CDC.
Nome | Tipo | Description |
---|---|---|
mode |
string |
Modo de execução do CDC: lote versus contínuo. |
recurrence |
Define a frequência e o intervalo para executar o CDC para o modo de lote. |
MapperPolicyRecurrence
Detalhes de recorrência da política CDC.
Nome | Tipo | Description |
---|---|---|
frequency |
Frequência do período em termos de 'Hora', 'Minuto' ou 'Segundo'. |
|
interval |
integer (int32) |
Valor de intervalo real de acordo com a frequência escolhida. |
MapperSourceConnectionsInfo
Um objeto que contém uma lista de tabelas e detalhes de conexão para uma conexão de origem.
Nome | Tipo | Description |
---|---|---|
connection |
Detalhes da conexão de origem. |
|
sourceEntities |
Lista de tabelas de origem para uma conexão de origem. |
MapperTable
Detalhes da tabela CDC.
Nome | Tipo | Description |
---|---|---|
name |
string |
Nome da tabela. |
properties.dslConnectorProperties |
Lista de pares nome/valor para propriedades de conexão. |
|
properties.schema |
Lista de colunas para a tabela de origem. |
MapperTableSchema
Esquema de uma tabela CDC em termos de nomes de coluna e seus tipos de dados correspondentes.
Nome | Tipo | Description |
---|---|---|
dataType |
string |
Tipo de dados da coluna. |
name |
string |
Nome da coluna. |
MapperTargetConnectionsInfo
Um objeto que contém uma lista de tabelas e detalhes de conexão para uma conexão de destino.
Nome | Tipo | Description |
---|---|---|
connection |
Detalhes da conexão de origem. |
|
dataMapperMappings |
Lista de mapeamentos de tabela. |
|
relationships |
object[] |
Lista de informações de relação entre as tabelas. |
targetEntities |
Lista de tabelas de origem para uma conexão de destino. |
MappingType
Tipo do mapeamento de atributo CDC. Observação: o tipo de mapeamento 'Avançado' também é salvo como 'Derivado'.
Valor | Description |
---|---|
Aggregate | |
Derived | |
Direct |
Type
Tipo de referência de serviço vinculado.
Valor | Description |
---|---|
LinkedServiceReference |