com.pulumi.azure.datafactory.Factory 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.FactoryArgs;
import com.pulumi.azure.datafactory.inputs.FactoryState;
import com.pulumi.azure.datafactory.outputs.FactoryGithubConfiguration;
import com.pulumi.azure.datafactory.outputs.FactoryGlobalParameter;
import com.pulumi.azure.datafactory.outputs.FactoryIdentity;
import com.pulumi.azure.datafactory.outputs.FactoryVstsConfiguration;
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 an Azure Data Factory (Version 2).
*
* ## 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 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Data Factory can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:datafactory/factory:Factory example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example
* ```
*
*/
@ResourceType(type="azure:datafactory/factory:Factory")
public class Factory extends com.pulumi.resources.CustomResource {
/**
* Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
*
*/
@Export(name="customerManagedKeyId", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> customerManagedKeyId;
/**
* @return Specifies the Azure Key Vault Key ID to be used as the Customer Managed Key (CMK) for double encryption. Required with user assigned identity.
*
*/
public Output> customerManagedKeyId() {
return Codegen.optional(this.customerManagedKeyId);
}
/**
* Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if `customer_managed_key_id` is set.
*
*/
@Export(name="customerManagedKeyIdentityId", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> customerManagedKeyIdentityId;
/**
* @return Specifies the ID of the user assigned identity associated with the Customer Managed Key. Must be supplied if `customer_managed_key_id` is set.
*
*/
public Output> customerManagedKeyIdentityId() {
return Codegen.optional(this.customerManagedKeyIdentityId);
}
/**
* A `github_configuration` block as defined below.
*
*/
@Export(name="githubConfiguration", refs={FactoryGithubConfiguration.class}, tree="[0]")
private Output* @Nullable */ FactoryGithubConfiguration> githubConfiguration;
/**
* @return A `github_configuration` block as defined below.
*
*/
public Output> githubConfiguration() {
return Codegen.optional(this.githubConfiguration);
}
/**
* A list of `global_parameter` blocks as defined above.
*
*/
@Export(name="globalParameters", refs={List.class,FactoryGlobalParameter.class}, tree="[0,1]")
private Output* @Nullable */ List> globalParameters;
/**
* @return A list of `global_parameter` blocks as defined above.
*
*/
public Output>> globalParameters() {
return Codegen.optional(this.globalParameters);
}
/**
* An `identity` block as defined below.
*
*/
@Export(name="identity", refs={FactoryIdentity.class}, tree="[0]")
private Output* @Nullable */ FactoryIdentity> identity;
/**
* @return An `identity` block as defined below.
*
*/
public Output> identity() {
return Codegen.optional(this.identity);
}
/**
* Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
*/
public Output location() {
return this.location;
}
/**
* Is Managed Virtual Network enabled?
*
*/
@Export(name="managedVirtualNetworkEnabled", refs={Boolean.class}, tree="[0]")
private Output* @Nullable */ Boolean> managedVirtualNetworkEnabled;
/**
* @return Is Managed Virtual Network enabled?
*
*/
public Output> managedVirtualNetworkEnabled() {
return Codegen.optional(this.managedVirtualNetworkEnabled);
}
/**
* Specifies the name of the Data Factory. 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. 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;
}
/**
* Is the Data Factory visible to the public network? Defaults to `true`.
*
*/
@Export(name="publicNetworkEnabled", refs={Boolean.class}, tree="[0]")
private Output* @Nullable */ Boolean> publicNetworkEnabled;
/**
* @return Is the Data Factory visible to the public network? Defaults to `true`.
*
*/
public Output> publicNetworkEnabled() {
return Codegen.optional(this.publicNetworkEnabled);
}
/**
* Specifies the ID of the purview account resource associated with the Data Factory.
*
*/
@Export(name="purviewId", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> purviewId;
/**
* @return Specifies the ID of the purview account resource associated with the Data Factory.
*
*/
public Output> purviewId() {
return Codegen.optional(this.purviewId);
}
/**
* The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
*
*/
@Export(name="resourceGroupName", refs={String.class}, tree="[0]")
private Output resourceGroupName;
/**
* @return The name of the resource group in which to create the Data Factory. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* A mapping of tags to assign to the resource.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output* @Nullable */ Map> tags;
/**
* @return A mapping of tags to assign to the resource.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A `vsts_configuration` block as defined below.
*
*/
@Export(name="vstsConfiguration", refs={FactoryVstsConfiguration.class}, tree="[0]")
private Output* @Nullable */ FactoryVstsConfiguration> vstsConfiguration;
/**
* @return A `vsts_configuration` block as defined below.
*
*/
public Output> vstsConfiguration() {
return Codegen.optional(this.vstsConfiguration);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Factory(java.lang.String name) {
this(name, FactoryArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Factory(java.lang.String name, FactoryArgs 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 Factory(java.lang.String name, FactoryArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/factory:Factory", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Factory(java.lang.String name, Output id, @Nullable FactoryState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/factory:Factory", name, state, makeResourceOptions(options, id), false);
}
private static FactoryArgs makeArgs(FactoryArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? FactoryArgs.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 Factory get(java.lang.String name, Output id, @Nullable FactoryState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Factory(name, id, state, options);
}
}