Azure.ResourceManager.Batch.Models Namespace

Classes

ArmBatchModelFactory

Model factory for models.

AutomaticOSUpgradePolicy

The configuration parameters used for performing automatic OS upgrade.

BatchAccessRule

Access rule in a network security perimeter configuration profile.

BatchAccessRuleProperties

Properties of Access Rule.

BatchAccountAutoScaleSettings

AutoScale settings for the pool.

BatchAccountAutoStorageBaseConfiguration

The properties related to the auto-storage account.

BatchAccountAutoStorageConfiguration

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

BatchAccountCertificateCreateOrUpdateContent

Contains information about a certificate.

BatchAccountCreateOrUpdateContent

Parameters supplied to the Create operation.

BatchAccountEncryptionConfiguration

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.

BatchAccountEndpointDependency

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

BatchAccountFixedScaleSettings

Fixed scale settings for the pool.

BatchAccountKeys

A set of Azure Batch account keys.

BatchAccountOutboundEnvironmentEndpoint

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

BatchAccountPatch

Parameters for updating an Azure Batch account.

BatchAccountPoolAutoScaleRun

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

BatchAccountPoolMetadataItem

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

BatchAccountPoolScaleSettings

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.

BatchAccountPoolStartTask

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.

BatchAccountRegenerateKeyContent

Parameters supplied to the RegenerateKey operation.

BatchApplicationPackageActivateContent

Parameters for an activating an application package.

BatchApplicationPackageReference

Link to an application package inside the batch account.

BatchAutoUserSpecification

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

BatchBlobFileSystemConfiguration

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

BatchCertificateReference

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

BatchCifsMountConfiguration

Information used to connect to a CIFS file system.

BatchCloudServiceConfiguration

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

BatchDeploymentConfiguration

Deployment configuration properties.

BatchEndpointAccessProfile

Network access profile for Batch endpoint.

BatchEndpointDetail

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

BatchEnvironmentSetting

An environment variable to be set on a task process.

BatchFileShareConfiguration

Information used to connect to an Azure Fileshare.

BatchImageReference

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.

BatchInboundNatPool

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

BatchIPRule

Rule to filter client IP address.

BatchKeyVaultReference

Identifies the Azure key vault associated with a Batch account.

BatchLinuxUserConfiguration

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

BatchLocationQuota

Quotas associated with a Batch region for a particular subscription.

BatchMountConfiguration

The file system to mount on each node.

BatchNameAvailabilityContent

Parameters for a check name availability request.

BatchNameAvailabilityResult

The CheckNameAvailability operation response.

BatchNetworkConfiguration

The network configuration for a pool.

BatchNetworkProfile

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

BatchNetworkSecurityGroupRule

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

BatchNfsMountConfiguration

Information used to connect to an NFS file system.

BatchOSDisk

Settings for the operating system disk of the virtual machine.

BatchPrivateLinkServiceConnectionState

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

BatchProvisioningIssue

Describes a provisioning issue for a network security perimeter configuration.

BatchProvisioningIssueProperties

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.

BatchPublicIPAddressConfiguration

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

BatchResizeOperationStatus

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

BatchResourceAssociation

Information about resource association.

BatchResourceFile

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

BatchSecurityProfile

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

BatchSkuCapability

A SKU capability, such as the number of cores.

BatchSupportedSku

Describes a Batch supported SKU.

BatchTaskContainerSettings

The container settings for a task.

BatchUefiSettings

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

BatchUserAccount

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

BatchUserIdentity

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

BatchVmConfiguration

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

BatchVmContainerConfiguration

The configuration for container-enabled pools.

BatchVmContainerRegistry

A private container registry.

BatchVmDataDisk

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.

BatchVmExtension

The configuration for virtual machine extensions.

BatchVmFamilyCoreQuota

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

ContainerHostBatchBindMountEntry

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

ManagedDisk

The ManagedDisk.

NetworkSecurityPerimeter

Information about a network security perimeter (NSP).

NetworkSecurityPerimeterConfigurationProperties

Network security configuration properties.

NetworkSecurityProfile

Network security perimeter configuration profile.

RollingUpgradePolicy

The configuration parameters used while performing a rolling upgrade.

UpgradePolicy

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

Structs

BatchAccessRuleDirection

Direction of Access Rule.

BatchAccountCertificateProvisioningState

The BatchAccountCertificateProvisioningState.

BatchAccountPoolProvisioningState

The current state of the pool.

BatchDiffDiskPlacement

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.

BatchIPRuleAction

Action when client IP address is matched.

BatchIssueType

Type of issue.

BatchPrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection.

BatchProvisioningState

The provisioned state of the resource.

BatchSecurityEncryptionType

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.

BatchSeverity

Severity of the issue.

BatchVmContainerType

The container technology to be used.

ContainerHostDataPath

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

NetworkSecurityPerimeterConfigurationProvisioningState

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

ResourceAssociationAccessMode

Access mode of the resource association.

Enums

BatchAccountCertificateFormat

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

BatchAccountKeySource

Type of the key source.

BatchAccountKeyType

The type of account key to regenerate.

BatchAccountPoolAllocationMode

The allocation mode for creating pools in the Batch account.

BatchAccountPoolAllocationState

Whether the pool is resizing.

BatchApplicationPackageState

The current state of the application package.

BatchAuthenticationMode

The authentication mode for the Batch account.

BatchAutoStorageAuthenticationMode

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

BatchAutoUserScope

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.

BatchCertificateStoreLocation

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.

BatchCertificateVisibility

The BatchCertificateVisibility.

BatchContainerWorkingDirectory

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

BatchDiskCachingType

The type of caching to enable for the disk.

BatchDiskEncryptionTarget

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

BatchEndpointAccessDefaultAction

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

BatchInboundEndpointProtocol

The protocol of the endpoint.

BatchIPAddressProvisioningType

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

BatchNameUnavailableReason

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

BatchNetworkSecurityGroupRuleAccess

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

BatchNodeDeallocationOption

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

BatchNodeFillType

How tasks should be distributed across compute nodes.

BatchNodePlacementPolicyType

The default value is regional.

BatchPrivateLinkServiceConnectionStatus

The status of the Batch private endpoint connection.

BatchPublicNetworkAccess

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

BatchSecurityType

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

BatchStorageAccountType

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

BatchUserAccountElevationLevel

The elevation level of the user.

BatchWindowsLoginMode

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

DynamicVNetAssignmentScope

The scope of dynamic vnet assignment.

InterNodeCommunicationState

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

NodeCommunicationMode

Determines how a pool communicates with the Batch service.

UpgradeMode

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.