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
new DatasetSqlServerTable(name: string, args: DatasetSqlServerTableArgs, opts?: CustomResourceOptions);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);func NewDatasetSqlServerTable(ctx *Context, name string, args DatasetSqlServerTableArgs, opts ...ResourceOption) (*DatasetSqlServerTable, error)public DatasetSqlServerTable(string name, DatasetSqlServerTableArgs args, CustomResourceOptions? opts = null)- 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:
- Data
Factory stringName The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
- Linked
Service stringName The Data Factory Linked Service name in which to associate the Dataset with.
- Resource
Group stringName 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 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.
- Schema
Columns List<DatasetSql Server Table Schema Column Args> A
schema_columnblock as defined below.- Table
Name string The table name of the Data Factory Dataset SQL Server Table.
- Data
Factory stringName The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
- Linked
Service stringName The Data Factory Linked Service name in which to associate the Dataset with.
- Resource
Group stringName 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 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.
- Schema
Columns []DatasetSql Server Table Schema Column A
schema_columnblock as defined below.- Table
Name string The table name of the Data Factory Dataset SQL Server Table.
- data
Factory stringName The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
- linked
Service stringName The Data Factory Linked Service name in which to associate the Dataset with.
- resource
Group stringName 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 {[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.
- schema
Columns DatasetSql Server Table Schema Column[] A
schema_columnblock as defined below.- table
Name string The table name of the Data Factory Dataset SQL Server Table.
- data_
factory_ strname The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
- linked_
service_ strname The Data Factory Linked Service name in which to associate the Dataset with.
- resource_
group_ strname 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[DatasetSql Server Table Schema Column] A
schema_columnblock 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:
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.
public static get(name: string, id: Input<ID>, state?: DatasetSqlServerTableState, opts?: CustomResourceOptions): DatasetSqlServerTablestatic 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)public static DatasetSqlServerTable Get(string name, Input<string> id, DatasetSqlServerTableState? state, CustomResourceOptions? opts = null)- 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:
- Additional
Properties 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.
- Data
Factory stringName 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.
- Linked
Service stringName 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.
- Resource
Group stringName 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<DatasetSql Server Table Schema Column Args> A
schema_columnblock as defined below.- Table
Name string The table name of the Data Factory Dataset SQL Server Table.
- Additional
Properties 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.
- Data
Factory stringName 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.
- Linked
Service stringName 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.
- Resource
Group stringName 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 []DatasetSql Server Table Schema Column A
schema_columnblock as defined below.- Table
Name string The table name of the Data Factory Dataset SQL Server Table.
- additional
Properties {[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.
- data
Factory stringName 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.
- linked
Service stringName 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.
- resource
Group stringName 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 DatasetSql Server Table Schema Column[] A
schema_columnblock as defined below.- table
Name 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_ strname 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_ strname 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_ strname 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[DatasetSql Server Table Schema Column] A
schema_columnblock as defined below.- table_
name str The table name of the Data Factory Dataset SQL Server Table.
Supporting Types
DatasetSqlServerTableSchemaColumn
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.