Azure.ResourceManager.Batch.Models Namespace

Model factory for models.

The configuration parameters used for performing automatic OS upgrade.

Access rule in a network security perimeter configuration profile.

Properties of Access Rule.

AutoScale settings for the pool.

The properties related to the auto-storage account.

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

Contains information about a certificate.

Parameters supplied to the Create operation.

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.

A domain name and connection details used to access a dependency.

Fixed scale settings for the pool.

A set of Azure Batch account keys.

A collection of related endpoints from the same service for which the Batch service requires outbound access.

Parameters for updating an Azure Batch account.

The results and errors from an execution of a pool autoscale formula.

The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.

Parameters supplied to the RegenerateKey operation.

Parameters for an activating an application package.

Link to an application package inside the batch account.

Specifies the parameters for the auto user that runs a task on the Batch service.

Information used to connect to an Azure Storage Container using Blobfuse.

Warning: This object is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

Information used to connect to a CIFS file system.

The configuration for nodes in a pool based on the Azure Cloud Services platform.

Deployment configuration properties.

Network access profile for Batch endpoint.

Details about the connection between the Batch service and the endpoint.

An environment variable to be set on a task process.

Information used to connect to an Azure Fileshare.

A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.

A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.

Rule to filter client IP address.

Identifies the Azure key vault associated with a Batch account.

Properties used to create a user account on a Linux node.

Quotas associated with a Batch region for a particular subscription.

The file system to mount on each node.

Parameters for a check name availability request.

The CheckNameAvailability operation response.

The network configuration for a pool.

Network profile for Batch account, which contains network rule settings for each endpoint.

A network security group rule to apply to an inbound endpoint.

Information used to connect to an NFS file system.

Settings for the operating system disk of the virtual machine.

The private link service connection state of the private endpoint connection.

Describes a provisioning issue for a network security perimeter configuration.

Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules.

The public IP Address configuration of the networking configuration of a Pool.

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

Information about resource association.

A single file or multiple files to be downloaded to a compute node.

Specifies the security profile settings for the virtual machine or virtual machine scale set.

A SKU capability, such as the number of cores.

Describes a Batch supported SKU.

The container settings for a task.

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Properties used to create a user on an Azure Batch node.

Specify either the userName or autoUser property, but not both.

The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

The configuration for container-enabled pools.

A private container registry.

Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.

The configuration for virtual machine extensions.

A VM Family and its associated core quota for the Batch account.

The entry of path and mount mode you want to mount into task container.

The ManagedDisk.

Information about a network security perimeter (NSP).

Network security configuration properties.

Network security perimeter configuration profile.

The configuration parameters used while performing a rolling upgrade.

Describes an upgrade policy - automatic, manual, or rolling.

Direction of Access Rule.

The BatchAccountCertificateProvisioningState.

The current state of the pool.

This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

Action when client IP address is matched.

Type of issue.

The provisioning state of the private endpoint connection.

The provisioned state of the resource.

Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. Note: It can be set for only Confidential VMs and required when using Confidential VMs.

Severity of the issue.

The container technology to be used.

The paths which will be mounted to container task's container.

Provisioning state of a network security perimeter configuration that is being created or updated.

Access mode of the resource association.

The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.

Type of the key source.

The type of account key to regenerate.

The allocation mode for creating pools in the Batch account.

Whether the pool is resizing.

The current state of the application package.

The authentication mode for the Batch account.

The authentication mode which the Batch service will use to manage the auto-storage account.

The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.

The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

The BatchCertificateVisibility.

A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.

The type of caching to enable for the disk.

If omitted, no disks on the compute nodes in the pool will be encrypted.

Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.

The protocol of the endpoint.

The provisioning type for Public IP Addresses for the Batch Pool.

Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.

The action that should be taken for a specified IP address, subnet range or tag.

Determines what to do with a node and its running task(s) after it has been selected for deallocation.

How tasks should be distributed across compute nodes.

The default value is regional.

The status of the Batch private endpoint connection.

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

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.

The storage account type for use in creating data disks or OS disk.

The elevation level of the user.

Specifies login mode for the user. The default value is Interactive.

The scope of dynamic vnet assignment.

This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.

Determines how a pool communicates with the Batch service.

Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> Automatic - All virtual machines in the scale set are automatically updated at the same time.<br /><br /> Rolling - Scale set performs updates in batches with an optional pause time in between.