com.pulumi.azure.batch.AccountArgs 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.batch;
import com.pulumi.azure.batch.inputs.AccountEncryptionArgs;
import com.pulumi.azure.batch.inputs.AccountIdentityArgs;
import com.pulumi.azure.batch.inputs.AccountKeyVaultReferenceArgs;
import com.pulumi.azure.batch.inputs.AccountNetworkProfileArgs;
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 AccountArgs extends com.pulumi.resources.ResourceArgs {
public static final AccountArgs Empty = new AccountArgs();
/**
* Specifies the allowed authentication mode for the Batch account. Possible values include `AAD`, `SharedKey` or `TaskAuthenticationToken`.
*
*/
@Import(name="allowedAuthenticationModes")
private @Nullable Output> allowedAuthenticationModes;
/**
* @return Specifies the allowed authentication mode for the Batch account. Possible values include `AAD`, `SharedKey` or `TaskAuthenticationToken`.
*
*/
public Optional>> allowedAuthenticationModes() {
return Optional.ofNullable(this.allowedAuthenticationModes);
}
/**
* Specifies if customer managed key encryption should be used to encrypt batch account data. One `encryption` block as defined below.
*
*/
@Import(name="encryption")
private @Nullable Output encryption;
/**
* @return Specifies if customer managed key encryption should be used to encrypt batch account data. One `encryption` block as defined below.
*
*/
public Optional> encryption() {
return Optional.ofNullable(this.encryption);
}
/**
* 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);
}
/**
* A `key_vault_reference` block, as defined below, that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the `UserSubscription` pool allocation mode.
*
*/
@Import(name="keyVaultReference")
private @Nullable Output keyVaultReference;
/**
* @return A `key_vault_reference` block, as defined below, that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the `UserSubscription` pool allocation mode.
*
*/
public Optional> keyVaultReference() {
return Optional.ofNullable(this.keyVaultReference);
}
/**
* Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
*/
@Import(name="location")
private @Nullable Output location;
/**
* @return Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
*/
public Optional> location() {
return Optional.ofNullable(this.location);
}
/**
* Specifies the name of the Batch account. Only lowercase Alphanumeric characters allowed. Changing this forces a new resource to be created.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Specifies the name of the Batch account. Only lowercase Alphanumeric characters allowed. Changing this forces a new resource to be created.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* A `network_profile` block as defined below.
*
*/
@Import(name="networkProfile")
private @Nullable Output networkProfile;
/**
* @return A `network_profile` block as defined below.
*
*/
public Optional> networkProfile() {
return Optional.ofNullable(this.networkProfile);
}
/**
* Specifies the mode to use for pool allocation. Possible values are `BatchService` or `UserSubscription`. Defaults to `BatchService`.
*
*/
@Import(name="poolAllocationMode")
private @Nullable Output poolAllocationMode;
/**
* @return Specifies the mode to use for pool allocation. Possible values are `BatchService` or `UserSubscription`. Defaults to `BatchService`.
*
*/
public Optional> poolAllocationMode() {
return Optional.ofNullable(this.poolAllocationMode);
}
/**
* Whether public network access is allowed for this server. Defaults to `true`.
*
* > **NOTE:** When using `UserSubscription` mode, an Azure KeyVault reference has to be specified. See `key_vault_reference` below.
*
* > **NOTE:** When using `UserSubscription` mode, the `Microsoft Azure Batch` service principal has to have `Contributor` role on your subscription scope, as documented [here](https://docs.microsoft.com/azure/batch/batch-account-create-portal#additional-configuration-for-user-subscription-mode).
*
*/
@Import(name="publicNetworkAccessEnabled")
private @Nullable Output publicNetworkAccessEnabled;
/**
* @return Whether public network access is allowed for this server. Defaults to `true`.
*
* > **NOTE:** When using `UserSubscription` mode, an Azure KeyVault reference has to be specified. See `key_vault_reference` below.
*
* > **NOTE:** When using `UserSubscription` mode, the `Microsoft Azure Batch` service principal has to have `Contributor` role on your subscription scope, as documented [here](https://docs.microsoft.com/azure/batch/batch-account-create-portal#additional-configuration-for-user-subscription-mode).
*
*/
public Optional> publicNetworkAccessEnabled() {
return Optional.ofNullable(this.publicNetworkAccessEnabled);
}
/**
* The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
*
* > **NOTE:** To work around [a bug in the Azure API](https://github.com/Azure/azure-rest-api-specs/issues/5574) this property is currently treated as case-insensitive. A future version of this provider will require that the casing is correct.
*
*/
@Import(name="resourceGroupName", required=true)
private Output resourceGroupName;
/**
* @return The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
*
* > **NOTE:** To work around [a bug in the Azure API](https://github.com/Azure/azure-rest-api-specs/issues/5574) this property is currently treated as case-insensitive. A future version of this provider will require that the casing is correct.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* Specifies the storage account authentication mode. Possible values include `StorageKeys`, `BatchAccountManagedIdentity`.
*
* > **NOTE:** When using `BatchAccountManagedIdentity` mod, the `identity.type` must set to `UserAssigned` or `SystemAssigned`.
*
*/
@Import(name="storageAccountAuthenticationMode")
private @Nullable Output storageAccountAuthenticationMode;
/**
* @return Specifies the storage account authentication mode. Possible values include `StorageKeys`, `BatchAccountManagedIdentity`.
*
* > **NOTE:** When using `BatchAccountManagedIdentity` mod, the `identity.type` must set to `UserAssigned` or `SystemAssigned`.
*
*/
public Optional> storageAccountAuthenticationMode() {
return Optional.ofNullable(this.storageAccountAuthenticationMode);
}
/**
* Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
*
* > **NOTE:** When using `storage_account_id`, the `storage_account_authentication_mode` must be specified as well.
*
*/
@Import(name="storageAccountId")
private @Nullable Output storageAccountId;
/**
* @return Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
*
* > **NOTE:** When using `storage_account_id`, the `storage_account_authentication_mode` must be specified as well.
*
*/
public Optional> storageAccountId() {
return Optional.ofNullable(this.storageAccountId);
}
/**
* Specifies the user assigned identity for the storage account.
*
*/
@Import(name="storageAccountNodeIdentity")
private @Nullable Output storageAccountNodeIdentity;
/**
* @return Specifies the user assigned identity for the storage account.
*
*/
public Optional> storageAccountNodeIdentity() {
return Optional.ofNullable(this.storageAccountNodeIdentity);
}
/**
* A mapping of tags to assign to the resource.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return A mapping of tags to assign to the resource.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
private AccountArgs() {}
private AccountArgs(AccountArgs $) {
this.allowedAuthenticationModes = $.allowedAuthenticationModes;
this.encryption = $.encryption;
this.identity = $.identity;
this.keyVaultReference = $.keyVaultReference;
this.location = $.location;
this.name = $.name;
this.networkProfile = $.networkProfile;
this.poolAllocationMode = $.poolAllocationMode;
this.publicNetworkAccessEnabled = $.publicNetworkAccessEnabled;
this.resourceGroupName = $.resourceGroupName;
this.storageAccountAuthenticationMode = $.storageAccountAuthenticationMode;
this.storageAccountId = $.storageAccountId;
this.storageAccountNodeIdentity = $.storageAccountNodeIdentity;
this.tags = $.tags;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(AccountArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private AccountArgs $;
public Builder() {
$ = new AccountArgs();
}
public Builder(AccountArgs defaults) {
$ = new AccountArgs(Objects.requireNonNull(defaults));
}
/**
* @param allowedAuthenticationModes Specifies the allowed authentication mode for the Batch account. Possible values include `AAD`, `SharedKey` or `TaskAuthenticationToken`.
*
* @return builder
*
*/
public Builder allowedAuthenticationModes(@Nullable Output> allowedAuthenticationModes) {
$.allowedAuthenticationModes = allowedAuthenticationModes;
return this;
}
/**
* @param allowedAuthenticationModes Specifies the allowed authentication mode for the Batch account. Possible values include `AAD`, `SharedKey` or `TaskAuthenticationToken`.
*
* @return builder
*
*/
public Builder allowedAuthenticationModes(List allowedAuthenticationModes) {
return allowedAuthenticationModes(Output.of(allowedAuthenticationModes));
}
/**
* @param allowedAuthenticationModes Specifies the allowed authentication mode for the Batch account. Possible values include `AAD`, `SharedKey` or `TaskAuthenticationToken`.
*
* @return builder
*
*/
public Builder allowedAuthenticationModes(String... allowedAuthenticationModes) {
return allowedAuthenticationModes(List.of(allowedAuthenticationModes));
}
/**
* @param encryption Specifies if customer managed key encryption should be used to encrypt batch account data. One `encryption` block as defined below.
*
* @return builder
*
*/
public Builder encryption(@Nullable Output encryption) {
$.encryption = encryption;
return this;
}
/**
* @param encryption Specifies if customer managed key encryption should be used to encrypt batch account data. One `encryption` block as defined below.
*
* @return builder
*
*/
public Builder encryption(AccountEncryptionArgs encryption) {
return encryption(Output.of(encryption));
}
/**
* @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(AccountIdentityArgs identity) {
return identity(Output.of(identity));
}
/**
* @param keyVaultReference A `key_vault_reference` block, as defined below, that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the `UserSubscription` pool allocation mode.
*
* @return builder
*
*/
public Builder keyVaultReference(@Nullable Output keyVaultReference) {
$.keyVaultReference = keyVaultReference;
return this;
}
/**
* @param keyVaultReference A `key_vault_reference` block, as defined below, that describes the Azure KeyVault reference to use when deploying the Azure Batch account using the `UserSubscription` pool allocation mode.
*
* @return builder
*
*/
public Builder keyVaultReference(AccountKeyVaultReferenceArgs keyVaultReference) {
return keyVaultReference(Output.of(keyVaultReference));
}
/**
* @param location Specifies the supported Azure location where the resource exists. 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 supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder location(String location) {
return location(Output.of(location));
}
/**
* @param name Specifies the name of the Batch account. Only lowercase Alphanumeric characters allowed. 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 of the Batch account. Only lowercase Alphanumeric characters allowed. Changing this forces a new resource to be created.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param networkProfile A `network_profile` block as defined below.
*
* @return builder
*
*/
public Builder networkProfile(@Nullable Output networkProfile) {
$.networkProfile = networkProfile;
return this;
}
/**
* @param networkProfile A `network_profile` block as defined below.
*
* @return builder
*
*/
public Builder networkProfile(AccountNetworkProfileArgs networkProfile) {
return networkProfile(Output.of(networkProfile));
}
/**
* @param poolAllocationMode Specifies the mode to use for pool allocation. Possible values are `BatchService` or `UserSubscription`. Defaults to `BatchService`.
*
* @return builder
*
*/
public Builder poolAllocationMode(@Nullable Output poolAllocationMode) {
$.poolAllocationMode = poolAllocationMode;
return this;
}
/**
* @param poolAllocationMode Specifies the mode to use for pool allocation. Possible values are `BatchService` or `UserSubscription`. Defaults to `BatchService`.
*
* @return builder
*
*/
public Builder poolAllocationMode(String poolAllocationMode) {
return poolAllocationMode(Output.of(poolAllocationMode));
}
/**
* @param publicNetworkAccessEnabled Whether public network access is allowed for this server. Defaults to `true`.
*
* > **NOTE:** When using `UserSubscription` mode, an Azure KeyVault reference has to be specified. See `key_vault_reference` below.
*
* > **NOTE:** When using `UserSubscription` mode, the `Microsoft Azure Batch` service principal has to have `Contributor` role on your subscription scope, as documented [here](https://docs.microsoft.com/azure/batch/batch-account-create-portal#additional-configuration-for-user-subscription-mode).
*
* @return builder
*
*/
public Builder publicNetworkAccessEnabled(@Nullable Output publicNetworkAccessEnabled) {
$.publicNetworkAccessEnabled = publicNetworkAccessEnabled;
return this;
}
/**
* @param publicNetworkAccessEnabled Whether public network access is allowed for this server. Defaults to `true`.
*
* > **NOTE:** When using `UserSubscription` mode, an Azure KeyVault reference has to be specified. See `key_vault_reference` below.
*
* > **NOTE:** When using `UserSubscription` mode, the `Microsoft Azure Batch` service principal has to have `Contributor` role on your subscription scope, as documented [here](https://docs.microsoft.com/azure/batch/batch-account-create-portal#additional-configuration-for-user-subscription-mode).
*
* @return builder
*
*/
public Builder publicNetworkAccessEnabled(Boolean publicNetworkAccessEnabled) {
return publicNetworkAccessEnabled(Output.of(publicNetworkAccessEnabled));
}
/**
* @param resourceGroupName The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
*
* > **NOTE:** To work around [a bug in the Azure API](https://github.com/Azure/azure-rest-api-specs/issues/5574) this property is currently treated as case-insensitive. A future version of this provider will require that the casing is correct.
*
* @return builder
*
*/
public Builder resourceGroupName(Output resourceGroupName) {
$.resourceGroupName = resourceGroupName;
return this;
}
/**
* @param resourceGroupName The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
*
* > **NOTE:** To work around [a bug in the Azure API](https://github.com/Azure/azure-rest-api-specs/issues/5574) this property is currently treated as case-insensitive. A future version of this provider will require that the casing is correct.
*
* @return builder
*
*/
public Builder resourceGroupName(String resourceGroupName) {
return resourceGroupName(Output.of(resourceGroupName));
}
/**
* @param storageAccountAuthenticationMode Specifies the storage account authentication mode. Possible values include `StorageKeys`, `BatchAccountManagedIdentity`.
*
* > **NOTE:** When using `BatchAccountManagedIdentity` mod, the `identity.type` must set to `UserAssigned` or `SystemAssigned`.
*
* @return builder
*
*/
public Builder storageAccountAuthenticationMode(@Nullable Output storageAccountAuthenticationMode) {
$.storageAccountAuthenticationMode = storageAccountAuthenticationMode;
return this;
}
/**
* @param storageAccountAuthenticationMode Specifies the storage account authentication mode. Possible values include `StorageKeys`, `BatchAccountManagedIdentity`.
*
* > **NOTE:** When using `BatchAccountManagedIdentity` mod, the `identity.type` must set to `UserAssigned` or `SystemAssigned`.
*
* @return builder
*
*/
public Builder storageAccountAuthenticationMode(String storageAccountAuthenticationMode) {
return storageAccountAuthenticationMode(Output.of(storageAccountAuthenticationMode));
}
/**
* @param storageAccountId Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
*
* > **NOTE:** When using `storage_account_id`, the `storage_account_authentication_mode` must be specified as well.
*
* @return builder
*
*/
public Builder storageAccountId(@Nullable Output storageAccountId) {
$.storageAccountId = storageAccountId;
return this;
}
/**
* @param storageAccountId Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
*
* > **NOTE:** When using `storage_account_id`, the `storage_account_authentication_mode` must be specified as well.
*
* @return builder
*
*/
public Builder storageAccountId(String storageAccountId) {
return storageAccountId(Output.of(storageAccountId));
}
/**
* @param storageAccountNodeIdentity Specifies the user assigned identity for the storage account.
*
* @return builder
*
*/
public Builder storageAccountNodeIdentity(@Nullable Output storageAccountNodeIdentity) {
$.storageAccountNodeIdentity = storageAccountNodeIdentity;
return this;
}
/**
* @param storageAccountNodeIdentity Specifies the user assigned identity for the storage account.
*
* @return builder
*
*/
public Builder storageAccountNodeIdentity(String storageAccountNodeIdentity) {
return storageAccountNodeIdentity(Output.of(storageAccountNodeIdentity));
}
/**
* @param tags A mapping of tags to assign to the resource.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags A mapping of tags to assign to the resource.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
public AccountArgs build() {
if ($.resourceGroupName == null) {
throw new MissingRequiredPropertyException("AccountArgs", "resourceGroupName");
}
return $;
}
}
}