LinkedServiceKeyVault

Manages a Linked Service (connection) between Key Vault and Azure Data Factory.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "eastus",
        });
        var exampleKeyVault = new Azure.KeyVault.KeyVault("exampleKeyVault", new Azure.KeyVault.KeyVaultArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            TenantId = current.Apply(current => current.TenantId),
            SkuName = "standard",
        });
        var exampleFactory = new Azure.DataFactory.Factory("exampleFactory", new Azure.DataFactory.FactoryArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleLinkedServiceKeyVault = new Azure.DataFactory.LinkedServiceKeyVault("exampleLinkedServiceKeyVault", new Azure.DataFactory.LinkedServiceKeyVaultArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            DataFactoryName = exampleFactory.Name,
            KeyVaultId = exampleKeyVault.Id,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/datafactory"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/keyvault"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        current, err := core.GetClientConfig(ctx, nil, nil)
        if err != nil {
            return err
        }
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("eastus"),
        })
        if err != nil {
            return err
        }
        exampleKeyVault, err := keyvault.NewKeyVault(ctx, "exampleKeyVault", &keyvault.KeyVaultArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            TenantId:          pulumi.String(current.TenantId),
            SkuName:           pulumi.String("standard"),
        })
        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.NewLinkedServiceKeyVault(ctx, "exampleLinkedServiceKeyVault", &datafactory.LinkedServiceKeyVaultArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            DataFactoryName:   exampleFactory.Name,
            KeyVaultId:        exampleKeyVault.ID(),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus")
example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tenant_id=current.tenant_id,
    sku_name="standard")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_key_vault = azure.datafactory.LinkedServiceKeyVault("exampleLinkedServiceKeyVault",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    key_vault_id=example_key_vault.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "eastus"});
const exampleKeyVault = new azure.keyvault.KeyVault("exampleKeyVault", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tenantId: current.then(current => current.tenantId),
    skuName: "standard",
});
const exampleFactory = new azure.datafactory.Factory("exampleFactory", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleLinkedServiceKeyVault = new azure.datafactory.LinkedServiceKeyVault("exampleLinkedServiceKeyVault", {
    resourceGroupName: exampleResourceGroup.name,
    dataFactoryName: exampleFactory.name,
    keyVaultId: exampleKeyVault.id,
});

Create a LinkedServiceKeyVault Resource

new LinkedServiceKeyVault(name: string, args: LinkedServiceKeyVaultArgs, opts?: CustomResourceOptions);

def LinkedServiceKeyVault(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, key_vault_id=None, name=None, parameters=None, resource_group_name=None, __props__=None);

func NewLinkedServiceKeyVault(ctx *Context, name string, args LinkedServiceKeyVaultArgs, opts ...ResourceOption) (*LinkedServiceKeyVault, error)

public LinkedServiceKeyVault(string name, LinkedServiceKeyVaultArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args LinkedServiceKeyVaultArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args LinkedServiceKeyVaultArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LinkedServiceKeyVaultArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

LinkedServiceKeyVault Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The LinkedServiceKeyVault resource accepts the following input properties:

DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
KeyVaultId string: The ID the Azure Key Vault resource.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource
AdditionalProperties Dictionary<string, string>: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
Annotations List<string>: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
Description string: The description for the Data Factory Linked Service Key Vault.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
Name string: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters Dictionary<string, string>: A map of parameters to associate with the Data Factory Linked Service Key Vault.

DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
KeyVaultId string: The ID the Azure Key Vault resource.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource
AdditionalProperties map[string]string: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
Annotations []string: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
Description string: The description for the Data Factory Linked Service Key Vault.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
Name string: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters map[string]string: A map of parameters to associate with the Data Factory Linked Service Key Vault.

dataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
keyVaultId string: The ID the Azure Key Vault resource.
resourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource
additionalProperties {[key: string]: string}: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
annotations string[]: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
description string: The description for the Data Factory Linked Service Key Vault.
integrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
name string: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters {[key: string]: string}: A map of parameters to associate with the Data Factory Linked Service Key Vault.

data_factory_name str: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
key_vault_id str: The ID the Azure Key Vault resource.
resource_group_name str: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource
additional_properties Dict[str, str]: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
annotations List[str]: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
description str: The description for the Data Factory Linked Service Key Vault.
integration_runtime_name str: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
name str: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters Dict[str, str]: A map of parameters to associate with the Data Factory Linked Service Key Vault.

Outputs

All input properties are implicitly available as output properties. Additionally, the LinkedServiceKeyVault 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing LinkedServiceKeyVault Resource

Get an existing LinkedServiceKeyVault 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?: LinkedServiceKeyVaultState, opts?: CustomResourceOptions): LinkedServiceKeyVault

static get(resource_name, id, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, key_vault_id=None, name=None, parameters=None, resource_group_name=None, __props__=None);

func GetLinkedServiceKeyVault(ctx *Context, name string, id IDInput, state *LinkedServiceKeyVaultState, opts ...ResourceOption) (*LinkedServiceKeyVault, error)

public static LinkedServiceKeyVault Get(string name, Input<string> id, LinkedServiceKeyVaultState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AdditionalProperties Dictionary<string, string>: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
Annotations List<string>: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
Description string: The description for the Data Factory Linked Service Key Vault.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
KeyVaultId string: The ID the Azure Key Vault resource.
Name string: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters Dictionary<string, string>: A map of parameters to associate with the Data Factory Linked Service Key Vault.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource

AdditionalProperties map[string]string: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
Annotations []string: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
DataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
Description string: The description for the Data Factory Linked Service Key Vault.
IntegrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
KeyVaultId string: The ID the Azure Key Vault resource.
Name string: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
Parameters map[string]string: A map of parameters to associate with the Data Factory Linked Service Key Vault.
ResourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource

additionalProperties {[key: string]: string}: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
annotations string[]: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
dataFactoryName string: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description string: The description for the Data Factory Linked Service Key Vault.
integrationRuntimeName string: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
keyVaultId string: The ID the Azure Key Vault resource.
name string: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters {[key: string]: string}: A map of parameters to associate with the Data Factory Linked Service Key Vault.
resourceGroupName string: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource

additional_properties Dict[str, str]: A map of additional properties to associate with the Data Factory Linked Service Key Vault.
annotations List[str]: List of tags that can be used for describing the Data Factory Linked Service Key Vault.
data_factory_name str: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description str: The description for the Data Factory Linked Service Key Vault.
integration_runtime_name str: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
key_vault_id str: The ID the Azure Key Vault resource.
name str: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters Dict[str, str]: A map of parameters to associate with the Data Factory Linked Service Key Vault.
resource_group_name str: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud