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

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const example = azure.cosmosdb.getAccount({
    name: "tfex-cosmosdb-account",
    resourceGroupName: "tfex-cosmosdb-account-rg",
});
const exampleFactory = new azure.datafactory.Factory("example", {
    name: "example",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceCosmosDb = new azure.datafactory.LinkedServiceCosmosDb("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    accountEndpoint: example.then(example => example.endpoint),
    database: "foo",
});
const exampleDatasetCosmosDBApi = new azure.datafactory.DatasetCosmosDBApi("example", {
    name: "example",
    dataFactoryId: exampleFactory.id,
    linkedServiceName: exampleLinkedServiceCosmosDb.name,
    collectionName: "bar",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
    resource_group_name="tfex-cosmosdb-account-rg")
example_factory = azure.datafactory.Factory("example",
    name="example",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_cosmos_db = azure.datafactory.LinkedServiceCosmosDb("example",
    name="example",
    data_factory_id=example_factory.id,
    account_endpoint=example.endpoint,
    database="foo")
example_dataset_cosmos_db_api = azure.datafactory.DatasetCosmosDBApi("example",
    name="example",
    data_factory_id=example_factory.id,
    linked_service_name=example_linked_service_cosmos_db.name,
    collection_name="bar")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });
    var example = Azure.CosmosDB.GetAccount.Invoke(new()
    {
        Name = "tfex-cosmosdb-account",
        ResourceGroupName = "tfex-cosmosdb-account-rg",
    });
    var exampleFactory = new Azure.DataFactory.Factory("example", new()
    {
        Name = "example",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });
    var exampleLinkedServiceCosmosDb = new Azure.DataFactory.LinkedServiceCosmosDb("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        AccountEndpoint = example.Apply(getAccountResult => getAccountResult.Endpoint),
        Database = "foo",
    });
    var exampleDatasetCosmosDBApi = new Azure.DataFactory.DatasetCosmosDBApi("example", new()
    {
        Name = "example",
        DataFactoryId = exampleFactory.Id,
        LinkedServiceName = exampleLinkedServiceCosmosDb.Name,
        CollectionName = "bar",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cosmosdb"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/datafactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		example, err := cosmosdb.LookupAccount(ctx, &cosmosdb.LookupAccountArgs{
			Name:              "tfex-cosmosdb-account",
			ResourceGroupName: "tfex-cosmosdb-account-rg",
		}, nil)
		if err != nil {
			return err
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
			Name:              pulumi.String("example"),
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		exampleLinkedServiceCosmosDb, err := datafactory.NewLinkedServiceCosmosDb(ctx, "example", &datafactory.LinkedServiceCosmosDbArgs{
			Name:            pulumi.String("example"),
			DataFactoryId:   exampleFactory.ID(),
			AccountEndpoint: pulumi.String(example.Endpoint),
			Database:        pulumi.String("foo"),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewDatasetCosmosDBApi(ctx, "example", &datafactory.DatasetCosmosDBApiArgs{
			Name:              pulumi.String("example"),
			DataFactoryId:     exampleFactory.ID(),
			LinkedServiceName: exampleLinkedServiceCosmosDb.Name,
			CollectionName:    pulumi.String("bar"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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()
            .name("example-resources")
            .location("West Europe")
            .build());
        final var example = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
            .name("tfex-cosmosdb-account")
            .resourceGroupName("tfex-cosmosdb-account-rg")
            .build());
        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .name("example")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());
        var exampleLinkedServiceCosmosDb = new LinkedServiceCosmosDb("exampleLinkedServiceCosmosDb", LinkedServiceCosmosDbArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .accountEndpoint(example.applyValue(getAccountResult -> getAccountResult.endpoint()))
            .database("foo")
            .build());
        var exampleDatasetCosmosDBApi = new DatasetCosmosDBApi("exampleDatasetCosmosDBApi", DatasetCosmosDBApiArgs.builder()
            .name("example")
            .dataFactoryId(exampleFactory.id())
            .linkedServiceName(exampleLinkedServiceCosmosDb.name())
            .collectionName("bar")
            .build());
    }
}
Content copied to clipboard
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: example-resources
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    name: example
    properties:
      name: example
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceCosmosDb:
    type: azure:datafactory:LinkedServiceCosmosDb
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      accountEndpoint: ${example.endpoint}
      database: foo
  exampleDatasetCosmosDBApi:
    type: azure:datafactory:DatasetCosmosDBApi
    name: example
    properties:
      name: example
      dataFactoryId: ${exampleFactory.id}
      linkedServiceName: ${exampleLinkedServiceCosmosDb.name}
      collectionName: bar
variables:
  example:
    fn::invoke:
      function: azure:cosmosdb:getAccount
      arguments:
        name: tfex-cosmosdb-account
        resourceGroupName: tfex-cosmosdb-account-rg
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
constructor(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)

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.

Functions

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