LinkedServiceAzureFileStorage

class LinkedServiceAzureFileStorage : KotlinCustomResource

Manages a Linked Service (connection) between a SFTP Server and Azure Data Factory.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const example = azure.storage.getAccountOutput({
name: "storageaccountname",
resourceGroupName: exampleResourceGroup.name,
});
const exampleFactory = new azure.datafactory.Factory("example", {
name: "example",
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceAzureFileStorage = new azure.datafactory.LinkedServiceAzureFileStorage("example", {
name: "example",
dataFactoryId: exampleFactory.id,
connectionString: example.apply(example => example.primaryConnectionString),
});
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example = azure.storage.get_account_output(name="storageaccountname",
resource_group_name=example_resource_group.name)
example_factory = azure.datafactory.Factory("example",
name="example",
location=example_resource_group.location,
resource_group_name=example_resource_group.name)
example_linked_service_azure_file_storage = azure.datafactory.LinkedServiceAzureFileStorage("example",
name="example",
data_factory_id=example_factory.id,
connection_string=example.primary_connection_string)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var example = Azure.Storage.GetAccount.Invoke(new()
{
Name = "storageaccountname",
ResourceGroupName = exampleResourceGroup.Name,
});
var exampleFactory = new Azure.DataFactory.Factory("example", new()
{
Name = "example",
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
});
var exampleLinkedServiceAzureFileStorage = new Azure.DataFactory.LinkedServiceAzureFileStorage("example", new()
{
Name = "example",
DataFactoryId = exampleFactory.Id,
ConnectionString = example.Apply(getAccountResult => getAccountResult.PrimaryConnectionString),
});
});
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-azure/sdk/v6/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
example := storage.LookupAccountOutput(ctx, storage.GetAccountOutputArgs{
Name: pulumi.String("storageaccountname"),
ResourceGroupName: exampleResourceGroup.Name,
}, nil)
exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
Name: pulumi.String("example"),
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
})
if err != nil {
return err
}
_, err = datafactory.NewLinkedServiceAzureFileStorage(ctx, "example", &datafactory.LinkedServiceAzureFileStorageArgs{
Name: pulumi.String("example"),
DataFactoryId: exampleFactory.ID(),
ConnectionString: pulumi.String(example.ApplyT(func(example storage.GetAccountResult) (*string, error) {
return &example.PrimaryConnectionString, nil
}).(pulumi.StringPtrOutput)),
})
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.storage.StorageFunctions;
import com.pulumi.azure.storage.inputs.GetAccountArgs;
import com.pulumi.azure.datafactory.Factory;
import com.pulumi.azure.datafactory.FactoryArgs;
import com.pulumi.azure.datafactory.LinkedServiceAzureFileStorage;
import com.pulumi.azure.datafactory.LinkedServiceAzureFileStorageArgs;
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()
.name("example-resources")
.location("West Europe")
.build());
final var example = StorageFunctions.getAccount(GetAccountArgs.builder()
.name("storageaccountname")
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
.name("example")
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleLinkedServiceAzureFileStorage = new LinkedServiceAzureFileStorage("exampleLinkedServiceAzureFileStorage", LinkedServiceAzureFileStorageArgs.builder()
.name("example")
.dataFactoryId(exampleFactory.id())
.connectionString(example.applyValue(getAccountResult -> getAccountResult).applyValue(example -> example.applyValue(getAccountResult -> getAccountResult.primaryConnectionString())))
.build());
}
}
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
name: example
properties:
name: example-resources
location: West Europe
exampleFactory:
type: azure:datafactory:Factory
name: example
properties:
name: example
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
exampleLinkedServiceAzureFileStorage:
type: azure:datafactory:LinkedServiceAzureFileStorage
name: example
properties:
name: example
dataFactoryId: ${exampleFactory.id}
connectionString: ${example.primaryConnectionString}
variables:
example:
fn::invoke:
function: azure:storage:getAccount
arguments:
name: storageaccountname
resourceGroupName: ${exampleResourceGroup.name}

Import

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

$ pulumi import azure:datafactory/linkedServiceAzureFileStorage:LinkedServiceAzureFileStorage example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example

Properties

Link copied to clipboard

A map of additional properties to associate with the Data Factory Linked Service. The following supported arguments are specific to Azure File Storage Linked Service:

Link copied to clipboard
val annotations: Output<List<String>>?

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

Link copied to clipboard

The connection string.

Link copied to clipboard
val dataFactoryId: Output<String>

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

Link copied to clipboard
val description: Output<String>?

The description for the Data Factory Linked Service.

Link copied to clipboard
val fileShare: Output<String>?

The name of the file share.

Link copied to clipboard
val host: Output<String>?

The Host name of the server.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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

Link copied to clipboard

A key_vault_password block as defined below. Use this argument to store Azure File Storage password in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service.

Link copied to clipboard
val name: Output<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.

Link copied to clipboard
val parameters: Output<Map<String, String>>?

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

Link copied to clipboard
val password: Output<String>?

The password to log in the server.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val userId: Output<String>?

The user ID to log in the server.