通过

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

Microsoft.DocumentDB databaseAccounts/dataTransferJobs 2024-05-15-preview

  • 项目

Bicep 资源定义

可以使用面向以下操作部署 databaseAccounts/dataTransferJobs 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    destination: {
      component: 'string'
      // For remaining properties, see DataTransferDataSourceSink objects
    }
    mode: 'string'
    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，请使用：

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

对于 CosmosDBSql，请使用：

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

属性值

databaseAccounts/dataTransferJobs

名称 说明 值
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。		 字符串 (必需)
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型的资源的符号名称： databaseAccounts
properties 数据传输创建作业属性 需要 DataTransferJobProperties ()

DataTransferJobProperties

名称 说明 值
destination 目标数据存储详细信息 DataTransferDataSourceSink (必需)
mode 作业执行模式 “脱机”
'Online'
source 源数据存储详细信息 DataTransferDataSourceSink (必需)
workerCount 辅助角色计数 int

约束：
最小值 = 0

DataTransferDataSourceSink

名称 说明 值
组件 设置对象类型 AzureBlob存储
CosmosDBCassandra
CosmosDBMongo
需要 CosmosDBSql ()

AzureBlobDataTransferDataSourceSink

名称 说明 值
组件 “AzureBlobStorage” (必需)
containerName 字符串 (必需)
endpointUrl 字符串

CosmosCassandraDataTransferDataSourceSink

名称 说明 值
组件 “CosmosDBCassandra” (必需)
keyspaceName 字符串 (必需)
remoteAccountName 字符串
tableName 字符串 (必需)

CosmosMongoDataTransferDataSourceSink

名称 说明 值
组件 “CosmosDBMongo” (必需)
collectionName 字符串 (必需)
databaseName 字符串 (必需)
remoteAccountName 字符串

CosmosSqlDataTransferDataSourceSink

名称 说明 值
组件 “CosmosDBSql” (必需)
containerName 字符串 (必需)
databaseName 字符串 (必需)
remoteAccountName 字符串

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "apiVersion": "2024-05-15-preview",
  "name": "string",
  "properties": {
    "destination": {
      "component": "string"
      // For remaining properties, see DataTransferDataSourceSink objects
    },
    "mode": "string",
    "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，请使用：

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

对于 CosmosDBSql，请使用：

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

属性值

databaseAccounts/dataTransferJobs

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/dataTransferJobs”
apiVersion 资源 API 版本 “2024-05-15-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)
properties 数据传输创建作业属性 DataTransferJobProperties (必需的)

DataTransferJobProperties

名称 说明 值
destination 目标数据存储详细信息 需要 DataTransferDataSourceSink ()
mode 作业执行模式 “脱机”
“Online”
source 源数据存储详细信息 需要 DataTransferDataSourceSink ()
workerCount 辅助角色计数 int

约束：
最小值 = 0

DataTransferDataSourceSink

名称 说明 值
组件 设置对象类型 AzureBlob存储
CosmosDBCassandra
CosmosDBMongo
需要 CosmosDBSql ()

AzureBlobDataTransferDataSourceSink

名称 说明 值
组件 “AzureBlobStorage” (必需)
containerName 字符串 (必需)
endpointUrl 字符串

CosmosCassandraDataTransferDataSourceSink

名称 说明 值
组件 “CosmosDBCassandra” (必需)
keyspaceName 字符串 (必需)
remoteAccountName 字符串
tableName 字符串 (必需)

CosmosMongoDataTransferDataSourceSink

名称 说明 值
组件 需要“CosmosDBMongo” ()
collectionName 字符串 (必需)
databaseName 字符串 (必需)
remoteAccountName 字符串

CosmosSqlDataTransferDataSourceSink

名称 说明 值
组件 需要“CosmosDBSql” ()
containerName 字符串 (必需)
databaseName 字符串 (必需)
remoteAccountName 字符串

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 databaseAccounts/dataTransferJobs 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      destination = {
        component = "string"
        // For remaining properties, see DataTransferDataSourceSink objects
      }
      mode = "string"
      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，请使用：

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

对于 CosmosDBSql，请使用：

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

属性值

databaseAccounts/dataTransferJobs

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型的资源的 ID： databaseAccounts
properties 数据传输创建作业属性 需要 DataTransferJobProperties ()

DataTransferJobProperties

名称 说明 值
destination 目标数据存储详细信息 DataTransferDataSourceSink (必需)
mode 作业执行模式 “脱机”
“Online”
source 源数据存储详细信息 DataTransferDataSourceSink (必需)
workerCount 辅助角色计数 int

约束：
最小值 = 0

DataTransferDataSourceSink

名称 说明 值
组件 设置对象类型 AzureBlob存储
CosmosDBCassandra
CosmosDBMongo
需要 CosmosDBSql ()

AzureBlobDataTransferDataSourceSink

名称 说明 值
组件 需要“AzureBlobStorage” ()
containerName 字符串 (必需)
endpointUrl 字符串

CosmosCassandraDataTransferDataSourceSink

名称 说明 值
组件 “CosmosDBCassandra” (必需)
keyspaceName 字符串 (必需)
remoteAccountName 字符串
tableName 字符串 (必需)

CosmosMongoDataTransferDataSourceSink

名称 说明 值
组件 “CosmosDBMongo” (必需)
collectionName 字符串 (必需)
databaseName 字符串 (必需)
remoteAccountName 字符串

CosmosSqlDataTransferDataSourceSink

名称 说明 值
组件 “CosmosDBSql” (必需)
containerName 字符串 (必需)
databaseName 字符串 (必需)
remoteAccountName 字符串