com.pulumi.azure.datafactory.inputs.LinkedServiceDataLakeStorageGen2State 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.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class LinkedServiceDataLakeStorageGen2State extends com.pulumi.resources.ResourceArgs {
public static final LinkedServiceDataLakeStorageGen2State Empty = new LinkedServiceDataLakeStorageGen2State();
/**
* A map of additional properties to associate with the Data Factory Linked Service.
*
* The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:
*
*/
@Import(name="additionalProperties")
private @Nullable Output> additionalProperties;
/**
* @return A map of additional properties to associate with the Data Factory Linked Service.
*
* The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:
*
*/
public Optional>> additionalProperties() {
return Optional.ofNullable(this.additionalProperties);
}
/**
* List of tags that can be used for describing the Data Factory Linked Service.
*
*/
@Import(name="annotations")
private @Nullable Output> annotations;
/**
* @return List of tags that can be used for describing the Data Factory Linked Service.
*
*/
public Optional>> annotations() {
return Optional.ofNullable(this.annotations);
}
/**
* The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
*/
@Import(name="dataFactoryId")
private @Nullable Output dataFactoryId;
/**
* @return The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
*/
public Optional> dataFactoryId() {
return Optional.ofNullable(this.dataFactoryId);
}
/**
* The description for the Data Factory Linked Service.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return The description for the Data Factory Linked Service.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* The integration runtime reference to associate with the Data Factory Linked Service.
*
*/
@Import(name="integrationRuntimeName")
private @Nullable Output integrationRuntimeName;
/**
* @return The integration runtime reference to associate with the Data Factory Linked Service.
*
*/
public Optional> integrationRuntimeName() {
return Optional.ofNullable(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.
*
*/
@Import(name="name")
private @Nullable 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 Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* A map of parameters to associate with the Data Factory Linked Service.
*
*/
@Import(name="parameters")
private @Nullable Output> parameters;
/**
* @return A map of parameters to associate with the Data Factory Linked Service.
*
*/
public Optional>> parameters() {
return Optional.ofNullable(this.parameters);
}
/**
* The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `storage_account_key` and `use_managed_identity`.
*
*/
@Import(name="servicePrincipalId")
private @Nullable Output servicePrincipalId;
/**
* @return The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `storage_account_key` and `use_managed_identity`.
*
*/
public Optional> servicePrincipalId() {
return Optional.ofNullable(this.servicePrincipalId);
}
/**
* The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
*
*/
@Import(name="servicePrincipalKey")
private @Nullable Output servicePrincipalKey;
/**
* @return The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
*
*/
public Optional> servicePrincipalKey() {
return Optional.ofNullable(this.servicePrincipalKey);
}
/**
* The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `use_managed_identity`.
*
*/
@Import(name="storageAccountKey")
private @Nullable Output storageAccountKey;
/**
* @return The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `use_managed_identity`.
*
*/
public Optional> storageAccountKey() {
return Optional.ofNullable(this.storageAccountKey);
}
/**
* The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.
*
* > **NOTE** If `service_principal_id` is used, `service_principal_key` and `tenant` are also required.
*
*/
@Import(name="tenant")
private @Nullable Output tenant;
/**
* @return The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.
*
* > **NOTE** If `service_principal_id` is used, `service_principal_key` and `tenant` are also required.
*
*/
public Optional> tenant() {
return Optional.ofNullable(this.tenant);
}
/**
* The endpoint for the Azure Data Lake Storage Gen2 service.
*
* > **NOTE** Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.
*
*/
@Import(name="url")
private @Nullable Output url;
/**
* @return The endpoint for the Azure Data Lake Storage Gen2 service.
*
* > **NOTE** Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.
*
*/
public Optional> url() {
return Optional.ofNullable(this.url);
}
/**
* Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `storage_account_key`.
*
*/
@Import(name="useManagedIdentity")
private @Nullable Output useManagedIdentity;
/**
* @return Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `storage_account_key`.
*
*/
public Optional> useManagedIdentity() {
return Optional.ofNullable(this.useManagedIdentity);
}
private LinkedServiceDataLakeStorageGen2State() {}
private LinkedServiceDataLakeStorageGen2State(LinkedServiceDataLakeStorageGen2State $) {
this.additionalProperties = $.additionalProperties;
this.annotations = $.annotations;
this.dataFactoryId = $.dataFactoryId;
this.description = $.description;
this.integrationRuntimeName = $.integrationRuntimeName;
this.name = $.name;
this.parameters = $.parameters;
this.servicePrincipalId = $.servicePrincipalId;
this.servicePrincipalKey = $.servicePrincipalKey;
this.storageAccountKey = $.storageAccountKey;
this.tenant = $.tenant;
this.url = $.url;
this.useManagedIdentity = $.useManagedIdentity;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(LinkedServiceDataLakeStorageGen2State defaults) {
return new Builder(defaults);
}
public static final class Builder {
private LinkedServiceDataLakeStorageGen2State $;
public Builder() {
$ = new LinkedServiceDataLakeStorageGen2State();
}
public Builder(LinkedServiceDataLakeStorageGen2State defaults) {
$ = new LinkedServiceDataLakeStorageGen2State(Objects.requireNonNull(defaults));
}
/**
* @param additionalProperties A map of additional properties to associate with the Data Factory Linked Service.
*
* The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:
*
* @return builder
*
*/
public Builder additionalProperties(@Nullable Output> additionalProperties) {
$.additionalProperties = additionalProperties;
return this;
}
/**
* @param additionalProperties A map of additional properties to associate with the Data Factory Linked Service.
*
* The following supported arguments are specific to Data Lake Storage Gen2 Linked Service:
*
* @return builder
*
*/
public Builder additionalProperties(Map additionalProperties) {
return additionalProperties(Output.of(additionalProperties));
}
/**
* @param annotations List of tags that can be used for describing the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder annotations(@Nullable Output> annotations) {
$.annotations = annotations;
return this;
}
/**
* @param annotations List of tags that can be used for describing the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder annotations(List annotations) {
return annotations(Output.of(annotations));
}
/**
* @param annotations List of tags that can be used for describing the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder annotations(String... annotations) {
return annotations(List.of(annotations));
}
/**
* @param dataFactoryId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
* @return builder
*
*/
public Builder dataFactoryId(@Nullable Output dataFactoryId) {
$.dataFactoryId = dataFactoryId;
return this;
}
/**
* @param dataFactoryId The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
* @return builder
*
*/
public Builder dataFactoryId(String dataFactoryId) {
return dataFactoryId(Output.of(dataFactoryId));
}
/**
* @param description The description for the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description The description for the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param integrationRuntimeName The integration runtime reference to associate with the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder integrationRuntimeName(@Nullable Output integrationRuntimeName) {
$.integrationRuntimeName = integrationRuntimeName;
return this;
}
/**
* @param integrationRuntimeName The integration runtime reference to associate with the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder integrationRuntimeName(String integrationRuntimeName) {
return integrationRuntimeName(Output.of(integrationRuntimeName));
}
/**
* @param name 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.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name 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.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param parameters A map of parameters to associate with the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder parameters(@Nullable Output> parameters) {
$.parameters = parameters;
return this;
}
/**
* @param parameters A map of parameters to associate with the Data Factory Linked Service.
*
* @return builder
*
*/
public Builder parameters(Map parameters) {
return parameters(Output.of(parameters));
}
/**
* @param servicePrincipalId The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `storage_account_key` and `use_managed_identity`.
*
* @return builder
*
*/
public Builder servicePrincipalId(@Nullable Output servicePrincipalId) {
$.servicePrincipalId = servicePrincipalId;
return this;
}
/**
* @param servicePrincipalId The service principal id with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `storage_account_key` and `use_managed_identity`.
*
* @return builder
*
*/
public Builder servicePrincipalId(String servicePrincipalId) {
return servicePrincipalId(Output.of(servicePrincipalId));
}
/**
* @param servicePrincipalKey The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
*
* @return builder
*
*/
public Builder servicePrincipalKey(@Nullable Output servicePrincipalKey) {
$.servicePrincipalKey = servicePrincipalKey;
return this;
}
/**
* @param servicePrincipalKey The service principal key with which to authenticate against the Azure Data Lake Storage Gen2 account.
*
* @return builder
*
*/
public Builder servicePrincipalKey(String servicePrincipalKey) {
return servicePrincipalKey(Output.of(servicePrincipalKey));
}
/**
* @param storageAccountKey The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `use_managed_identity`.
*
* @return builder
*
*/
public Builder storageAccountKey(@Nullable Output storageAccountKey) {
$.storageAccountKey = storageAccountKey;
return this;
}
/**
* @param storageAccountKey The Storage Account Key with which to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `use_managed_identity`.
*
* @return builder
*
*/
public Builder storageAccountKey(String storageAccountKey) {
return storageAccountKey(Output.of(storageAccountKey));
}
/**
* @param tenant The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.
*
* > **NOTE** If `service_principal_id` is used, `service_principal_key` and `tenant` are also required.
*
* @return builder
*
*/
public Builder tenant(@Nullable Output tenant) {
$.tenant = tenant;
return this;
}
/**
* @param tenant The tenant id or name in which the service principal exists to authenticate against the Azure Data Lake Storage Gen2 account.
*
* > **NOTE** If `service_principal_id` is used, `service_principal_key` and `tenant` are also required.
*
* @return builder
*
*/
public Builder tenant(String tenant) {
return tenant(Output.of(tenant));
}
/**
* @param url The endpoint for the Azure Data Lake Storage Gen2 service.
*
* > **NOTE** Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.
*
* @return builder
*
*/
public Builder url(@Nullable Output url) {
$.url = url;
return this;
}
/**
* @param url The endpoint for the Azure Data Lake Storage Gen2 service.
*
* > **NOTE** Users should specify only one of the following three authentication strategies: storage account key, managed identity, service principal.
*
* @return builder
*
*/
public Builder url(String url) {
return url(Output.of(url));
}
/**
* @param useManagedIdentity Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `storage_account_key`.
*
* @return builder
*
*/
public Builder useManagedIdentity(@Nullable Output useManagedIdentity) {
$.useManagedIdentity = useManagedIdentity;
return this;
}
/**
* @param useManagedIdentity Whether to use the Data Factory's managed identity to authenticate against the Azure Data Lake Storage Gen2 account. Incompatible with `service_principal_id`, `service_principal_key`, `tenant` and `storage_account_key`.
*
* @return builder
*
*/
public Builder useManagedIdentity(Boolean useManagedIdentity) {
return useManagedIdentity(Output.of(useManagedIdentity));
}
public LinkedServiceDataLakeStorageGen2State build() {
return $;
}
}
}