次の方法で共有

Microsoft.DocumentDB データベースアカウント/データ転送ジョブ 2024-05-15-preview

Bicep リソース定義

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

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview' = {
  parent: resourceSymbolicName
  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の場合は、次を使用します。

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

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

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

プロパティ値

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs (英語)

名前 形容 価値
名前 リソース名 string (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

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

AzureBlobDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'AzureBlobStorage' (必須)
コンテナ名 string (必須)
エンドポイントURL 糸

CosmosCassandraDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'CosmosDBCassandra' (必須)
キースペース名 string (必須)
リモートアカウント名 糸
テーブル名 string (必須)

CosmosMongoDataTransferDataSourceSink

名前 形容 価値
コレクション名 string (必須)
コンポーネント 'CosmosDBMongo' (必須)
データベース名 string (必須)
リモートアカウント名 糸

CosmosSqlDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'CosmosDBSql' (必須)
コンテナ名 string (必須)
データベース名 string (必須)
リモートアカウント名 糸

DataTransferDataSourceSink

名前 形容 価値
コンポーネント AzureBlobDataTransferDataSourceSink型として 'AzureBlobStorage' に設定します。 CosmosCassandraDataTransferDataSourceSink型として 'CosmosDBCassandra' に設定します。 CosmosMongoDataTransferDataSourceSink型として 'CosmosDBMongo' に設定します。 CosmosSqlDataTransferDataSourceSink型に対して 'CosmosDBSql' に設定します。 'AzureBlobStorage'
「CosmosDBCassandra」
「CosmosDBMongo」
'CosmosDBSql' (必須)

DataTransferJobProperties(英語)

名前 形容 価値
行き先 宛先データストアの詳細 DataTransferDataSourceSink (必須)
モード ジョブの実行モード 'オフライン'
「オンライン」
源 ソース データストアの詳細 DataTransferDataSourceSink (必須)
ワーカー数 ワーカー数 int

制約：
最小値 = 0

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

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

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

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

プロパティ値

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs (英語)

名前 形容 価値
apiVersion (英語) API のバージョン 「2024-05-15-プレビュー」
名前 リソース名 string (必須)
プロパティ データ転送のジョブの作成プロパティ DataTransferJobProperties (必須)
種類 リソースの種類 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'

AzureBlobDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'AzureBlobStorage' (必須)
コンテナ名 string (必須)
エンドポイントURL 糸

CosmosCassandraDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'CosmosDBCassandra' (必須)
キースペース名 string (必須)
リモートアカウント名 糸
テーブル名 string (必須)

CosmosMongoDataTransferDataSourceSink

名前 形容 価値
コレクション名 string (必須)
コンポーネント 'CosmosDBMongo' (必須)
データベース名 string (必須)
リモートアカウント名 糸

CosmosSqlDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'CosmosDBSql' (必須)
コンテナ名 string (必須)
データベース名 string (必須)
リモートアカウント名 糸

DataTransferDataSourceSink

名前 形容 価値
コンポーネント AzureBlobDataTransferDataSourceSink型として 'AzureBlobStorage' に設定します。 CosmosCassandraDataTransferDataSourceSink型として 'CosmosDBCassandra' に設定します。 CosmosMongoDataTransferDataSourceSink型として 'CosmosDBMongo' に設定します。 CosmosSqlDataTransferDataSourceSink型に対して 'CosmosDBSql' に設定します。 'AzureBlobStorage'
「CosmosDBCassandra」
「CosmosDBMongo」
'CosmosDBSql' (必須)

DataTransferJobProperties(英語)

名前 形容 価値
行き先 宛先データストアの詳細 DataTransferDataSourceSink (必須)
モード ジョブの実行モード 'オフライン'
「オンライン」
源 ソース データストアの詳細 DataTransferDataSourceSink (必須)
ワーカー数 ワーカー数 int

制約：
最小値 = 0

使用例

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

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

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

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

プロパティ値

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs (英語)

名前 形容 価値
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
プロパティ データ転送のジョブの作成プロパティ DataTransferJobProperties (必須)
種類 リソースの種類 「Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview」

AzureBlobDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'AzureBlobStorage' (必須)
コンテナ名 string (必須)
エンドポイントURL 糸

CosmosCassandraDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'CosmosDBCassandra' (必須)
キースペース名 string (必須)
リモートアカウント名 糸
テーブル名 string (必須)

CosmosMongoDataTransferDataSourceSink

名前 形容 価値
コレクション名 string (必須)
コンポーネント 'CosmosDBMongo' (必須)
データベース名 string (必須)
リモートアカウント名 糸

CosmosSqlDataTransferDataSourceSink

名前 形容 価値
コンポーネント 'CosmosDBSql' (必須)
コンテナ名 string (必須)
データベース名 string (必須)
リモートアカウント名 糸

DataTransferDataSourceSink

名前 形容 価値
コンポーネント AzureBlobDataTransferDataSourceSink型として 'AzureBlobStorage' に設定します。 CosmosCassandraDataTransferDataSourceSink型として 'CosmosDBCassandra' に設定します。 CosmosMongoDataTransferDataSourceSink型として 'CosmosDBMongo' に設定します。 CosmosSqlDataTransferDataSourceSink型に対して 'CosmosDBSql' に設定します。 'AzureBlobStorage'
「CosmosDBCassandra」
「CosmosDBMongo」
'CosmosDBSql' (必須)

DataTransferJobProperties(英語)

名前 形容 価値
行き先 宛先データストアの詳細 DataTransferDataSourceSink (必須)
モード ジョブの実行モード 'オフライン'
「オンライン」
源 ソース データストアの詳細 DataTransferDataSourceSink (必須)
ワーカー数 ワーカー数 int

制約：
最小値 = 0