Share via

BatchAccount Class

  • Reference

Contains information about an Azure Batch account.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.batch.models._models_py3.AzureResource
BatchAccount

Constructor

BatchAccount(*, identity: _models.BatchAccountIdentity | None = None, public_network_access: str | _models.PublicNetworkAccessType = 'Enabled', network_profile: _models.NetworkProfile | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
identity
BatchAccountIdentity

The identity of the Batch account.
public_network_access
str or PublicNetworkAccessType

If not specified, the default value is 'enabled'. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter".

Default value: Enabled
network_profile
NetworkProfile

The network profile only takes effect when publicNetworkAccess is enabled.

Variables

Name Description
id
str

The ID of the resource.
name
str

The name of the resource.
type
str

The type of the resource.
location
str

The location of the resource.
tags
dict[str, str]

The tags of the resource.
identity
BatchAccountIdentity

The identity of the Batch account.
account_endpoint
str

The account endpoint used to interact with the Batch service.
node_management_endpoint
str

The endpoint used by compute node to connect to the Batch node management service.
provisioning_state
str or ProvisioningState

The provisioned state of the resource. Known values are: "Invalid", "Creating", "Deleting", "Succeeded", "Failed", and "Cancelled".
pool_allocation_mode
str or PoolAllocationMode

The allocation mode for creating pools in the Batch account. Known values are: "BatchService" and "UserSubscription".
key_vault_reference
KeyVaultReference

Identifies the Azure key vault associated with a Batch account.
public_network_access
str or PublicNetworkAccessType

If not specified, the default value is 'enabled'. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter".
network_profile
NetworkProfile

The network profile only takes effect when publicNetworkAccess is enabled.
private_endpoint_connections
list[PrivateEndpointConnection]

List of private endpoint connections associated with the Batch account.
auto_storage
AutoStorageProperties

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

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.
dedicated_core_quota
int

For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
low_priority_core_quota
int

For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
dedicated_core_quota_per_vm_family
list[VirtualMachineFamilyCoreQuota]

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_core_quota_per_vm_family_enforced
bool

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.
pool_quota
int

The pool quota for the Batch account.
active_job_and_job_schedule_quota
int

The active job and job schedule quota for the Batch account.
allowed_authentication_modes
list[str or AuthenticationMode]

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.