Microsoft.DocumentDB-DatenbankAccounts/dataTransferJobs 2023-11-15-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/dataTransferJobs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

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 den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-11-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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 Komponenteneigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für AzureBlobStorage Folgendes:

  component: 'AzureBlobStorage'
  containerName: 'string'
  endpointUrl: 'string'

Verwenden Sie für CosmosDBCassandra Folgendes:

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

Verwenden Sie für CosmosDBMongo Folgendes:

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

Verwenden Sie für CosmosDBSql Folgendes:

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

Eigenschaftswerte

databaseAccounts/dataTransferJobs

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 Zeichenfolge (erforderlich)
parent 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 vom Typ: databaseAccounts
properties Datenübertragung Auftragseigenschaften erstellen DataTransferJobProperties (erforderlich)

DataTransferJobProperties

Name BESCHREIBUNG Wert
destination Details zum Zieldatenspeicher DataTransferDataSourceSink (erforderlich)
Modus Art der Auftragsausführung "Offline"
"Online"
source Quelldatenspeicherdetails DataTransferDataSourceSink (erforderlich)
ArbeiterZahl Workeranzahl INT

Einschränkungen:
Min-Wert = 0

DataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente Festlegen des Objekttyps AzureBlobStorage
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (erforderlich)

AzureBlobDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "AzureBlobStorage" (erforderlich)
containerName Zeichenfolge (erforderlich)
endpointUrl Zeichenfolge

CosmosCassandraDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBCassandra" (erforderlich)
keyspaceName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge
tableName Zeichenfolge (erforderlich)

CosmosMongoDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBMongo" (erforderlich)
collectionName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge

CosmosSqlDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBSql" (erforderlich)
containerName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

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 im Änderungsprotokoll.

Ressourcenformat

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "apiVersion": "2023-11-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 Komponenteneigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für AzureBlobStorage Folgendes:

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

Verwenden Sie für CosmosDBCassandra Folgendes:

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

Verwenden Sie für CosmosDBMongo Folgendes:

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

Verwenden Sie für CosmosDBSql Folgendes:

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

Eigenschaftswerte

databaseAccounts/dataTransferJobs

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs"
apiVersion Die Version der Ressourcen-API "2023-11-15-preview"
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)
properties Datenübertragung: Auftragseigenschaften erstellen DataTransferJobProperties (erforderlich)

DataTransferJobProperties

Name BESCHREIBUNG Wert
destination Details zum Zieldatenspeicher DataTransferDataSourceSink (erforderlich)
Modus Art der Auftragsausführung "Offline"
"Online"
source Details zum Quelldatenspeicher DataTransferDataSourceSink (erforderlich)
ArbeiterZahl Workeranzahl INT

Einschränkungen:
Minimaler Wert = 0

DataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente Festlegen des Objekttyps AzureBlobStorage
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (erforderlich)

AzureBlobDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "AzureBlobStorage" (erforderlich)
containerName Zeichenfolge (erforderlich)
endpointUrl Zeichenfolge

CosmosCassandraDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente CosmosDBCassandra (erforderlich)
keyspaceName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge
tableName Zeichenfolge (erforderlich)

CosmosMongoDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBMongo" (erforderlich)
collectionName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge

CosmosSqlDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBSql" (erforderlich)
containerName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp databaseAccounts/dataTransferJobs kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • 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 der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-11-15-preview"
  name = "string"
  parent_id = "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 Komponenteneigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für AzureBlobStorage Folgendes:

  component = "AzureBlobStorage"
  containerName = "string"
  endpointUrl = "string"

Verwenden Sie für CosmosDBCassandra Folgendes:

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

Verwenden Sie für CosmosDBMongo Folgendes:

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

Verwenden Sie für CosmosDBSql Folgendes:

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

Eigenschaftswerte

databaseAccounts/dataTransferJobs

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-11-15-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: databaseAccounts
properties Datenübertragung Auftragseigenschaften erstellen DataTransferJobProperties (erforderlich)

DataTransferJobProperties

Name BESCHREIBUNG Wert
destination Details zum Zieldatenspeicher DataTransferDataSourceSink (erforderlich)
Modus Art der Auftragsausführung "Offline"
"Online"
source Quelldatenspeicherdetails DataTransferDataSourceSink (erforderlich)
ArbeiterZahl Workeranzahl INT

Einschränkungen:
Min-Wert = 0

DataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente Festlegen des Objekttyps AzureBlobStorage
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (erforderlich)

AzureBlobDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "AzureBlobStorage" (erforderlich)
containerName Zeichenfolge (erforderlich)
endpointUrl Zeichenfolge

CosmosCassandraDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBCassandra" (erforderlich)
keyspaceName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge
tableName Zeichenfolge (erforderlich)

CosmosMongoDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBMongo" (erforderlich)
collectionName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge

CosmosSqlDataTransferDataSourceSink

Name BESCHREIBUNG Wert
Komponente "CosmosDBSql" (erforderlich)
containerName Zeichenfolge (erforderlich)
databaseName Zeichenfolge (erforderlich)
remoteAccountName Zeichenfolge