Partager via

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

  • 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 de l’API, consultez journal des modifications.

Format de ressource

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

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

Objets DataTransferDataSourceSink

Définissez le composant propriété 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 :

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

Pour CosmosDBSql, utilisez :

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

Valeurs de propriété

AzureBlobDataTransferDataSourceSink

Nom Description Valeur
composant 'AzureBlobStorage' (obligatoire)
containerName chaîne (obligatoire)
endpointUrl corde

CosmosCassandraDataTransferDataSourceSink

Nom Description Valeur
composant 'CosmosDBCassandra' (obligatoire)
keyspaceName chaîne (obligatoire)
remoteAccountName corde
tableName chaîne (obligatoire)

CosmosMongoDataTransferDataSourceSink

Nom Description Valeur
collectionName chaîne (obligatoire)
composant 'CosmosDBMongo' (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName corde

CosmosSqlDataTransferDataSourceSink

Nom Description Valeur
composant 'CosmosDBSql' (obligatoire)
containerName chaîne (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName corde

DataTransferDataSourceSink

Nom Description Valeur
composant Défini sur « AzureBlobStorage » pour le type AzureBlobDataTransferDataSourceSink. Défini sur « CosmosDBCassandra » pour le type CosmosCassandraDataTransferDataSourceSink. Défini sur « CosmosDBMongo » pour le type CosmosMongoDataTransferDataSourceSink. Défini sur « CosmosDBSql » pour le type CosmosSqlDataTransferDataSourceSink. 'AzureBlobStorage'
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBSql' (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'
'Online'
source Détails du magasin de données source DataTransferDataSourceSink (obligatoire)
workerCount Nombre de workers Int

Contraintes:
Valeur minimale = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés Propriétés de création d’un travail de transfert de données DataTransferJobProperties (obligatoire)

Définition de ressource 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 de ressource

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

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

Objets DataTransferDataSourceSink

Définissez le composant propriété 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 :

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

Pour CosmosDBSql, utilisez :

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

Valeurs de propriété

AzureBlobDataTransferDataSourceSink

Nom Description Valeur
composant 'AzureBlobStorage' (obligatoire)
containerName chaîne (obligatoire)
endpointUrl corde

CosmosCassandraDataTransferDataSourceSink

Nom Description Valeur
composant 'CosmosDBCassandra' (obligatoire)
keyspaceName chaîne (obligatoire)
remoteAccountName corde
tableName chaîne (obligatoire)

CosmosMongoDataTransferDataSourceSink

Nom Description Valeur
collectionName chaîne (obligatoire)
composant 'CosmosDBMongo' (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName corde

CosmosSqlDataTransferDataSourceSink

Nom Description Valeur
composant 'CosmosDBSql' (obligatoire)
containerName chaîne (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName corde

DataTransferDataSourceSink

Nom Description Valeur
composant Défini sur « AzureBlobStorage » pour le type AzureBlobDataTransferDataSourceSink. Défini sur « CosmosDBCassandra » pour le type CosmosCassandraDataTransferDataSourceSink. Défini sur « CosmosDBMongo » pour le type CosmosMongoDataTransferDataSourceSink. Défini sur « CosmosDBSql » pour le type CosmosSqlDataTransferDataSourceSink. 'AzureBlobStorage'
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBSql' (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'
'Online'
source Détails du magasin de données source DataTransferDataSourceSink (obligatoire)
workerCount Nombre de workers Int

Contraintes:
Valeur minimale = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nom Description Valeur
apiVersion Version de l’API '2023-11-15-preview'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de création d’un travail de transfert de données DataTransferJobProperties (obligatoire)
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'

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 de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, ajoutez la terraform suivante à votre modèle.

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

Objets DataTransferDataSourceSink

Définissez le composant propriété 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 :

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

Pour CosmosDBSql, utilisez :

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

Valeurs de propriété

AzureBlobDataTransferDataSourceSink

Nom Description Valeur
composant 'AzureBlobStorage' (obligatoire)
containerName chaîne (obligatoire)
endpointUrl corde

CosmosCassandraDataTransferDataSourceSink

Nom Description Valeur
composant 'CosmosDBCassandra' (obligatoire)
keyspaceName chaîne (obligatoire)
remoteAccountName corde
tableName chaîne (obligatoire)

CosmosMongoDataTransferDataSourceSink

Nom Description Valeur
collectionName chaîne (obligatoire)
composant 'CosmosDBMongo' (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName corde

CosmosSqlDataTransferDataSourceSink

Nom Description Valeur
composant 'CosmosDBSql' (obligatoire)
containerName chaîne (obligatoire)
databaseName chaîne (obligatoire)
remoteAccountName corde

DataTransferDataSourceSink

Nom Description Valeur
composant Défini sur « AzureBlobStorage » pour le type AzureBlobDataTransferDataSourceSink. Défini sur « CosmosDBCassandra » pour le type CosmosCassandraDataTransferDataSourceSink. Défini sur « CosmosDBMongo » pour le type CosmosMongoDataTransferDataSourceSink. Défini sur « CosmosDBSql » pour le type CosmosSqlDataTransferDataSourceSink. 'AzureBlobStorage'
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBSql' (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'
'Online'
source Détails du magasin de données source DataTransferDataSourceSink (obligatoire)
workerCount Nombre de workers Int

Contraintes:
Valeur minimale = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts
Propriétés Propriétés de création d’un travail de transfert de données DataTransferJobProperties (obligatoire)
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-11-15-preview »