Freigeben über


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

Bicep-Ressourcendefinition

Der Ressourcentyp "databaseAccounts/dataTransferJobs" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/dataTransferJobs-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

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-Objekte

Legen Sie die Komponente Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureBlobStorage-:

{
  component: 'AzureBlobStorage'
  containerName: 'string'
  endpointUrl: 'string'
}

Verwenden Sie für CosmosDBCassandra:

{
  component: 'CosmosDBCassandra'
  keyspaceName: 'string'
  remoteAccountName: 'string'
  tableName: 'string'
}

Verwenden Sie für CosmosDBMongo:

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

Verwenden Sie für CosmosDBSql:

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

Eigenschaftswerte

AzureBlobDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil "AzureBlobStorage" (erforderlich)
containerName Zeichenfolge (erforderlich)
endpointUrl Schnur

CosmosCassandraDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil 'CosmosDBCassandra' (erforderlich)
keyspaceName Zeichenfolge (erforderlich)
remoteAccountName Schnur
tableName Zeichenfolge (erforderlich)

CosmosMongoDataTransferDataSourceSink

Name Beschreibung Wert
collectionName Zeichenfolge (erforderlich)
Bestandteil 'CosmosDBMongo' (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Schnur

CosmosSqlDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil 'CosmosDBSql' (erforderlich)
containerName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Schnur

DataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil Legen Sie für den Typ AzureBlobDataTransferDataSourceSink-auf "AzureBlobStorage" fest. Set to 'CosmosDBCassandra' for type CosmosCassandraDataTransferDataSourceSink. Set to 'CosmosDBMongo' for type CosmosMongoDataTransferDataSourceSink. Set to 'CosmosDBSql' for type CosmosSqlDataTransferDataSourceSink. "AzureBlobStorage"
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBSql' (erforderlich)

DataTransferJobProperties

Name Beschreibung Wert
Bestimmungsort Details zum Zieldatenspeicher DataTransferDataSourceSink- (erforderlich)
Modus Ausführungsmodus des Auftrags "Offline"
"Online"
Quelle Details zum Datenquellendatenspeicher DataTransferDataSourceSink- (erforderlich)
workerCount Anzahl arbeite Int

Zwänge:
Min.-Wert = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource des Typs: databaseAccounts
Eigenschaften Datenübertragung – Auftragseigenschaften erstellen DataTransferJobProperties (erforderlich)

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "databaseAccounts/dataTransferJobs" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/dataTransferJobs-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "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-Objekte

Legen Sie die Komponente Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureBlobStorage-:

{
  "component": "AzureBlobStorage",
  "containerName": "string",
  "endpointUrl": "string"
}

Verwenden Sie für CosmosDBCassandra:

{
  "component": "CosmosDBCassandra",
  "keyspaceName": "string",
  "remoteAccountName": "string",
  "tableName": "string"
}

Verwenden Sie für CosmosDBMongo:

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

Verwenden Sie für CosmosDBSql:

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

Eigenschaftswerte

AzureBlobDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil "AzureBlobStorage" (erforderlich)
containerName Zeichenfolge (erforderlich)
endpointUrl Schnur

CosmosCassandraDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil 'CosmosDBCassandra' (erforderlich)
keyspaceName Zeichenfolge (erforderlich)
remoteAccountName Schnur
tableName Zeichenfolge (erforderlich)

CosmosMongoDataTransferDataSourceSink

Name Beschreibung Wert
collectionName Zeichenfolge (erforderlich)
Bestandteil 'CosmosDBMongo' (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Schnur

CosmosSqlDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil 'CosmosDBSql' (erforderlich)
containerName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Schnur

DataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil Legen Sie für den Typ AzureBlobDataTransferDataSourceSink-auf "AzureBlobStorage" fest. Set to 'CosmosDBCassandra' for type CosmosCassandraDataTransferDataSourceSink. Set to 'CosmosDBMongo' for type CosmosMongoDataTransferDataSourceSink. Set to 'CosmosDBSql' for type CosmosSqlDataTransferDataSourceSink. "AzureBlobStorage"
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBSql' (erforderlich)

DataTransferJobProperties

Name Beschreibung Wert
Bestimmungsort Details zum Zieldatenspeicher DataTransferDataSourceSink- (erforderlich)
Modus Ausführungsmodus des Auftrags "Offline"
"Online"
Quelle Details zum Datenquellendatenspeicher DataTransferDataSourceSink- (erforderlich)
workerCount Anzahl arbeite Int

Zwänge:
Min.-Wert = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Name Beschreibung Wert
apiVersion Die API-Version "2024-05-15-preview"
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Datenübertragung – Auftragseigenschaften erstellen DataTransferJobProperties (erforderlich)
Art Der Ressourcentyp 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "databaseAccounts/dataTransferJobs" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/dataTransferJobs-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview"
  name = "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-Objekte

Legen Sie die Komponente Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AzureBlobStorage-:

{
  component = "AzureBlobStorage"
  containerName = "string"
  endpointUrl = "string"
}

Verwenden Sie für CosmosDBCassandra:

{
  component = "CosmosDBCassandra"
  keyspaceName = "string"
  remoteAccountName = "string"
  tableName = "string"
}

Verwenden Sie für CosmosDBMongo:

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

Verwenden Sie für CosmosDBSql:

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

Eigenschaftswerte

AzureBlobDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil "AzureBlobStorage" (erforderlich)
containerName Zeichenfolge (erforderlich)
endpointUrl Schnur

CosmosCassandraDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil 'CosmosDBCassandra' (erforderlich)
keyspaceName Zeichenfolge (erforderlich)
remoteAccountName Schnur
tableName Zeichenfolge (erforderlich)

CosmosMongoDataTransferDataSourceSink

Name Beschreibung Wert
collectionName Zeichenfolge (erforderlich)
Bestandteil 'CosmosDBMongo' (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Schnur

CosmosSqlDataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil 'CosmosDBSql' (erforderlich)
containerName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Schnur

DataTransferDataSourceSink

Name Beschreibung Wert
Bestandteil Legen Sie für den Typ AzureBlobDataTransferDataSourceSink-auf "AzureBlobStorage" fest. Set to 'CosmosDBCassandra' for type CosmosCassandraDataTransferDataSourceSink. Set to 'CosmosDBMongo' for type CosmosMongoDataTransferDataSourceSink. Set to 'CosmosDBSql' for type CosmosSqlDataTransferDataSourceSink. "AzureBlobStorage"
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBSql' (erforderlich)

DataTransferJobProperties

Name Beschreibung Wert
Bestimmungsort Details zum Zieldatenspeicher DataTransferDataSourceSink- (erforderlich)
Modus Ausführungsmodus des Auftrags "Offline"
"Online"
Quelle Details zum Datenquellendatenspeicher DataTransferDataSourceSink- (erforderlich)
workerCount Anzahl arbeite Int

Zwänge:
Min.-Wert = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: databaseAccounts
Eigenschaften Datenübertragung – Auftragseigenschaften erstellen DataTransferJobProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview"