com.pulumi.azure.synapse.WorkspaceArgs 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.synapse;
import com.pulumi.azure.synapse.inputs.WorkspaceAzureDevopsRepoArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceCustomerManagedKeyArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceGithubRepoArgs;
import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
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 WorkspaceArgs extends com.pulumi.resources.ResourceArgs {
public static final WorkspaceArgs Empty = new WorkspaceArgs();
/**
* An `azure_devops_repo` block as defined below.
*
*/
@Import(name="azureDevopsRepo")
private @Nullable Output azureDevopsRepo;
/**
* @return An `azure_devops_repo` block as defined below.
*
*/
public Optional> azureDevopsRepo() {
return Optional.ofNullable(this.azureDevopsRepo);
}
/**
* Is Azure Active Directory Authentication the only way to authenticate with resources inside this synapse Workspace. Defaults to `false`.
*
*/
@Import(name="azureadAuthenticationOnly")
private @Nullable Output azureadAuthenticationOnly;
/**
* @return Is Azure Active Directory Authentication the only way to authenticate with resources inside this synapse Workspace. Defaults to `false`.
*
*/
public Optional> azureadAuthenticationOnly() {
return Optional.ofNullable(this.azureadAuthenticationOnly);
}
/**
* Subnet ID used for computes in workspace Changing this forces a new resource to be created.
*
*/
@Import(name="computeSubnetId")
private @Nullable Output computeSubnetId;
/**
* @return Subnet ID used for computes in workspace Changing this forces a new resource to be created.
*
*/
public Optional> computeSubnetId() {
return Optional.ofNullable(this.computeSubnetId);
}
/**
* A `customer_managed_key` block as defined below.
*
*/
@Import(name="customerManagedKey")
private @Nullable Output customerManagedKey;
/**
* @return A `customer_managed_key` block as defined below.
*
*/
public Optional> customerManagedKey() {
return Optional.ofNullable(this.customerManagedKey);
}
/**
* Is data exfiltration protection enabled in this workspace? If set to `true`, `managed_virtual_network_enabled` must also be set to `true`. Changing this forces a new resource to be created.
*
*/
@Import(name="dataExfiltrationProtectionEnabled")
private @Nullable Output dataExfiltrationProtectionEnabled;
/**
* @return Is data exfiltration protection enabled in this workspace? If set to `true`, `managed_virtual_network_enabled` must also be set to `true`. Changing this forces a new resource to be created.
*
*/
public Optional> dataExfiltrationProtectionEnabled() {
return Optional.ofNullable(this.dataExfiltrationProtectionEnabled);
}
/**
* A `github_repo` block as defined below.
*
*/
@Import(name="githubRepo")
private @Nullable Output githubRepo;
/**
* @return A `github_repo` block as defined below.
*
*/
public Optional> githubRepo() {
return Optional.ofNullable(this.githubRepo);
}
/**
* An `identity` block as defined below.
*
*/
@Import(name="identity")
private @Nullable Output identity;
/**
* @return An `identity` block as defined below.
*
*/
public Optional> identity() {
return Optional.ofNullable(this.identity);
}
/**
* Allowed AAD Tenant Ids For Linking.
*
*/
@Import(name="linkingAllowedForAadTenantIds")
private @Nullable Output> linkingAllowedForAadTenantIds;
/**
* @return Allowed AAD Tenant Ids For Linking.
*
*/
public Optional>> linkingAllowedForAadTenantIds() {
return Optional.ofNullable(this.linkingAllowedForAadTenantIds);
}
/**
* Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
*/
@Import(name="location")
private @Nullable Output location;
/**
* @return Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
*/
public Optional> location() {
return Optional.ofNullable(this.location);
}
/**
* Workspace managed resource group. Changing this forces a new resource to be created.
*
*/
@Import(name="managedResourceGroupName")
private @Nullable Output managedResourceGroupName;
/**
* @return Workspace managed resource group. Changing this forces a new resource to be created.
*
*/
public Optional> managedResourceGroupName() {
return Optional.ofNullable(this.managedResourceGroupName);
}
/**
* Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.
*
*/
@Import(name="managedVirtualNetworkEnabled")
private @Nullable Output managedVirtualNetworkEnabled;
/**
* @return Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.
*
*/
public Optional> managedVirtualNetworkEnabled() {
return Optional.ofNullable(this.managedVirtualNetworkEnabled);
}
/**
* Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* Whether public network access is allowed for the Cognitive Account. Defaults to `true`.
*
*/
@Import(name="publicNetworkAccessEnabled")
private @Nullable Output publicNetworkAccessEnabled;
/**
* @return Whether public network access is allowed for the Cognitive Account. Defaults to `true`.
*
*/
public Optional> publicNetworkAccessEnabled() {
return Optional.ofNullable(this.publicNetworkAccessEnabled);
}
/**
* The ID of purview account.
*
*/
@Import(name="purviewId")
private @Nullable Output purviewId;
/**
* @return The ID of purview account.
*
*/
public Optional> purviewId() {
return Optional.ofNullable(this.purviewId);
}
/**
* Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
*/
@Import(name="resourceGroupName", required=true)
private Output resourceGroupName;
/**
* @return Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided `customer_managed_key` must be provided.
*
*/
@Import(name="sqlAdministratorLogin")
private @Nullable Output sqlAdministratorLogin;
/**
* @return Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided `customer_managed_key` must be provided.
*
*/
public Optional> sqlAdministratorLogin() {
return Optional.ofNullable(this.sqlAdministratorLogin);
}
/**
* The Password associated with the `sql_administrator_login` for the SQL administrator. If this is not provided `customer_managed_key` must be provided.
*
*/
@Import(name="sqlAdministratorLoginPassword")
private @Nullable Output sqlAdministratorLoginPassword;
/**
* @return The Password associated with the `sql_administrator_login` for the SQL administrator. If this is not provided `customer_managed_key` must be provided.
*
*/
public Optional> sqlAdministratorLoginPassword() {
return Optional.ofNullable(this.sqlAdministratorLoginPassword);
}
/**
* Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?
*
*/
@Import(name="sqlIdentityControlEnabled")
private @Nullable Output sqlIdentityControlEnabled;
/**
* @return Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?
*
*/
public Optional> sqlIdentityControlEnabled() {
return Optional.ofNullable(this.sqlIdentityControlEnabled);
}
/**
* Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.
*
*/
@Import(name="storageDataLakeGen2FilesystemId", required=true)
private Output storageDataLakeGen2FilesystemId;
/**
* @return Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.
*
*/
public Output storageDataLakeGen2FilesystemId() {
return this.storageDataLakeGen2FilesystemId;
}
/**
* A mapping of tags which should be assigned to the Synapse Workspace.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return A mapping of tags which should be assigned to the Synapse Workspace.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
private WorkspaceArgs() {}
private WorkspaceArgs(WorkspaceArgs $) {
this.azureDevopsRepo = $.azureDevopsRepo;
this.azureadAuthenticationOnly = $.azureadAuthenticationOnly;
this.computeSubnetId = $.computeSubnetId;
this.customerManagedKey = $.customerManagedKey;
this.dataExfiltrationProtectionEnabled = $.dataExfiltrationProtectionEnabled;
this.githubRepo = $.githubRepo;
this.identity = $.identity;
this.linkingAllowedForAadTenantIds = $.linkingAllowedForAadTenantIds;
this.location = $.location;
this.managedResourceGroupName = $.managedResourceGroupName;
this.managedVirtualNetworkEnabled = $.managedVirtualNetworkEnabled;
this.name = $.name;
this.publicNetworkAccessEnabled = $.publicNetworkAccessEnabled;
this.purviewId = $.purviewId;
this.resourceGroupName = $.resourceGroupName;
this.sqlAdministratorLogin = $.sqlAdministratorLogin;
this.sqlAdministratorLoginPassword = $.sqlAdministratorLoginPassword;
this.sqlIdentityControlEnabled = $.sqlIdentityControlEnabled;
this.storageDataLakeGen2FilesystemId = $.storageDataLakeGen2FilesystemId;
this.tags = $.tags;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(WorkspaceArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private WorkspaceArgs $;
public Builder() {
$ = new WorkspaceArgs();
}
public Builder(WorkspaceArgs defaults) {
$ = new WorkspaceArgs(Objects.requireNonNull(defaults));
}
/**
* @param azureDevopsRepo An `azure_devops_repo` block as defined below.
*
* @return builder
*
*/
public Builder azureDevopsRepo(@Nullable Output azureDevopsRepo) {
$.azureDevopsRepo = azureDevopsRepo;
return this;
}
/**
* @param azureDevopsRepo An `azure_devops_repo` block as defined below.
*
* @return builder
*
*/
public Builder azureDevopsRepo(WorkspaceAzureDevopsRepoArgs azureDevopsRepo) {
return azureDevopsRepo(Output.of(azureDevopsRepo));
}
/**
* @param azureadAuthenticationOnly Is Azure Active Directory Authentication the only way to authenticate with resources inside this synapse Workspace. Defaults to `false`.
*
* @return builder
*
*/
public Builder azureadAuthenticationOnly(@Nullable Output azureadAuthenticationOnly) {
$.azureadAuthenticationOnly = azureadAuthenticationOnly;
return this;
}
/**
* @param azureadAuthenticationOnly Is Azure Active Directory Authentication the only way to authenticate with resources inside this synapse Workspace. Defaults to `false`.
*
* @return builder
*
*/
public Builder azureadAuthenticationOnly(Boolean azureadAuthenticationOnly) {
return azureadAuthenticationOnly(Output.of(azureadAuthenticationOnly));
}
/**
* @param computeSubnetId Subnet ID used for computes in workspace Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder computeSubnetId(@Nullable Output computeSubnetId) {
$.computeSubnetId = computeSubnetId;
return this;
}
/**
* @param computeSubnetId Subnet ID used for computes in workspace Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder computeSubnetId(String computeSubnetId) {
return computeSubnetId(Output.of(computeSubnetId));
}
/**
* @param customerManagedKey A `customer_managed_key` block as defined below.
*
* @return builder
*
*/
public Builder customerManagedKey(@Nullable Output customerManagedKey) {
$.customerManagedKey = customerManagedKey;
return this;
}
/**
* @param customerManagedKey A `customer_managed_key` block as defined below.
*
* @return builder
*
*/
public Builder customerManagedKey(WorkspaceCustomerManagedKeyArgs customerManagedKey) {
return customerManagedKey(Output.of(customerManagedKey));
}
/**
* @param dataExfiltrationProtectionEnabled Is data exfiltration protection enabled in this workspace? If set to `true`, `managed_virtual_network_enabled` must also be set to `true`. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder dataExfiltrationProtectionEnabled(@Nullable Output dataExfiltrationProtectionEnabled) {
$.dataExfiltrationProtectionEnabled = dataExfiltrationProtectionEnabled;
return this;
}
/**
* @param dataExfiltrationProtectionEnabled Is data exfiltration protection enabled in this workspace? If set to `true`, `managed_virtual_network_enabled` must also be set to `true`. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder dataExfiltrationProtectionEnabled(Boolean dataExfiltrationProtectionEnabled) {
return dataExfiltrationProtectionEnabled(Output.of(dataExfiltrationProtectionEnabled));
}
/**
* @param githubRepo A `github_repo` block as defined below.
*
* @return builder
*
*/
public Builder githubRepo(@Nullable Output githubRepo) {
$.githubRepo = githubRepo;
return this;
}
/**
* @param githubRepo A `github_repo` block as defined below.
*
* @return builder
*
*/
public Builder githubRepo(WorkspaceGithubRepoArgs githubRepo) {
return githubRepo(Output.of(githubRepo));
}
/**
* @param identity An `identity` block as defined below.
*
* @return builder
*
*/
public Builder identity(@Nullable Output identity) {
$.identity = identity;
return this;
}
/**
* @param identity An `identity` block as defined below.
*
* @return builder
*
*/
public Builder identity(WorkspaceIdentityArgs identity) {
return identity(Output.of(identity));
}
/**
* @param linkingAllowedForAadTenantIds Allowed AAD Tenant Ids For Linking.
*
* @return builder
*
*/
public Builder linkingAllowedForAadTenantIds(@Nullable Output> linkingAllowedForAadTenantIds) {
$.linkingAllowedForAadTenantIds = linkingAllowedForAadTenantIds;
return this;
}
/**
* @param linkingAllowedForAadTenantIds Allowed AAD Tenant Ids For Linking.
*
* @return builder
*
*/
public Builder linkingAllowedForAadTenantIds(List linkingAllowedForAadTenantIds) {
return linkingAllowedForAadTenantIds(Output.of(linkingAllowedForAadTenantIds));
}
/**
* @param linkingAllowedForAadTenantIds Allowed AAD Tenant Ids For Linking.
*
* @return builder
*
*/
public Builder linkingAllowedForAadTenantIds(String... linkingAllowedForAadTenantIds) {
return linkingAllowedForAadTenantIds(List.of(linkingAllowedForAadTenantIds));
}
/**
* @param location Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder location(@Nullable Output location) {
$.location = location;
return this;
}
/**
* @param location Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder location(String location) {
return location(Output.of(location));
}
/**
* @param managedResourceGroupName Workspace managed resource group. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder managedResourceGroupName(@Nullable Output managedResourceGroupName) {
$.managedResourceGroupName = managedResourceGroupName;
return this;
}
/**
* @param managedResourceGroupName Workspace managed resource group. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder managedResourceGroupName(String managedResourceGroupName) {
return managedResourceGroupName(Output.of(managedResourceGroupName));
}
/**
* @param managedVirtualNetworkEnabled Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder managedVirtualNetworkEnabled(@Nullable Output managedVirtualNetworkEnabled) {
$.managedVirtualNetworkEnabled = managedVirtualNetworkEnabled;
return this;
}
/**
* @param managedVirtualNetworkEnabled Is Virtual Network enabled for all computes in this workspace? Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder managedVirtualNetworkEnabled(Boolean managedVirtualNetworkEnabled) {
return managedVirtualNetworkEnabled(Output.of(managedVirtualNetworkEnabled));
}
/**
* @param name Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param publicNetworkAccessEnabled Whether public network access is allowed for the Cognitive Account. Defaults to `true`.
*
* @return builder
*
*/
public Builder publicNetworkAccessEnabled(@Nullable Output publicNetworkAccessEnabled) {
$.publicNetworkAccessEnabled = publicNetworkAccessEnabled;
return this;
}
/**
* @param publicNetworkAccessEnabled Whether public network access is allowed for the Cognitive Account. Defaults to `true`.
*
* @return builder
*
*/
public Builder publicNetworkAccessEnabled(Boolean publicNetworkAccessEnabled) {
return publicNetworkAccessEnabled(Output.of(publicNetworkAccessEnabled));
}
/**
* @param purviewId The ID of purview account.
*
* @return builder
*
*/
public Builder purviewId(@Nullable Output purviewId) {
$.purviewId = purviewId;
return this;
}
/**
* @param purviewId The ID of purview account.
*
* @return builder
*
*/
public Builder purviewId(String purviewId) {
return purviewId(Output.of(purviewId));
}
/**
* @param resourceGroupName Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder resourceGroupName(Output resourceGroupName) {
$.resourceGroupName = resourceGroupName;
return this;
}
/**
* @param resourceGroupName Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder resourceGroupName(String resourceGroupName) {
return resourceGroupName(Output.of(resourceGroupName));
}
/**
* @param sqlAdministratorLogin Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided `customer_managed_key` must be provided.
*
* @return builder
*
*/
public Builder sqlAdministratorLogin(@Nullable Output sqlAdministratorLogin) {
$.sqlAdministratorLogin = sqlAdministratorLogin;
return this;
}
/**
* @param sqlAdministratorLogin Specifies The login name of the SQL administrator. Changing this forces a new resource to be created. If this is not provided `customer_managed_key` must be provided.
*
* @return builder
*
*/
public Builder sqlAdministratorLogin(String sqlAdministratorLogin) {
return sqlAdministratorLogin(Output.of(sqlAdministratorLogin));
}
/**
* @param sqlAdministratorLoginPassword The Password associated with the `sql_administrator_login` for the SQL administrator. If this is not provided `customer_managed_key` must be provided.
*
* @return builder
*
*/
public Builder sqlAdministratorLoginPassword(@Nullable Output sqlAdministratorLoginPassword) {
$.sqlAdministratorLoginPassword = sqlAdministratorLoginPassword;
return this;
}
/**
* @param sqlAdministratorLoginPassword The Password associated with the `sql_administrator_login` for the SQL administrator. If this is not provided `customer_managed_key` must be provided.
*
* @return builder
*
*/
public Builder sqlAdministratorLoginPassword(String sqlAdministratorLoginPassword) {
return sqlAdministratorLoginPassword(Output.of(sqlAdministratorLoginPassword));
}
/**
* @param sqlIdentityControlEnabled Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?
*
* @return builder
*
*/
public Builder sqlIdentityControlEnabled(@Nullable Output sqlIdentityControlEnabled) {
$.sqlIdentityControlEnabled = sqlIdentityControlEnabled;
return this;
}
/**
* @param sqlIdentityControlEnabled Are pipelines (running as workspace's system assigned identity) allowed to access SQL pools?
*
* @return builder
*
*/
public Builder sqlIdentityControlEnabled(Boolean sqlIdentityControlEnabled) {
return sqlIdentityControlEnabled(Output.of(sqlIdentityControlEnabled));
}
/**
* @param storageDataLakeGen2FilesystemId Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder storageDataLakeGen2FilesystemId(Output storageDataLakeGen2FilesystemId) {
$.storageDataLakeGen2FilesystemId = storageDataLakeGen2FilesystemId;
return this;
}
/**
* @param storageDataLakeGen2FilesystemId Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder storageDataLakeGen2FilesystemId(String storageDataLakeGen2FilesystemId) {
return storageDataLakeGen2FilesystemId(Output.of(storageDataLakeGen2FilesystemId));
}
/**
* @param tags A mapping of tags which should be assigned to the Synapse Workspace.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags A mapping of tags which should be assigned to the Synapse Workspace.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
public WorkspaceArgs build() {
if ($.resourceGroupName == null) {
throw new MissingRequiredPropertyException("WorkspaceArgs", "resourceGroupName");
}
if ($.storageDataLakeGen2FilesystemId == null) {
throw new MissingRequiredPropertyException("WorkspaceArgs", "storageDataLakeGen2FilesystemId");
}
return $;
}
}
}