pulumi-azure-kotlin/com.pulumi.azure.datafactory.kotlin/DatasetCosmosDBApiArgs

DatasetCosmosDBApiArgs

data class DatasetCosmosDBApiArgs(val additionalProperties: Output<Map<String, String>>? = null, val annotations: Output<List<String>>? = null, val collectionName: Output<String>? = null, val dataFactoryId: Output<String>? = null, val description: Output<String>? = null, val folder: Output<String>? = null, val linkedServiceName: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val schemaColumns: Output<List<DatasetCosmosDBApiSchemaColumnArgs>>? = null) : ConvertibleToJava<DatasetCosmosDBApiArgs>

Manages an Azure Cosmos DB SQL API Dataset inside an Azure Data Factory.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.cosmosdb.CosmosdbFunctions;
import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.datafactory.LinkedServiceCosmosDb;
import com.pulumi.azure.datafactory.LinkedServiceCosmosDbArgs;
import com.pulumi.azure.datafactory.DatasetCosmosDBApi;
import com.pulumi.azure.datafactory.DatasetCosmosDBApiArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        final var exampleAccount = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
            .name("tfex-cosmosdb-account")
            .resourceGroupName("tfex-cosmosdb-account-rg")
            .build());
        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());
        var exampleLinkedServiceCosmosDb = new LinkedServiceCosmosDb("exampleLinkedServiceCosmosDb", LinkedServiceCosmosDbArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .accountEndpoint(exampleAccount.applyValue(getAccountResult -> getAccountResult.endpoint()))
            .database("foo")
            .build());
        var exampleDatasetCosmosDBApi = new DatasetCosmosDBApi("exampleDatasetCosmosDBApi", DatasetCosmosDBApiArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .linkedServiceName(exampleLinkedServiceCosmosDb.name())
            .collectionName("bar")
            .build());
    }
}
Content copied to clipboard

Import

Data Factory Datasets can be imported using the resource id, e.g.

$ pulumi import azure:datafactory/datasetCosmosDBApi:DatasetCosmosDBApi example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
Content copied to clipboard

Constructors

Link copied to clipboard
fun DatasetCosmosDBApiArgs(additionalProperties: Output<Map<String, String>>? = null, annotations: Output<List<String>>? = null, collectionName: Output<String>? = null, dataFactoryId: Output<String>? = null, description: Output<String>? = null, folder: Output<String>? = null, linkedServiceName: Output<String>? = null, name: Output<String>? = null, parameters: Output<Map<String, String>>? = null, schemaColumns: Output<List<DatasetCosmosDBApiSchemaColumnArgs>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DatasetCosmosDBApiArgs

Properties

Link copied to clipboard
val additionalProperties: Output<Map<String, String>>? = null

A map of additional properties to associate with the Data Factory Dataset. The following supported arguments are specific to Azure Cosmos DB SQL API Dataset:

Link copied to clipboard
val annotations: Output<List<String>>? = null

List of tags that can be used for describing the Data Factory Dataset.

Link copied to clipboard
val collectionName: Output<String>? = null

The collection name of the Data Factory Dataset Azure Cosmos DB SQL API.

Link copied to clipboard
val dataFactoryId: Output<String>? = null

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Link copied to clipboard
val description: Output<String>? = null

The description for the Data Factory Dataset.

Link copied to clipboard
val folder: Output<String>? = null

The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.

Link copied to clipboard
val linkedServiceName: Output<String>? = null

The Data Factory Linked Service name in which to associate the Dataset with.

Link copied to clipboard
val name: Output<String>? = null

Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

Link copied to clipboard
val parameters: Output<Map<String, String>>? = null

A map of parameters to associate with the Data Factory Dataset.

Link copied to clipboard
val schemaColumns: Output<List<DatasetCosmosDBApiSchemaColumnArgs>>? = null

A schema_column block as defined below.