你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB databaseAccounts/dataTransferJobs 2023-09-15-preview

• 最新
• 2024-12-01-preview
• 2024-09-01-preview
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15-preview
• 2023-09-15-preview
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15-preview
• 2022-08-15-preview
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15-preview

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/dataTransferJobs 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/dataTransferJobs 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-09-15-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    destination: {
      component: 'string'
      // For remaining properties, see DataTransferDataSourceSink objects
    }
    source: {
      component: 'string'
      // For remaining properties, see DataTransferDataSourceSink objects
    }
    workerCount: int
  }
}

DataTransferDataSourceSink 对象

设置 组件 属性以指定对象的类型。

对于 azureBlobStorage，请使用：

{
  component: 'AzureBlobStorage'
  containerName: 'string'
  endpointUrl: 'string'
}

对于 CosmosDBCassandra，请使用：

{
  component: 'CosmosDBCassandra'
  keyspaceName: 'string'
  remoteAccountName: 'string'
  tableName: 'string'
}

对于 CosmosDBMongo，请使用：

{
  collectionName: 'string'
  component: 'CosmosDBMongo'
  databaseName: 'string'
  remoteAccountName: 'string'
}

对于 CosmosDBSql，请使用：

{
  component: 'CosmosDBSql'
  containerName: 'string'
  databaseName: 'string'
  remoteAccountName: 'string'
}

属性值

AzureBlobDataTransferDataSourceSink

名字	描述	价值
元件		“AzureBlobStorage”（必需）
containerName		string （必需）
endpointUrl		字符串

CosmosCassandraDataTransferDataSourceSink

名字	描述	价值
元件		“CosmosDBCassandra”（必需）
keyspaceName		string （必需）
remoteAccountName		字符串
tableName		string （必需）

CosmosMongoDataTransferDataSourceSink

名字	描述	价值
collectionName		string （必需）
元件		“CosmosDBMongo”（必需）
databaseName		string （必需）
remoteAccountName		字符串

CosmosSqlDataTransferDataSourceSink

名字	描述	价值
元件		“CosmosDBSql”（必需）
containerName		string （必需）
databaseName		string （必需）
remoteAccountName		字符串

DataTransferDataSourceSink

名字	描述	价值
元件	对于 AzureBlobDataTransferDataSourceSink，请设置为“AzureBlobStorage”。 对于类型 CosmosCassandraDataTransferDataSourceSink，设置为“CosmosDBCassandra”。 对于 CosmosMongoDataTransferDataSourceSink，请设置为“CosmosDBMongo”。 对于 CosmosSqlDataTransferDataSourceSink，请设置为“CosmosDBSql”。	“AzureBlobStorage” “CosmosDBCassandra” “CosmosDBMongo” “CosmosDBSql”（必需）

DataTransferJobProperties

名字	描述	价值
目的地	目标数据存储详细信息	DataTransferDataSourceSink （必需）
源	源 DataStore 详细信息	DataTransferDataSourceSink （必需）
workerCount	辅助角色计数	int 约束： 最小值 = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

名字	描述	价值
名字	资源名称	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：databaseAccounts
性能	数据传输创建作业属性	DataTransferJobProperties（必需）

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/dataTransferJobs 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/dataTransferJobs 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "properties": {
    "destination": {
      "component": "string"
      // For remaining properties, see DataTransferDataSourceSink objects
    },
    "source": {
      "component": "string"
      // For remaining properties, see DataTransferDataSourceSink objects
    },
    "workerCount": "int"
  }
}

DataTransferDataSourceSink 对象

设置 组件 属性以指定对象的类型。

对于 azureBlobStorage，请使用：

{
  "component": "AzureBlobStorage",
  "containerName": "string",
  "endpointUrl": "string"
}

对于 CosmosDBCassandra，请使用：

{
  "component": "CosmosDBCassandra",
  "keyspaceName": "string",
  "remoteAccountName": "string",
  "tableName": "string"
}

对于 CosmosDBMongo，请使用：

{
  "collectionName": "string",
  "component": "CosmosDBMongo",
  "databaseName": "string",
  "remoteAccountName": "string"
}

对于 CosmosDBSql，请使用：

{
  "component": "CosmosDBSql",
  "containerName": "string",
  "databaseName": "string",
  "remoteAccountName": "string"
}

属性值

AzureBlobDataTransferDataSourceSink

名字	描述	价值
元件		“AzureBlobStorage”（必需）
containerName		string （必需）
endpointUrl		字符串

CosmosCassandraDataTransferDataSourceSink

名字	描述	价值
元件		“CosmosDBCassandra”（必需）
keyspaceName		string （必需）
remoteAccountName		字符串
tableName		string （必需）

CosmosMongoDataTransferDataSourceSink

名字	描述	价值
collectionName		string （必需）
元件		“CosmosDBMongo”（必需）
databaseName		string （必需）
remoteAccountName		字符串

CosmosSqlDataTransferDataSourceSink

名字	描述	价值
元件		“CosmosDBSql”（必需）
containerName		string （必需）
databaseName		string （必需）
remoteAccountName		字符串

DataTransferDataSourceSink

名字	描述	价值
元件	对于 AzureBlobDataTransferDataSourceSink，请设置为“AzureBlobStorage”。 对于类型 CosmosCassandraDataTransferDataSourceSink，设置为“CosmosDBCassandra”。 对于 CosmosMongoDataTransferDataSourceSink，请设置为“CosmosDBMongo”。 对于 CosmosSqlDataTransferDataSourceSink，请设置为“CosmosDBSql”。	“AzureBlobStorage” “CosmosDBCassandra” “CosmosDBMongo” “CosmosDBSql”（必需）

DataTransferJobProperties

名字	描述	价值
目的地	目标数据存储详细信息	DataTransferDataSourceSink （必需）
源	源 DataStore 详细信息	DataTransferDataSourceSink （必需）
workerCount	辅助角色计数	int 约束： 最小值 = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

名字	描述	价值
apiVersion	API 版本	'2023-09-15-preview'
名字	资源名称	string （必需）
性能	数据传输创建作业属性	DataTransferJobProperties（必需）
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/dataTransferJobs”

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 databaseAccounts/dataTransferJobs 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/dataTransferJobs 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-09-15-preview"
  name = "string"
  body = jsonencode({
    properties = {
      destination = {
        component = "string"
        // For remaining properties, see DataTransferDataSourceSink objects
      }
      source = {
        component = "string"
        // For remaining properties, see DataTransferDataSourceSink objects
      }
      workerCount = int
    }
  })
}

DataTransferDataSourceSink 对象

设置 组件 属性以指定对象的类型。

对于 azureBlobStorage，请使用：

{
  component = "AzureBlobStorage"
  containerName = "string"
  endpointUrl = "string"
}

对于 CosmosDBCassandra，请使用：

{
  component = "CosmosDBCassandra"
  keyspaceName = "string"
  remoteAccountName = "string"
  tableName = "string"
}

对于 CosmosDBMongo，请使用：

{
  collectionName = "string"
  component = "CosmosDBMongo"
  databaseName = "string"
  remoteAccountName = "string"
}

对于 CosmosDBSql，请使用：

{
  component = "CosmosDBSql"
  containerName = "string"
  databaseName = "string"
  remoteAccountName = "string"
}

属性值

AzureBlobDataTransferDataSourceSink

名字	描述	价值
元件		“AzureBlobStorage”（必需）
containerName		string （必需）
endpointUrl		字符串

CosmosCassandraDataTransferDataSourceSink

名字	描述	价值
元件		“CosmosDBCassandra”（必需）
keyspaceName		string （必需）
remoteAccountName		字符串
tableName		string （必需）

CosmosMongoDataTransferDataSourceSink

名字	描述	价值
collectionName		string （必需）
元件		“CosmosDBMongo”（必需）
databaseName		string （必需）
remoteAccountName		字符串

CosmosSqlDataTransferDataSourceSink

名字	描述	价值
元件		“CosmosDBSql”（必需）
containerName		string （必需）
databaseName		string （必需）
remoteAccountName		字符串

DataTransferDataSourceSink

名字	描述	价值
元件	对于 AzureBlobDataTransferDataSourceSink，请设置为“AzureBlobStorage”。 对于类型 CosmosCassandraDataTransferDataSourceSink，设置为“CosmosDBCassandra”。 对于 CosmosMongoDataTransferDataSourceSink，请设置为“CosmosDBMongo”。 对于 CosmosSqlDataTransferDataSourceSink，请设置为“CosmosDBSql”。	“AzureBlobStorage” “CosmosDBCassandra” “CosmosDBMongo” “CosmosDBSql”（必需）

DataTransferJobProperties

名字	描述	价值
目的地	目标数据存储详细信息	DataTransferDataSourceSink （必需）
源	源 DataStore 详细信息	DataTransferDataSourceSink （必需）
workerCount	辅助角色计数	int 约束： 最小值 = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

名字	描述	价值
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：databaseAccounts
性能	数据传输创建作业属性	DataTransferJobProperties（必需）
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-09-15-preview”