Azure Classic

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

LinkedServiceMysql

Manages a Linked Service (connection) between MySQL 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 exampleLinkedServiceMysql = new Azure.DataFactory.LinkedServiceMysql("exampleLinkedServiceMysql", new()
    {
        DataFactoryId = exampleFactory.Id,
        ConnectionString = "Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test",
    });

});
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.NewLinkedServiceMysql(ctx, "exampleLinkedServiceMysql", &datafactory.LinkedServiceMysqlArgs{
			DataFactoryId:    exampleFactory.ID(),
			ConnectionString: pulumi.String("Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test"),
		})
		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.LinkedServiceMysql;
import com.pulumi.azure.datafactory.LinkedServiceMysqlArgs;
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 exampleLinkedServiceMysql = new LinkedServiceMysql("exampleLinkedServiceMysql", LinkedServiceMysqlArgs.builder()        
            .dataFactoryId(exampleFactory.id())
            .connectionString("Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test")
            .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_mysql = azure.datafactory.LinkedServiceMysql("exampleLinkedServiceMysql",
    data_factory_id=example_factory.id,
    connection_string="Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test")
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 exampleLinkedServiceMysql = new azure.datafactory.LinkedServiceMysql("exampleLinkedServiceMysql", {
    dataFactoryId: exampleFactory.id,
    connectionString: "Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceMysql:
    type: azure:datafactory:LinkedServiceMysql
    properties:
      dataFactoryId: ${exampleFactory.id}
      connectionString: Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test

Create LinkedServiceMysql Resource

new LinkedServiceMysql(name: string, args: LinkedServiceMysqlArgs, opts?: CustomResourceOptions);
@overload
def LinkedServiceMysql(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 LinkedServiceMysql(resource_name: str,
                       args: LinkedServiceMysqlArgs,
                       opts: Optional[ResourceOptions] = None)
func NewLinkedServiceMysql(ctx *Context, name string, args LinkedServiceMysqlArgs, opts ...ResourceOption) (*LinkedServiceMysql, error)
public LinkedServiceMysql(string name, LinkedServiceMysqlArgs args, CustomResourceOptions? opts = null)
public LinkedServiceMysql(String name, LinkedServiceMysqlArgs args)
public LinkedServiceMysql(String name, LinkedServiceMysqlArgs args, CustomResourceOptions options)
type: azure:datafactory:LinkedServiceMysql
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args LinkedServiceMysqlArgs
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 LinkedServiceMysqlArgs
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 LinkedServiceMysqlArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args LinkedServiceMysqlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args LinkedServiceMysqlArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

LinkedServiceMysql 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 LinkedServiceMysql resource accepts the following input properties:

ConnectionString string

The connection string in which to authenticate with MySQL.

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

Annotations List<string>

List of tags that can be used for describing the Data Factory Linked Service MySQL.

Description string

The description for the Data Factory Linked Service MySQL.

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

Name string

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

ConnectionString string

The connection string in which to authenticate with MySQL.

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

Annotations []string

List of tags that can be used for describing the Data Factory Linked Service MySQL.

Description string

The description for the Data Factory Linked Service MySQL.

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

Name string

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

connectionString String

The connection string in which to authenticate with MySQL.

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

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service MySQL.

description String

The description for the Data Factory Linked Service MySQL.

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name String

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

connectionString string

The connection string in which to authenticate with MySQL.

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

annotations string[]

List of tags that can be used for describing the Data Factory Linked Service MySQL.

description string

The description for the Data Factory Linked Service MySQL.

integrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name string

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

connection_string str

The connection string in which to authenticate with MySQL.

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

annotations Sequence[str]

List of tags that can be used for describing the Data Factory Linked Service MySQL.

description str

The description for the Data Factory Linked Service MySQL.

integration_runtime_name str

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name str

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

connectionString String

The connection string in which to authenticate with MySQL.

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

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service MySQL.

description String

The description for the Data Factory Linked Service MySQL.

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name String

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

Outputs

All input properties are implicitly available as output properties. Additionally, the LinkedServiceMysql 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 LinkedServiceMysql Resource

Get an existing LinkedServiceMysql 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?: LinkedServiceMysqlState, opts?: CustomResourceOptions): LinkedServiceMysql
@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) -> LinkedServiceMysql
func GetLinkedServiceMysql(ctx *Context, name string, id IDInput, state *LinkedServiceMysqlState, opts ...ResourceOption) (*LinkedServiceMysql, error)
public static LinkedServiceMysql Get(string name, Input<string> id, LinkedServiceMysqlState? state, CustomResourceOptions? opts = null)
public static LinkedServiceMysql get(String name, Output<String> id, LinkedServiceMysqlState 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 MySQL.

Annotations List<string>

List of tags that can be used for describing the Data Factory Linked Service MySQL.

ConnectionString string

The connection string in which to authenticate with MySQL.

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

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

Name string

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

AdditionalProperties map[string]string

A map of additional properties to associate with the Data Factory Linked Service MySQL.

Annotations []string

List of tags that can be used for describing the Data Factory Linked Service MySQL.

ConnectionString string

The connection string in which to authenticate with MySQL.

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

IntegrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

Name string

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

additionalProperties Map<String,String>

A map of additional properties to associate with the Data Factory Linked Service MySQL.

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service MySQL.

connectionString String

The connection string in which to authenticate with MySQL.

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

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name String

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

additionalProperties {[key: string]: string}

A map of additional properties to associate with the Data Factory Linked Service MySQL.

annotations string[]

List of tags that can be used for describing the Data Factory Linked Service MySQL.

connectionString string

The connection string in which to authenticate with MySQL.

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

integrationRuntimeName string

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name string

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

additional_properties Mapping[str, str]

A map of additional properties to associate with the Data Factory Linked Service MySQL.

annotations Sequence[str]

List of tags that can be used for describing the Data Factory Linked Service MySQL.

connection_string str

The connection string in which to authenticate with MySQL.

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

integration_runtime_name str

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name str

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

additionalProperties Map<String>

A map of additional properties to associate with the Data Factory Linked Service MySQL.

annotations List<String>

List of tags that can be used for describing the Data Factory Linked Service MySQL.

connectionString String

The connection string in which to authenticate with MySQL.

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

integrationRuntimeName String

The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name String

Specifies the name of the Data Factory Linked Service MySQL. 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 MySQL.

Import

Data Factory MySQL Linked Service’s can be imported using the resource id, e.g.

 $ pulumi import azure:datafactory/linkedServiceMysql:LinkedServiceMysql 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.