BatchAccountCreateParameters interface

Package:

@azure/arm-batch

Parameters supplied to the Create operation.

Properties

allowedAuthenticationModes	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.
autoStorage	The properties related to the auto-storage account.
encryption	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.
identity	The identity of the Batch account.
keyVaultReference	A reference to the Azure key vault associated with the Batch account.
location	The region in which to create the account.
networkProfile	The network profile only takes effect when publicNetworkAccess is enabled.
poolAllocationMode	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.
publicNetworkAccess	If not specified, the default value is 'enabled'.
tags	The user-specified tags associated with the account.

Property Details

allowedAuthenticationModes

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.

allowedAuthenticationModes?: AuthenticationMode[]

Property Value

AuthenticationMode[]

autoStorage

The properties related to the auto-storage account.

autoStorage?: AutoStorageBaseProperties

Property Value

AutoStorageBaseProperties

encryption

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.

encryption?: EncryptionProperties

Property Value

EncryptionProperties

identity

The identity of the Batch account.

identity?: BatchAccountIdentity

Property Value

BatchAccountIdentity

keyVaultReference

A reference to the Azure key vault associated with the Batch account.

keyVaultReference?: KeyVaultReference

Property Value

KeyVaultReference

location

The region in which to create the account.

location: string

Property Value

string

networkProfile

The network profile only takes effect when publicNetworkAccess is enabled.

networkProfile?: NetworkProfile

Property Value

NetworkProfile

poolAllocationMode

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.

poolAllocationMode?: PoolAllocationMode

Property Value

PoolAllocationMode

publicNetworkAccess

If not specified, the default value is 'enabled'.

publicNetworkAccess?: PublicNetworkAccessType

Property Value

PublicNetworkAccessType

tags

The user-specified tags associated with the account.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}