1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. DatasetCosmosDBApi
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.datafactory.DatasetCosmosDBApi

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAccount = Azure.CosmosDB.GetAccount.Invoke(new()
    {
        Name = "tfex-cosmosdb-account",
        ResourceGroupName = "tfex-cosmosdb-account-rg",
    });

    var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleLinkedServiceCosmosDb = new Azure.DataFactory.LinkedServiceCosmosDb("exampleLinkedServiceCosmosDb", new()
    {
        DataFactoryId = exampleFactory.Id,
        AccountEndpoint = exampleAccount.Apply(getAccountResult => getAccountResult.Endpoint),
        Database = "foo",
    });

    var exampleDatasetCosmosDBApi = new Azure.DataFactory.DatasetCosmosDBApi("exampleDatasetCosmosDBApi", new()
    {
        DataFactoryId = exampleFactory.Id,
        LinkedServiceName = exampleLinkedServiceCosmosDb.Name,
        CollectionName = "bar",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
	"github.com/pulumi/pulumi-azure/sdk/v5/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, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, 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, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		exampleLinkedServiceCosmosDb, err := datafactory.NewLinkedServiceCosmosDb(ctx, "exampleLinkedServiceCosmosDb", &datafactory.LinkedServiceCosmosDbArgs{
			DataFactoryId:   exampleFactory.ID(),
			AccountEndpoint: *pulumi.String(exampleAccount.Endpoint),
			Database:        pulumi.String("foo"),
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewDatasetCosmosDBApi(ctx, "exampleDatasetCosmosDBApi", &datafactory.DatasetCosmosDBApiArgs{
			DataFactoryId:     exampleFactory.ID(),
			LinkedServiceName: exampleLinkedServiceCosmosDb.Name,
			CollectionName:    pulumi.String("bar"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.cosmosdb.get_account(name="tfex-cosmosdb-account",
    resource_group_name="tfex-cosmosdb-account-rg")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_cosmos_db = azure.datafactory.LinkedServiceCosmosDb("exampleLinkedServiceCosmosDb",
    data_factory_id=example_factory.id,
    account_endpoint=example_account.endpoint,
    database="foo")
example_dataset_cosmos_db_api = azure.datafactory.DatasetCosmosDBApi("exampleDatasetCosmosDBApi",
    data_factory_id=example_factory.id,
    linked_service_name=example_linked_service_cosmos_db.name,
    collection_name="bar")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = azure.cosmosdb.getAccount({
    name: "tfex-cosmosdb-account",
    resourceGroupName: "tfex-cosmosdb-account-rg",
});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceCosmosDb = new azure.datafactory.LinkedServiceCosmosDb("exampleLinkedServiceCosmosDb", {
    dataFactoryId: exampleFactory.id,
    accountEndpoint: exampleAccount.then(exampleAccount => exampleAccount.endpoint),
    database: "foo",
});
const exampleDatasetCosmosDBApi = new azure.datafactory.DatasetCosmosDBApi("exampleDatasetCosmosDBApi", {
    dataFactoryId: exampleFactory.id,
    linkedServiceName: exampleLinkedServiceCosmosDb.name,
    collectionName: "bar",
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceCosmosDb:
    type: azure:datafactory:LinkedServiceCosmosDb
    properties:
      dataFactoryId: ${exampleFactory.id}
      accountEndpoint: ${exampleAccount.endpoint}
      database: foo
  exampleDatasetCosmosDBApi:
    type: azure:datafactory:DatasetCosmosDBApi
    properties:
      dataFactoryId: ${exampleFactory.id}
      linkedServiceName: ${exampleLinkedServiceCosmosDb.name}
      collectionName: bar
variables:
  exampleAccount:
    fn::invoke:
      Function: azure:cosmosdb:getAccount
      Arguments:
        name: tfex-cosmosdb-account
        resourceGroupName: tfex-cosmosdb-account-rg

Create DatasetCosmosDBApi Resource

new DatasetCosmosDBApi(name: string, args: DatasetCosmosDBApiArgs, opts?: CustomResourceOptions);
@overload
def DatasetCosmosDBApi(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       additional_properties: Optional[Mapping[str, str]] = None,
                       annotations: Optional[Sequence[str]] = None,
                       collection_name: Optional[str] = None,
                       data_factory_id: Optional[str] = None,
                       description: Optional[str] = None,
                       folder: Optional[str] = None,
                       linked_service_name: Optional[str] = None,
                       name: Optional[str] = None,
                       parameters: Optional[Mapping[str, str]] = None,
                       schema_columns: Optional[Sequence[DatasetCosmosDBApiSchemaColumnArgs]] = None)
@overload
def DatasetCosmosDBApi(resource_name: str,
                       args: DatasetCosmosDBApiArgs,
                       opts: Optional[ResourceOptions] = None)
func NewDatasetCosmosDBApi(ctx *Context, name string, args DatasetCosmosDBApiArgs, opts ...ResourceOption) (*DatasetCosmosDBApi, error)
public DatasetCosmosDBApi(string name, DatasetCosmosDBApiArgs args, CustomResourceOptions? opts = null)
public DatasetCosmosDBApi(String name, DatasetCosmosDBApiArgs args)
public DatasetCosmosDBApi(String name, DatasetCosmosDBApiArgs args, CustomResourceOptions options)

type: azure:datafactory:DatasetCosmosDBApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatasetCosmosDBApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DatasetCosmosDBApiArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatasetCosmosDBApiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatasetCosmosDBApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DatasetCosmosDBApiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DatasetCosmosDBApi Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DatasetCosmosDBApi resource accepts the following input properties:

DataFactoryId string

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

LinkedServiceName string

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

AdditionalProperties Dictionary<string, string>

A map of additional properties to associate with the Data Factory Dataset.

Annotations List<string>

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

CollectionName string

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

Description string

The description for the Data Factory Dataset.

Folder string

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

Name string

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.

Parameters Dictionary<string, string>

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

SchemaColumns List<DatasetCosmosDBApiSchemaColumnArgs>

A schema_column block as defined below.

DataFactoryId string

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

LinkedServiceName string

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

AdditionalProperties map[string]string

A map of additional properties to associate with the Data Factory Dataset.

Annotations []string

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

CollectionName string

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

Description string

The description for the Data Factory Dataset.

Folder string

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

Name string

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.

Parameters map[string]string

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

SchemaColumns []DatasetCosmosDBApiSchemaColumnArgs

A schema_column block as defined below.

dataFactoryId String

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

linkedServiceName String

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

additionalProperties Map<String,String>

A map of additional properties to associate with the Data Factory Dataset.

annotations List<String>

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

collectionName String

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

description String

The description for the Data Factory Dataset.

folder String

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

name String

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.

parameters Map<String,String>

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

schemaColumns List<DatasetCosmosDBApiSchemaColumnArgs>

A schema_column block as defined below.

dataFactoryId string

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

linkedServiceName string

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

additionalProperties {[key: string]: string}

A map of additional properties to associate with the Data Factory Dataset.

annotations string[]

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

collectionName string

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

description string

The description for the Data Factory Dataset.

folder string

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

name string

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.

parameters {[key: string]: string}

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

schemaColumns DatasetCosmosDBApiSchemaColumnArgs[]

A schema_column block as defined below.

data_factory_id str

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

linked_service_name str

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

additional_properties Mapping[str, str]

A map of additional properties to associate with the Data Factory Dataset.

annotations Sequence[str]

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

collection_name str

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

description str

The description for the Data Factory Dataset.

folder str

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

name str

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.

parameters Mapping[str, str]

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

schema_columns Sequence[DatasetCosmosDBApiSchemaColumnArgs]

A schema_column block as defined below.

dataFactoryId String

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

linkedServiceName String

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

additionalProperties Map<String>

A map of additional properties to associate with the Data Factory Dataset.

annotations List<String>

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

collectionName String

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

description String

The description for the Data Factory Dataset.

folder String

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

name String

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.

parameters Map<String>

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

schemaColumns List<Property Map>

A schema_column block as defined below.

Outputs

All input properties are implicitly available as output properties. Additionally, the DatasetCosmosDBApi resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing DatasetCosmosDBApi Resource

Get an existing DatasetCosmosDBApi resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DatasetCosmosDBApiState, opts?: CustomResourceOptions): DatasetCosmosDBApi
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        collection_name: Optional[str] = None,
        data_factory_id: Optional[str] = None,
        description: Optional[str] = None,
        folder: Optional[str] = None,
        linked_service_name: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        schema_columns: Optional[Sequence[DatasetCosmosDBApiSchemaColumnArgs]] = None) -> DatasetCosmosDBApi
func GetDatasetCosmosDBApi(ctx *Context, name string, id IDInput, state *DatasetCosmosDBApiState, opts ...ResourceOption) (*DatasetCosmosDBApi, error)
public static DatasetCosmosDBApi Get(string name, Input<string> id, DatasetCosmosDBApiState? state, CustomResourceOptions? opts = null)
public static DatasetCosmosDBApi get(String name, Output<String> id, DatasetCosmosDBApiState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdditionalProperties Dictionary<string, string>

A map of additional properties to associate with the Data Factory Dataset.

Annotations List<string>

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

CollectionName string

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

DataFactoryId string

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

Description string

The description for the Data Factory Dataset.

Folder string

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

LinkedServiceName string

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

Name string

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.

Parameters Dictionary<string, string>

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

SchemaColumns List<DatasetCosmosDBApiSchemaColumnArgs>

A schema_column block as defined below.

AdditionalProperties map[string]string

A map of additional properties to associate with the Data Factory Dataset.

Annotations []string

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

CollectionName string

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

DataFactoryId string

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

Description string

The description for the Data Factory Dataset.

Folder string

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

LinkedServiceName string

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

Name string

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.

Parameters map[string]string

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

SchemaColumns []DatasetCosmosDBApiSchemaColumnArgs

A schema_column block as defined below.

additionalProperties Map<String,String>

A map of additional properties to associate with the Data Factory Dataset.

annotations List<String>

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

collectionName String

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

dataFactoryId String

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

description String

The description for the Data Factory Dataset.

folder String

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

linkedServiceName String

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

name String

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.

parameters Map<String,String>

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

schemaColumns List<DatasetCosmosDBApiSchemaColumnArgs>

A schema_column block as defined below.

additionalProperties {[key: string]: string}

A map of additional properties to associate with the Data Factory Dataset.

annotations string[]

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

collectionName string

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

dataFactoryId string

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

description string

The description for the Data Factory Dataset.

folder string

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

linkedServiceName string

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

name string

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.

parameters {[key: string]: string}

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

schemaColumns DatasetCosmosDBApiSchemaColumnArgs[]

A schema_column block as defined below.

additional_properties Mapping[str, str]

A map of additional properties to associate with the Data Factory Dataset.

annotations Sequence[str]

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

collection_name str

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

data_factory_id str

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

description str

The description for the Data Factory Dataset.

folder str

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

linked_service_name str

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

name str

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.

parameters Mapping[str, str]

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

schema_columns Sequence[DatasetCosmosDBApiSchemaColumnArgs]

A schema_column block as defined below.

additionalProperties Map<String>

A map of additional properties to associate with the Data Factory Dataset.

annotations List<String>

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

collectionName String

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

dataFactoryId String

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

description String

The description for the Data Factory Dataset.

folder String

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

linkedServiceName String

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

name String

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.

parameters Map<String>

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

schemaColumns List<Property Map>

A schema_column block as defined below.

Supporting Types

DatasetCosmosDBApiSchemaColumn

Name string

The name of the column.

Description string

The description of the column.

Type string

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

Name string

The name of the column.

Description string

The description of the column.

Type string

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

name String

The name of the column.

description String

The description of the column.

type String

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

name string

The name of the column.

description string

The description of the column.

type string

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

name str

The name of the column.

description str

The description of the column.

type str

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

name String

The name of the column.

description String

The description of the column.

type String

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.