@azure/arm-batch package

Classes

Interfaces

AccessRule	Access rule in a network security perimeter configuration profile
AccessRuleProperties	Properties of Access Rule
AccessRulePropertiesSubscriptionsItem	The subscription resource ID for an access rule.
ActivateApplicationPackageParameters	Parameters for an activating an application package.
Application	Contains information about an application in a Batch account.
ApplicationCreateOptionalParams	Optional parameters.
ApplicationDeleteOptionalParams	Optional parameters.
ApplicationGetOptionalParams	Optional parameters.
ApplicationListOptionalParams	Optional parameters.
ApplicationOperations	Interface representing a Application operations.
ApplicationPackage	An application package which represents a particular version of an application.
ApplicationPackageActivateOptionalParams	Optional parameters.
ApplicationPackageCreateOptionalParams	Optional parameters.
ApplicationPackageDeleteOptionalParams	Optional parameters.
ApplicationPackageGetOptionalParams	Optional parameters.
ApplicationPackageListOptionalParams	Optional parameters.
ApplicationPackageOperations	Interface representing a ApplicationPackage operations.
ApplicationPackageProperties	Properties of an application package
ApplicationPackageReference	Link to an application package inside the batch account
ApplicationProperties	The properties associated with the Application.
ApplicationUpdateOptionalParams	Optional parameters.
AutoScaleRun	The results and errors from an execution of a pool autoscale formula.
AutoScaleRunError	An error that occurred when autoscaling a pool.
AutoScaleSettings	AutoScale settings for the pool.
AutoStorageBaseProperties	The properties related to the auto-storage account.
AutoStorageProperties	Contains information about the auto-storage account associated with a Batch account.
AutoUserSpecification	Specifies the parameters for the auto user that runs a task on the Batch service.
AutomaticOSUpgradePolicy	The configuration parameters used for performing automatic OS upgrade.
AzureBlobFileSystemConfiguration	Information used to connect to an Azure Storage Container using Blobfuse.
AzureFileShareConfiguration	Information used to connect to an Azure Fileshare.
BatchAccount	Contains information about an Azure Batch account.
BatchAccountCreateOptionalParams	Optional parameters.
BatchAccountCreateParameters	Parameters supplied to the Create operation.
BatchAccountCreateProperties	The properties of a Batch account.
BatchAccountDeleteOptionalParams	Optional parameters.
BatchAccountGetDetectorOptionalParams	Optional parameters.
BatchAccountGetKeysOptionalParams	Optional parameters.
BatchAccountGetOptionalParams	Optional parameters.
BatchAccountIdentity	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.
BatchAccountKeys	A set of Azure Batch account keys.
BatchAccountListByResourceGroupOptionalParams	Optional parameters.
BatchAccountListDetectorsOptionalParams	Optional parameters.
BatchAccountListOptionalParams	Optional parameters.
BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams	Optional parameters.
BatchAccountOperations	Interface representing a BatchAccount operations.
BatchAccountProperties	Account specific properties.
BatchAccountRegenerateKeyOptionalParams	Optional parameters.
BatchAccountRegenerateKeyParameters	Parameters supplied to the RegenerateKey operation.
BatchAccountSynchronizeAutoStorageKeysOptionalParams	Optional parameters.
BatchAccountUpdateOptionalParams	Optional parameters.
BatchAccountUpdateParameters	Parameters for updating an Azure Batch account.
BatchAccountUpdateProperties	The properties of a Batch account.
BatchLocationQuota	Quotas associated with a Batch region for a particular subscription.
BatchManagementClientOptionalParams	Optional parameters for the client.
BatchPoolIdentity	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
CheckNameAvailabilityParameters	Parameters for a check name availability request.
CheckNameAvailabilityResult	The CheckNameAvailability operation response.
CifsMountConfiguration	Information used to connect to a CIFS file system.
CloudError	An error response from the Batch service.
CloudErrorBody	An error response from the Batch service.
ComputeNodeIdentityReference	The reference to a user assigned identity associated with the Batch pool which a compute node will use.
ContainerConfiguration	The configuration for container-enabled pools.
ContainerHostBatchBindMountEntry	The entry of path and mount mode you want to mount into task container.
ContainerRegistry	A private container registry.
DataDisk	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.
DeploymentConfiguration	Deployment configuration properties.
DetectorResponse	Contains the information for a detector.
DetectorResponseProperties	Detector response properties.
DiffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
DiskCustomerManagedKey	The Customer Managed Key reference to encrypt the Disk.
DiskEncryptionConfiguration	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.
DiskEncryptionSetParameters	The ARM resource id of the disk encryption set.
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.
EndpointAccessProfile	Network access profile for Batch endpoint.
EndpointDependency	A domain name and connection details used to access a dependency.
EndpointDetail	Details about the connection between the Batch service and the endpoint.
EnvironmentSetting	An environment variable to be set on a task process.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FixedScaleSettings	Fixed scale settings for the pool.
HostEndpointSettings	Specifies particular host endpoint settings.
IPRule	Rule to filter client IP address.
IPTag	Specifies how tasks should be distributed across compute nodes.
ImageReference	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.
InboundNatPool	A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.
KeyVaultProperties	KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
KeyVaultReference	Identifies the Azure key vault associated with a Batch account.
LinuxUserConfiguration	Properties used to create a user account on a Linux node.
LocationCheckNameAvailabilityOptionalParams	Optional parameters.
LocationGetQuotasOptionalParams	Optional parameters.
LocationListSupportedVirtualMachineSkusOptionalParams	Optional parameters.
LocationOperations	Interface representing a Location operations.
ManagedDisk	The managed disk parameters.
MetadataItem	The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
MountConfiguration	The file system to mount on each node.
NFSMountConfiguration	Information used to connect to an NFS file system.
NetworkConfiguration	The network configuration for a pool.
NetworkProfile	Network profile for Batch account, which contains network rule settings for each endpoint.
NetworkSecurityGroupRule	A network security group rule to apply to an inbound endpoint.
NetworkSecurityPerimeter	Information about a network security perimeter (NSP)
NetworkSecurityPerimeterConfiguration	Network security perimeter (NSP) configuration resource
NetworkSecurityPerimeterConfigurationProperties	Network security configuration properties.
NetworkSecurityPerimeterGetConfigurationOptionalParams	Optional parameters.
NetworkSecurityPerimeterListConfigurationsOptionalParams	Optional parameters.
NetworkSecurityPerimeterOperations	Interface representing a NetworkSecurityPerimeter operations.
NetworkSecurityPerimeterReconcileConfigurationOptionalParams	Optional parameters.
NetworkSecurityProfile	Network security perimeter configuration profile
NodePlacementConfiguration	Allocation configuration used by Batch Service to provision the nodes.
OSDisk	Settings for the operating system disk of the virtual machine.
Operation	A REST API operation
OperationDisplay	The object that describes the operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OutboundEnvironmentEndpoint	A collection of related endpoints from the same service for which the Batch service requires outbound access.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Pool	Contains information about a pool.
PoolCreateOptionalParams	Optional parameters.
PoolDeleteOptionalParams	Optional parameters.
PoolDisableAutoScaleOptionalParams	Optional parameters.
PoolEndpointConfiguration	The endpoint configuration for a pool.
PoolGetOptionalParams	Optional parameters.
PoolListByBatchAccountOptionalParams	Optional parameters.
PoolOperations	Interface representing a Pool operations.
PoolProperties	Pool properties.
PoolStopResizeOptionalParams	Optional parameters.
PoolUpdateOptionalParams	Optional parameters.
PrivateEndpoint	The private endpoint of the private endpoint connection.
PrivateEndpointConnection	Contains information about a private link resource.
PrivateEndpointConnectionDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionGetOptionalParams	Optional parameters.
PrivateEndpointConnectionListByBatchAccountOptionalParams	Optional parameters.
PrivateEndpointConnectionOperations	Interface representing a PrivateEndpointConnection operations.
PrivateEndpointConnectionProperties	Private endpoint connection properties.
PrivateEndpointConnectionUpdateOptionalParams	Optional parameters.
PrivateLinkResource	Contains information about a private link resource.
PrivateLinkResourceGetOptionalParams	Optional parameters.
PrivateLinkResourceListByBatchAccountOptionalParams	Optional parameters.
PrivateLinkResourceOperations	Interface representing a PrivateLinkResource operations.
PrivateLinkResourceProperties	Private link resource properties.
PrivateLinkServiceConnectionState	The private link service connection state of the private endpoint connection
ProvisioningIssue	Describes a provisioning issue for a network security perimeter configuration
ProvisioningIssueProperties	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
ProxyAgentSettings	Specifies ProxyAgent settings while creating the virtual machine.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PublicIPAddressConfiguration	The public IP Address configuration of the networking configuration of a Pool.
ResizeError	An error that occurred when resizing a pool.
ResizeOperationStatus	Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceAssociation	Information about resource association
ResourceFile	A single file or multiple files to be downloaded to a compute node.
RestorePollerOptions
RollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.
ScaleSettings	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.
SecurityProfile	Specifies the security profile settings for the virtual machine or virtual machine scale set.
ServiceArtifactReference	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.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SkuCapability	A SKU capability, such as the number of cores.
StartTask	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.
SupportedSku	Describes a Batch supported SKU.
SystemData	Metadata pertaining to creation and last modification of the resource.
TaskContainerSettings	The container settings for a task.
TaskSchedulingPolicy	Specifies how tasks should be distributed across compute nodes.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UefiSettings	Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
UpgradePolicy	Describes an upgrade policy - automatic, manual, or rolling.
UserAccount	Properties used to create a user on an Azure Batch node.
UserAssignedIdentities	The list of associated user identities.
UserIdentity	Specify either the userName or autoUser property, but not both.
VMDiskSecurityProfile	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.
VMExtension	The configuration for virtual machine extensions.
VirtualMachineConfiguration	The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.
VirtualMachineFamilyCoreQuota	A VM Family and its associated core quota for the Batch account.
WindowsConfiguration	Windows operating system settings to apply to the virtual machine.
WindowsUserConfiguration	Properties used to create a user account on a Windows node.

Type Aliases

AccessRuleDirection	Direction of Access Rule KnownAccessRuleDirection can be used interchangeably with AccessRuleDirection, this enum contains the known values that the service supports. Known values supported by the service Inbound: Applies to inbound network traffic to the secured resources. Outbound: Applies to outbound network traffic from the secured resources
AccountKeyType	The type of account key to regenerate.
AllocationState	Whether the pool is resizing.
AuthenticationMode	The authentication mode for the Batch account.
AutoStorageAuthenticationMode	The authentication mode which the Batch service will use to manage the auto-storage account.
AutoUserScope	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.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CachingType	The type of caching to enable for the disk.
ComputeNodeDeallocationOption	Determines what to do with a node and its running task(s) after it has been selected for deallocation.
ComputeNodeFillType	How tasks should be distributed across compute nodes.
ContainerHostDataPath	The paths which will be mounted to container task's container. KnownContainerHostDataPath can be used interchangeably with ContainerHostDataPath, this enum contains the known values that the service supports. Known values supported by the service Shared: The path for multi-instances task to shared their files. Startup: The path for start task. VfsMounts: The path contains all virtual file systems are mounted on this node. Task: The task path. JobPrep: The job-prep task path. Applications: The applications path.
ContainerType	The container technology to be used. KnownContainerType can be used interchangeably with ContainerType, this enum contains the known values that the service supports. Known values supported by the service DockerCompatible: A Docker compatible container technology will be used to launch the containers. CriCompatible: A CRI based technology will be used to launch the containers.
ContainerWorkingDirectory	A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DiffDiskPlacement	The location where the OS disk should be placed.
DiskEncryptionTarget	If omitted, no disks on the compute nodes in the pool will be encrypted.
DynamicVNetAssignmentScope	The scope of dynamic vnet assignment.
ElevationLevel	The elevation level of the user.
EndpointAccessDefaultAction	Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
HostEndpointSettingsModeTypes	Specifies the access control policy execution mode. KnownHostEndpointSettingsModeTypes can be used interchangeably with HostEndpointSettingsModeTypes, this enum contains the known values that the service supports. Known values supported by the service Audit: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. Enforce: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'.
IPAddressProvisioningType	The provisioning type for Public IP Addresses for the Batch Pool.
IPFamily	The IP families used to specify IP versions available to the pool. KnownIPFamily can be used interchangeably with IPFamily, this enum contains the known values that the service supports. Known values supported by the service IPv4: IPv4 is available to the pool. IPv6: IPv6 is available to the pool.
IPRuleAction	The action when client IP address is matched.
InboundEndpointProtocol	The protocol of the endpoint.
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'.
IssueType	Type of issue KnownIssueType can be used interchangeably with IssueType, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown issue type ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration. MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules. MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP.
JobDefaultOrder	The order for scheduling tasks from different jobs with the same priority. KnownJobDefaultOrder can be used interchangeably with JobDefaultOrder, this enum contains the known values that the service supports. Known values supported by the service None: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. CreationTime: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first.
KeySource	Type of the key source.
LoginMode	Specifies login mode for the user. The default value is Interactive.
NameAvailabilityReason	Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.
NetworkSecurityGroupRuleAccess	The action that should be taken for a specified IP address, subnet range or tag.
NetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of a network security perimeter configuration that is being created or updated. KnownNetworkSecurityPerimeterConfigurationProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigurationProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Updating Deleting Accepted Failed Canceled
NodePlacementPolicyType	The default value is regional.
PackageState	The current state of the application package.
PoolAllocationMode	The allocation mode for creating pools in the Batch account.
PoolIdentityType	The type of identity used for the Batch Pool.
PoolProvisioningState	The current state of the pool.
PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection.
PrivateLinkServiceConnectionStatus	The status of the Batch private endpoint connection
ProvisioningState	The provisioned state of the resource
PublicNetworkAccessType	The network access type for operating on the resources in the Batch account.
ResourceAssociationAccessMode	Access mode of the resource association KnownResourceAssociationAccessMode can be used interchangeably with ResourceAssociationAccessMode, this enum contains the known values that the service supports. Known values supported by the service Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked
ResourceIdentityType	The type of identity used for the Batch account.
ResourceType	The result of the request to list operations.
SecurityEncryptionTypes	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, 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. KnownSecurityEncryptionTypes can be used interchangeably with SecurityEncryptionTypes, this enum contains the known values that the service supports. Known values supported by the service NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks.
SecurityTypes	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
Severity	Severity of the issue. KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports. Known values supported by the service Warning Error
StorageAccountType	The storage account type for use in creating data disks or OS disk.
UpgradeMode	Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time. Rolling - Scale set performs updates in batches with an optional pause time in between.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessRuleDirection	Direction of Access Rule
KnownContainerHostDataPath	The paths which will be mounted to container task's container.
KnownContainerType	The container technology to be used.
KnownCreatedByType	The kind of entity that created the resource.
KnownHostEndpointSettingsModeTypes	Specifies the access control policy execution mode.
KnownIPFamily	The IP families used to specify IP versions available to the pool.
KnownIssueType	Type of issue
KnownJobDefaultOrder	The order for scheduling tasks from different jobs with the same priority.
KnownNetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of a network security perimeter configuration that is being created or updated.
KnownResourceAssociationAccessMode	Access mode of the resource association
KnownSecurityEncryptionTypes	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, 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.
KnownSeverity	Severity of the issue.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(BatchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(BatchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

function restorePoller<TResponse, TResult>(client: BatchManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: BatchManagementClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Share via

@azure/arm-batch package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

restorePoller<TResponse, TResult>(BatchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns