Udostępnij za pośrednictwem

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

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/dataTransferJobs można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, dodaj następujący kod Bicep do szablonu.

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

Obiekty DataTransferDataSourceSink

Ustaw właściwość składnika , aby określić typ obiektu.

W przypadku azureBlobStorageużyj:

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

W przypadku usługi CosmosDBCassandraużyj:

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

W przypadku CosmosDBMongoużyj:

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

W przypadku CosmosDBSqlużyj:

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

Wartości właściwości

AzureBlobDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "AzureBlobStorage" (wymagane)
containerName ciąg (wymagany)
endpointUrl struna

CosmosCassandraDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "CosmosDBCassandra" (wymagane)
keyspaceName ciąg (wymagany)
remoteAccountName struna
tableName ciąg (wymagany)

CosmosMongoDataTransferDataSourceSink

Nazwa Opis Wartość
collectionName ciąg (wymagany)
składnik "CosmosDBMongo" (wymagane)
databaseName ciąg (wymagany)
remoteAccountName struna

CosmosSqlDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "CosmosDBSql" (wymagane)
containerName ciąg (wymagany)
databaseName ciąg (wymagany)
remoteAccountName struna

DataTransferDataSourceSink

Nazwa Opis Wartość
składnik Ustaw wartość "AzureBlobStorage" dla typu AzureBlobDataTransferDataSourceSink. Ustaw wartość "CosmosDBCassandra" dla typu CosmosCassandraDataTransferDataSourceSink. Ustaw wartość "CosmosDBMongo" dla typu CosmosMongoDataTransferSourceSink. Ustaw wartość "CosmosDBSql" dla typu CosmosSqlDataTransferDataSourceSink. "AzureBlobStorage"
"CosmosDBCassandra"
"CosmosDBMongo"
"CosmosDBSql" (wymagane)

DataTransferJobProperties

Nazwa Opis Wartość
cel Szczegóły docelowego magazynu danych DataTransferDataSourceSink (wymagane)
tryb Tryb wykonywania zadania "Offline"
"Online"
źródło Szczegóły źródłowego magazynu danych DataTransferDataSourceSink (wymagane)
workerCount Liczba procesów roboczych Int

Ograniczenia:
Minimalna wartość = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts
Właściwości Właściwości tworzenia zadania tworzenia transferu danych DataTransferJobProperties (wymagane)

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/dataTransferJobs można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, dodaj następujący kod JSON do szablonu.

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

Obiekty DataTransferDataSourceSink

Ustaw właściwość składnika , aby określić typ obiektu.

W przypadku azureBlobStorageużyj:

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

W przypadku usługi CosmosDBCassandraużyj:

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

W przypadku CosmosDBMongoużyj:

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

W przypadku CosmosDBSqlużyj:

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

Wartości właściwości

AzureBlobDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "AzureBlobStorage" (wymagane)
containerName ciąg (wymagany)
endpointUrl struna

CosmosCassandraDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "CosmosDBCassandra" (wymagane)
keyspaceName ciąg (wymagany)
remoteAccountName struna
tableName ciąg (wymagany)

CosmosMongoDataTransferDataSourceSink

Nazwa Opis Wartość
collectionName ciąg (wymagany)
składnik "CosmosDBMongo" (wymagane)
databaseName ciąg (wymagany)
remoteAccountName struna

CosmosSqlDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "CosmosDBSql" (wymagane)
containerName ciąg (wymagany)
databaseName ciąg (wymagany)
remoteAccountName struna

DataTransferDataSourceSink

Nazwa Opis Wartość
składnik Ustaw wartość "AzureBlobStorage" dla typu AzureBlobDataTransferDataSourceSink. Ustaw wartość "CosmosDBCassandra" dla typu CosmosCassandraDataTransferDataSourceSink. Ustaw wartość "CosmosDBMongo" dla typu CosmosMongoDataTransferSourceSink. Ustaw wartość "CosmosDBSql" dla typu CosmosSqlDataTransferDataSourceSink. "AzureBlobStorage"
"CosmosDBCassandra"
"CosmosDBMongo"
"CosmosDBSql" (wymagane)

DataTransferJobProperties

Nazwa Opis Wartość
cel Szczegóły docelowego magazynu danych DataTransferDataSourceSink (wymagane)
tryb Tryb wykonywania zadania "Offline"
"Online"
źródło Szczegóły źródłowego magazynu danych DataTransferDataSourceSink (wymagane)
workerCount Liczba procesów roboczych Int

Ograniczenia:
Minimalna wartość = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2024-02-15-preview"
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości tworzenia zadania tworzenia transferu danych DataTransferJobProperties (wymagane)
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs"

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/dataTransferJobs można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/dataTransferJobs, dodaj następujący program Terraform do szablonu.

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

Obiekty DataTransferDataSourceSink

Ustaw właściwość składnika , aby określić typ obiektu.

W przypadku azureBlobStorageużyj:

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

W przypadku usługi CosmosDBCassandraużyj:

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

W przypadku CosmosDBMongoużyj:

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

W przypadku CosmosDBSqlużyj:

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

Wartości właściwości

AzureBlobDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "AzureBlobStorage" (wymagane)
containerName ciąg (wymagany)
endpointUrl struna

CosmosCassandraDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "CosmosDBCassandra" (wymagane)
keyspaceName ciąg (wymagany)
remoteAccountName struna
tableName ciąg (wymagany)

CosmosMongoDataTransferDataSourceSink

Nazwa Opis Wartość
collectionName ciąg (wymagany)
składnik "CosmosDBMongo" (wymagane)
databaseName ciąg (wymagany)
remoteAccountName struna

CosmosSqlDataTransferDataSourceSink

Nazwa Opis Wartość
składnik "CosmosDBSql" (wymagane)
containerName ciąg (wymagany)
databaseName ciąg (wymagany)
remoteAccountName struna

DataTransferDataSourceSink

Nazwa Opis Wartość
składnik Ustaw wartość "AzureBlobStorage" dla typu AzureBlobDataTransferDataSourceSink. Ustaw wartość "CosmosDBCassandra" dla typu CosmosCassandraDataTransferDataSourceSink. Ustaw wartość "CosmosDBMongo" dla typu CosmosMongoDataTransferSourceSink. Ustaw wartość "CosmosDBSql" dla typu CosmosSqlDataTransferDataSourceSink. "AzureBlobStorage"
"CosmosDBCassandra"
"CosmosDBMongo"
"CosmosDBSql" (wymagane)

DataTransferJobProperties

Nazwa Opis Wartość
cel Szczegóły docelowego magazynu danych DataTransferDataSourceSink (wymagane)
tryb Tryb wykonywania zadania "Offline"
"Online"
źródło Szczegóły źródłowego magazynu danych DataTransferDataSourceSink (wymagane)
workerCount Liczba procesów roboczych Int

Ograniczenia:
Minimalna wartość = 0

Microsoft.DocumentDB/databaseAccounts/dataTransferJobs

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts
Właściwości Właściwości tworzenia zadania tworzenia transferu danych DataTransferJobProperties (wymagane)
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-02-15-preview"