All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.datafactory.LinkedServiceCosmosDb Maven / Gradle / Ivy

// *** 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.LinkedServiceCosmosDbArgs;
import com.pulumi.azure.datafactory.inputs.LinkedServiceCosmosDbState;
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.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Manages a Linked Service (connection) between a CosmosDB and Azure Data Factory using SQL API.
 * 
 * ## 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.cosmosdb.CosmosdbFunctions;
 * import com.pulumi.azure.cosmosdb.inputs.GetAccountArgs;
 * import com.pulumi.azure.datafactory.Factory;
 * import com.pulumi.azure.datafactory.FactoryArgs;
 * import com.pulumi.azure.datafactory.LinkedServiceCosmosDb;
 * import com.pulumi.azure.datafactory.LinkedServiceCosmosDbArgs;
 * 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 = CosmosdbFunctions.getAccount(GetAccountArgs.builder()
 *             .name("tfex-cosmosdb-account")
 *             .resourceGroupName("tfex-cosmosdb-account-rg")
 *             .build());
 * 
 *         var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
 *             .name("example")
 *             .location(exampleResourceGroup.location())
 *             .resourceGroupName(exampleResourceGroup.name())
 *             .build());
 * 
 *         var exampleLinkedServiceCosmosDb = new LinkedServiceCosmosDb("exampleLinkedServiceCosmosDb", LinkedServiceCosmosDbArgs.builder()
 *             .name("example")
 *             .dataFactoryId(exampleFactory.id())
 *             .accountEndpoint(example.applyValue(getAccountResult -> getAccountResult.endpoint()))
 *             .accountKey(example.applyValue(getAccountResult -> getAccountResult.primaryKey()))
 *             .database("foo")
 *             .build());
 * 
 *     }
 * }
 * }
 * 
* <!--End PulumiCodeChooser --> * * ## Import * * Data Factory Linked Service's can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:datafactory/linkedServiceCosmosDb:LinkedServiceCosmosDb example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/linkedservices/example * ``` * */ @ResourceType(type="azure:datafactory/linkedServiceCosmosDb:LinkedServiceCosmosDb") public class LinkedServiceCosmosDb extends com.pulumi.resources.CustomResource { /** * The endpoint of the Azure CosmosDB account. Required if `connection_string` is unspecified. * */ @Export(name="accountEndpoint", refs={String.class}, tree="[0]") private Output accountEndpoint; /** * @return The endpoint of the Azure CosmosDB account. Required if `connection_string` is unspecified. * */ public Output> accountEndpoint() { return Codegen.optional(this.accountEndpoint); } /** * The account key of the Azure Cosmos DB account. Required if `connection_string` is unspecified. * */ @Export(name="accountKey", refs={String.class}, tree="[0]") private Output accountKey; /** * @return The account key of the Azure Cosmos DB account. Required if `connection_string` is unspecified. * */ public Output> accountKey() { return Codegen.optional(this.accountKey); } /** * A map of additional properties to associate with the Data Factory Linked Service. * * The following supported arguments are specific to CosmosDB 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 CosmosDB 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 connection string. Required if `account_endpoint`, `account_key`, and `database` are unspecified. * */ @Export(name="connectionString", refs={String.class}, tree="[0]") private Output connectionString; /** * @return The connection string. Required if `account_endpoint`, `account_key`, and `database` are unspecified. * */ public Output> connectionString() { return Codegen.optional(this.connectionString); } /** * 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 name of the database. Required if `connection_string` is unspecified. * */ @Export(name="database", refs={String.class}, tree="[0]") private Output database; /** * @return The name of the database. Required if `connection_string` is unspecified. * */ public Output> database() { return Codegen.optional(this.database); } /** * 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); } /** * 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); } /** * * @param name The _unique_ name of the resulting resource. */ public LinkedServiceCosmosDb(java.lang.String name) { this(name, LinkedServiceCosmosDbArgs.Empty); } /** * * @param name The _unique_ name of the resulting resource. * @param args The arguments to use to populate this resource's properties. */ public LinkedServiceCosmosDb(java.lang.String name, LinkedServiceCosmosDbArgs 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 LinkedServiceCosmosDb(java.lang.String name, LinkedServiceCosmosDbArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) { super("azure:datafactory/linkedServiceCosmosDb:LinkedServiceCosmosDb", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false); } private LinkedServiceCosmosDb(java.lang.String name, Output id, @Nullable LinkedServiceCosmosDbState state, @Nullable com.pulumi.resources.CustomResourceOptions options) { super("azure:datafactory/linkedServiceCosmosDb:LinkedServiceCosmosDb", name, state, makeResourceOptions(options, id), false); } private static LinkedServiceCosmosDbArgs makeArgs(LinkedServiceCosmosDbArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) { if (options != null && options.getUrn().isPresent()) { return null; } return args == null ? LinkedServiceCosmosDbArgs.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( "accountKey", "connectionString" )) .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 LinkedServiceCosmosDb get(java.lang.String name, Output id, @Nullable LinkedServiceCosmosDbState state, @Nullable com.pulumi.resources.CustomResourceOptions options) { return new LinkedServiceCosmosDb(name, id, state, options); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy