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

We recommend using Azure Native.

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

azure.datafactory.LinkedServiceKusto

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 a Kusto Cluster and Azure Data Factory.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleFactory = new azure.datafactory.Factory("example", {
        name: "example",
        location: example.location,
        resourceGroupName: example.name,
        identity: {
            type: "SystemAssigned",
        },
    });
    const exampleCluster = new azure.kusto.Cluster("example", {
        name: "kustocluster",
        location: example.location,
        resourceGroupName: example.name,
        sku: {
            name: "Standard_D13_v2",
            capacity: 2,
        },
    });
    const exampleDatabase = new azure.kusto.Database("example", {
        name: "my-kusto-database",
        resourceGroupName: example.name,
        location: example.location,
        clusterName: exampleCluster.name,
    });
    const exampleLinkedServiceKusto = new azure.datafactory.LinkedServiceKusto("example", {
        name: "example",
        dataFactoryId: exampleFactory.id,
        kustoEndpoint: exampleCluster.uri,
        kustoDatabaseName: exampleDatabase.name,
        useManagedIdentity: true,
    });
    const exampleDatabasePrincipalAssignment = new azure.kusto.DatabasePrincipalAssignment("example", {
        name: "KustoPrincipalAssignment",
        resourceGroupName: example.name,
        clusterName: exampleCluster.name,
        databaseName: exampleDatabase.name,
        tenantId: exampleFactory.identity.apply(identity => identity?.tenantId),
        principalId: exampleFactory.identity.apply(identity => identity?.principalId),
        principalType: "App",
        role: "Viewer",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_factory = azure.datafactory.Factory("example",
        name="example",
        location=example.location,
        resource_group_name=example.name,
        identity={
            "type": "SystemAssigned",
        })
    example_cluster = azure.kusto.Cluster("example",
        name="kustocluster",
        location=example.location,
        resource_group_name=example.name,
        sku={
            "name": "Standard_D13_v2",
            "capacity": 2,
        })
    example_database = azure.kusto.Database("example",
        name="my-kusto-database",
        resource_group_name=example.name,
        location=example.location,
        cluster_name=example_cluster.name)
    example_linked_service_kusto = azure.datafactory.LinkedServiceKusto("example",
        name="example",
        data_factory_id=example_factory.id,
        kusto_endpoint=example_cluster.uri,
        kusto_database_name=example_database.name,
        use_managed_identity=True)
    example_database_principal_assignment = azure.kusto.DatabasePrincipalAssignment("example",
        name="KustoPrincipalAssignment",
        resource_group_name=example.name,
        cluster_name=example_cluster.name,
        database_name=example_database.name,
        tenant_id=example_factory.identity.tenant_id,
        principal_id=example_factory.identity.principal_id,
        principal_type="App",
        role="Viewer")
    
    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/kusto"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Identity: &datafactory.FactoryIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleCluster, err := kusto.NewCluster(ctx, "example", &kusto.ClusterArgs{
    			Name:              pulumi.String("kustocluster"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Sku: &kusto.ClusterSkuArgs{
    				Name:     pulumi.String("Standard_D13_v2"),
    				Capacity: pulumi.Int(2),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleDatabase, err := kusto.NewDatabase(ctx, "example", &kusto.DatabaseArgs{
    			Name:              pulumi.String("my-kusto-database"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			ClusterName:       exampleCluster.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datafactory.NewLinkedServiceKusto(ctx, "example", &datafactory.LinkedServiceKustoArgs{
    			Name:               pulumi.String("example"),
    			DataFactoryId:      exampleFactory.ID(),
    			KustoEndpoint:      exampleCluster.Uri,
    			KustoDatabaseName:  exampleDatabase.Name,
    			UseManagedIdentity: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = kusto.NewDatabasePrincipalAssignment(ctx, "example", &kusto.DatabasePrincipalAssignmentArgs{
    			Name:              pulumi.String("KustoPrincipalAssignment"),
    			ResourceGroupName: example.Name,
    			ClusterName:       exampleCluster.Name,
    			DatabaseName:      exampleDatabase.Name,
    			TenantId: exampleFactory.Identity.ApplyT(func(identity datafactory.FactoryIdentity) (*string, error) {
    				return &identity.TenantId, nil
    			}).(pulumi.StringPtrOutput),
    			PrincipalId: exampleFactory.Identity.ApplyT(func(identity datafactory.FactoryIdentity) (*string, error) {
    				return &identity.PrincipalId, nil
    			}).(pulumi.StringPtrOutput),
    			PrincipalType: pulumi.String("App"),
    			Role:          pulumi.String("Viewer"),
    		})
    		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 example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleFactory = new Azure.DataFactory.Factory("example", new()
        {
            Name = "example",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Identity = new Azure.DataFactory.Inputs.FactoryIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
        var exampleCluster = new Azure.Kusto.Cluster("example", new()
        {
            Name = "kustocluster",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Sku = new Azure.Kusto.Inputs.ClusterSkuArgs
            {
                Name = "Standard_D13_v2",
                Capacity = 2,
            },
        });
    
        var exampleDatabase = new Azure.Kusto.Database("example", new()
        {
            Name = "my-kusto-database",
            ResourceGroupName = example.Name,
            Location = example.Location,
            ClusterName = exampleCluster.Name,
        });
    
        var exampleLinkedServiceKusto = new Azure.DataFactory.LinkedServiceKusto("example", new()
        {
            Name = "example",
            DataFactoryId = exampleFactory.Id,
            KustoEndpoint = exampleCluster.Uri,
            KustoDatabaseName = exampleDatabase.Name,
            UseManagedIdentity = true,
        });
    
        var exampleDatabasePrincipalAssignment = new Azure.Kusto.DatabasePrincipalAssignment("example", new()
        {
            Name = "KustoPrincipalAssignment",
            ResourceGroupName = example.Name,
            ClusterName = exampleCluster.Name,
            DatabaseName = exampleDatabase.Name,
            TenantId = exampleFactory.Identity.Apply(identity => identity?.TenantId),
            PrincipalId = exampleFactory.Identity.Apply(identity => identity?.PrincipalId),
            PrincipalType = "App",
            Role = "Viewer",
        });
    
    });
    
    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.inputs.FactoryIdentityArgs;
    import com.pulumi.azure.kusto.Cluster;
    import com.pulumi.azure.kusto.ClusterArgs;
    import com.pulumi.azure.kusto.inputs.ClusterSkuArgs;
    import com.pulumi.azure.kusto.Database;
    import com.pulumi.azure.kusto.DatabaseArgs;
    import com.pulumi.azure.datafactory.LinkedServiceKusto;
    import com.pulumi.azure.datafactory.LinkedServiceKustoArgs;
    import com.pulumi.azure.kusto.DatabasePrincipalAssignment;
    import com.pulumi.azure.kusto.DatabasePrincipalAssignmentArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .identity(FactoryIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
            var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
                .name("kustocluster")
                .location(example.location())
                .resourceGroupName(example.name())
                .sku(ClusterSkuArgs.builder()
                    .name("Standard_D13_v2")
                    .capacity(2)
                    .build())
                .build());
    
            var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
                .name("my-kusto-database")
                .resourceGroupName(example.name())
                .location(example.location())
                .clusterName(exampleCluster.name())
                .build());
    
            var exampleLinkedServiceKusto = new LinkedServiceKusto("exampleLinkedServiceKusto", LinkedServiceKustoArgs.builder()
                .name("example")
                .dataFactoryId(exampleFactory.id())
                .kustoEndpoint(exampleCluster.uri())
                .kustoDatabaseName(exampleDatabase.name())
                .useManagedIdentity(true)
                .build());
    
            var exampleDatabasePrincipalAssignment = new DatabasePrincipalAssignment("exampleDatabasePrincipalAssignment", DatabasePrincipalAssignmentArgs.builder()
                .name("KustoPrincipalAssignment")
                .resourceGroupName(example.name())
                .clusterName(exampleCluster.name())
                .databaseName(exampleDatabase.name())
                .tenantId(exampleFactory.identity().applyValue(identity -> identity.tenantId()))
                .principalId(exampleFactory.identity().applyValue(identity -> identity.principalId()))
                .principalType("App")
                .role("Viewer")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleFactory:
        type: azure:datafactory:Factory
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
          identity:
            type: SystemAssigned
      exampleCluster:
        type: azure:kusto:Cluster
        name: example
        properties:
          name: kustocluster
          location: ${example.location}
          resourceGroupName: ${example.name}
          sku:
            name: Standard_D13_v2
            capacity: 2
      exampleDatabase:
        type: azure:kusto:Database
        name: example
        properties:
          name: my-kusto-database
          resourceGroupName: ${example.name}
          location: ${example.location}
          clusterName: ${exampleCluster.name}
      exampleLinkedServiceKusto:
        type: azure:datafactory:LinkedServiceKusto
        name: example
        properties:
          name: example
          dataFactoryId: ${exampleFactory.id}
          kustoEndpoint: ${exampleCluster.uri}
          kustoDatabaseName: ${exampleDatabase.name}
          useManagedIdentity: true
      exampleDatabasePrincipalAssignment:
        type: azure:kusto:DatabasePrincipalAssignment
        name: example
        properties:
          name: KustoPrincipalAssignment
          resourceGroupName: ${example.name}
          clusterName: ${exampleCluster.name}
          databaseName: ${exampleDatabase.name}
          tenantId: ${exampleFactory.identity.tenantId}
          principalId: ${exampleFactory.identity.principalId}
          principalType: App
          role: Viewer
    

    Create LinkedServiceKusto Resource

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

    Constructor syntax

    new LinkedServiceKusto(name: string, args: LinkedServiceKustoArgs, opts?: CustomResourceOptions);
    @overload
    def LinkedServiceKusto(resource_name: str,
                           args: LinkedServiceKustoArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def LinkedServiceKusto(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           kusto_database_name: Optional[str] = None,
                           kusto_endpoint: Optional[str] = None,
                           data_factory_id: Optional[str] = None,
                           description: Optional[str] = None,
                           integration_runtime_name: Optional[str] = None,
                           additional_properties: Optional[Mapping[str, str]] = None,
                           annotations: Optional[Sequence[str]] = None,
                           name: Optional[str] = None,
                           parameters: Optional[Mapping[str, str]] = None,
                           service_principal_id: Optional[str] = None,
                           service_principal_key: Optional[str] = None,
                           tenant: Optional[str] = None,
                           use_managed_identity: Optional[bool] = None)
    func NewLinkedServiceKusto(ctx *Context, name string, args LinkedServiceKustoArgs, opts ...ResourceOption) (*LinkedServiceKusto, error)
    public LinkedServiceKusto(string name, LinkedServiceKustoArgs args, CustomResourceOptions? opts = null)
    public LinkedServiceKusto(String name, LinkedServiceKustoArgs args)
    public LinkedServiceKusto(String name, LinkedServiceKustoArgs args, CustomResourceOptions options)
    
    type: azure:datafactory:LinkedServiceKusto
    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 LinkedServiceKustoArgs
    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 LinkedServiceKustoArgs
    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 LinkedServiceKustoArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServiceKustoArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServiceKustoArgs
    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 linkedServiceKustoResource = new Azure.DataFactory.LinkedServiceKusto("linkedServiceKustoResource", new()
    {
        KustoDatabaseName = "string",
        KustoEndpoint = "string",
        DataFactoryId = "string",
        Description = "string",
        IntegrationRuntimeName = "string",
        AdditionalProperties = 
        {
            { "string", "string" },
        },
        Annotations = new[]
        {
            "string",
        },
        Name = "string",
        Parameters = 
        {
            { "string", "string" },
        },
        ServicePrincipalId = "string",
        ServicePrincipalKey = "string",
        Tenant = "string",
        UseManagedIdentity = false,
    });
    
    example, err := datafactory.NewLinkedServiceKusto(ctx, "linkedServiceKustoResource", &datafactory.LinkedServiceKustoArgs{
    	KustoDatabaseName:      pulumi.String("string"),
    	KustoEndpoint:          pulumi.String("string"),
    	DataFactoryId:          pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	IntegrationRuntimeName: pulumi.String("string"),
    	AdditionalProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Annotations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ServicePrincipalId:  pulumi.String("string"),
    	ServicePrincipalKey: pulumi.String("string"),
    	Tenant:              pulumi.String("string"),
    	UseManagedIdentity:  pulumi.Bool(false),
    })
    
    var linkedServiceKustoResource = new LinkedServiceKusto("linkedServiceKustoResource", LinkedServiceKustoArgs.builder()
        .kustoDatabaseName("string")
        .kustoEndpoint("string")
        .dataFactoryId("string")
        .description("string")
        .integrationRuntimeName("string")
        .additionalProperties(Map.of("string", "string"))
        .annotations("string")
        .name("string")
        .parameters(Map.of("string", "string"))
        .servicePrincipalId("string")
        .servicePrincipalKey("string")
        .tenant("string")
        .useManagedIdentity(false)
        .build());
    
    linked_service_kusto_resource = azure.datafactory.LinkedServiceKusto("linkedServiceKustoResource",
        kusto_database_name="string",
        kusto_endpoint="string",
        data_factory_id="string",
        description="string",
        integration_runtime_name="string",
        additional_properties={
            "string": "string",
        },
        annotations=["string"],
        name="string",
        parameters={
            "string": "string",
        },
        service_principal_id="string",
        service_principal_key="string",
        tenant="string",
        use_managed_identity=False)
    
    const linkedServiceKustoResource = new azure.datafactory.LinkedServiceKusto("linkedServiceKustoResource", {
        kustoDatabaseName: "string",
        kustoEndpoint: "string",
        dataFactoryId: "string",
        description: "string",
        integrationRuntimeName: "string",
        additionalProperties: {
            string: "string",
        },
        annotations: ["string"],
        name: "string",
        parameters: {
            string: "string",
        },
        servicePrincipalId: "string",
        servicePrincipalKey: "string",
        tenant: "string",
        useManagedIdentity: false,
    });
    
    type: azure:datafactory:LinkedServiceKusto
    properties:
        additionalProperties:
            string: string
        annotations:
            - string
        dataFactoryId: string
        description: string
        integrationRuntimeName: string
        kustoDatabaseName: string
        kustoEndpoint: string
        name: string
        parameters:
            string: string
        servicePrincipalId: string
        servicePrincipalKey: string
        tenant: string
        useManagedIdentity: false
    

    LinkedServiceKusto 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 LinkedServiceKusto 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.
    KustoDatabaseName string
    The Kusto Database Name.
    KustoEndpoint string
    The URI of the Kusto Cluster endpoint.
    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 Kusto 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.
    ServicePrincipalId string
    The service principal id in which to authenticate against the Kusto Database.
    ServicePrincipalKey string
    The service principal key in which to authenticate against the Kusto Database.
    Tenant string

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    DataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    KustoDatabaseName string
    The Kusto Database Name.
    KustoEndpoint string
    The URI of the Kusto Cluster endpoint.
    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 Kusto 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.
    ServicePrincipalId string
    The service principal id in which to authenticate against the Kusto Database.
    ServicePrincipalKey string
    The service principal key in which to authenticate against the Kusto Database.
    Tenant string

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    kustoDatabaseName String
    The Kusto Database Name.
    kustoEndpoint String
    The URI of the Kusto Cluster endpoint.
    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 Kusto 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.
    servicePrincipalId String
    The service principal id in which to authenticate against the Kusto Database.
    servicePrincipalKey String
    The service principal key in which to authenticate against the Kusto Database.
    tenant String

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    dataFactoryId string
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    kustoDatabaseName string
    The Kusto Database Name.
    kustoEndpoint string
    The URI of the Kusto Cluster endpoint.
    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 Kusto 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.
    servicePrincipalId string
    The service principal id in which to authenticate against the Kusto Database.
    servicePrincipalKey string
    The service principal key in which to authenticate against the Kusto Database.
    tenant string

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    useManagedIdentity boolean
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    data_factory_id str
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    kusto_database_name str
    The Kusto Database Name.
    kusto_endpoint str
    The URI of the Kusto Cluster endpoint.
    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 Kusto 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.
    service_principal_id str
    The service principal id in which to authenticate against the Kusto Database.
    service_principal_key str
    The service principal key in which to authenticate against the Kusto Database.
    tenant str

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    use_managed_identity bool
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    dataFactoryId String
    The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
    kustoDatabaseName String
    The Kusto Database Name.
    kustoEndpoint String
    The URI of the Kusto Cluster endpoint.
    additionalProperties Map<String>

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

    The following supported arguments are specific to Azure Kusto 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.
    servicePrincipalId String
    The service principal id in which to authenticate against the Kusto Database.
    servicePrincipalKey String
    The service principal key in which to authenticate against the Kusto Database.
    tenant String

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.

    Outputs

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

    Get an existing LinkedServiceKusto 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?: LinkedServiceKustoState, opts?: CustomResourceOptions): LinkedServiceKusto
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            additional_properties: Optional[Mapping[str, str]] = None,
            annotations: Optional[Sequence[str]] = None,
            data_factory_id: Optional[str] = None,
            description: Optional[str] = None,
            integration_runtime_name: Optional[str] = None,
            kusto_database_name: Optional[str] = None,
            kusto_endpoint: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            service_principal_id: Optional[str] = None,
            service_principal_key: Optional[str] = None,
            tenant: Optional[str] = None,
            use_managed_identity: Optional[bool] = None) -> LinkedServiceKusto
    func GetLinkedServiceKusto(ctx *Context, name string, id IDInput, state *LinkedServiceKustoState, opts ...ResourceOption) (*LinkedServiceKusto, error)
    public static LinkedServiceKusto Get(string name, Input<string> id, LinkedServiceKustoState? state, CustomResourceOptions? opts = null)
    public static LinkedServiceKusto get(String name, Output<String> id, LinkedServiceKustoState 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 Kusto Linked Service:

    Annotations List<string>
    List of tags that can be used for describing the Data Factory Linked Service.
    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.
    KustoDatabaseName string
    The Kusto Database Name.
    KustoEndpoint string
    The URI of the Kusto Cluster endpoint.
    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.
    ServicePrincipalId string
    The service principal id in which to authenticate against the Kusto Database.
    ServicePrincipalKey string
    The service principal key in which to authenticate against the Kusto Database.
    Tenant string

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    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 Kusto Linked Service:

    Annotations []string
    List of tags that can be used for describing the Data Factory Linked Service.
    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.
    KustoDatabaseName string
    The Kusto Database Name.
    KustoEndpoint string
    The URI of the Kusto Cluster endpoint.
    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.
    ServicePrincipalId string
    The service principal id in which to authenticate against the Kusto Database.
    ServicePrincipalKey string
    The service principal key in which to authenticate against the Kusto Database.
    Tenant string

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    UseManagedIdentity bool
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    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 Kusto Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    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.
    kustoDatabaseName String
    The Kusto Database Name.
    kustoEndpoint String
    The URI of the Kusto Cluster endpoint.
    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.
    servicePrincipalId String
    The service principal id in which to authenticate against the Kusto Database.
    servicePrincipalKey String
    The service principal key in which to authenticate against the Kusto Database.
    tenant String

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    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 Kusto Linked Service:

    annotations string[]
    List of tags that can be used for describing the Data Factory Linked Service.
    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.
    kustoDatabaseName string
    The Kusto Database Name.
    kustoEndpoint string
    The URI of the Kusto Cluster endpoint.
    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.
    servicePrincipalId string
    The service principal id in which to authenticate against the Kusto Database.
    servicePrincipalKey string
    The service principal key in which to authenticate against the Kusto Database.
    tenant string

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    useManagedIdentity boolean
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    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 Kusto Linked Service:

    annotations Sequence[str]
    List of tags that can be used for describing the Data Factory Linked Service.
    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.
    kusto_database_name str
    The Kusto Database Name.
    kusto_endpoint str
    The URI of the Kusto Cluster endpoint.
    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.
    service_principal_id str
    The service principal id in which to authenticate against the Kusto Database.
    service_principal_key str
    The service principal key in which to authenticate against the Kusto Database.
    tenant str

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    use_managed_identity bool
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
    additionalProperties Map<String>

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

    The following supported arguments are specific to Azure Kusto Linked Service:

    annotations List<String>
    List of tags that can be used for describing the Data Factory Linked Service.
    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.
    kustoDatabaseName String
    The Kusto Database Name.
    kustoEndpoint String
    The URI of the Kusto Cluster endpoint.
    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.
    servicePrincipalId String
    The service principal id in which to authenticate against the Kusto Database.
    servicePrincipalKey String
    The service principal key in which to authenticate against the Kusto Database.
    tenant String

    The service principal tenant id or name in which to authenticate against the Kusto Database.

    NOTE If service_principal_id is used, service_principal_key and tenant is also required.

    NOTE One of Managed Identity authentication and Service Principal authentication must be set.

    useManagedIdentity Boolean
    Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.

    Import

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

    $ pulumi import azure:datafactory/linkedServiceKusto:LinkedServiceKusto 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