Share via

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

  • [アーティクル]

Bicep リソース定義

databaseAccounts/dataTransferJobs リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-09-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'
  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 で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 種類のリソースのシンボル名: databaseAccounts
properties データ転送のジョブの作成プロパティ DataTransferJobProperties (必須)

DataTransferJobProperties

名前 説明 値
destination Destination DataStore の詳細 DataTransferDataSourceSink (必須)
source ソース データストアの詳細 DataTransferDataSourceSink (必須)
workerCount ワーカー数 INT

制約:
最小値 = 0

DataTransferDataSourceSink

名前 説明 値
コンポーネント オブジェクトの種類を設定する AzureBlobStorage
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (必須)

AzureBlobDataTransferDataSourceSink

名前 説明 値
コンポーネント 'AzureBlobStorage' (必須)
containerName string (必須)
endpointUrl string

CosmosCassandraDataTransferDataSourceSink

名前 説明 値
コンポーネント 'CosmosDBCassandra' (必須)
keyspaceName string (必須)
remoteAccountName string
tableName string (必須)

CosmosMongoDataTransferDataSourceSink

名前 説明 値
コンポーネント 'CosmosDBMongo' (必須)
collectionName string (必須)
databaseName string (必須)
remoteAccountName string

CosmosSqlDataTransferDataSourceSink

名前 説明 値
コンポーネント 'CosmosDBSql' (必須)
containerName string (必須)
databaseName string (必須)
remoteAccountName string

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 の場合は、次の値を使用します。

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

CosmosDBSql の場合は、次を使用します。

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

プロパティ値

databaseAccounts/dataTransferJobs

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'
apiVersion リソース API のバージョン '2023-09-15-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties データ転送のジョブの作成プロパティ DataTransferJobProperties (必須)

DataTransferJobProperties

名前 説明 値
destination Destination DataStore の詳細 DataTransferDataSourceSink (必須)
source ソース データストアの詳細 DataTransferDataSourceSink (必須)
workerCount ワーカー数 INT

制約:
最小値 = 0

DataTransferDataSourceSink

名前 説明 値
コンポーネント オブジェクトの種類を設定する AzureBlobStorage
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (必須)

AzureBlobDataTransferDataSourceSink

名前 説明 値
コンポーネント 'AzureBlobStorage' (必須)
containerName string (必須)
endpointUrl string

CosmosCassandraDataTransferDataSourceSink

名前 説明 値
コンポーネント 'CosmosDBCassandra' (必須)
keyspaceName string (必須)
remoteAccountName string
tableName string (必須)

CosmosMongoDataTransferDataSourceSink

名前 説明 値
コンポーネント 'CosmosDBMongo' (必須)
collectionName string (必須)
databaseName string (必須)
remoteAccountName string

CosmosSqlDataTransferDataSourceSink

名前 説明 値
コンポーネント 'CosmosDBSql' (必須)
containerName string (必須)
databaseName string (必須)
remoteAccountName string

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"
  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"
  remoteAccountName = "string"
  tableName = "string"

CosmosDBMongo の場合は、次の値を使用します。

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

CosmosDBSql の場合は、次の値を使用します。

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

プロパティ値

databaseAccounts/dataTransferJobs

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-09-15-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
properties データ転送ジョブの作成プロパティ DataTransferJobProperties (必須)

DataTransferJobProperties

名前 説明 値
destination 宛先データストアの詳細 DataTransferDataSourceSink (必須)
source ソース データストアの詳細 DataTransferDataSourceSink (必須)
workerCount ワーカー数 INT

制約:
最小値 = 0

DataTransferDataSourceSink

名前 説明 値
コンポーネント オブジェクトの種類を設定する AzureBlobStorage
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (必須)

AzureBlobDataTransferDataSourceSink

名前 説明 値
コンポーネント "AzureBlobStorage" (必須)
containerName string (必須)
endpointUrl string

CosmosCassandraDataTransferDataSourceSink

名前 説明 値
コンポーネント "CosmosDBCassandra" (必須)
keyspaceName string (必須)
remoteAccountName string
tableName string (必須)

CosmosMongoDataTransferDataSourceSink

名前 説明 値
コンポーネント "CosmosDBMongo" (必須)
collectionName string (必須)
databaseName string (必須)
remoteAccountName string

CosmosSqlDataTransferDataSourceSink

名前 説明 値
コンポーネント "CosmosDBSql" (必須)
containerName string (必須)
databaseName string (必須)
remoteAccountName string