共用方式為


Microsoft.DocumentDB 資料庫Accounts/dataTransferJobs 2021-11-15-preview

Bicep 資源定義

databaseAccounts/dataTransferJobs 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/dataTransferJobs 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2021-11-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
  tableName: 'string'

針對 CosmosDBSql,請使用:

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

屬性值

databaseAccounts/dataTransferJobs

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
需要字串 ()
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: databaseAccounts
properties 數據傳輸建立作業屬性 DataTransferJobProperties (必要)

DataTransferJobProperties

名稱 描述
目的地 目的地 DataStore 詳細數據 需要 DataTransferDataSourceSink ()
來源 源數據存放區詳細數據 需要 DataTransferDataSourceSink ()
workerCount 背景工作計數 int

約束:
最小值 = 0

DataTransferDataSourceSink

名稱 描述
component 設定物件類型 AzureBlob儲存體
CosmosDBCassandra
需要 CosmosDBSql ()

AzureBlobDataTransferDataSourceSink

名稱 描述
component 'AzureBlobStorage' (必要)
containerName 需要字串 ()
endpointUrl 字串

CosmosCassandraDataTransferDataSourceSink

名稱 描述
component 'CosmosDBCassandra' (必要)
keyspaceName 需要字串 ()
tableName 需要字串 ()

CosmosSqlDataTransferDataSourceSink

名稱 描述
component 需要 'CosmosDBSql' ()
containerName 需要字串 ()
databaseName 需要字串 ()

ARM 範本資源定義

databaseAccounts/dataTransferJobs 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/dataTransferJobs 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "apiVersion": "2021-11-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",
  "tableName": "string"

針對 CosmosDBSql,請使用:

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

屬性值

databaseAccounts/dataTransferJobs

名稱 描述
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'
apiVersion 資源 API 版本 '2021-11-15-preview'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。
需要字串 ()
properties 數據傳輸建立作業屬性 DataTransferJobProperties (必要)

DataTransferJobProperties

名稱 描述
目的地 目的地 DataStore 詳細數據 需要 DataTransferDataSourceSink ()
來源 源數據存放區詳細數據 需要 DataTransferDataSourceSink ()
workerCount 背景工作計數 int

約束:
最小值 = 0

DataTransferDataSourceSink

名稱 描述
component 設定物件類型 AzureBlob儲存體
CosmosDBCassandra
需要 CosmosDBSql ()

AzureBlobDataTransferDataSourceSink

名稱 描述
component 'AzureBlobStorage' (必要)
containerName 需要字串 ()
endpointUrl 字串

CosmosCassandraDataTransferDataSourceSink

名稱 描述
component 'CosmosDBCassandra' (必要)
keyspaceName 需要字串 ()
tableName 需要字串 ()

CosmosSqlDataTransferDataSourceSink

名稱 描述
component 需要 'CosmosDBSql' ()
containerName 需要字串 ()
databaseName 需要字串 ()

Terraform (AzAPI 提供者) 資源定義

databaseAccounts/dataTransferJobs 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/dataTransferJobs 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2021-11-15-preview"
  name = "string"
  parent_id = "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"
  tableName = "string"

針對 CosmosDBSql,請使用:

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

屬性值

databaseAccounts/dataTransferJobs

名稱 描述
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2021-11-15-preview”
NAME 資源名稱 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼: databaseAccounts
properties 數據傳輸建立作業屬性 DataTransferJobProperties (必要)

DataTransferJobProperties

名稱 描述
目的地 目的地 DataStore 詳細數據 DataTransferDataSourceSink (必要)
來源 源數據存放區詳細數據 DataTransferDataSourceSink (必要)
workerCount 背景工作計數 int

約束:
最小值 = 0

DataTransferDataSourceSink

名稱 描述
component 設定物件類型 AzureBlob儲存體
CosmosDBCassandra
CosmosDBSql (必要)

AzureBlobDataTransferDataSourceSink

名稱 描述
component “AzureBlobStorage” (必要)
containerName 字串 (必要)
endpointUrl 字串

CosmosCassandraDataTransferDataSourceSink

名稱 描述
component “CosmosDBCassandra” (必要)
keyspaceName 字串 (必要)
tableName 字串 (必要)

CosmosSqlDataTransferDataSourceSink

名稱 描述
component ) 所需的 「CosmosDBSql」 (
containerName 字串 (必要)
databaseName 字串 (必要)