Azure Classic

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

LinkedServiceWeb

Manages a Linked Service (connection) between a Web Server 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 exampleLinkedServiceWeb = new Azure.DataFactory.LinkedServiceWeb("exampleLinkedServiceWeb", new()
    {
        DataFactoryId = exampleFactory.Id,
        AuthenticationType = "Anonymous",
        Url = "http://www.bing.com",
    });

});
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.NewLinkedServiceWeb(ctx, "exampleLinkedServiceWeb", &datafactory.LinkedServiceWebArgs{
			DataFactoryId:      exampleFactory.ID(),
			AuthenticationType: pulumi.String("Anonymous"),
			Url:                pulumi.String("http://www.bing.com"),
		})
		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.LinkedServiceWeb;
import com.pulumi.azure.datafactory.LinkedServiceWebArgs;
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 exampleLinkedServiceWeb = new LinkedServiceWeb("exampleLinkedServiceWeb", LinkedServiceWebArgs.builder()        
            .dataFactoryId(exampleFactory.id())
            .authenticationType("Anonymous")
            .url("http://www.bing.com")
            .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_web = azure.datafactory.LinkedServiceWeb("exampleLinkedServiceWeb",
    data_factory_id=example_factory.id,
    authentication_type="Anonymous",
    url="http://www.bing.com")
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 exampleLinkedServiceWeb = new azure.datafactory.LinkedServiceWeb("exampleLinkedServiceWeb", {
    dataFactoryId: exampleFactory.id,
    authenticationType: "Anonymous",
    url: "http://www.bing.com",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleFactory:
    type: azure:datafactory:Factory
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleLinkedServiceWeb:
    type: azure:datafactory:LinkedServiceWeb
    properties:
      dataFactoryId: ${exampleFactory.id}
      authenticationType: Anonymous
      url: http://www.bing.com

Create LinkedServiceWeb Resource

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

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

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

AuthenticationType string

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

DataFactoryId string

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

Url string

The URL of the web service endpoint (e.g. https://www.microsoft.com).

AdditionalProperties Dictionary<string, string>

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

Annotations List<string>

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

Description string

The description for the Data Factory Linked Service.

IntegrationRuntimeName string

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

Name string

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

Password string
Username string
AuthenticationType string

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

DataFactoryId string

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

Url string

The URL of the web service endpoint (e.g. https://www.microsoft.com).

AdditionalProperties map[string]string

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

Annotations []string

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

Description string

The description for the Data Factory Linked Service.

IntegrationRuntimeName string

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

Name string

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

Password string
Username string
authenticationType String

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

dataFactoryId String

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

url String

The URL of the web service endpoint (e.g. https://www.microsoft.com).

additionalProperties Map<String,String>

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

annotations List<String>

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

description String

The description for the Data Factory Linked Service.

integrationRuntimeName String

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

name String

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

password String
username String
authenticationType string

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

dataFactoryId string

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

url string

The URL of the web service endpoint (e.g. https://www.microsoft.com).

additionalProperties {[key: string]: string}

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

annotations string[]

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

description string

The description for the Data Factory Linked Service.

integrationRuntimeName string

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

name string

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

password string
username string
authentication_type str

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

data_factory_id str

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

url str

The URL of the web service endpoint (e.g. https://www.microsoft.com).

additional_properties Mapping[str, str]

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

annotations Sequence[str]

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

description str

The description for the Data Factory Linked Service.

integration_runtime_name str

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

name str

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

password str
username str
authenticationType String

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

dataFactoryId String

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

url String

The URL of the web service endpoint (e.g. https://www.microsoft.com).

additionalProperties Map<String>

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

annotations List<String>

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

description String

The description for the Data Factory Linked Service.

integrationRuntimeName String

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

name String

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

password String
username String

Outputs

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

Get an existing LinkedServiceWeb 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?: LinkedServiceWebState, opts?: CustomResourceOptions): LinkedServiceWeb
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_properties: Optional[Mapping[str, str]] = None,
        annotations: Optional[Sequence[str]] = None,
        authentication_type: 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,
        password: Optional[str] = None,
        url: Optional[str] = None,
        username: Optional[str] = None) -> LinkedServiceWeb
func GetLinkedServiceWeb(ctx *Context, name string, id IDInput, state *LinkedServiceWebState, opts ...ResourceOption) (*LinkedServiceWeb, error)
public static LinkedServiceWeb Get(string name, Input<string> id, LinkedServiceWebState? state, CustomResourceOptions? opts = null)
public static LinkedServiceWeb get(String name, Output<String> id, LinkedServiceWebState 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.

Annotations List<string>

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

AuthenticationType string

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

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.

IntegrationRuntimeName string

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

Name string

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

Password string
Url string

The URL of the web service endpoint (e.g. https://www.microsoft.com).

Username string
AdditionalProperties map[string]string

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

Annotations []string

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

AuthenticationType string

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

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.

IntegrationRuntimeName string

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

Name string

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

Password string
Url string

The URL of the web service endpoint (e.g. https://www.microsoft.com).

Username string
additionalProperties Map<String,String>

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

annotations List<String>

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

authenticationType String

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

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.

integrationRuntimeName String

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

name String

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

password String
url String

The URL of the web service endpoint (e.g. https://www.microsoft.com).

username String
additionalProperties {[key: string]: string}

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

annotations string[]

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

authenticationType string

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

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.

integrationRuntimeName string

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

name string

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

password string
url string

The URL of the web service endpoint (e.g. https://www.microsoft.com).

username string
additional_properties Mapping[str, str]

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

annotations Sequence[str]

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

authentication_type str

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

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.

integration_runtime_name str

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

name str

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

password str
url str

The URL of the web service endpoint (e.g. https://www.microsoft.com).

username str
additionalProperties Map<String>

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

annotations List<String>

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

authenticationType String

The type of authentication used to connect to the web table source. Valid options are Anonymous, Basic and ClientCertificate.

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.

integrationRuntimeName String

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

name String

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

password String
url String

The URL of the web service endpoint (e.g. https://www.microsoft.com).

username String

Import

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

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