We recommend using Azure Native.
azure.datafactory.LinkedServicePostgresql
Explore with Pulumi AI
Manages a Linked Service (connection) between PostgreSQL and Azure Data Factory.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleFactory = new azure.datafactory.Factory("example", {
name: "example",
location: example.location,
resourceGroupName: example.name,
});
const exampleLinkedServicePostgresql = new azure.datafactory.LinkedServicePostgresql("example", {
name: "example",
dataFactoryId: exampleFactory.id,
connectionString: "Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_factory = azure.datafactory.Factory("example",
name="example",
location=example.location,
resource_group_name=example.name)
example_linked_service_postgresql = azure.datafactory.LinkedServicePostgresql("example",
name="example",
data_factory_id=example_factory.id,
connection_string="Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"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 {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
Name: pulumi.String("example"),
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
_, err = datafactory.NewLinkedServicePostgresql(ctx, "example", &datafactory.LinkedServicePostgresqlArgs{
Name: pulumi.String("example"),
DataFactoryId: exampleFactory.ID(),
ConnectionString: pulumi.String("Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleFactory = new Azure.DataFactory.Factory("example", new()
{
Name = "example",
Location = example.Location,
ResourceGroupName = example.Name,
});
var exampleLinkedServicePostgresql = new Azure.DataFactory.LinkedServicePostgresql("example", new()
{
Name = "example",
DataFactoryId = exampleFactory.Id,
ConnectionString = "Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example",
});
});
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.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.datafactory.LinkedServicePostgresql;
import com.pulumi.azure.datafactory.LinkedServicePostgresqlArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
.name("example")
.location(example.location())
.resourceGroupName(example.name())
.build());
var exampleLinkedServicePostgresql = new LinkedServicePostgresql("exampleLinkedServicePostgresql", LinkedServicePostgresqlArgs.builder()
.name("example")
.dataFactoryId(exampleFactory.id())
.connectionString("Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleFactory:
type: azure:datafactory:Factory
name: example
properties:
name: example
location: ${example.location}
resourceGroupName: ${example.name}
exampleLinkedServicePostgresql:
type: azure:datafactory:LinkedServicePostgresql
name: example
properties:
name: example
dataFactoryId: ${exampleFactory.id}
connectionString: Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example
Create LinkedServicePostgresql Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LinkedServicePostgresql(name: string, args: LinkedServicePostgresqlArgs, opts?: CustomResourceOptions);
@overload
def LinkedServicePostgresql(resource_name: str,
args: LinkedServicePostgresqlArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LinkedServicePostgresql(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_string: Optional[str] = None,
data_factory_id: Optional[str] = None,
additional_properties: Optional[Mapping[str, str]] = None,
annotations: Optional[Sequence[str]] = None,
description: Optional[str] = None,
integration_runtime_name: Optional[str] = None,
name: Optional[str] = None,
parameters: Optional[Mapping[str, str]] = None)
func NewLinkedServicePostgresql(ctx *Context, name string, args LinkedServicePostgresqlArgs, opts ...ResourceOption) (*LinkedServicePostgresql, error)
public LinkedServicePostgresql(string name, LinkedServicePostgresqlArgs args, CustomResourceOptions? opts = null)
public LinkedServicePostgresql(String name, LinkedServicePostgresqlArgs args)
public LinkedServicePostgresql(String name, LinkedServicePostgresqlArgs args, CustomResourceOptions options)
type: azure:datafactory:LinkedServicePostgresql
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LinkedServicePostgresqlArgs
- 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 LinkedServicePostgresqlArgs
- 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 LinkedServicePostgresqlArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LinkedServicePostgresqlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LinkedServicePostgresqlArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var linkedServicePostgresqlResource = new Azure.DataFactory.LinkedServicePostgresql("linkedServicePostgresqlResource", new()
{
ConnectionString = "string",
DataFactoryId = "string",
AdditionalProperties =
{
{ "string", "string" },
},
Annotations = new[]
{
"string",
},
Description = "string",
IntegrationRuntimeName = "string",
Name = "string",
Parameters =
{
{ "string", "string" },
},
});
example, err := datafactory.NewLinkedServicePostgresql(ctx, "linkedServicePostgresqlResource", &datafactory.LinkedServicePostgresqlArgs{
ConnectionString: pulumi.String("string"),
DataFactoryId: pulumi.String("string"),
AdditionalProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
Annotations: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
IntegrationRuntimeName: pulumi.String("string"),
Name: pulumi.String("string"),
Parameters: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var linkedServicePostgresqlResource = new LinkedServicePostgresql("linkedServicePostgresqlResource", LinkedServicePostgresqlArgs.builder()
.connectionString("string")
.dataFactoryId("string")
.additionalProperties(Map.of("string", "string"))
.annotations("string")
.description("string")
.integrationRuntimeName("string")
.name("string")
.parameters(Map.of("string", "string"))
.build());
linked_service_postgresql_resource = azure.datafactory.LinkedServicePostgresql("linkedServicePostgresqlResource",
connection_string="string",
data_factory_id="string",
additional_properties={
"string": "string",
},
annotations=["string"],
description="string",
integration_runtime_name="string",
name="string",
parameters={
"string": "string",
})
const linkedServicePostgresqlResource = new azure.datafactory.LinkedServicePostgresql("linkedServicePostgresqlResource", {
connectionString: "string",
dataFactoryId: "string",
additionalProperties: {
string: "string",
},
annotations: ["string"],
description: "string",
integrationRuntimeName: "string",
name: "string",
parameters: {
string: "string",
},
});
type: azure:datafactory:LinkedServicePostgresql
properties:
additionalProperties:
string: string
annotations:
- string
connectionString: string
dataFactoryId: string
description: string
integrationRuntimeName: string
name: string
parameters:
string: string
LinkedServicePostgresql Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LinkedServicePostgresql resource accepts the following input properties:
- Connection
String string - The connection string in which to authenticate with PostgreSQL.
- Data
Factory stringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- Additional
Properties Dictionary<string, string> - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- Annotations List<string>
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- Description string
- The description for the Data Factory Linked Service PostgreSQL.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- Name string
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- Parameters Dictionary<string, string>
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- Connection
String string - The connection string in which to authenticate with PostgreSQL.
- Data
Factory stringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- Additional
Properties map[string]string - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- Annotations []string
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- Description string
- The description for the Data Factory Linked Service PostgreSQL.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- Name string
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- Parameters map[string]string
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- connection
String String - The connection string in which to authenticate with PostgreSQL.
- data
Factory StringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- additional
Properties Map<String,String> - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- description String
- The description for the Data Factory Linked Service PostgreSQL.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name String
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters Map<String,String>
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- connection
String string - The connection string in which to authenticate with PostgreSQL.
- data
Factory stringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- additional
Properties {[key: string]: string} - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations string[]
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- description string
- The description for the Data Factory Linked Service PostgreSQL.
- integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name string
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters {[key: string]: string}
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- connection_
string str - The connection string in which to authenticate with PostgreSQL.
- data_
factory_ strid - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- additional_
properties Mapping[str, str] - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations Sequence[str]
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- description str
- The description for the Data Factory Linked Service PostgreSQL.
- integration_
runtime_ strname - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name str
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters Mapping[str, str]
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- connection
String String - The connection string in which to authenticate with PostgreSQL.
- data
Factory StringId - The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
- additional
Properties Map<String> - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- description String
- The description for the Data Factory Linked Service PostgreSQL.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name String
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters Map<String>
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
Outputs
All input properties are implicitly available as output properties. Additionally, the LinkedServicePostgresql 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 LinkedServicePostgresql Resource
Get an existing LinkedServicePostgresql 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?: LinkedServicePostgresqlState, opts?: CustomResourceOptions): LinkedServicePostgresql
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_properties: Optional[Mapping[str, str]] = None,
annotations: Optional[Sequence[str]] = None,
connection_string: Optional[str] = None,
data_factory_id: Optional[str] = None,
description: Optional[str] = None,
integration_runtime_name: Optional[str] = None,
name: Optional[str] = None,
parameters: Optional[Mapping[str, str]] = None) -> LinkedServicePostgresql
func GetLinkedServicePostgresql(ctx *Context, name string, id IDInput, state *LinkedServicePostgresqlState, opts ...ResourceOption) (*LinkedServicePostgresql, error)
public static LinkedServicePostgresql Get(string name, Input<string> id, LinkedServicePostgresqlState? state, CustomResourceOptions? opts = null)
public static LinkedServicePostgresql get(String name, Output<String> id, LinkedServicePostgresqlState 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.
- Additional
Properties Dictionary<string, string> - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- Annotations List<string>
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- Connection
String string - The connection string in which to authenticate with PostgreSQL.
- Data
Factory stringId - 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 Linked Service PostgreSQL.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- Name string
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- Parameters Dictionary<string, string>
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- Additional
Properties map[string]string - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- Annotations []string
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- Connection
String string - The connection string in which to authenticate with PostgreSQL.
- Data
Factory stringId - 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 Linked Service PostgreSQL.
- Integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- Name string
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- Parameters map[string]string
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- additional
Properties Map<String,String> - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- connection
String String - The connection string in which to authenticate with PostgreSQL.
- data
Factory StringId - 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 Linked Service PostgreSQL.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name String
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters Map<String,String>
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- additional
Properties {[key: string]: string} - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations string[]
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- connection
String string - The connection string in which to authenticate with PostgreSQL.
- data
Factory stringId - 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 Linked Service PostgreSQL.
- integration
Runtime stringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name string
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters {[key: string]: string}
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- additional_
properties Mapping[str, str] - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations Sequence[str]
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- connection_
string str - The connection string in which to authenticate with PostgreSQL.
- data_
factory_ strid - 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 Linked Service PostgreSQL.
- integration_
runtime_ strname - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name str
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters Mapping[str, str]
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
- additional
Properties Map<String> - A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
- annotations List<String>
- List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
- connection
String String - The connection string in which to authenticate with PostgreSQL.
- data
Factory StringId - 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 Linked Service PostgreSQL.
- integration
Runtime StringName - The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
- name String
- Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be unique within a data factory. See the Microsoft documentation for all restrictions.
- parameters Map<String>
- A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
Import
Data Factory PostgreSQL Linked Service’s can be imported using the resource id
, e.g.
$ pulumi import azure:datafactory/linkedServicePostgresql:LinkedServicePostgresql example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.