BatchAccountCreateProperties Class

Package:: com.azure.resourcemanager.batch.fluent.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-batch:3.0.0

java.lang.Object
- com.azure.resourcemanager.batch.fluent.models.BatchAccountCreateProperties

Implements

JsonSerializable<BatchAccountCreateProperties>

public final class BatchAccountCreateProperties
implements JsonSerializable<BatchAccountCreateProperties>

The properties of a Batch account.

Constructor Summary

Constructor	Description
BatchAccountCreateProperties()	Creates an instance of BatchAccountCreateProperties class.

Method Summary

Modifier and Type	Method and Description
List<AuthenticationMode>	allowedAuthenticationModes() Get the allowedAuthenticationModes property: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane.
AutoStorageBaseProperties	autoStorage() Get the autoStorage property: The properties related to the auto-storage account.
EncryptionProperties	encryption() Get the encryption property: The encryption configuration for the Batch account.
static BatchAccountCreateProperties	fromJson(JsonReader jsonReader) Reads an instance of BatchAccountCreateProperties from the JsonReader.
KeyVaultReference	keyVaultReference() Get the keyVaultReference property: A reference to the Azure key vault associated with the Batch account.
NetworkProfile	networkProfile() Get the networkProfile property: Network profile for Batch account, which contains network rule settings for each endpoint.
PoolAllocationMode	poolAllocationMode() Get the poolAllocationMode property: The allocation mode to use for creating pools in the Batch account.
PublicNetworkAccessType	publicNetworkAccess() Get the publicNetworkAccess property: The network access type for accessing Azure Batch account.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
BatchAccountCreateProperties	withAllowedAuthenticationModes(List<AuthenticationMode> allowedAuthenticationModes) Set the allowedAuthenticationModes property: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane.
BatchAccountCreateProperties	withAutoStorage(AutoStorageBaseProperties autoStorage) Set the autoStorage property: The properties related to the auto-storage account.
BatchAccountCreateProperties	withEncryption(EncryptionProperties encryption) Set the encryption property: The encryption configuration for the Batch account.
BatchAccountCreateProperties	withKeyVaultReference(KeyVaultReference keyVaultReference) Set the keyVaultReference property: A reference to the Azure key vault associated with the Batch account.
BatchAccountCreateProperties	withNetworkProfile(NetworkProfile networkProfile) Set the networkProfile property: Network profile for Batch account, which contains network rule settings for each endpoint.
BatchAccountCreateProperties	withPoolAllocationMode(PoolAllocationMode poolAllocationMode) Set the poolAllocationMode property: The allocation mode to use for creating pools in the Batch account.
BatchAccountCreateProperties	withPublicNetworkAccess(PublicNetworkAccessType publicNetworkAccess) Set the publicNetworkAccess property: The network access type for accessing Azure Batch account.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BatchAccountCreateProperties

public BatchAccountCreateProperties()

Creates an instance of BatchAccountCreateProperties class.

Method Details

allowedAuthenticationModes

public List<AuthenticationMode> allowedAuthenticationModes()

Get the allowedAuthenticationModes property: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.

Returns:

the allowedAuthenticationModes value.

autoStorage

public AutoStorageBaseProperties autoStorage()

Get the autoStorage property: The properties related to the auto-storage account.

Returns:

the autoStorage value.

encryption

public EncryptionProperties encryption()

Get the encryption property: The encryption configuration for the Batch account. Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.

Returns:

the encryption value.

fromJson

public static BatchAccountCreateProperties fromJson(JsonReader jsonReader)

Reads an instance of BatchAccountCreateProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchAccountCreateProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the BatchAccountCreateProperties.

keyVaultReference

public KeyVaultReference keyVaultReference()

Get the keyVaultReference property: A reference to the Azure key vault associated with the Batch account.

Returns:

the keyVaultReference value.

networkProfile

public NetworkProfile networkProfile()

Get the networkProfile property: Network profile for Batch account, which contains network rule settings for each endpoint. The network profile only takes effect when publicNetworkAccess is enabled.

Returns:

the networkProfile value.

poolAllocationMode

public PoolAllocationMode poolAllocationMode()

Get the poolAllocationMode property: The allocation mode to use for creating pools in the Batch account. The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.

Returns:

the poolAllocationMode value.

publicNetworkAccess

public PublicNetworkAccessType publicNetworkAccess()

Get the publicNetworkAccess property: The network access type for accessing Azure Batch account. The network access type for operating on the resources in the Batch account.

Returns:

the publicNetworkAccess value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAllowedAuthenticationModes

public BatchAccountCreateProperties withAllowedAuthenticationModes(List<AuthenticationMode> allowedAuthenticationModes)

Set the allowedAuthenticationModes property: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.

Parameters:

allowedAuthenticationModes - the allowedAuthenticationModes value to set.

Returns:

the BatchAccountCreateProperties object itself.

withAutoStorage

public BatchAccountCreateProperties withAutoStorage(AutoStorageBaseProperties autoStorage)

Set the autoStorage property: The properties related to the auto-storage account.

Parameters:

autoStorage - the autoStorage value to set.

Returns:

the BatchAccountCreateProperties object itself.

withEncryption

public BatchAccountCreateProperties withEncryption(EncryptionProperties encryption)

Set the encryption property: The encryption configuration for the Batch account. Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.

Parameters:

encryption - the encryption value to set.

Returns:

the BatchAccountCreateProperties object itself.

withKeyVaultReference

public BatchAccountCreateProperties withKeyVaultReference(KeyVaultReference keyVaultReference)

Set the keyVaultReference property: A reference to the Azure key vault associated with the Batch account.

Parameters:

keyVaultReference - the keyVaultReference value to set.

Returns:

the BatchAccountCreateProperties object itself.

withNetworkProfile

public BatchAccountCreateProperties withNetworkProfile(NetworkProfile networkProfile)

Set the networkProfile property: Network profile for Batch account, which contains network rule settings for each endpoint. The network profile only takes effect when publicNetworkAccess is enabled.

Parameters:

networkProfile - the networkProfile value to set.

Returns:

the BatchAccountCreateProperties object itself.

withPoolAllocationMode

public BatchAccountCreateProperties withPoolAllocationMode(PoolAllocationMode poolAllocationMode)

Set the poolAllocationMode property: The allocation mode to use for creating pools in the Batch account. The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.

Parameters:

poolAllocationMode - the poolAllocationMode value to set.

Returns:

the BatchAccountCreateProperties object itself.

withPublicNetworkAccess

public BatchAccountCreateProperties withPublicNetworkAccess(PublicNetworkAccessType publicNetworkAccess)

Set the publicNetworkAccess property: The network access type for accessing Azure Batch account. The network access type for operating on the resources in the Batch account.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the BatchAccountCreateProperties object itself.

Applies to

Feedback

Was this page helpful?