BatchAccountCreateParameters Class

Parameters supplied to the Create operation.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.batch._serialization.Model
BatchAccountCreateParameters

Constructor

BatchAccountCreateParameters(*, location: str, tags: Dict[str, str] | None = None, identity: _models.BatchAccountIdentity | None = None, auto_storage: _models.AutoStorageBaseProperties | None = None, pool_allocation_mode: str | _models.PoolAllocationMode | None = None, key_vault_reference: _models.KeyVaultReference | None = None, public_network_access: str | _models.PublicNetworkAccessType = 'Enabled', network_profile: _models.NetworkProfile | None = None, encryption: _models.EncryptionProperties | None = None, allowed_authentication_modes: List[str | _models.AuthenticationMode] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

The region in which to create the account. Required.

tags

The user-specified tags associated with the account.

identity

The identity of the Batch account.

auto_storage

The properties related to the auto-storage account.

pool_allocation_mode

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. Known values are: "BatchService" and "UserSubscription".

key_vault_reference

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

public_network_access

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

Default value: Enabled
network_profile

The network profile only takes effect when publicNetworkAccess is enabled.

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.

allowed_authentication_modes

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.

Variables

Name Description
location
str

The region in which to create the account. Required.

tags

The user-specified tags associated with the account.

identity

The identity of the Batch account.

auto_storage

The properties related to the auto-storage account.

pool_allocation_mode

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. Known values are: "BatchService" and "UserSubscription".

key_vault_reference

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

public_network_access

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

network_profile

The network profile only takes effect when publicNetworkAccess is enabled.

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.

allowed_authentication_modes

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.