BatchAccount interface

Package:

@azure/arm-batch

Contains information about an Azure Batch account.

Extends

AzureResource

Properties

accountEndpoint	The account endpoint used to interact with the Batch service. NOTE: This property will not be serialized. It can only be populated by the server.
activeJobAndJobScheduleQuota	The active job and job schedule quota for the Batch account. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
autoStorage	Contains information about the auto-storage account associated with a Batch account. NOTE: This property will not be serialized. It can only be populated by the server.
dedicatedCoreQuota	For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. NOTE: This property will not be serialized. It can only be populated by the server.
dedicatedCoreQuotaPerVMFamily	A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. NOTE: This property will not be serialized. It can only be populated by the server.
dedicatedCoreQuotaPerVMFamilyEnforced	If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
identity	The identity of the Batch account.
keyVaultReference	Identifies the Azure key vault associated with a Batch account. NOTE: This property will not be serialized. It can only be populated by the server.
lowPriorityCoreQuota	For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. NOTE: This property will not be serialized. It can only be populated by the server.
networkProfile	The network profile only takes effect when publicNetworkAccess is enabled.
nodeManagementEndpoint	The endpoint used by compute node to connect to the Batch node management service. NOTE: This property will not be serialized. It can only be populated by the server.
poolAllocationMode	The allocation mode for creating pools in the Batch account. NOTE: This property will not be serialized. It can only be populated by the server.
poolQuota	The pool quota for the Batch account. NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections	List of private endpoint connections associated with the Batch account NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The provisioned state of the resource NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess	If not specified, the default value is 'enabled'.

Inherited Properties

id	The ID of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
location	The location of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	The tags of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accountEndpoint

The account endpoint used to interact with the Batch service. NOTE: This property will not be serialized. It can only be populated by the server.

accountEndpoint?: string

Property Value

string

activeJobAndJobScheduleQuota

The active job and job schedule quota for the Batch account. NOTE: This property will not be serialized. It can only be populated by the server.

activeJobAndJobScheduleQuota?: number

Property Value

number

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. NOTE: This property will not be serialized. It can only be populated by the server.

allowedAuthenticationModes?: AuthenticationMode[]

Property Value

AuthenticationMode[]

autoStorage

Contains information about the auto-storage account associated with a Batch account. NOTE: This property will not be serialized. It can only be populated by the server.

autoStorage?: AutoStorageProperties

Property Value

AutoStorageProperties

dedicatedCoreQuota

For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. NOTE: This property will not be serialized. It can only be populated by the server.

dedicatedCoreQuota?: number

Property Value

number

dedicatedCoreQuotaPerVMFamily

A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. NOTE: This property will not be serialized. It can only be populated by the server.

dedicatedCoreQuotaPerVMFamily?: VirtualMachineFamilyCoreQuota[]

Property Value

VirtualMachineFamilyCoreQuota[]

dedicatedCoreQuotaPerVMFamilyEnforced

If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family. NOTE: This property will not be serialized. It can only be populated by the server.

dedicatedCoreQuotaPerVMFamilyEnforced?: boolean

Property Value

boolean

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. NOTE: This property will not be serialized. It can only be populated by the server.

encryption?: EncryptionProperties

Property Value

EncryptionProperties

identity

The identity of the Batch account.

identity?: BatchAccountIdentity

Property Value

BatchAccountIdentity

keyVaultReference

Identifies the Azure key vault associated with a Batch account. NOTE: This property will not be serialized. It can only be populated by the server.

keyVaultReference?: KeyVaultReference

Property Value

KeyVaultReference

lowPriorityCoreQuota

For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. NOTE: This property will not be serialized. It can only be populated by the server.

lowPriorityCoreQuota?: number

Property Value

number

networkProfile

The network profile only takes effect when publicNetworkAccess is enabled.

networkProfile?: NetworkProfile

Property Value

NetworkProfile

nodeManagementEndpoint

The endpoint used by compute node to connect to the Batch node management service. NOTE: This property will not be serialized. It can only be populated by the server.

nodeManagementEndpoint?: string

Property Value

string

poolAllocationMode

The allocation mode for creating pools in the Batch account. NOTE: This property will not be serialized. It can only be populated by the server.

poolAllocationMode?: PoolAllocationMode

Property Value

PoolAllocationMode

poolQuota

The pool quota for the Batch account. NOTE: This property will not be serialized. It can only be populated by the server.

poolQuota?: number

Property Value

number

privateEndpointConnections

List of private endpoint connections associated with the Batch account NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The provisioned state of the resource NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: ProvisioningState

Property Value

ProvisioningState

publicNetworkAccess

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

publicNetworkAccess?: PublicNetworkAccessType

Property Value

PublicNetworkAccessType

Inherited Property Details

id

The ID of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From AzureResource.id

location

The location of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From AzureResource.location

name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From AzureResource.name

tags

The tags of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

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

Property Value

{[propertyName: string]: string}

Inherited From AzureResource.tags

type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From AzureResource.type