models Package

Access rule in a network security perimeter configuration profile.

Properties of Access Rule.

Subscription identifiers.

Parameters for an activating an application package.

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

Contains information about an application in a Batch account.

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

An application package which represents a particular version of an application.

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

Link to an application package inside the batch account.

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

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

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

An error that occurred when autoscaling a pool.

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

AutoScale settings for the pool.

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

The properties related to the auto-storage account.

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

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

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

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

The configuration parameters used for performing automatic OS upgrade.

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

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

Information used to connect to an Azure Fileshare.

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

A definition of an Azure resource.

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

A definition of an Azure resource.

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

Contains information about an Azure Batch account.

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

Parameters supplied to the Create operation.

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

The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode.

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

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

A set of Azure Batch account keys.

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

Values returned by the List operation.

Parameters supplied to the RegenerateKey operation.

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

Parameters for updating an Azure Batch account.

Quotas associated with a Batch region for a particular subscription.

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

The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities.

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

Information used to connect to a CIFS file system.

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

Contains information about a certificate.

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

Base certificate properties.

Contains information about a certificate.

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

Certificate properties for create operations.

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

Certificate properties.

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

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

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

Parameters for a check name availability request.

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

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

The CheckNameAvailability operation response.

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

An error response from the Batch service.

The reference to a user assigned identity associated with the Batch pool which a compute node will use.

The configuration for container-enabled pools.

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

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

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.

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

An error response from the Batch service.

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

Deployment configuration properties.

Values returned by the List operation.

Contains the information for a detector.

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

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image.

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.

Network access profile for Batch endpoint.

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

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

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

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

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

An environment variable to be set on a task process.

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

The resource management error additional info.

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

The error detail.

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

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Fixed scale settings for the pool.

Rule to filter client IP address.

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

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

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.

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

KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.

Identifies the Azure key vault associated with a Batch account.

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

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

The result of performing list application packages.

The result of performing list applications.

Values returned by the List operation.

Values returned by the List operation.

Values returned by the List operation.

Values returned by the List operation.

ManagedDisk.

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

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

The file system to mount on each node.

Information used to connect to an NFS file system.

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

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.

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

Information about a network security perimeter (NSP).

Network security perimeter (NSP) configuration resource.

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

Result of a list NSP (network security perimeter) configurations request.

Network security configuration properties.

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

Network security perimeter configuration profile.

Allocation configuration used by Batch Service to provision the nodes.

Settings for the operating system disk of the virtual machine.

A REST API operation.

The object that describes the operation.

Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

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

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

Values returned by the List operation.

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

Contains information about a pool.

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

The endpoint configuration for a pool.

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

The private endpoint of the private endpoint connection.

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

Contains information about a private link resource.

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

Contains information about a private link resource.

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

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

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

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

Describes a provisioning issue for a network security perimeter configuration.

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

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.

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

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

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

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

An error that occurred when resizing a pool.

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

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

Common fields that are returned in the response for all Azure Resource Manager resources.

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

Information about resource association.

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

The configuration parameters used while performing a rolling upgrade.

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.

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

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.

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

A SKU capability, such as the number of cores.

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

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.

Describes a Batch supported SKU.

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

The Batch List supported SKUs operation response.

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

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

Metadata pertaining to creation and last modification of the resource.

The container settings for a task.

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

Specifies how tasks should be distributed across compute nodes.

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

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

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

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

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

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

The list of associated user identities.

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

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

Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.

The configuration for virtual machine extensions.

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

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

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

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

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

Windows operating system settings to apply to the virtual machine.

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

Direction of Access Rule.

The type of account key to regenerate.

Whether the pool is resizing.

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 type of caching to enable for the disk.

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

CertificateProvisioningState.

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.

CertificateVisibility.

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 paths which will be mounted to container task's container.

The container technology to be used.

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

The type of identity that created the resource.

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

The scope of dynamic vnet assignment.

The elevation level of the user.

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

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

The protocol of the endpoint.

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'.

Type of issue.

Type of the key source.

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

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.

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

Determines how a pool communicates with the Batch service.

The default value is regional.

The current state of the application package.

The allocation mode for creating pools in the Batch account.

The type of identity used for the Batch Pool.

The current state of the pool.

The provisioning state of the private endpoint connection.

The status of the Batch private endpoint connection.

The provisioned state of the resource.

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

Access mode of the resource association.

The type of identity used for the Batch account.

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.

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

Severity of the issue.

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

Specifies the mode of an upgrade to virtual machines in the scale set.:code:
<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.:code:
<br /> Automatic - All virtual machines in the scale set are automatically updated at the same time.:code:
<br /> Rolling - Scale set performs updates in batches with an optional pause time in between.