BatchAccountProperties interface
Account specific properties.
Properties
| account |
The account endpoint used to interact with the Batch service. |
| active |
The active job and job schedule quota for the Batch account. |
| allowed |
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. |
| auto |
Contains information about the auto-storage account associated with a Batch account. |
| dedicated |
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. |
| dedicated |
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. |
| dedicated |
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. |
| key |
Identifies the Azure key vault associated with a Batch account. |
| low |
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. |
| network |
The network profile only takes effect when publicNetworkAccess is enabled. |
| node |
The endpoint used by compute node to connect to the Batch node management service. |
| pool |
The allocation mode for creating pools in the Batch account. |
| pool |
The pool quota for the Batch account. |
| private |
List of private endpoint connections associated with the Batch account |
| provisioning |
The provisioned state of the resource |
| public |
The network access type for operating on the resources in the Batch account. |
Property Details
accountEndpoint
The account endpoint used to interact with the Batch service.
accountEndpoint?: stringProperty Value
string
activeJobAndJobScheduleQuota
The active job and job schedule quota for the Batch account.
activeJobAndJobScheduleQuota?: numberProperty 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
autoStorage
Contains information about the auto-storage account associated with a Batch account.
autoStorage?: AutoStoragePropertiesProperty Value
dedicatedCoreQuota
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicatedCoreQuota?: numberProperty 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
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?: booleanProperty 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?: EncryptionPropertiesProperty Value
keyVaultReference
Identifies the Azure key vault associated with a Batch account.
keyVaultReference?: KeyVaultReferenceProperty Value
lowPriorityCoreQuota
For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
lowPriorityCoreQuota?: numberProperty Value
number
networkProfile
The network profile only takes effect when publicNetworkAccess is enabled.
networkProfile?: NetworkProfileProperty Value
nodeManagementEndpoint
The endpoint used by compute node to connect to the Batch node management service.
nodeManagementEndpoint?: stringProperty Value
string
poolAllocationMode
The allocation mode for creating pools in the Batch account.
poolAllocationMode?: PoolAllocationModeProperty Value
poolQuota
The pool quota for the Batch account.
poolQuota?: numberProperty Value
number
privateEndpointConnections
List of private endpoint connections associated with the Batch account
privateEndpointConnections?: PrivateEndpointConnection[]Property Value
provisioningState
The provisioned state of the resource
provisioningState?: ProvisioningStateProperty Value
publicNetworkAccess
The network access type for operating on the resources in the Batch account.
publicNetworkAccess?: PublicNetworkAccessType