DatasetSqlServerTable

Manages a SQL Server Table Dataset inside a Azure Data Factory.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "northeurope",
        });
        var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new Azure.DataFactory.FactoryArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleLinkedServiceSqlServer = new Azure.DataFactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer", new Azure.DataFactory.LinkedServiceSqlServerArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            DataFactoryName = exampleFactory.Name,
            ConnectionString = "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test",
        });
        var exampleDatasetSqlServerTable = new Azure.DataFactory.DatasetSqlServerTable("exampleDatasetSqlServerTable", new Azure.DataFactory.DatasetSqlServerTableArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            DataFactoryName = exampleFactory.Name,
            LinkedServiceName = exampleLinkedServiceSqlServer.Name,
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/datafactory"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("northeurope"),
        })
        if err != nil {
            return err
        }
        exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
        })
        if err != nil {
            return err
        }
        exampleLinkedServiceSqlServer, err := datafactory.NewLinkedServiceSqlServer(ctx, "exampleLinkedServiceSqlServer", &datafactory.LinkedServiceSqlServerArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            DataFactoryName:   exampleFactory.Name,
            ConnectionString:  pulumi.String("Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test"),
        })
        if err != nil {
            return err
        }
        _, err = datafactory.NewDatasetSqlServerTable(ctx, "exampleDatasetSqlServerTable", &datafactory.DatasetSqlServerTableArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            DataFactoryName:   exampleFactory.Name,
            LinkedServiceName: exampleLinkedServiceSqlServer.Name,
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_sql_server = azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test")
example_dataset_sql_server_table = azure.datafactory.DatasetSqlServerTable("exampleDatasetSqlServerTable",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    linked_service_name=example_linked_service_sql_server.name)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceSqlServer = new azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer", {
    resourceGroupName: exampleResourceGroup.name,
    dataFactoryName: exampleFactory.name,
    connectionString: "Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test",
});
const exampleDatasetSqlServerTable = new azure.datafactory.DatasetSqlServerTable("exampleDatasetSqlServerTable", {
    resourceGroupName: exampleResourceGroup.name,
    dataFactoryName: exampleFactory.name,
    linkedServiceName: exampleLinkedServiceSqlServer.name,
});

Create a DatasetSqlServerTable Resource

def DatasetSqlServerTable(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, folder=None, linked_service_name=None, name=None, parameters=None, resource_group_name=None, schema_columns=None, table_name=None, __props__=None);
name string
The unique name of the resource.
args DatasetSqlServerTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatasetSqlServerTableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatasetSqlServerTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

DatasetSqlServerTable Resource Properties

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

Inputs

The DatasetSqlServerTable resource accepts the following input properties:

DataFactoryName string

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

LinkedServiceName string

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

ResourceGroupName string

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

AdditionalProperties Dictionary<string, string>

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

Annotations List<string>

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

Description string

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. 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 SQL Server Table.

SchemaColumns List<DatasetSqlServerTableSchemaColumnArgs>

A schema_column block as defined below.

TableName string

The table name of the Data Factory Dataset SQL Server Table.

DataFactoryName string

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

LinkedServiceName string

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

ResourceGroupName string

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

AdditionalProperties map[string]string

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

Annotations []string

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

Description string

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. 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 SQL Server Table.

SchemaColumns []DatasetSqlServerTableSchemaColumn

A schema_column block as defined below.

TableName string

The table name of the Data Factory Dataset SQL Server Table.

dataFactoryName string

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

linkedServiceName string

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

resourceGroupName string

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

additionalProperties {[key: string]: string}

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

annotations string[]

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

description string

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. 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 SQL Server Table.

schemaColumns DatasetSqlServerTableSchemaColumn[]

A schema_column block as defined below.

tableName string

The table name of the Data Factory Dataset SQL Server Table.

data_factory_name str

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

linked_service_name str

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

resource_group_name str

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

additional_properties Dict[str, str]

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

annotations List[str]

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

description str

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Dict[str, str]

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

schema_columns List[DatasetSqlServerTableSchemaColumn]

A schema_column block as defined below.

table_name str

The table name of the Data Factory Dataset SQL Server Table.

Outputs

All input properties are implicitly available as output properties. Additionally, the DatasetSqlServerTable 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing DatasetSqlServerTable Resource

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

static get(resource_name, id, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, folder=None, linked_service_name=None, name=None, parameters=None, resource_group_name=None, schema_columns=None, table_name=None, __props__=None);
func GetDatasetSqlServerTable(ctx *Context, name string, id IDInput, state *DatasetSqlServerTableState, opts ...ResourceOption) (*DatasetSqlServerTable, error)
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.

The following state arguments are supported:

AdditionalProperties Dictionary<string, string>

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

Annotations List<string>

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

DataFactoryName string

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

Description string

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. 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 SQL Server Table.

ResourceGroupName string

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

SchemaColumns List<DatasetSqlServerTableSchemaColumnArgs>

A schema_column block as defined below.

TableName string

The table name of the Data Factory Dataset SQL Server Table.

AdditionalProperties map[string]string

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

Annotations []string

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

DataFactoryName string

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

Description string

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. 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 SQL Server Table.

ResourceGroupName string

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

SchemaColumns []DatasetSqlServerTableSchemaColumn

A schema_column block as defined below.

TableName string

The table name of the Data Factory Dataset SQL Server Table.

additionalProperties {[key: string]: string}

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

annotations string[]

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

dataFactoryName string

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

description string

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. 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 SQL Server Table.

resourceGroupName string

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

schemaColumns DatasetSqlServerTableSchemaColumn[]

A schema_column block as defined below.

tableName string

The table name of the Data Factory Dataset SQL Server Table.

additional_properties Dict[str, str]

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

annotations List[str]

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

data_factory_name str

The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

description str

The description for the Data Factory Dataset SQL Server Table.

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 SQL Server Table. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters Dict[str, str]

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

resource_group_name str

The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

schema_columns List[DatasetSqlServerTableSchemaColumn]

A schema_column block as defined below.

table_name str

The table name of the Data Factory Dataset SQL Server Table.

Supporting Types

DatasetSqlServerTableSchemaColumn

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.