com.pulumi.azure.datafactory.LinkedServiceKusto Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.datafactory;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.datafactory.LinkedServiceKustoArgs;
import com.pulumi.azure.datafactory.inputs.LinkedServiceKustoState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages a Linked Service (connection) between a Kusto Cluster and Azure Data Factory.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Data Factory Linked Service's can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:datafactory/linkedServiceKusto:LinkedServiceKusto example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example
* ```
*
*/
@ResourceType(type="azure:datafactory/linkedServiceKusto:LinkedServiceKusto")
public class LinkedServiceKusto extends com.pulumi.resources.CustomResource {
/**
* A map of additional properties to associate with the Data Factory Linked Service.
*
* The following supported arguments are specific to Azure Kusto Linked Service:
*
*/
@Export(name="additionalProperties", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> additionalProperties;
/**
* @return A map of additional properties to associate with the Data Factory Linked Service.
*
* The following supported arguments are specific to Azure Kusto Linked Service:
*
*/
public Output>> additionalProperties() {
return Codegen.optional(this.additionalProperties);
}
/**
* List of tags that can be used for describing the Data Factory Linked Service.
*
*/
@Export(name="annotations", refs={List.class,String.class}, tree="[0,1]")
private Output> annotations;
/**
* @return List of tags that can be used for describing the Data Factory Linked Service.
*
*/
public Output>> annotations() {
return Codegen.optional(this.annotations);
}
/**
* The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
*/
@Export(name="dataFactoryId", refs={String.class}, tree="[0]")
private Output dataFactoryId;
/**
* @return The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
*/
public Output dataFactoryId() {
return this.dataFactoryId;
}
/**
* The description for the Data Factory Linked Service.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The description for the Data Factory Linked Service.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The integration runtime reference to associate with the Data Factory Linked Service.
*
*/
@Export(name="integrationRuntimeName", refs={String.class}, tree="[0]")
private Output integrationRuntimeName;
/**
* @return The integration runtime reference to associate with the Data Factory Linked Service.
*
*/
public Output> integrationRuntimeName() {
return Codegen.optional(this.integrationRuntimeName);
}
/**
* The Kusto Database Name.
*
*/
@Export(name="kustoDatabaseName", refs={String.class}, tree="[0]")
private Output kustoDatabaseName;
/**
* @return The Kusto Database Name.
*
*/
public Output kustoDatabaseName() {
return this.kustoDatabaseName;
}
/**
* The URI of the Kusto Cluster endpoint.
*
*/
@Export(name="kustoEndpoint", refs={String.class}, tree="[0]")
private Output kustoEndpoint;
/**
* @return The URI of the Kusto Cluster endpoint.
*
*/
public Output kustoEndpoint() {
return this.kustoEndpoint;
}
/**
* 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return 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](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*
*/
public Output name() {
return this.name;
}
/**
* A map of parameters to associate with the Data Factory Linked Service.
*
*/
@Export(name="parameters", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> parameters;
/**
* @return A map of parameters to associate with the Data Factory Linked Service.
*
*/
public Output>> parameters() {
return Codegen.optional(this.parameters);
}
/**
* The service principal id in which to authenticate against the Kusto Database.
*
*/
@Export(name="servicePrincipalId", refs={String.class}, tree="[0]")
private Output servicePrincipalId;
/**
* @return The service principal id in which to authenticate against the Kusto Database.
*
*/
public Output> servicePrincipalId() {
return Codegen.optional(this.servicePrincipalId);
}
/**
* The service principal key in which to authenticate against the Kusto Database.
*
*/
@Export(name="servicePrincipalKey", refs={String.class}, tree="[0]")
private Output servicePrincipalKey;
/**
* @return The service principal key in which to authenticate against the Kusto Database.
*
*/
public Output> servicePrincipalKey() {
return Codegen.optional(this.servicePrincipalKey);
}
/**
* 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.
*
*/
@Export(name="tenant", refs={String.class}, tree="[0]")
private Output tenant;
/**
* @return 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.
*
*/
public Output> tenant() {
return Codegen.optional(this.tenant);
}
/**
* Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
*
*/
@Export(name="useManagedIdentity", refs={Boolean.class}, tree="[0]")
private Output useManagedIdentity;
/**
* @return Whether to use the Data Factory's managed identity to authenticate against the Kusto Database.
*
*/
public Output> useManagedIdentity() {
return Codegen.optional(this.useManagedIdentity);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public LinkedServiceKusto(java.lang.String name) {
this(name, LinkedServiceKustoArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public LinkedServiceKusto(java.lang.String name, LinkedServiceKustoArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public LinkedServiceKusto(java.lang.String name, LinkedServiceKustoArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/linkedServiceKusto:LinkedServiceKusto", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private LinkedServiceKusto(java.lang.String name, Output id, @Nullable LinkedServiceKustoState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/linkedServiceKusto:LinkedServiceKusto", name, state, makeResourceOptions(options, id), false);
}
private static LinkedServiceKustoArgs makeArgs(LinkedServiceKustoArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? LinkedServiceKustoArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.additionalSecretOutputs(List.of(
"servicePrincipalKey"
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static LinkedServiceKusto get(java.lang.String name, Output id, @Nullable LinkedServiceKustoState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new LinkedServiceKusto(name, id, state, options);
}
}