Share via

BatchAccount interface

Package:
@azure/arm-batch

Contains information about an Azure Batch account.

Extends
TrackedResource

Properties

accountEndpoint

The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota

The active job and job schedule quota for the Batch account.
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

Contains information about the auto-storage account associated with a Batch account.
dedicatedCoreQuota

For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
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.
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.
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

Identifies the Azure key vault associated with a Batch account.
lowPriorityCoreQuota

For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
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.
poolAllocationMode

The allocation mode for creating pools in the Batch account.
poolQuota

The pool quota for the Batch account.
privateEndpointConnections

List of private endpoint connections associated with the Batch account
provisioningState

The provisioned state of the resource
publicNetworkAccess

The network access type for operating on the resources in the Batch account.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

accountEndpoint

The account endpoint used to interact with the Batch service.

accountEndpoint?: string

Property Value

string

activeJobAndJobScheduleQuota

The active job and job schedule quota for the Batch account.

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.

allowedAuthenticationModes?: AuthenticationMode[]

Property Value

AuthenticationMode[]

autoStorage

Contains information about the auto-storage account associated with a Batch account.

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.

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.

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.

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.

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.

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.

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.

nodeManagementEndpoint?: string

Property Value

string

poolAllocationMode

The allocation mode for creating pools in the Batch account.

poolAllocationMode?: PoolAllocationMode

Property Value

PoolAllocationMode

poolQuota

The pool quota for the Batch account.

poolQuota?: number

Property Value

number

privateEndpointConnections

List of private endpoint connections associated with the Batch account

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The provisioned state of the resource

provisioningState?: ProvisioningState

Property Value

ProvisioningState

publicNetworkAccess

The network access type for operating on the resources in the Batch account.

publicNetworkAccess?: PublicNetworkAccessType

Property Value

PublicNetworkAccessType

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type