Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

LinkedServicePostgresql

Manages a Linked Service (connection) between PostgreSQL and 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 exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
    });

    var exampleLinkedServicePostgresql = new Azure.DataFactory.LinkedServicePostgresql("exampleLinkedServicePostgresql", new()
    {
        DataFactoryId = exampleFactory.Id,
        ConnectionString = "Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"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
		}
		exampleFactory, err := datafactory.NewFactory(ctx, "exampleFactory", &datafactory.FactoryArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = datafactory.NewLinkedServicePostgresql(ctx, "exampleLinkedServicePostgresql", &datafactory.LinkedServicePostgresqlArgs{
			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
	})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleLinkedServicePostgresql = new LinkedServicePostgresql("exampleLinkedServicePostgresql", LinkedServicePostgresqlArgs.builder()        
            .dataFactoryId(exampleFactory.id())
            .connectionString("Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_postgresql = azure.datafactory.LinkedServicePostgresql("exampleLinkedServicePostgresql",
    data_factory_id=example_factory.id,
    connection_string="Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServicePostgresql = new azure.datafactory.LinkedServicePostgresql("exampleLinkedServicePostgresql", {
    dataFactoryId: exampleFactory.id,
    connectionString: "Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServicePostgresql:
    type: azure:datafactory:LinkedServicePostgresql
    properties:
      dataFactoryId: ${exampleFactory.id}
      connectionString: Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example

Create LinkedServicePostgresql Resource

new LinkedServicePostgresql(name: string, args: LinkedServicePostgresqlArgs, opts?: CustomResourceOptions);
@overload
def LinkedServicePostgresql(resource_name: 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)
@overload
def LinkedServicePostgresql(resource_name: str,
                            args: LinkedServicePostgresqlArgs,
                            opts: Optional[ResourceOptions] = 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.

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.

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

The LinkedServicePostgresql resource accepts the following input properties:

ConnectionString string

The connection string in which to authenticate with PostgreSQL.

DataFactoryId string

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

AdditionalProperties 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.

IntegrationRuntimeName string

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.

ConnectionString string

The connection string in which to authenticate with PostgreSQL.

DataFactoryId string

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

AdditionalProperties 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.

IntegrationRuntimeName string

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.

connectionString String

The connection string in which to authenticate with PostgreSQL.

dataFactoryId String

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

additionalProperties 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.

integrationRuntimeName String

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.

connectionString string

The connection string in which to authenticate with PostgreSQL.

dataFactoryId string

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

additionalProperties {[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.

integrationRuntimeName string

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_id str

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_name str

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.

connectionString String

The connection string in which to authenticate with PostgreSQL.

dataFactoryId String

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

additionalProperties 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.

integrationRuntimeName String

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.
The following state arguments are supported:
AdditionalProperties 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.

ConnectionString string

The connection string in which to authenticate with PostgreSQL.

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 Linked Service PostgreSQL.

IntegrationRuntimeName string

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.

AdditionalProperties 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.

ConnectionString string

The connection string in which to authenticate with PostgreSQL.

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 Linked Service PostgreSQL.

IntegrationRuntimeName string

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.

additionalProperties 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.

connectionString String

The connection string in which to authenticate with PostgreSQL.

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 Linked Service PostgreSQL.

integrationRuntimeName String

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.

additionalProperties {[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.

connectionString string

The connection string in which to authenticate with PostgreSQL.

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 Linked Service PostgreSQL.

integrationRuntimeName string

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_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 Linked Service PostgreSQL.

integration_runtime_name str

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.

additionalProperties 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.

connectionString String

The connection string in which to authenticate with PostgreSQL.

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 Linked Service PostgreSQL.

integrationRuntimeName String

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.