Compartilhar via


Microsoft.DocumentDB databaseAccounts/dataTransferJobs 2024-12-01-preview

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/dataTransferJobs pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, adicione o seguinte Bicep ao seu modelo.

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

Objetos DataTransferDataSourceSink

Defina o componente propriedade para especificar o tipo de objeto.

Para do AzureBlobStorage, use:

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

Para CosmosDBCassandra, use:

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

Para CosmosDBMongo, use:

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

Para cosmosDBSql, use:

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

Para CosmosDBMongoVCore, use:

{
  collectionName: 'string'
  component: 'CosmosDBMongoVCore'
  connectionStringKeyVaultUri: 'string'
  databaseName: 'string'
  hostName: 'string'
}

Valores de propriedade

AzureBlobDataTransferDataSourceSink

Nome Descrição Valor
componente 'AzureBlobStorage' (obrigatório)
containerName cadeia de caracteres (obrigatório)
endpointUrl corda

CosmosCassandraDataTransferDataSourceSink

Nome Descrição Valor
componente 'CosmosDBCassandra' (obrigatório)
keyspaceName cadeia de caracteres (obrigatório)
remoteAccountName corda
tableName cadeia de caracteres (obrigatório)

CosmosMongoDataTransferDataSourceSink

Nome Descrição Valor
collectionName cadeia de caracteres (obrigatório)
componente 'CosmosDBMongo' (obrigatório)
databaseName cadeia de caracteres (obrigatório)
remoteAccountName corda

CosmosMongoVCoreDataTransferDataSourceSink

Nome Descrição Valor
collectionName cadeia de caracteres (obrigatório)
componente 'CosmosDBMongoVCore' (obrigatório)
connectionStringKeyVaultUri corda
databaseName cadeia de caracteres (obrigatório)
hostName corda

CosmosSqlDataTransferDataSourceSink

Nome Descrição Valor
componente 'CosmosDBSql' (obrigatório)
containerName cadeia de caracteres (obrigatório)
databaseName cadeia de caracteres (obrigatório)
remoteAccountName corda

DataTransferDataSourceSink

Nome Descrição Valor
componente Defina como 'AzureBlobStorage' para o tipo AzureBlobDataTransferDataSourceSink. Defina como 'CosmosDBCassandra' para o tipo CosmosCassandraDataTransferDataSourceSink. Defina como 'CosmosDBMongo' para o tipo CosmosMongoDataTransferDataSourceSink . Defina como 'CosmosDBSql' para o tipo CosmosSqlDataTransferDataSourceSink . Defina como 'CosmosDBMongoVCore' para o tipo CosmosMongoVCoreDataTransferDataSourceSink. 'AzureBlobStorage'
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBMongoVCore'
'CosmosDBSql' (obrigatório)

DataTransferJobProperties

Nome Descrição Valor
destino Detalhes do Armazenamento de Dados de Destino DataTransferDataSourceSink (obrigatório)
modo Modo de execução do trabalho 'Offline'
'Online'
fonte Detalhes do Armazenamento de Dados de Origem DataTransferDataSourceSink (obrigatório)
workerCount Contagem de trabalhadores int

Restrições:
Valor mínimo = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico do recurso do tipo: databaseAccounts
Propriedades Criar propriedades de trabalho de criação de transferência de dados DataTransferJobProperties (obrigatório)

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/dataTransferJobs pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "apiVersion": "2024-12-01-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"
  }
}

Objetos DataTransferDataSourceSink

Defina o componente propriedade para especificar o tipo de objeto.

Para do AzureBlobStorage, use:

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

Para CosmosDBCassandra, use:

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

Para CosmosDBMongo, use:

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

Para cosmosDBSql, use:

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

Para CosmosDBMongoVCore, use:

{
  "collectionName": "string",
  "component": "CosmosDBMongoVCore",
  "connectionStringKeyVaultUri": "string",
  "databaseName": "string",
  "hostName": "string"
}

Valores de propriedade

AzureBlobDataTransferDataSourceSink

Nome Descrição Valor
componente 'AzureBlobStorage' (obrigatório)
containerName cadeia de caracteres (obrigatório)
endpointUrl corda

CosmosCassandraDataTransferDataSourceSink

Nome Descrição Valor
componente 'CosmosDBCassandra' (obrigatório)
keyspaceName cadeia de caracteres (obrigatório)
remoteAccountName corda
tableName cadeia de caracteres (obrigatório)

CosmosMongoDataTransferDataSourceSink

Nome Descrição Valor
collectionName cadeia de caracteres (obrigatório)
componente 'CosmosDBMongo' (obrigatório)
databaseName cadeia de caracteres (obrigatório)
remoteAccountName corda

CosmosMongoVCoreDataTransferDataSourceSink

Nome Descrição Valor
collectionName cadeia de caracteres (obrigatório)
componente 'CosmosDBMongoVCore' (obrigatório)
connectionStringKeyVaultUri corda
databaseName cadeia de caracteres (obrigatório)
hostName corda

CosmosSqlDataTransferDataSourceSink

Nome Descrição Valor
componente 'CosmosDBSql' (obrigatório)
containerName cadeia de caracteres (obrigatório)
databaseName cadeia de caracteres (obrigatório)
remoteAccountName corda

DataTransferDataSourceSink

Nome Descrição Valor
componente Defina como 'AzureBlobStorage' para o tipo AzureBlobDataTransferDataSourceSink. Defina como 'CosmosDBCassandra' para o tipo CosmosCassandraDataTransferDataSourceSink. Defina como 'CosmosDBMongo' para o tipo CosmosMongoDataTransferDataSourceSink . Defina como 'CosmosDBSql' para o tipo CosmosSqlDataTransferDataSourceSink . Defina como 'CosmosDBMongoVCore' para o tipo CosmosMongoVCoreDataTransferDataSourceSink. 'AzureBlobStorage'
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBMongoVCore'
'CosmosDBSql' (obrigatório)

DataTransferJobProperties

Nome Descrição Valor
destino Detalhes do Armazenamento de Dados de Destino DataTransferDataSourceSink (obrigatório)
modo Modo de execução do trabalho 'Offline'
'Online'
fonte Detalhes do Armazenamento de Dados de Origem DataTransferDataSourceSink (obrigatório)
workerCount Contagem de trabalhadores int

Restrições:
Valor mínimo = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nome Descrição Valor
apiVersion A versão da API '2024-12-01-preview'
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Criar propriedades de trabalho de criação de transferência de dados DataTransferJobProperties (obrigatório)
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso databaseAccounts/dataTransferJobs pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, adicione o Terraform a seguir ao modelo.

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

Objetos DataTransferDataSourceSink

Defina o componente propriedade para especificar o tipo de objeto.

Para do AzureBlobStorage, use:

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

Para CosmosDBCassandra, use:

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

Para CosmosDBMongo, use:

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

Para cosmosDBSql, use:

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

Para CosmosDBMongoVCore, use:

{
  collectionName = "string"
  component = "CosmosDBMongoVCore"
  connectionStringKeyVaultUri = "string"
  databaseName = "string"
  hostName = "string"
}

Valores de propriedade

AzureBlobDataTransferDataSourceSink

Nome Descrição Valor
componente 'AzureBlobStorage' (obrigatório)
containerName cadeia de caracteres (obrigatório)
endpointUrl corda

CosmosCassandraDataTransferDataSourceSink

Nome Descrição Valor
componente 'CosmosDBCassandra' (obrigatório)
keyspaceName cadeia de caracteres (obrigatório)
remoteAccountName corda
tableName cadeia de caracteres (obrigatório)

CosmosMongoDataTransferDataSourceSink

Nome Descrição Valor
collectionName cadeia de caracteres (obrigatório)
componente 'CosmosDBMongo' (obrigatório)
databaseName cadeia de caracteres (obrigatório)
remoteAccountName corda

CosmosMongoVCoreDataTransferDataSourceSink

Nome Descrição Valor
collectionName cadeia de caracteres (obrigatório)
componente 'CosmosDBMongoVCore' (obrigatório)
connectionStringKeyVaultUri corda
databaseName cadeia de caracteres (obrigatório)
hostName corda

CosmosSqlDataTransferDataSourceSink

Nome Descrição Valor
componente 'CosmosDBSql' (obrigatório)
containerName cadeia de caracteres (obrigatório)
databaseName cadeia de caracteres (obrigatório)
remoteAccountName corda

DataTransferDataSourceSink

Nome Descrição Valor
componente Defina como 'AzureBlobStorage' para o tipo AzureBlobDataTransferDataSourceSink. Defina como 'CosmosDBCassandra' para o tipo CosmosCassandraDataTransferDataSourceSink. Defina como 'CosmosDBMongo' para o tipo CosmosMongoDataTransferDataSourceSink . Defina como 'CosmosDBSql' para o tipo CosmosSqlDataTransferDataSourceSink . Defina como 'CosmosDBMongoVCore' para o tipo CosmosMongoVCoreDataTransferDataSourceSink. 'AzureBlobStorage'
'CosmosDBCassandra'
'CosmosDBMongo'
'CosmosDBMongoVCore'
'CosmosDBSql' (obrigatório)

DataTransferJobProperties

Nome Descrição Valor
destino Detalhes do Armazenamento de Dados de Destino DataTransferDataSourceSink (obrigatório)
modo Modo de execução do trabalho 'Offline'
'Online'
fonte Detalhes do Armazenamento de Dados de Origem DataTransferDataSourceSink (obrigatório)
workerCount Contagem de trabalhadores int

Restrições:
Valor mínimo = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: databaseAccounts
Propriedades Criar propriedades de trabalho de criação de transferência de dados DataTransferJobProperties (obrigatório)
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-12-01-preview"