Partager via

Base de données Microsoft.DocumentDBAccounts/dataTransferJobs

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/dataTransferJobs peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-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
  }
}

Objets DataTransferDataSourceSink

Définissez la propriété component pour spécifier le type d’objet.

Pour AzureBlobStorage, utilisez :

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

Pour CosmosDBCassandra, utilisez :

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

Pour CosmosDBMongo, utilisez :

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

Pour CosmosDBSql, utilisez :

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

Valeurs de propriétés

databaseAccounts/dataTransferJobs

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 string (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : databaseAccounts
properties Propriétés de la tâche de transfert de données DataTransferJobProperties (obligatoire)

DataTransferJobProperties

Nom Description Valeur
destination Détails du magasin de données de destination DataTransferDataSourceSink (obligatoire)
mode Mode d’exécution du travail 'Hors connexion'
'En ligne'
source Détails du magasin de données source DataTransferDataSourceSink (obligatoire)
workerCount Nombre de rôles de travail int

Contraintes :
Valeur minimale = 0

DataTransferDataSourceSink

Nom Description Valeur
component Définir le type d’objet StockageBlobAzure
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (obligatoire)

AzureBlobDataTransferDataSourceSink

Nom Description Valeur
component 'AzureBlobStorage' (obligatoire)
containerName string (obligatoire)
endpointUrl string

CosmosCassandraDataTransferDataSourceSink

Nom Description Valeur
component 'CosmosDBCassandra' (obligatoire)
keyspaceName string (obligatoire)
remoteAccountName string
tableName string (obligatoire)

CosmosMongoDataTransferDataSourceSink

Nom Description Valeur
component 'CosmosDBMongo' (obligatoire)
collectionName chaîne (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName string

CosmosSqlDataTransferDataSourceSink

Nom Description Valeur
component 'CosmosDBSql' (obligatoire)
containerName chaîne (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName string

Définition de ressources de modèle ARM

Le type de ressource databaseAccounts/dataTransferJobs peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, ajoutez le json suivant à votre modèle.

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

Objets DataTransferDataSourceSink

Définissez la propriété de composant pour spécifier le type d’objet.

Pour AzureBlobStorage, utilisez :

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

Pour CosmosDBCassandra, utilisez :

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

Pour CosmosDBMongo, utilisez :

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

Pour CosmosDBSql, utilisez :

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

Valeurs de propriétés

databaseAccounts/dataTransferJobs

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/dataTransferJobs »
apiVersion Version de l’API de ressource « 2024-05-15-preview »
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 chaîne (obligatoire)
properties Propriétés de la tâche de création de transfert de données DataTransferJobProperties (obligatoire)

DataTransferJobProperties

Nom Description Valeur
destination Détails du DataStore de destination DataTransferDataSourceSink (obligatoire)
mode Mode d’exécution du travail 'Hors connexion'
'Online'
source Détails du DataStore source DataTransferDataSourceSink (obligatoire)
workerCount Nombre de rôles de travail int

Contraintes :
Valeur minimale = 0

DataTransferDataSourceSink

Nom Description Valeur
component Définir le type d’objet StockageBlobAzure
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (obligatoire)

AzureBlobDataTransferDataSourceSink

Nom Description Valeur
component 'AzureBlobStorage' (obligatoire)
containerName chaîne (obligatoire)
endpointUrl string

CosmosCassandraDataTransferDataSourceSink

Nom Description Valeur
component 'CosmosDBCassandra' (obligatoire)
keyspaceName chaîne (obligatoire)
remoteAccountName string
tableName chaîne (obligatoire)

CosmosMongoDataTransferDataSourceSink

Nom Description Valeur
component 'CosmosDBMongo' (obligatoire)
collectionName chaîne (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName string

CosmosSqlDataTransferDataSourceSink

Nom Description Valeur
component 'CosmosDBSql' (obligatoire)
containerName chaîne (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/dataTransferJobs peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, ajoutez le Terraform suivant à votre modèle.

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

Objets DataTransferDataSourceSink

Définissez la propriété de composant pour spécifier le type d’objet.

Pour AzureBlobStorage, utilisez :

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

Pour CosmosDBCassandra, utilisez :

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

Pour CosmosDBMongo, utilisez :

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

Pour CosmosDBSql, utilisez :

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

Valeurs de propriétés

databaseAccounts/dataTransferJobs

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-05-15-preview »
name Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : databaseAccounts
properties Propriétés de la tâche de création de transfert de données DataTransferJobProperties (obligatoire)

DataTransferJobProperties

Nom Description Valeur
destination Détails du DataStore de destination DataTransferDataSourceSink (obligatoire)
mode Mode d’exécution du travail « Hors connexion »
« En ligne »
source Détails du DataStore source DataTransferDataSourceSink (obligatoire)
workerCount Nombre de rôles de travail int

Contraintes :
Valeur minimale = 0

DataTransferDataSourceSink

Nom Description Valeur
component Définir le type d’objet StockageBlobAzure
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (obligatoire)

AzureBlobDataTransferDataSourceSink

Nom Description Valeur
component « AzureBlobStorage » (obligatoire)
containerName chaîne (obligatoire)
endpointUrl string

CosmosCassandraDataTransferDataSourceSink

Nom Description Valeur
component « CosmosDBCassandra » (obligatoire)
keyspaceName string (obligatoire)
remoteAccountName string
tableName string (obligatoire)

CosmosMongoDataTransferDataSourceSink

Nom Description Valeur
component « CosmosDBMongo » (obligatoire)
collectionName string (obligatoire)
databaseName string (obligatoire)
remoteAccountName string

CosmosSqlDataTransferDataSourceSink

Nom Description Valeur
component « CosmosDBSql » (obligatoire)
containerName string (obligatoire)
databaseName string (obligatoire)
remoteAccountName string