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

Data Transfer Jobs - Create

创建数据传输作业。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}?api-version=2024-05-15-preview

URI 参数

名称 必需 类型 说明
accountName
path True

string

Cosmos DB 数据库帐户名称。

正则表达式模式: ^[a-z0-9]+(-[a-z0-9]+)*

jobName
path True

string

数据传输作业的名称

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
properties True

DataTransferJobProperties

数据传输Create作业属性

响应

名称 类型 说明
200 OK

DataTransferJobGetResults

成功的 CreateJob 响应

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CosmosDBDataTransferJobCreate

示例请求

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/dataTransferJobs/j1?api-version=2024-05-15-preview

{
  "properties": {
    "source": {
      "component": "CosmosDBCassandra",
      "keyspaceName": "keyspace",
      "tableName": "table"
    },
    "destination": {
      "component": "AzureBlobStorage",
      "containerName": "blob_container",
      "endpointUrl": "https://blob.windows.net"
    }
  }
}

示例响应

{
  "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "properties": {
    "jobName": "j1",
    "source": {
      "tableName": "table",
      "keyspaceName": "keyspace",
      "component": "CosmosDBCassandra"
    },
    "destination": {
      "component": "AzureBlobStorage",
      "containerName": "blob_container",
      "endpointUrl": "https://blob.windows.net"
    },
    "status": "Running",
    "processedCount": 0,
    "totalCount": 0,
    "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z",
    "duration": "00:00:00"
  }
}

定义

名称 说明
AzureBlobDataTransferDataSourceSink

Azure Blob 存储数据源/接收器

CloudError

来自服务的错误响应。

CreateJobRequest

用于创建数据传输作业的参数

DataTransferJobGetResults

Cosmos DB 数据传输作业

DataTransferJobMode

作业执行模式

DataTransferJobProperties

DataTransfer 作业的属性

ErrorResponse

错误响应。

AzureBlobDataTransferDataSourceSink

Azure Blob 存储数据源/接收器

名称 类型 默认值 说明
component string:

AzureBlobStorage

CosmosDBCassandra
containerName

string

endpointUrl

string

CloudError

来自服务的错误响应。

名称 类型 说明
error

ErrorResponse

错误响应。

CreateJobRequest

用于创建数据传输作业的参数

名称 类型 说明
id

string

数据库帐户的唯一资源标识符。

name

string

数据库帐户的名称。

properties

DataTransferJobProperties

数据传输Create作业属性

type

string

Azure 资源的类型。

DataTransferJobGetResults

Cosmos DB 数据传输作业

名称 类型 说明
id

string

数据库帐户的唯一资源标识符。

name

string

数据库帐户的名称。

properties.destination DataTransferDataSourceSink:

AzureBlobDataTransferDataSourceSink

目标数据存储详细信息

properties.duration

string

作业总持续时间

properties.error

ErrorResponse

出错作业的错误响应

properties.jobName

string

作业名称

properties.lastUpdatedUtcTime

string

上次更新时间 (ISO-8601 格式) 。

properties.mode

DataTransferJobMode

作业执行模式

properties.processedCount

integer

已处理计数。

properties.source DataTransferDataSourceSink:

AzureBlobDataTransferDataSourceSink

源数据存储详细信息

properties.status

string

作业状态

properties.totalCount

integer

总计计数。

properties.workerCount

integer

辅助角色计数

type

string

Azure 资源的类型。

DataTransferJobMode

作业执行模式

名称 类型 说明
Offline

string

Online

string

DataTransferJobProperties

DataTransfer 作业的属性

名称 类型 说明
destination DataTransferDataSourceSink:

AzureBlobDataTransferDataSourceSink

目标数据存储详细信息

duration

string

作业总持续时间

error

ErrorResponse

出错作业的错误响应

jobName

string

作业名称

lastUpdatedUtcTime

string

上次更新时间 (ISO-8601 格式) 。

mode

DataTransferJobMode

作业执行模式

processedCount

integer

已处理计数。

source DataTransferDataSourceSink:

AzureBlobDataTransferDataSourceSink

源数据存储详细信息

status

string

作业状态

totalCount

integer

总计计数。

workerCount

integer

辅助角色计数

ErrorResponse

错误响应。

名称 类型 说明
code

string

错误代码。

message

string

指示操作失败原因的错误消息。