com.pulumi.azure.datafactory.DatasetAzureBlob 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.DatasetAzureBlobArgs;
import com.pulumi.azure.datafactory.inputs.DatasetAzureBlobState;
import com.pulumi.azure.datafactory.outputs.DatasetAzureBlobSchemaColumn;
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 Blob Dataset inside an 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.storage.StorageFunctions;
* import com.pulumi.azure.storage.inputs.GetAccountArgs;
* import com.pulumi.azure.datafactory.Factory;
* import com.pulumi.azure.datafactory.FactoryArgs;
* import com.pulumi.azure.datafactory.LinkedServiceAzureBlobStorage;
* import com.pulumi.azure.datafactory.LinkedServiceAzureBlobStorageArgs;
* import com.pulumi.azure.datafactory.DatasetAzureBlob;
* import com.pulumi.azure.datafactory.DatasetAzureBlobArgs;
* 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 = StorageFunctions.getAccount(GetAccountArgs.builder()
* .name("storageaccountname")
* .resourceGroupName(exampleResourceGroup.name())
* .build());
*
* var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
* .name("example")
* .location(exampleResourceGroup.location())
* .resourceGroupName(exampleResourceGroup.name())
* .build());
*
* var exampleLinkedServiceAzureBlobStorage = new LinkedServiceAzureBlobStorage("exampleLinkedServiceAzureBlobStorage", LinkedServiceAzureBlobStorageArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .connectionString(example.applyValue(getAccountResult -> getAccountResult).applyValue(example -> example.applyValue(getAccountResult -> getAccountResult.primaryConnectionString())))
* .build());
*
* var exampleDatasetAzureBlob = new DatasetAzureBlob("exampleDatasetAzureBlob", DatasetAzureBlobArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .linkedServiceName(exampleLinkedServiceAzureBlobStorage.name())
* .path("foo")
* .filename("bar.png")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Data Factory Datasets can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:datafactory/datasetAzureBlob:DatasetAzureBlob example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
* ```
*
*/
@ResourceType(type="azure:datafactory/datasetAzureBlob:DatasetAzureBlob")
public class DatasetAzureBlob extends com.pulumi.resources.CustomResource {
/**
* A map of additional properties to associate with the Data Factory Dataset.
*
* The following supported arguments are specific to Azure Blob Dataset:
*
*/
@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 Dataset.
*
* The following supported arguments are specific to Azure Blob Dataset:
*
*/
public Output>> additionalProperties() {
return Codegen.optional(this.additionalProperties);
}
/**
* List of tags that can be used for describing the Data Factory Dataset.
*
*/
@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 Dataset.
*
*/
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 Dataset.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The description for the Data Factory Dataset.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Is the `filename` using dynamic expression, function or system variables? Defaults to `false`.
*
*/
@Export(name="dynamicFilenameEnabled", refs={Boolean.class}, tree="[0]")
private Output dynamicFilenameEnabled;
/**
* @return Is the `filename` using dynamic expression, function or system variables? Defaults to `false`.
*
*/
public Output> dynamicFilenameEnabled() {
return Codegen.optional(this.dynamicFilenameEnabled);
}
/**
* Is the `path` using dynamic expression, function or system variables? Defaults to `false`.
*
*/
@Export(name="dynamicPathEnabled", refs={Boolean.class}, tree="[0]")
private Output dynamicPathEnabled;
/**
* @return Is the `path` using dynamic expression, function or system variables? Defaults to `false`.
*
*/
public Output> dynamicPathEnabled() {
return Codegen.optional(this.dynamicPathEnabled);
}
/**
* The filename of the Azure Blob.
*
*/
@Export(name="filename", refs={String.class}, tree="[0]")
private Output filename;
/**
* @return The filename of the Azure Blob.
*
*/
public Output> filename() {
return Codegen.optional(this.filename);
}
/**
* The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
*
*/
@Export(name="folder", refs={String.class}, tree="[0]")
private Output folder;
/**
* @return The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
*
*/
public Output> folder() {
return Codegen.optional(this.folder);
}
/**
* The Data Factory Linked Service name in which to associate the Dataset with.
*
*/
@Export(name="linkedServiceName", refs={String.class}, tree="[0]")
private Output linkedServiceName;
/**
* @return The Data Factory Linked Service name in which to associate the Dataset with.
*
*/
public Output linkedServiceName() {
return this.linkedServiceName;
}
/**
* Specifies the name of the Data Factory Dataset. 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 Dataset. 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 Dataset.
*
*/
@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 Dataset.
*
*/
public Output>> parameters() {
return Codegen.optional(this.parameters);
}
/**
* The path of the Azure Blob.
*
*/
@Export(name="path", refs={String.class}, tree="[0]")
private Output path;
/**
* @return The path of the Azure Blob.
*
*/
public Output> path() {
return Codegen.optional(this.path);
}
/**
* A `schema_column` block as defined below.
*
*/
@Export(name="schemaColumns", refs={List.class,DatasetAzureBlobSchemaColumn.class}, tree="[0,1]")
private Output> schemaColumns;
/**
* @return A `schema_column` block as defined below.
*
*/
public Output>> schemaColumns() {
return Codegen.optional(this.schemaColumns);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public DatasetAzureBlob(java.lang.String name) {
this(name, DatasetAzureBlobArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public DatasetAzureBlob(java.lang.String name, DatasetAzureBlobArgs 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 DatasetAzureBlob(java.lang.String name, DatasetAzureBlobArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/datasetAzureBlob:DatasetAzureBlob", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private DatasetAzureBlob(java.lang.String name, Output id, @Nullable DatasetAzureBlobState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/datasetAzureBlob:DatasetAzureBlob", name, state, makeResourceOptions(options, id), false);
}
private static DatasetAzureBlobArgs makeArgs(DatasetAzureBlobArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? DatasetAzureBlobArgs.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 DatasetAzureBlob get(java.lang.String name, Output id, @Nullable DatasetAzureBlobState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new DatasetAzureBlob(name, id, state, options);
}
}