com.pulumi.azure.datafactory.Pipeline 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.PipelineArgs;
import com.pulumi.azure.datafactory.inputs.PipelineState;
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.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages a Pipeline inside a 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.Pipeline;
* import com.pulumi.azure.datafactory.PipelineArgs;
* 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())
* .build());
*
* var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### With Activities
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azure.datafactory.Pipeline;
* import com.pulumi.azure.datafactory.PipelineArgs;
* 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 test = new Pipeline("test", PipelineArgs.builder()
* .name("example")
* .dataFactoryId(testAzurermDataFactory.id())
* .variables(Map.of("bob", "item1"))
* .activitiesJson("""
* [
* {
* "name": "Append variable1",
* "type": "AppendVariable",
* "dependsOn": [],
* "userProperties": [],
* "typeProperties": {
* "variableName": "bob",
* "value": "something"
* }
* }
* ]
* """)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Data Factory Pipeline's can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:datafactory/pipeline:Pipeline example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/pipelines/example
* ```
*
*/
@ResourceType(type="azure:datafactory/pipeline:Pipeline")
public class Pipeline extends com.pulumi.resources.CustomResource {
/**
* A JSON object that contains the activities that will be associated with the Data Factory Pipeline.
*
*/
@Export(name="activitiesJson", refs={String.class}, tree="[0]")
private Output activitiesJson;
/**
* @return A JSON object that contains the activities that will be associated with the Data Factory Pipeline.
*
*/
public Output> activitiesJson() {
return Codegen.optional(this.activitiesJson);
}
/**
* List of tags that can be used for describing the Data Factory Pipeline.
*
*/
@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 Pipeline.
*
*/
public Output>> annotations() {
return Codegen.optional(this.annotations);
}
/**
* The max number of concurrent runs for the Data Factory Pipeline. Must be between `1` and `50`.
*
*/
@Export(name="concurrency", refs={Integer.class}, tree="[0]")
private Output concurrency;
/**
* @return The max number of concurrent runs for the Data Factory Pipeline. Must be between `1` and `50`.
*
*/
public Output> concurrency() {
return Codegen.optional(this.concurrency);
}
/**
* 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 Pipeline.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The description for the Data Factory Pipeline.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.
*
*/
@Export(name="folder", refs={String.class}, tree="[0]")
private Output folder;
/**
* @return The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.
*
*/
public Output> folder() {
return Codegen.optional(this.folder);
}
/**
* The TimeSpan value after which an Azure Monitoring Metric is fired.
*
*/
@Export(name="moniterMetricsAfterDuration", refs={String.class}, tree="[0]")
private Output moniterMetricsAfterDuration;
/**
* @return The TimeSpan value after which an Azure Monitoring Metric is fired.
*
*/
public Output> moniterMetricsAfterDuration() {
return Codegen.optional(this.moniterMetricsAfterDuration);
}
/**
* Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. 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 Pipeline. Changing this forces a new resource to be created. Must be globally unique. 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 Pipeline.
*
*/
@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 Pipeline.
*
*/
public Output>> parameters() {
return Codegen.optional(this.parameters);
}
/**
* A map of variables to associate with the Data Factory Pipeline.
*
*/
@Export(name="variables", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> variables;
/**
* @return A map of variables to associate with the Data Factory Pipeline.
*
*/
public Output>> variables() {
return Codegen.optional(this.variables);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Pipeline(java.lang.String name) {
this(name, PipelineArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Pipeline(java.lang.String name, PipelineArgs 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 Pipeline(java.lang.String name, PipelineArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/pipeline:Pipeline", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Pipeline(java.lang.String name, Output id, @Nullable PipelineState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/pipeline:Pipeline", name, state, makeResourceOptions(options, id), false);
}
private static PipelineArgs makeArgs(PipelineArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? PipelineArgs.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())
.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 Pipeline get(java.lang.String name, Output id, @Nullable PipelineState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Pipeline(name, id, state, options);
}
}