@azure/arm-batch package

Classes

BatchManagementClient

Interfaces

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.

ApplicationListNextOptionalParams

Optional parameters.

ApplicationListOptionalParams

Optional parameters.

ApplicationOperations

Interface representing a ApplicationOperations.

ApplicationPackage

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

ApplicationPackageActivateOptionalParams

Optional parameters.

ApplicationPackageCreateOptionalParams

Optional parameters.

ApplicationPackageDeleteOptionalParams

Optional parameters.

ApplicationPackageGetOptionalParams

Optional parameters.

ApplicationPackageListNextOptionalParams

Optional parameters.

ApplicationPackageListOptionalParams

Optional parameters.

ApplicationPackageOperations

Interface representing a ApplicationPackageOperations.

ApplicationPackageReference

Link to an application package inside the batch account

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.

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.

BatchAccountCreateHeaders

Defines headers for BatchAccount_create operation.

BatchAccountCreateOptionalParams

Optional parameters.

BatchAccountCreateParameters

Parameters supplied to the Create operation.

BatchAccountDeleteHeaders

Defines headers for BatchAccount_delete operation.

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.

BatchAccountListByResourceGroupNextOptionalParams

Optional parameters.

BatchAccountListByResourceGroupOptionalParams

Optional parameters.

BatchAccountListDetectorsNextOptionalParams

Optional parameters.

BatchAccountListDetectorsOptionalParams

Optional parameters.

BatchAccountListNextOptionalParams

Optional parameters.

BatchAccountListOptionalParams

Optional parameters.

BatchAccountListOutboundNetworkDependenciesEndpointsNextOptionalParams

Optional parameters.

BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams

Optional parameters.

BatchAccountListResult

Values returned by the List operation.

BatchAccountOperations

Interface representing a BatchAccountOperations.

BatchAccountRegenerateKeyOptionalParams

Optional parameters.

BatchAccountRegenerateKeyParameters

Parameters supplied to the RegenerateKey operation.

BatchAccountSynchronizeAutoStorageKeysOptionalParams

Optional parameters.

BatchAccountUpdateOptionalParams

Optional parameters.

BatchAccountUpdateParameters

Parameters for updating an Azure Batch account.

BatchLocationQuota

Quotas associated with a Batch region for a particular subscription.

BatchManagementClientOptionalParams

Optional parameters.

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

Certificate

Contains information about a certificate.

CertificateBaseProperties

Base certificate properties.

CertificateCancelDeletionHeaders

Defines headers for Certificate_cancelDeletion operation.

CertificateCancelDeletionOptionalParams

Optional parameters.

CertificateCreateHeaders

Defines headers for Certificate_create operation.

CertificateCreateOptionalParams

Optional parameters.

CertificateCreateOrUpdateParameters

Contains information about a certificate.

CertificateCreateOrUpdateProperties

Certificate properties for create operations

CertificateDeleteHeaders

Defines headers for Certificate_delete operation.

CertificateDeleteOptionalParams

Optional parameters.

CertificateGetHeaders

Defines headers for Certificate_get operation.

CertificateGetOptionalParams

Optional parameters.

CertificateListByBatchAccountNextOptionalParams

Optional parameters.

CertificateListByBatchAccountOptionalParams

Optional parameters.

CertificateOperations

Interface representing a CertificateOperations.

CertificateProperties

Certificate properties.

CertificateReference

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

CertificateUpdateHeaders

Defines headers for Certificate_update operation.

CertificateUpdateOptionalParams

Optional parameters.

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.

CloudServiceConfiguration

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

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.

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.

DeleteCertificateError

An error response from the Batch service.

DeploymentConfiguration

Deployment configuration properties.

DetectorListResult

Values returned by the List operation.

DetectorResponse

Contains the information for a detector.

DiffDiskSettings

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

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 Shared Image Gallery Image.

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.

FixedScaleSettings

Fixed scale settings for the pool.

IPRule

Rule to filter client IP address.

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.

ListApplicationPackagesResult

The result of performing list application packages.

ListApplicationsResult

The result of performing list applications.

ListCertificatesResult

Values returned by the List operation.

ListPoolsResult

Values returned by the List operation.

ListPrivateEndpointConnectionsResult

Values returned by the List operation.

ListPrivateLinkResourcesResult

Values returned by the List operation.

LocationCheckNameAvailabilityOptionalParams

Optional parameters.

LocationGetQuotasOptionalParams

Optional parameters.

LocationListSupportedCloudServiceSkusNextOptionalParams

Optional parameters.

LocationListSupportedCloudServiceSkusOptionalParams

Optional parameters.

LocationListSupportedVirtualMachineSkusNextOptionalParams

Optional parameters.

LocationListSupportedVirtualMachineSkusOptionalParams

Optional parameters.

Location_2

Interface representing a Location.

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.

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.

OperationListResult

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.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OutboundEnvironmentEndpoint

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

OutboundEnvironmentEndpointCollection

Values returned by the List operation.

Pool

Contains information about a pool.

PoolCreateHeaders

Defines headers for Pool_create operation.

PoolCreateOptionalParams

Optional parameters.

PoolDeleteHeaders

Defines headers for Pool_delete operation.

PoolDeleteOptionalParams

Optional parameters.

PoolDisableAutoScaleHeaders

Defines headers for Pool_disableAutoScale operation.

PoolDisableAutoScaleOptionalParams

Optional parameters.

PoolEndpointConfiguration

The endpoint configuration for a pool.

PoolGetHeaders

Defines headers for Pool_get operation.

PoolGetOptionalParams

Optional parameters.

PoolListByBatchAccountNextOptionalParams

Optional parameters.

PoolListByBatchAccountOptionalParams

Optional parameters.

PoolOperations

Interface representing a PoolOperations.

PoolStopResizeHeaders

Defines headers for Pool_stopResize operation.

PoolStopResizeOptionalParams

Optional parameters.

PoolUpdateHeaders

Defines headers for Pool_update operation.

PoolUpdateOptionalParams

Optional parameters.

PrivateEndpoint

The private endpoint of the private endpoint connection.

PrivateEndpointConnection

Contains information about a private link resource.

PrivateEndpointConnectionDeleteHeaders

Defines headers for PrivateEndpointConnection_delete operation.

PrivateEndpointConnectionDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionGetOptionalParams

Optional parameters.

PrivateEndpointConnectionListByBatchAccountNextOptionalParams

Optional parameters.

PrivateEndpointConnectionListByBatchAccountOptionalParams

Optional parameters.

PrivateEndpointConnectionOperations

Interface representing a PrivateEndpointConnectionOperations.

PrivateEndpointConnectionUpdateHeaders

Defines headers for PrivateEndpointConnection_update operation.

PrivateEndpointConnectionUpdateOptionalParams

Optional parameters.

PrivateLinkResource

Contains information about a private link resource.

PrivateLinkResourceGetOptionalParams

Optional parameters.

PrivateLinkResourceListByBatchAccountNextOptionalParams

Optional parameters.

PrivateLinkResourceListByBatchAccountOptionalParams

Optional parameters.

PrivateLinkResourceOperations

Interface representing a PrivateLinkResourceOperations.

PrivateLinkServiceConnectionState

The private link service connection state of the private endpoint connection

ProxyResource

A definition of an Azure resource.

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

A definition of an Azure resource.

ResourceFile

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

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.

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.

SupportedSkusResult

The Batch List supported SKUs operation response.

TaskContainerSettings

The container settings for a task.

TaskSchedulingPolicy

Specifies how tasks should be distributed across compute nodes.

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.

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

AccountKeyType

Defines values for AccountKeyType.

AllocationState

Defines values for AllocationState.

ApplicationCreateResponse

Contains response data for the create operation.

ApplicationGetResponse

Contains response data for the get operation.

ApplicationListNextResponse

Contains response data for the listNext operation.

ApplicationListResponse

Contains response data for the list operation.

ApplicationPackageActivateResponse

Contains response data for the activate operation.

ApplicationPackageCreateResponse

Contains response data for the create operation.

ApplicationPackageGetResponse

Contains response data for the get operation.

ApplicationPackageListNextResponse

Contains response data for the listNext operation.

ApplicationPackageListResponse

Contains response data for the list operation.

ApplicationUpdateResponse

Contains response data for the update operation.

AuthenticationMode

Defines values for AuthenticationMode.

AutoStorageAuthenticationMode

Defines values for AutoStorageAuthenticationMode.

AutoUserScope

Defines values for AutoUserScope.

BatchAccountCreateResponse

Contains response data for the create operation.

BatchAccountGetDetectorResponse

Contains response data for the getDetector operation.

BatchAccountGetKeysResponse

Contains response data for the getKeys operation.

BatchAccountGetResponse

Contains response data for the get operation.

BatchAccountListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

BatchAccountListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

BatchAccountListDetectorsNextResponse

Contains response data for the listDetectorsNext operation.

BatchAccountListDetectorsResponse

Contains response data for the listDetectors operation.

BatchAccountListNextResponse

Contains response data for the listNext operation.

BatchAccountListOutboundNetworkDependenciesEndpointsNextResponse

Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.

BatchAccountListOutboundNetworkDependenciesEndpointsResponse

Contains response data for the listOutboundNetworkDependenciesEndpoints operation.

BatchAccountListResponse

Contains response data for the list operation.

BatchAccountRegenerateKeyResponse

Contains response data for the regenerateKey operation.

BatchAccountUpdateResponse

Contains response data for the update operation.

CachingType

Defines values for CachingType.

CertificateCancelDeletionResponse

Contains response data for the cancelDeletion operation.

CertificateCreateResponse

Contains response data for the create operation.

CertificateFormat

Defines values for CertificateFormat.

CertificateGetResponse

Contains response data for the get operation.

CertificateListByBatchAccountNextResponse

Contains response data for the listByBatchAccountNext operation.

CertificateListByBatchAccountResponse

Contains response data for the listByBatchAccount operation.

CertificateProvisioningState

Defines values for CertificateProvisioningState.

CertificateStoreLocation

Defines values for CertificateStoreLocation.

CertificateUpdateResponse

Contains response data for the update operation.

CertificateVisibility

Defines values for CertificateVisibility.

ComputeNodeDeallocationOption

Defines values for ComputeNodeDeallocationOption.

ComputeNodeFillType

Defines values for ComputeNodeFillType.

ContainerWorkingDirectory

Defines values for ContainerWorkingDirectory.

DiskEncryptionTarget

Defines values for DiskEncryptionTarget.

DynamicVNetAssignmentScope

Defines values for DynamicVNetAssignmentScope.

ElevationLevel

Defines values for ElevationLevel.

EndpointAccessDefaultAction

Defines values for EndpointAccessDefaultAction.

IPAddressProvisioningType

Defines values for IPAddressProvisioningType.

InboundEndpointProtocol

Defines values for InboundEndpointProtocol.

InterNodeCommunicationState

Defines values for InterNodeCommunicationState.

KeySource

Defines values for KeySource.

LocationCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

LocationGetQuotasResponse

Contains response data for the getQuotas operation.

LocationListSupportedCloudServiceSkusNextResponse

Contains response data for the listSupportedCloudServiceSkusNext operation.

LocationListSupportedCloudServiceSkusResponse

Contains response data for the listSupportedCloudServiceSkus operation.

LocationListSupportedVirtualMachineSkusNextResponse

Contains response data for the listSupportedVirtualMachineSkusNext operation.

LocationListSupportedVirtualMachineSkusResponse

Contains response data for the listSupportedVirtualMachineSkus operation.

LoginMode

Defines values for LoginMode.

NameAvailabilityReason

Defines values for NameAvailabilityReason.

NetworkSecurityGroupRuleAccess

Defines values for NetworkSecurityGroupRuleAccess.

NodeCommunicationMode

Defines values for NodeCommunicationMode.

NodePlacementPolicyType

Defines values for NodePlacementPolicyType.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PackageState

Defines values for PackageState.

PoolAllocationMode

Defines values for PoolAllocationMode.

PoolCreateResponse

Contains response data for the create operation.

PoolDisableAutoScaleResponse

Contains response data for the disableAutoScale operation.

PoolGetResponse

Contains response data for the get operation.

PoolIdentityType

Defines values for PoolIdentityType.

PoolListByBatchAccountNextResponse

Contains response data for the listByBatchAccountNext operation.

PoolListByBatchAccountResponse

Contains response data for the listByBatchAccount operation.

PoolProvisioningState

Defines values for PoolProvisioningState.

PoolStopResizeResponse

Contains response data for the stopResize operation.

PoolUpdateResponse

Contains response data for the update operation.

PrivateEndpointConnectionDeleteResponse

Contains response data for the delete operation.

PrivateEndpointConnectionGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionListByBatchAccountNextResponse

Contains response data for the listByBatchAccountNext operation.

PrivateEndpointConnectionListByBatchAccountResponse

Contains response data for the listByBatchAccount operation.

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.

PrivateEndpointConnectionUpdateResponse

Contains response data for the update operation.

PrivateLinkResourceGetResponse

Contains response data for the get operation.

PrivateLinkResourceListByBatchAccountNextResponse

Contains response data for the listByBatchAccountNext operation.

PrivateLinkResourceListByBatchAccountResponse

Contains response data for the listByBatchAccount operation.

PrivateLinkServiceConnectionStatus

Defines values for PrivateLinkServiceConnectionStatus.

ProvisioningState

Defines values for ProvisioningState.

PublicNetworkAccessType

Defines values for PublicNetworkAccessType.

ResourceIdentityType

Defines values for ResourceIdentityType.

StorageAccountType

Defines values for StorageAccountType.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().