1. Packages
  2. Azure Classic
  3. API Docs
  4. datafactory
  5. LinkedServiceAzureBlobStorage

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

azure.datafactory.LinkedServiceAzureBlobStorage

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi

    Manages a Linked Service (connection) between an Azure Blob Storage Account 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 exampleLinkedServiceAzureBlobStorage = new azure.datafactory.LinkedServiceAzureBlobStorage("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_blob_storage = azure.datafactory.LinkedServiceAzureBlobStorage("example",
        name="example",
        data_factory_id=example_factory.id,
        connection_string=example.primary_connection_string)
    
    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-azure/sdk/v5/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.NewLinkedServiceAzureBlobStorage(ctx, "example", &datafactory.LinkedServiceAzureBlobStorageArgs{
    			Name:          pulumi.String("example"),
    			DataFactoryId: exampleFactory.ID(),
    			ConnectionString: example.ApplyT(func(example storage.GetAccountResult) (*string, error) {
    				return &example.PrimaryConnectionString, nil
    			}).(pulumi.StringPtrOutput),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 exampleLinkedServiceAzureBlobStorage = new Azure.DataFactory.LinkedServiceAzureBlobStorage("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            ConnectionString = example.Apply(getAccountResult => getAccountResult.PrimaryConnectionString),
        });
    
    });
    
    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.LinkedServiceAzureBlobStorage;
    import com.pulumi.azure.datafactory.LinkedServiceAzureBlobStorageArgs;
    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 exampleLinkedServiceAzureBlobStorage = new LinkedServiceAzureBlobStorage("exampleLinkedServiceAzureBlobStorage", LinkedServiceAzureBlobStorageArgs.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}
      exampleLinkedServiceAzureBlobStorage:
        type: azure:datafactory:LinkedServiceAzureBlobStorage
        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}
    

    Create LinkedServiceAzureBlobStorage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LinkedServiceAzureBlobStorage(name: string, args: LinkedServiceAzureBlobStorageArgs, opts?: CustomResourceOptions);
    @overload
    def LinkedServiceAzureBlobStorage(resource_name: str,
                                      args: LinkedServiceAzureBlobStorageArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def LinkedServiceAzureBlobStorage(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      data_factory_id: Optional[str] = None,
                                      name: Optional[str] = None,
                                      description: Optional[str] = None,
                                      parameters: Optional[Mapping[str, str]] = None,
                                      annotations: Optional[Sequence[str]] = None,
                                      sas_uri: Optional[str] = None,
                                      integration_runtime_name: Optional[str] = None,
                                      key_vault_sas_token: Optional[LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs] = None,
                                      service_endpoint: Optional[str] = None,
                                      connection_string_insecure: Optional[str] = None,
                                      connection_string: Optional[str] = None,
                                      additional_properties: Optional[Mapping[str, str]] = None,
                                      service_principal_id: Optional[str] = None,
                                      service_principal_key: Optional[str] = None,
                                      service_principal_linked_key_vault_key: Optional[LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs] = None,
                                      storage_kind: Optional[str] = None,
                                      tenant_id: Optional[str] = None,
                                      use_managed_identity: Optional[bool] = None)
    func NewLinkedServiceAzureBlobStorage(ctx *Context, name string, args LinkedServiceAzureBlobStorageArgs, opts ...ResourceOption) (*LinkedServiceAzureBlobStorage, error)
    public LinkedServiceAzureBlobStorage(string name, LinkedServiceAzureBlobStorageArgs args, CustomResourceOptions? opts = null)
    public LinkedServiceAzureBlobStorage(String name, LinkedServiceAzureBlobStorageArgs args)
    public LinkedServiceAzureBlobStorage(String name, LinkedServiceAzureBlobStorageArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:LinkedServiceAzureBlobStorage
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var linkedServiceAzureBlobStorageResource = new Azure.DataFactory.LinkedServiceAzureBlobStorage("linkedServiceAzureBlobStorageResource", new()
    {
        DataFactoryId = "string",
        Name = "string",
        Description = "string",
        Parameters = 
        {
            { "string", "string" },
        },
        Annotations = new[]
        {
            "string",
        },
        SasUri = "string",
        IntegrationRuntimeName = "string",
        KeyVaultSasToken = new Azure.DataFactory.Inputs.LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs
        {
            LinkedServiceName = "string",
            SecretName = "string",
        },
        ServiceEndpoint = "string",
        ConnectionStringInsecure = "string",
        ConnectionString = "string",
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        ServicePrincipalId = "string",
        ServicePrincipalKey = "string",
        ServicePrincipalLinkedKeyVaultKey = new Azure.DataFactory.Inputs.LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs
        {
            LinkedServiceName = "string",
            SecretName = "string",
        },
        StorageKind = "string",
        TenantId = "string",
        UseManagedIdentity = false,
    });
    
    example, err := datafactory.NewLinkedServiceAzureBlobStorage(ctx, "linkedServiceAzureBlobStorageResource", &datafactory.LinkedServiceAzureBlobStorageArgs{
    	DataFactoryId: pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SasUri:                 pulumi.String("string"),
    	IntegrationRuntimeName: pulumi.String("string"),
    	KeyVaultSasToken: &datafactory.LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs{
    		LinkedServiceName: pulumi.String("string"),
    		SecretName:        pulumi.String("string"),
    	},
    	ServiceEndpoint:          pulumi.String("string"),
    	ConnectionStringInsecure: pulumi.String("string"),
    	ConnectionString:         pulumi.String("string"),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ServicePrincipalId:  pulumi.String("string"),
    	ServicePrincipalKey: pulumi.String("string"),
    	ServicePrincipalLinkedKeyVaultKey: &datafactory.LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs{
    		LinkedServiceName: pulumi.String("string"),
    		SecretName:        pulumi.String("string"),
    	},
    	StorageKind:        pulumi.String("string"),
    	TenantId:           pulumi.String("string"),
    	UseManagedIdentity: pulumi.Bool(false),
    })
    
    var linkedServiceAzureBlobStorageResource = new LinkedServiceAzureBlobStorage("linkedServiceAzureBlobStorageResource", LinkedServiceAzureBlobStorageArgs.builder()
        .dataFactoryId("string")
        .name("string")
        .description("string")
        .parameters(Map.of("string", "string"))
        .annotations("string")
        .sasUri("string")
        .integrationRuntimeName("string")
        .keyVaultSasToken(LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs.builder()
            .linkedServiceName("string")
            .secretName("string")
            .build())
        .serviceEndpoint("string")
        .connectionStringInsecure("string")
        .connectionString("string")
        .additionalProperties(Map.of("string", "string"))
        .servicePrincipalId("string")
        .servicePrincipalKey("string")
        .servicePrincipalLinkedKeyVaultKey(LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs.builder()
            .linkedServiceName("string")
            .secretName("string")
            .build())
        .storageKind("string")
        .tenantId("string")
        .useManagedIdentity(false)
        .build());
    
    linked_service_azure_blob_storage_resource = azure.datafactory.LinkedServiceAzureBlobStorage("linkedServiceAzureBlobStorageResource",
        data_factory_id="string",
        name="string",
        description="string",
        parameters={
            "string": "string",
        },
        annotations=["string"],
        sas_uri="string",
        integration_runtime_name="string",
        key_vault_sas_token={
            "linkedServiceName": "string",
            "secretName": "string",
        },
        service_endpoint="string",
        connection_string_insecure="string",
        connection_string="string",
        additional_properties={
            "string": "string",
        },
        service_principal_id="string",
        service_principal_key="string",
        service_principal_linked_key_vault_key={
            "linkedServiceName": "string",
            "secretName": "string",
        },
        storage_kind="string",
        tenant_id="string",
        use_managed_identity=False)
    
    const linkedServiceAzureBlobStorageResource = new azure.datafactory.LinkedServiceAzureBlobStorage("linkedServiceAzureBlobStorageResource", {
        dataFactoryId: "string",
        name: "string",
        description: "string",
        parameters: {
            string: "string",
        },
        annotations: ["string"],
        sasUri: "string",
        integrationRuntimeName: "string",
        keyVaultSasToken: {
            linkedServiceName: "string",
            secretName: "string",
        },
        serviceEndpoint: "string",
        connectionStringInsecure: "string",
        connectionString: "string",
        additionalProperties: {
            string: "string",
        },
        servicePrincipalId: "string",
        servicePrincipalKey: "string",
        servicePrincipalLinkedKeyVaultKey: {
            linkedServiceName: "string",
            secretName: "string",
        },
        storageKind: "string",
        tenantId: "string",
        useManagedIdentity: false,
    });
    
    type: azure:datafactory:LinkedServiceAzureBlobStorage
    properties:
        additionalProperties:
            string: string
        annotations:
            - string
        connectionString: string
        connectionStringInsecure: string
        dataFactoryId: string
        description: string
        integrationRuntimeName: string
        keyVaultSasToken:
            linkedServiceName: string
            secretName: string
        name: string
        parameters:
            string: string
        sasUri: string
        serviceEndpoint: string
        servicePrincipalId: string
        servicePrincipalKey: string
        servicePrincipalLinkedKeyVaultKey:
            linkedServiceName: string
            secretName: string
        storageKind: string
        tenantId: string
        useManagedIdentity: false
    

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

    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.

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    ConnectionStringInsecure string

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    KeyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasToken
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    SasUri string
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    ServiceEndpoint string
    ServicePrincipalId string
    ServicePrincipalKey string
    ServicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKey
    StorageKind string
    TenantId string
    UseManagedIdentity bool
    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.

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    ConnectionStringInsecure string

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    Description string
    The description for the Data Factory Linked Service.
    IntegrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    KeyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    SasUri string
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    ServiceEndpoint string
    ServicePrincipalId string
    ServicePrincipalKey string
    ServicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs
    StorageKind string
    TenantId string
    UseManagedIdentity bool
    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.

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connectionStringInsecure String

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    keyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasToken
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sasUri String
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    serviceEndpoint String
    servicePrincipalId String
    servicePrincipalKey String
    servicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKey
    storageKind String
    tenantId String
    useManagedIdentity Boolean
    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.

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString string
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connectionStringInsecure string

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    description string
    The description for the Data Factory Linked Service.
    integrationRuntimeName string
    The integration runtime reference to associate with the Data Factory Linked Service.
    keyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasToken
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sasUri string
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    serviceEndpoint string
    servicePrincipalId string
    servicePrincipalKey string
    servicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKey
    storageKind string
    tenantId string
    useManagedIdentity boolean
    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.

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    connection_string str
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connection_string_insecure str

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    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.
    key_vault_sas_token LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sas_uri str
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    service_endpoint str
    service_principal_id str
    service_principal_key str
    service_principal_linked_key_vault_key LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs
    storage_kind str
    tenant_id str
    use_managed_identity bool
    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.

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connectionStringInsecure String

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    description String
    The description for the Data Factory Linked Service.
    integrationRuntimeName String
    The integration runtime reference to associate with the Data Factory Linked Service.
    keyVaultSasToken Property Map
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sasUri String
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    serviceEndpoint String
    servicePrincipalId String
    servicePrincipalKey String
    servicePrincipalLinkedKeyVaultKey Property Map
    storageKind String
    tenantId String
    useManagedIdentity Boolean

    Outputs

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

    Get an existing LinkedServiceAzureBlobStorage 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?: LinkedServiceAzureBlobStorageState, opts?: CustomResourceOptions): LinkedServiceAzureBlobStorage
    @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,
            connection_string_insecure: Optional[str] = None,
            data_factory_id: Optional[str] = None,
            description: Optional[str] = None,
            integration_runtime_name: Optional[str] = None,
            key_vault_sas_token: Optional[LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            sas_uri: Optional[str] = None,
            service_endpoint: Optional[str] = None,
            service_principal_id: Optional[str] = None,
            service_principal_key: Optional[str] = None,
            service_principal_linked_key_vault_key: Optional[LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs] = None,
            storage_kind: Optional[str] = None,
            tenant_id: Optional[str] = None,
            use_managed_identity: Optional[bool] = None) -> LinkedServiceAzureBlobStorage
    func GetLinkedServiceAzureBlobStorage(ctx *Context, name string, id IDInput, state *LinkedServiceAzureBlobStorageState, opts ...ResourceOption) (*LinkedServiceAzureBlobStorage, error)
    public static LinkedServiceAzureBlobStorage Get(string name, Input<string> id, LinkedServiceAzureBlobStorageState? state, CustomResourceOptions? opts = null)
    public static LinkedServiceAzureBlobStorage get(String name, Output<String> id, LinkedServiceAzureBlobStorageState 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.

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    ConnectionStringInsecure string

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    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.
    KeyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasToken
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    SasUri string
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    ServiceEndpoint string
    ServicePrincipalId string
    ServicePrincipalKey string
    ServicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKey
    StorageKind string
    TenantId string
    UseManagedIdentity bool
    AdditionalProperties map[string]string

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

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    ConnectionString string
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    ConnectionStringInsecure string

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    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.
    KeyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    SasUri string
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    ServiceEndpoint string
    ServicePrincipalId string
    ServicePrincipalKey string
    ServicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs
    StorageKind string
    TenantId string
    UseManagedIdentity bool
    additionalProperties Map<String,String>

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

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connectionStringInsecure String

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    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.
    keyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasToken
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sasUri String
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    serviceEndpoint String
    servicePrincipalId String
    servicePrincipalKey String
    servicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKey
    storageKind String
    tenantId String
    useManagedIdentity Boolean
    additionalProperties {[key: string]: string}

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

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString string
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connectionStringInsecure string

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    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.
    keyVaultSasToken LinkedServiceAzureBlobStorageKeyVaultSasToken
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sasUri string
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    serviceEndpoint string
    servicePrincipalId string
    servicePrincipalKey string
    servicePrincipalLinkedKeyVaultKey LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKey
    storageKind string
    tenantId string
    useManagedIdentity boolean
    additional_properties Mapping[str, str]

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

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    connection_string str
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connection_string_insecure str

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    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.
    key_vault_sas_token LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sas_uri str
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    service_endpoint str
    service_principal_id str
    service_principal_key str
    service_principal_linked_key_vault_key LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs
    storage_kind str
    tenant_id str
    use_managed_identity bool
    additionalProperties Map<String>

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

    The following supported arguments are specific to Azure Blob Storage Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    connectionString String
    The connection string. Conflicts with connection_string_insecure, sas_uri and service_endpoint.
    connectionStringInsecure String

    The connection string sent insecurely. Conflicts with connection_string, sas_uri and service_endpoint.

    Note: connection_string uses the Azure SecureString to encrypt the contents within the REST payload sent to Azure whilst the connection_string_insecure is sent as a regular string. Both properties are still sent using SSL/HTTPS. At this time the portal will not decrypt Secure Strings so the connection_string property in the portal will show as ****** whilst connection_string_insecure will be viewable in the portal.

    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.
    keyVaultSasToken Property Map
    A key_vault_sas_token block as defined below. Use this argument to store SAS Token in an existing Key Vault. It needs an existing Key Vault Data Factory Linked Service. A sas_uri is required.
    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.
    sasUri String
    The SAS URI. Conflicts with connection_string_insecure, connection_string and service_endpoint.
    serviceEndpoint String
    servicePrincipalId String
    servicePrincipalKey String
    servicePrincipalLinkedKeyVaultKey Property Map
    storageKind String
    tenantId String
    useManagedIdentity Boolean

    Supporting Types

    LinkedServiceAzureBlobStorageKeyVaultSasToken, LinkedServiceAzureBlobStorageKeyVaultSasTokenArgs

    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores the SAS token.
    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores the SAS token.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores the SAS token.
    linkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName string
    Specifies the secret name in Azure Key Vault that stores the SAS token.
    linked_service_name str
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secret_name str
    Specifies the secret name in Azure Key Vault that stores the SAS token.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores the SAS token.

    LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKey, LinkedServiceAzureBlobStorageServicePrincipalLinkedKeyVaultKeyArgs

    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores the Service Principal key.
    LinkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    SecretName string
    Specifies the secret name in Azure Key Vault that stores the Service Principal key.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores the Service Principal key.
    linkedServiceName string
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName string
    Specifies the secret name in Azure Key Vault that stores the Service Principal key.
    linked_service_name str
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secret_name str
    Specifies the secret name in Azure Key Vault that stores the Service Principal key.
    linkedServiceName String
    Specifies the name of an existing Key Vault Data Factory Linked Service.
    secretName String
    Specifies the secret name in Azure Key Vault that stores the Service Principal key.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.83.0 published on Monday, Jul 8, 2024 by Pulumi