BatchAccountCreateParameters Class

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

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

java.lang.Object
- com.azure.resourcemanager.batch.models.BatchAccountCreateParameters

Implements

JsonSerializable<BatchAccountCreateParameters>

public final class BatchAccountCreateParameters
implements JsonSerializable<BatchAccountCreateParameters>

Parameters supplied to the Create operation.

Constructor Summary

Constructor	Description
BatchAccountCreateParameters()	Creates an instance of BatchAccountCreateParameters 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 BatchAccountCreateParameters	fromJson(JsonReader jsonReader) Reads an instance of BatchAccountCreateParameters from the JsonReader.
BatchAccountIdentity	identity() Get the identity property: The identity of the Batch account.
KeyVaultReference	keyVaultReference() Get the keyVaultReference property: A reference to the Azure key vault associated with the Batch account.
String	location() Get the location property: The region in which to create the 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.
Map<String,String>	tags() Get the tags property: The user-specified tags associated with the account.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
BatchAccountCreateParameters	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.
BatchAccountCreateParameters	withAutoStorage(AutoStorageBaseProperties autoStorage) Set the autoStorage property: The properties related to the auto-storage account.
BatchAccountCreateParameters	withEncryption(EncryptionProperties encryption) Set the encryption property: The encryption configuration for the Batch account.
BatchAccountCreateParameters	withIdentity(BatchAccountIdentity identity) Set the identity property: The identity of the Batch account.
BatchAccountCreateParameters	withKeyVaultReference(KeyVaultReference keyVaultReference) Set the keyVaultReference property: A reference to the Azure key vault associated with the Batch account.
BatchAccountCreateParameters	withLocation(String location) Set the location property: The region in which to create the account.
BatchAccountCreateParameters	withNetworkProfile(NetworkProfile networkProfile) Set the networkProfile property: Network profile for Batch account, which contains network rule settings for each endpoint.
BatchAccountCreateParameters	withPoolAllocationMode(PoolAllocationMode poolAllocationMode) Set the poolAllocationMode property: The allocation mode to use for creating pools in the Batch account.
BatchAccountCreateParameters	withPublicNetworkAccess(PublicNetworkAccessType publicNetworkAccess) Set the publicNetworkAccess property: The network access type for accessing Azure Batch account.
BatchAccountCreateParameters	withTags(Map<String,String> tags) Set the tags property: The user-specified tags associated with the account.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BatchAccountCreateParameters

public BatchAccountCreateParameters()

Creates an instance of BatchAccountCreateParameters 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 BatchAccountCreateParameters fromJson(JsonReader jsonReader)

Reads an instance of BatchAccountCreateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

identity

public BatchAccountIdentity identity()

Get the identity property: The identity of the Batch account.

Returns:

the identity value.

keyVaultReference

public KeyVaultReference keyVaultReference()

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

Returns:

the keyVaultReference value.

location

public String location()

Get the location property: The region in which to create the account.

Returns:

the location 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 BatchAccountCreateParameters 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 BatchAccountCreateParameters object itself.

withAutoStorage

public BatchAccountCreateParameters withAutoStorage(AutoStorageBaseProperties autoStorage)

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

Parameters:

autoStorage - the autoStorage value to set.

Returns:

the BatchAccountCreateParameters object itself.

withEncryption

public BatchAccountCreateParameters 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 BatchAccountCreateParameters object itself.

withIdentity

public BatchAccountCreateParameters withIdentity(BatchAccountIdentity identity)

Set the identity property: The identity of the Batch account.

Parameters:

identity - the identity value to set.

Returns:

the BatchAccountCreateParameters object itself.

withKeyVaultReference

public BatchAccountCreateParameters 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 BatchAccountCreateParameters object itself.

withLocation

public BatchAccountCreateParameters withLocation(String location)

Set the location property: The region in which to create the account.

Parameters:

location - the location value to set.

Returns:

the BatchAccountCreateParameters object itself.

withNetworkProfile

public BatchAccountCreateParameters 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 BatchAccountCreateParameters object itself.

withPoolAllocationMode

public BatchAccountCreateParameters 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 BatchAccountCreateParameters object itself.

withPublicNetworkAccess

public BatchAccountCreateParameters 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 BatchAccountCreateParameters object itself.

withTags

public BatchAccountCreateParameters withTags(Map<String,String> tags)

Set the tags property: The user-specified tags associated with the account.

Parameters:

tags - the tags value to set.

Returns:

the BatchAccountCreateParameters object itself.

Applies to

Feedback

Was this page helpful?