Share via


@azure-rest/batch package

Interfaces

AuthenticationTokenSettings

The settings for an authentication token that the Task can use to perform Batch service operations.

AuthenticationTokenSettingsOutput

The settings for an authentication token that the Task can use to perform Batch service operations.

AutoScaleRunErrorOutput

An error that occurred when executing or evaluating a Pool autoscale formula.

AutoScaleRunOutput

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

AutoUserSpecification

Specifies the options for the auto user that runs an Azure Batch Task.

AutoUserSpecificationOutput

Specifies the options for the auto user that runs an Azure Batch Task.

AutomaticOsUpgradePolicy

The configuration parameters used for performing automatic OS upgrade.

AutomaticOsUpgradePolicyOutput

The configuration parameters used for performing automatic OS upgrade.

AzureBlobFileSystemConfiguration

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

AzureBlobFileSystemConfigurationOutput

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

AzureFileShareConfiguration

Information used to connect to an Azure Fileshare.

AzureFileShareConfigurationOutput

Information used to connect to an Azure Fileshare.

BatchAccountListSupportedImagesResultOutput

The result of listing the supported Virtual Machine Images.

BatchAffinityInfo

A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.

BatchAffinityInfoOutput

A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.

BatchApplicationListResultOutput

The result of listing the applications available in an Account.

BatchApplicationOutput

Contains information about an application in an Azure Batch Account.

BatchApplicationPackageReference

A reference to an Package to be deployed to Compute Nodes.

BatchApplicationPackageReferenceOutput

A reference to an Package to be deployed to Compute Nodes.

BatchAutoPoolSpecification

Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.

BatchAutoPoolSpecificationOutput

Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.

BatchClientOptions

The optional parameters for the client

BatchContainerConfiguration

The configuration for container-enabled Pools.

BatchContainerConfigurationOutput

The configuration for container-enabled Pools.

BatchCreateTaskCollectionResultOutput

The result of creating a collection of Tasks to a Job.

BatchDiffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).

BatchDiffDiskSettingsOutput

Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).

BatchErrorDetailOutput

An item of additional information included in an Azure Batch error response.

BatchErrorMessageOutput

An error message received in an Azure Batch error response.

BatchErrorOutput

An error response received from the Azure Batch service.

BatchInboundNatPool

A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.

BatchInboundNatPoolOutput

A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.

BatchJob

An Azure Batch Job.

BatchJobConstraints

The execution constraints for a Job.

BatchJobConstraintsOutput

The execution constraints for a Job.

BatchJobCreateOptions

Parameters for creating an Azure Batch Job.

BatchJobDisableOptions

Parameters for disabling an Azure Batch Job.

BatchJobExecutionInfo

Contains information about the execution of a Job in the Azure Batch service.

BatchJobExecutionInfoOutput

Contains information about the execution of a Job in the Azure Batch service.

BatchJobListResultOutput

The result of listing the Jobs in an Account.

BatchJobManagerTask

Specifies details of a Job Manager Task. The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.

BatchJobManagerTaskOutput

Specifies details of a Job Manager Task. The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.

BatchJobNetworkConfiguration

(This property is not available by default. Please contact support for more information) The network configuration for the Job.

BatchJobNetworkConfigurationOutput

(This property is not available by default. Please contact support for more information) The network configuration for the Job.

BatchJobOutput

An Azure Batch Job.

BatchJobPreparationAndReleaseTaskStatusListResultOutput

The result of listing the status of the Job Preparation and Job Release Tasks for a Job.

BatchJobPreparationAndReleaseTaskStatusOutput

The status of the Job Preparation and Job Release Tasks on a Compute Node.

BatchJobPreparationTask

A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.

BatchJobPreparationTaskExecutionInfoOutput

Contains information about the execution of a Job Preparation Task on a Compute Node.

BatchJobPreparationTaskOutput

A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.

BatchJobReleaseTask

A Job Release Task to run on Job completion on any Compute Node where the Job has run. The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job's maximum wall clock time constraint is reached, and the Job is still active, or the Job's Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool.

BatchJobReleaseTaskExecutionInfoOutput

Contains information about the execution of a Job Release Task on a Compute Node.

BatchJobReleaseTaskOutput

A Job Release Task to run on Job completion on any Compute Node where the Job has run. The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job's maximum wall clock time constraint is reached, and the Job is still active, or the Job's Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool.

BatchJobSchedule

A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.

BatchJobScheduleConfiguration

The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.

BatchJobScheduleConfigurationOutput

The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.

BatchJobScheduleCreateOptions

Parameters for creating an Azure Batch Job Schedule

BatchJobScheduleExecutionInfo

Contains information about Jobs that have been and will be run under a Job Schedule.

BatchJobScheduleExecutionInfoOutput

Contains information about Jobs that have been and will be run under a Job Schedule.

BatchJobScheduleListResultOutput

The result of listing the Job Schedules in an Account.

BatchJobScheduleOutput

A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.

BatchJobScheduleStatistics

Resource usage statistics for a Job Schedule.

BatchJobScheduleStatisticsOutput

Resource usage statistics for a Job Schedule.

BatchJobScheduleUpdateOptions

Parameters for updating an Azure Batch Job Schedule.

BatchJobSchedulingError

An error encountered by the Batch service when scheduling a Job.

BatchJobSchedulingErrorOutput

An error encountered by the Batch service when scheduling a Job.

BatchJobSpecification

Specifies details of the Jobs to be created on a schedule.

BatchJobSpecificationOutput

Specifies details of the Jobs to be created on a schedule.

BatchJobStatistics

Resource usage statistics for a Job.

BatchJobStatisticsOutput

Resource usage statistics for a Job.

BatchJobTerminateOptions

Parameters for terminating an Azure Batch Job.

BatchJobUpdateOptions

Parameters for updating an Azure Batch Job.

BatchMetadataItem

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

BatchMetadataItemOutput

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

BatchNodeAgentInfoOutput

The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node.

BatchNodeCountsOutput

The number of Compute Nodes in each Compute Node state.

BatchNodeDeallocateOptions

Options for deallocating a Compute Node.

BatchNodeDisableSchedulingOptions

Parameters for disabling scheduling on an Azure Batch Compute Node.

BatchNodeEndpointConfigurationOutput

The endpoint configuration for the Compute Node.

BatchNodeErrorOutput

An error encountered by a Compute Node.

BatchNodeFileListResultOutput

The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.

BatchNodeFileOutput

Information about a file or directory on a Compute Node.

BatchNodeIdentityReference

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

BatchNodeIdentityReferenceOutput

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

BatchNodeInfo

Information about the Compute Node on which a Task ran.

BatchNodeInfoOutput

Information about the Compute Node on which a Task ran.

BatchNodeListResultOutput

The result of listing the Compute Nodes in a Pool.

BatchNodeOutput

A Compute Node in the Batch service.

BatchNodePlacementConfiguration

For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones with best effort balancing.

BatchNodePlacementConfigurationOutput

For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones with best effort balancing.

BatchNodeRebootOptions

Parameters for rebooting an Azure Batch Compute Node.

BatchNodeReimageOptions

Parameters for reimaging an Azure Batch Compute Node.

BatchNodeRemoteLoginSettingsOutput

The remote login settings for a Compute Node.

BatchNodeRemoveOptions

Parameters for removing nodes from an Azure Batch Pool.

BatchNodeUserCreateOptions

Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.

BatchNodeUserUpdateOptions

Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.

BatchNodeVMExtensionListResultOutput

The result of listing the Compute Node extensions in a Node.

BatchNodeVMExtensionOutput

The configuration for virtual machine extension instance view.

BatchOsDisk

Settings for the operating system disk of the compute node (VM).

BatchOsDiskOutput

Settings for the operating system disk of the compute node (VM).

BatchPoolCreateOptions

Parameters for creating an Azure Batch Pool.

BatchPoolEnableAutoScaleOptions

Parameters for enabling automatic scaling on an Azure Batch Pool.

BatchPoolEndpointConfiguration

The endpoint configuration for a Pool.

BatchPoolEndpointConfigurationOutput

The endpoint configuration for a Pool.

BatchPoolEvaluateAutoScaleOptions

Parameters for evaluating an automatic scaling formula on an Azure Batch Pool.

BatchPoolIdentityOutput

The identity of the Batch pool, if configured.

BatchPoolIdentityReference

The reference of one of the pool identities to encrypt Disk. This identity will be used to access the key vault.

BatchPoolIdentityReferenceOutput

The reference of one of the pool identities to encrypt Disk. This identity will be used to access the key vault.

BatchPoolInfo

Specifies how a Job should be assigned to a Pool.

BatchPoolInfoOutput

Specifies how a Job should be assigned to a Pool.

BatchPoolListResultOutput

The result of listing the Pools in an Account.

BatchPoolListUsageMetricsResultOutput

The result of a listing the usage metrics for an Account.

BatchPoolNodeCountsListResultOutput

The result of listing the Compute Node counts in the Account.

BatchPoolNodeCountsOutput

The number of Compute Nodes in each state for a Pool.

BatchPoolOutput

A Pool in the Azure Batch service.

BatchPoolReplaceOptions

Parameters for replacing properties on an Azure Batch Pool.

BatchPoolResizeOptions

Parameters for changing the size of an Azure Batch Pool.

BatchPoolResourceStatisticsOutput

Statistics related to resource consumption by Compute Nodes in a Pool.

BatchPoolSpecification

Specification for creating a new Pool.

BatchPoolSpecificationOutput

Specification for creating a new Pool.

BatchPoolStatisticsOutput

Contains utilization and resource usage statistics for the lifetime of a Pool.

BatchPoolUpdateOptions

Parameters for updating an Azure Batch Pool.

BatchPoolUsageMetricsOutput

Usage metrics for a Pool across an aggregation interval.

BatchPoolUsageStatisticsOutput

Statistics related to Pool usage information.

BatchPublicIpAddressConfiguration

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

BatchPublicIpAddressConfigurationOutput

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

BatchStartTask

Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask.

BatchStartTaskInfoOutput

Information about a StartTask running on a Compute Node.

BatchStartTaskOutput

Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask.

BatchSubtaskOutput

Information about an Azure Batch subtask.

BatchSupportedImageOutput

A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.

BatchTask

Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.

BatchTaskConstraints

Execution constraints to apply to a Task.

BatchTaskConstraintsOutput

Execution constraints to apply to a Task.

BatchTaskContainerExecutionInfo

Contains information about the container which a Task is executing.

BatchTaskContainerExecutionInfoOutput

Contains information about the container which a Task is executing.

BatchTaskContainerSettings

The container settings for a Task.

BatchTaskContainerSettingsOutput

The container settings for a Task.

BatchTaskCountsOutput

The Task counts for a Job.

BatchTaskCountsResultOutput

The Task and TaskSlot counts for a Job.

BatchTaskCreateOptions

Parameters for creating an Azure Batch Task.

BatchTaskCreateResultOutput

Result for a single Task created as part of an add Task collection operation.

BatchTaskDependencies

Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled.

BatchTaskDependenciesOutput

Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled.

BatchTaskExecutionInfo

Information about the execution of a Task.

BatchTaskExecutionInfoOutput

Information about the execution of a Task.

BatchTaskFailureInfo

Information about a Task failure.

BatchTaskFailureInfoOutput

Information about a Task failure.

BatchTaskGroup

A collection of Azure Batch Tasks to add.

BatchTaskIdRange

The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.

BatchTaskIdRangeOutput

The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.

BatchTaskInfoOutput

Information about a Task running on a Compute Node.

BatchTaskListResultOutput

The result of listing the Tasks in a Job.

BatchTaskListSubtasksResultOutput

The result of listing the subtasks of a Task.

BatchTaskOutput

Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.

BatchTaskSchedulingPolicy

Specifies how Tasks should be distributed across Compute Nodes.

BatchTaskSchedulingPolicyOutput

Specifies how Tasks should be distributed across Compute Nodes.

BatchTaskSlotCountsOutput

The TaskSlot counts for a Job.

BatchTaskStatistics

Resource usage statistics for a Task.

BatchTaskStatisticsOutput

Resource usage statistics for a Task.

BatchUefiSettings

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

BatchUefiSettingsOutput

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

BatchUserAssignedIdentityOutput

The user assigned Identity

BatchVmDiskSecurityProfile

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

BatchVmDiskSecurityProfileOutput

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

BatchVmImageReference

A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the ' List Supported Images ' operation.

BatchVmImageReferenceOutput

A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the ' List Supported Images ' operation.

CifsMountConfiguration

Information used to connect to a CIFS file system.

CifsMountConfigurationOutput

Information used to connect to a CIFS file system.

ContainerHostBatchBindMountEntry

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

ContainerHostBatchBindMountEntryOutput

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

ContainerRegistryReference

A private container registry.

ContainerRegistryReferenceOutput

A private container registry.

CreateJob
CreateJob201Headers
CreateJob201Response

The request has succeeded and a new resource has been created as a result.

CreateJobBodyParam
CreateJobDefaultResponse
CreateJobHeaderParam
CreateJobHeaders
CreateJobMediaTypesParam
CreateJobQueryParam
CreateJobQueryParamProperties
CreateJobSchedule
CreateJobSchedule201Headers
CreateJobSchedule201Response

The request has succeeded and a new resource has been created as a result.

CreateJobScheduleBodyParam
CreateJobScheduleDefaultResponse
CreateJobScheduleHeaderParam
CreateJobScheduleHeaders
CreateJobScheduleMediaTypesParam
CreateJobScheduleQueryParam
CreateJobScheduleQueryParamProperties
CreateNodeUser
CreateNodeUser201Headers
CreateNodeUser201Response

The request has succeeded and a new resource has been created as a result.

CreateNodeUserBodyParam
CreateNodeUserDefaultResponse
CreateNodeUserHeaderParam
CreateNodeUserHeaders
CreateNodeUserMediaTypesParam
CreateNodeUserQueryParam
CreateNodeUserQueryParamProperties
CreatePool
CreatePool201Headers
CreatePool201Response

The request has succeeded and a new resource has been created as a result.

CreatePoolBodyParam
CreatePoolDefaultResponse
CreatePoolHeaderParam
CreatePoolHeaders
CreatePoolMediaTypesParam
CreatePoolQueryParam
CreatePoolQueryParamProperties
CreateTask
CreateTask201Headers
CreateTask201Response

The request has succeeded and a new resource has been created as a result.

CreateTaskBodyParam
CreateTaskCollection
CreateTaskCollection200Headers
CreateTaskCollection200Response

The request has succeeded.

CreateTaskCollectionBodyParam
CreateTaskCollectionDefaultResponse
CreateTaskCollectionHeaderParam
CreateTaskCollectionHeaders
CreateTaskCollectionMediaTypesParam
CreateTaskCollectionQueryParam
CreateTaskCollectionQueryParamProperties
CreateTaskDefaultResponse
CreateTaskHeaderParam
CreateTaskHeaders
CreateTaskMediaTypesParam
CreateTaskQueryParam
CreateTaskQueryParamProperties
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.

DataDiskOutput

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.

DeallocateNode
DeallocateNode202Headers
DeallocateNode202Response

The request has been accepted for processing, but processing has not yet completed.

DeallocateNodeBodyParam
DeallocateNodeDefaultResponse
DeallocateNodeHeaderParam
DeallocateNodeHeaders
DeallocateNodeMediaTypesParam
DeallocateNodeQueryParam
DeallocateNodeQueryParamProperties
DeleteJob
DeleteJob202Headers
DeleteJob202Response

The request has been accepted for processing, but processing has not yet completed.

DeleteJobDefaultResponse
DeleteJobHeaderParam
DeleteJobHeaders
DeleteJobQueryParam
DeleteJobQueryParamProperties
DeleteJobSchedule202Headers
DeleteJobSchedule202Response

The request has been accepted for processing, but processing has not yet completed.

DeleteJobScheduleDefaultResponse
DeleteJobScheduleHeaderParam
DeleteJobScheduleHeaders
DeleteJobScheduleQueryParam
DeleteJobScheduleQueryParamProperties
DeleteNodeFile
DeleteNodeFile200Headers
DeleteNodeFile200Response

The request has succeeded.

DeleteNodeFileDefaultResponse
DeleteNodeFileHeaderParam
DeleteNodeFileHeaders
DeleteNodeFileQueryParam
DeleteNodeFileQueryParamProperties
DeleteNodeUser
DeleteNodeUser200Headers
DeleteNodeUser200Response

The request has succeeded.

DeleteNodeUserDefaultResponse
DeleteNodeUserHeaderParam
DeleteNodeUserHeaders
DeleteNodeUserQueryParam
DeleteNodeUserQueryParamProperties
DeletePool
DeletePool202Headers
DeletePool202Response

The request has been accepted for processing, but processing has not yet completed.

DeletePoolDefaultResponse
DeletePoolHeaderParam
DeletePoolHeaders
DeletePoolQueryParam
DeletePoolQueryParamProperties
DeleteTask
DeleteTask200Headers
DeleteTask200Response

The request has succeeded.

DeleteTaskDefaultResponse
DeleteTaskFile
DeleteTaskFile200Headers
DeleteTaskFile200Response

The request has succeeded.

DeleteTaskFileDefaultResponse
DeleteTaskFileHeaderParam
DeleteTaskFileHeaders
DeleteTaskFileQueryParam
DeleteTaskFileQueryParamProperties
DeleteTaskHeaderParam
DeleteTaskHeaders
DeleteTaskQueryParam
DeleteTaskQueryParamProperties
DisableJob
DisableJob202Headers
DisableJob202Response

The request has been accepted for processing, but processing has not yet completed.

DisableJobBodyParam
DisableJobDefaultResponse
DisableJobHeaderParam
DisableJobHeaders
DisableJobMediaTypesParam
DisableJobQueryParam
DisableJobQueryParamProperties
DisableJobSchedule
DisableJobSchedule204Headers
DisableJobSchedule204Response

There is no content to send for this request, but the headers may be useful.

DisableJobScheduleDefaultResponse
DisableJobScheduleHeaderParam
DisableJobScheduleHeaders
DisableJobScheduleQueryParam
DisableJobScheduleQueryParamProperties
DisableNodeScheduling
DisableNodeScheduling200Headers
DisableNodeScheduling200Response

The request has succeeded.

DisableNodeSchedulingBodyParam
DisableNodeSchedulingDefaultResponse
DisableNodeSchedulingHeaderParam
DisableNodeSchedulingHeaders
DisableNodeSchedulingMediaTypesParam
DisableNodeSchedulingQueryParam
DisableNodeSchedulingQueryParamProperties
DisablePoolAutoScale
DisablePoolAutoScale200Headers
DisablePoolAutoScale200Response

The request has succeeded.

DisablePoolAutoScaleDefaultResponse
DisablePoolAutoScaleHeaderParam
DisablePoolAutoScaleHeaders
DisablePoolAutoScaleQueryParam
DisablePoolAutoScaleQueryParamProperties
DiskCustomerManagedKey

The Customer Managed Key reference to encrypt the Disk.

DiskCustomerManagedKeyOutput

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 Azure Compute Gallery Image.

DiskEncryptionConfigurationOutput

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

DiskEncryptionSetParameters

The ARM resource id of the disk encryption set.

DiskEncryptionSetParametersOutput

The ARM resource id of the disk encryption set.

EnableJob
EnableJob202Headers
EnableJob202Response

The request has been accepted for processing, but processing has not yet completed.

EnableJobDefaultResponse
EnableJobHeaderParam
EnableJobHeaders
EnableJobQueryParam
EnableJobQueryParamProperties
EnableJobSchedule
EnableJobSchedule204Headers
EnableJobSchedule204Response

There is no content to send for this request, but the headers may be useful.

EnableJobScheduleDefaultResponse
EnableJobScheduleHeaderParam
EnableJobScheduleHeaders
EnableJobScheduleQueryParam
EnableJobScheduleQueryParamProperties
EnableNodeScheduling
EnableNodeScheduling200Headers
EnableNodeScheduling200Response

The request has succeeded.

EnableNodeSchedulingDefaultResponse
EnableNodeSchedulingHeaderParam
EnableNodeSchedulingHeaders
EnableNodeSchedulingQueryParam
EnableNodeSchedulingQueryParamProperties
EnablePoolAutoScale
EnablePoolAutoScale200Headers
EnablePoolAutoScale200Response

The request has succeeded.

EnablePoolAutoScaleBodyParam
EnablePoolAutoScaleDefaultResponse
EnablePoolAutoScaleHeaderParam
EnablePoolAutoScaleHeaders
EnablePoolAutoScaleMediaTypesParam
EnablePoolAutoScaleQueryParam
EnablePoolAutoScaleQueryParamProperties
EnvironmentSetting

An environment variable to be set on a Task process.

EnvironmentSettingOutput

An environment variable to be set on a Task process.

EvaluatePoolAutoScale
EvaluatePoolAutoScale200Headers
EvaluatePoolAutoScale200Response

The request has succeeded.

EvaluatePoolAutoScaleBodyParam
EvaluatePoolAutoScaleDefaultResponse
EvaluatePoolAutoScaleHeaderParam
EvaluatePoolAutoScaleHeaders
EvaluatePoolAutoScaleMediaTypesParam
EvaluatePoolAutoScaleQueryParam
EvaluatePoolAutoScaleQueryParamProperties
ExitCodeMapping

How the Batch service should respond if a Task exits with a particular exit code.

ExitCodeMappingOutput

How the Batch service should respond if a Task exits with a particular exit code.

ExitCodeRangeMapping

A range of exit codes and how the Batch service should respond to exit codes within that range.

ExitCodeRangeMappingOutput

A range of exit codes and how the Batch service should respond to exit codes within that range.

ExitConditions

Specifies how the Batch service should respond when the Task completes.

ExitConditionsOutput

Specifies how the Batch service should respond when the Task completes.

ExitOptions

Specifies how the Batch service responds to a particular exit condition.

ExitOptionsOutput

Specifies how the Batch service responds to a particular exit condition.

FilePropertiesOutput

The properties of a file on a Compute Node.

GetApplication
GetApplication200Headers
GetApplication200Response

The request has succeeded.

GetApplicationDefaultResponse
GetApplicationHeaderParam
GetApplicationHeaders
GetApplicationQueryParam
GetApplicationQueryParamProperties
GetJob200Headers
GetJob200Response

The request has succeeded.

GetJobDefaultResponse
GetJobExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

GetJobHeaderParam
GetJobHeaders
GetJobQueryParam
GetJobQueryParamProperties
GetJobSchedule200Headers
GetJobSchedule200Response

The request has succeeded.

GetJobScheduleDefaultResponse
GetJobScheduleExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

GetJobScheduleHeaderParam
GetJobScheduleHeaders
GetJobScheduleQueryParam
GetJobScheduleQueryParamProperties
GetJobScheduleSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

GetJobSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

GetJobTaskCounts
GetJobTaskCounts200Headers
GetJobTaskCounts200Response

The request has succeeded.

GetJobTaskCountsDefaultResponse
GetJobTaskCountsHeaderParam
GetJobTaskCountsHeaders
GetJobTaskCountsQueryParam
GetJobTaskCountsQueryParamProperties
GetNode
GetNode200Headers
GetNode200Response

The request has succeeded.

GetNodeDefaultResponse
GetNodeExtension
GetNodeExtension200Headers
GetNodeExtension200Response

The request has succeeded.

GetNodeExtensionDefaultResponse
GetNodeExtensionHeaderParam
GetNodeExtensionHeaders
GetNodeExtensionQueryParam
GetNodeExtensionQueryParamProperties
GetNodeExtensionSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

GetNodeFile200Headers
GetNodeFile200Response

The request has succeeded.

GetNodeFileDefaultResponse
GetNodeFileHeaderParam
GetNodeFileHeaders
GetNodeFileProperties200Headers
GetNodeFileProperties200Response

The request has succeeded.

GetNodeFilePropertiesDefaultResponse
GetNodeFilePropertiesHeaderParam
GetNodeFilePropertiesHeaders
GetNodeFilePropertiesQueryParam
GetNodeFilePropertiesQueryParamProperties
GetNodeFileQueryParam
GetNodeFileQueryParamProperties
GetNodeHeaderParam
GetNodeHeaders
GetNodeQueryParam
GetNodeQueryParamProperties
GetNodeRemoteLoginSettings
GetNodeRemoteLoginSettings200Headers
GetNodeRemoteLoginSettings200Response

The request has succeeded.

GetNodeRemoteLoginSettingsDefaultResponse
GetNodeRemoteLoginSettingsHeaderParam
GetNodeRemoteLoginSettingsHeaders
GetNodeRemoteLoginSettingsQueryParam
GetNodeRemoteLoginSettingsQueryParamProperties
GetNodeSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

GetPool200Headers
GetPool200Response

The request has succeeded.

GetPoolDefaultResponse
GetPoolExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

GetPoolHeaderParam
GetPoolHeaders
GetPoolQueryParam
GetPoolQueryParamProperties
GetPoolSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

GetTask200Headers
GetTask200Response

The request has succeeded.

GetTaskDefaultResponse
GetTaskExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

GetTaskFile200Headers
GetTaskFile200Response

The request has succeeded.

GetTaskFileDefaultResponse
GetTaskFileHeaderParam
GetTaskFileHeaders
GetTaskFileProperties200Headers
GetTaskFileProperties200Response

The request has succeeded.

GetTaskFilePropertiesDefaultResponse
GetTaskFilePropertiesHeaderParam
GetTaskFilePropertiesHeaders
GetTaskFilePropertiesQueryParam
GetTaskFilePropertiesQueryParamProperties
GetTaskFileQueryParam
GetTaskFileQueryParamProperties
GetTaskHeaderParam
GetTaskHeaders
GetTaskQueryParam
GetTaskQueryParamProperties
GetTaskSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

HostEndpointSettings

Specifies particular host endpoint settings.

HostEndpointSettingsOutput

Specifies particular host endpoint settings.

IPTag

Contains the IP tag associated with the public IP address.

IPTagOutput

Contains the IP tag associated with the public IP address.

InboundEndpointOutput

An inbound endpoint on a Compute Node.

InstanceViewStatusOutput

The instance view status.

JobScheduleExists
JobScheduleExists200Headers
JobScheduleExists200Response

The request has succeeded.

JobScheduleExists404Response

The server cannot find the requested resource.

JobScheduleExistsDefaultResponse
JobScheduleExistsHeaderParam
JobScheduleExistsHeaders
JobScheduleExistsQueryParam
JobScheduleExistsQueryParamProperties
LinuxUserConfiguration

Properties used to create a user Account on a Linux Compute Node.

LinuxUserConfigurationOutput

Properties used to create a user Account on a Linux Compute Node.

ListApplications
ListApplications200Headers
ListApplications200Response

The request has succeeded.

ListApplicationsDefaultResponse
ListApplicationsHeaderParam
ListApplicationsHeaders
ListApplicationsQueryParam
ListApplicationsQueryParamProperties
ListJobPreparationAndReleaseTaskStatus
ListJobPreparationAndReleaseTaskStatus200Headers
ListJobPreparationAndReleaseTaskStatus200Response

The request has succeeded.

ListJobPreparationAndReleaseTaskStatusDefaultResponse
ListJobPreparationAndReleaseTaskStatusHeaderParam
ListJobPreparationAndReleaseTaskStatusHeaders
ListJobPreparationAndReleaseTaskStatusQueryParam
ListJobPreparationAndReleaseTaskStatusQueryParamProperties
ListJobPreparationAndReleaseTaskStatusSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListJobSchedules200Headers
ListJobSchedules200Response

The request has succeeded.

ListJobSchedulesDefaultResponse
ListJobSchedulesExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

ListJobSchedulesHeaderParam
ListJobSchedulesHeaders
ListJobSchedulesQueryParam
ListJobSchedulesQueryParamProperties
ListJobSchedulesSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListJobs200Headers
ListJobs200Response

The request has succeeded.

ListJobsDefaultResponse
ListJobsExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

ListJobsFromSchedule
ListJobsFromSchedule200Headers
ListJobsFromSchedule200Response

The request has succeeded.

ListJobsFromScheduleDefaultResponse
ListJobsFromScheduleExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

ListJobsFromScheduleHeaderParam
ListJobsFromScheduleHeaders
ListJobsFromScheduleQueryParam
ListJobsFromScheduleQueryParamProperties
ListJobsFromScheduleSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListJobsHeaderParam
ListJobsHeaders
ListJobsQueryParam
ListJobsQueryParamProperties
ListJobsSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListNodeExtensions
ListNodeExtensions200Headers
ListNodeExtensions200Response

The request has succeeded.

ListNodeExtensionsDefaultResponse
ListNodeExtensionsHeaderParam
ListNodeExtensionsHeaders
ListNodeExtensionsQueryParam
ListNodeExtensionsQueryParamProperties
ListNodeExtensionsSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListNodeFiles
ListNodeFiles200Headers
ListNodeFiles200Response

The request has succeeded.

ListNodeFilesDefaultResponse
ListNodeFilesHeaderParam
ListNodeFilesHeaders
ListNodeFilesQueryParam
ListNodeFilesQueryParamProperties
ListNodes
ListNodes200Headers
ListNodes200Response

The request has succeeded.

ListNodesDefaultResponse
ListNodesHeaderParam
ListNodesHeaders
ListNodesQueryParam
ListNodesQueryParamProperties
ListNodesSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListPoolNodeCounts
ListPoolNodeCounts200Headers
ListPoolNodeCounts200Response

The request has succeeded.

ListPoolNodeCountsDefaultResponse
ListPoolNodeCountsHeaderParam
ListPoolNodeCountsHeaders
ListPoolNodeCountsQueryParam
ListPoolNodeCountsQueryParamProperties
ListPoolUsageMetrics
ListPoolUsageMetrics200Headers
ListPoolUsageMetrics200Response

The request has succeeded.

ListPoolUsageMetricsDefaultResponse
ListPoolUsageMetricsHeaderParam
ListPoolUsageMetricsHeaders
ListPoolUsageMetricsQueryParam
ListPoolUsageMetricsQueryParamProperties
ListPools200Headers
ListPools200Response

The request has succeeded.

ListPoolsDefaultResponse
ListPoolsExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

ListPoolsHeaderParam
ListPoolsHeaders
ListPoolsQueryParam
ListPoolsQueryParamProperties
ListPoolsSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListSubTasks
ListSubTasks200Headers
ListSubTasks200Response

The request has succeeded.

ListSubTasksDefaultResponse
ListSubTasksHeaderParam
ListSubTasksHeaders
ListSubTasksQueryParam
ListSubTasksQueryParamProperties
ListSubTasksSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ListSupportedImages
ListSupportedImages200Headers
ListSupportedImages200Response

The request has succeeded.

ListSupportedImagesDefaultResponse
ListSupportedImagesHeaderParam
ListSupportedImagesHeaders
ListSupportedImagesQueryParam
ListSupportedImagesQueryParamProperties
ListTaskFiles
ListTaskFiles200Headers
ListTaskFiles200Response

The request has succeeded.

ListTaskFilesDefaultResponse
ListTaskFilesHeaderParam
ListTaskFilesHeaders
ListTaskFilesQueryParam
ListTaskFilesQueryParamProperties
ListTasks200Headers
ListTasks200Response

The request has succeeded.

ListTasksDefaultResponse
ListTasksExpandQueryParam

This is the wrapper object for the parameter $expand with explode set to false and style set to form.

ListTasksHeaderParam
ListTasksHeaders
ListTasksQueryParam
ListTasksQueryParamProperties
ListTasksSelectQueryParam

This is the wrapper object for the parameter $select with explode set to false and style set to form.

ManagedDisk

The managed disk parameters.

ManagedDiskOutput

The managed disk parameters.

MountConfiguration

The file system to mount on each node.

MountConfigurationOutput

The file system to mount on each node.

MultiInstanceSettings

Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit.

MultiInstanceSettingsOutput

Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit.

NameValuePair

Represents a name-value pair.

NameValuePairOutput

Represents a name-value pair.

NetworkConfiguration

The network configuration for a Pool.

NetworkConfigurationOutput

The network configuration for a Pool.

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleOutput

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

NfsMountConfiguration

Information used to connect to an NFS file system.

NfsMountConfigurationOutput

Information used to connect to an NFS file system.

OutputFile

On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure.

OutputFileBlobContainerDestination

Specifies a file upload destination within an Azure blob storage container.

OutputFileBlobContainerDestinationOutput

Specifies a file upload destination within an Azure blob storage container.

OutputFileDestination

The destination to which a file should be uploaded.

OutputFileDestinationOutput

The destination to which a file should be uploaded.

OutputFileOutput

On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure.

OutputFileUploadConfig

Options for an output file upload operation, including under what conditions to perform the upload.

OutputFileUploadConfigOutput

Options for an output file upload operation, including under what conditions to perform the upload.

OutputFileUploadHeader

An HTTP header name-value pair

OutputFileUploadHeaderOutput

An HTTP header name-value pair

PageSettings

An interface that tracks the settings for paged iteration

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PagingOptions

Options for the paging helper

PoolExists200Headers
PoolExists200Response

The request has succeeded.

PoolExists404Response

The server cannot find the requested resource.

PoolExistsDefaultResponse
PoolExistsHeaderParam
PoolExistsHeaders
PoolExistsQueryParam
PoolExistsQueryParamProperties
ProxyAgentSettings

Specifies ProxyAgent settings while creating the virtual machine.

ProxyAgentSettingsOutput

Specifies ProxyAgent settings while creating the virtual machine.

ReactivateTask
ReactivateTask204Headers
ReactivateTask204Response

There is no content to send for this request, but the headers may be useful.

ReactivateTaskDefaultResponse
ReactivateTaskHeaderParam
ReactivateTaskHeaders
ReactivateTaskQueryParam
ReactivateTaskQueryParamProperties
RebootNode
RebootNode202Headers
RebootNode202Response

The request has been accepted for processing, but processing has not yet completed.

RebootNodeBodyParam
RebootNodeDefaultResponse
RebootNodeHeaderParam
RebootNodeHeaders
RebootNodeMediaTypesParam
RebootNodeQueryParam
RebootNodeQueryParamProperties
RecentBatchJob

Information about the most recent Job to run under the Job Schedule.

RecentBatchJobOutput

Information about the most recent Job to run under the Job Schedule.

ReimageNode
ReimageNode202Headers
ReimageNode202Response

The request has been accepted for processing, but processing has not yet completed.

ReimageNodeBodyParam
ReimageNodeDefaultResponse
ReimageNodeHeaderParam
ReimageNodeHeaders
ReimageNodeMediaTypesParam
ReimageNodeQueryParam
ReimageNodeQueryParamProperties
RemoveNodes
RemoveNodes202Headers
RemoveNodes202Response

The request has been accepted for processing, but processing has not yet completed.

RemoveNodesBodyParam
RemoveNodesDefaultResponse
RemoveNodesHeaderParam
RemoveNodesHeaders
RemoveNodesMediaTypesParam
RemoveNodesQueryParam
RemoveNodesQueryParamProperties
ReplaceJob200Headers
ReplaceJob200Response

The request has succeeded.

ReplaceJobBodyParam
ReplaceJobDefaultResponse
ReplaceJobHeaderParam
ReplaceJobHeaders
ReplaceJobMediaTypesParam
ReplaceJobQueryParam
ReplaceJobQueryParamProperties
ReplaceJobSchedule200Headers
ReplaceJobSchedule200Response

The request has succeeded.

ReplaceJobScheduleBodyParam
ReplaceJobScheduleDefaultResponse
ReplaceJobScheduleHeaderParam
ReplaceJobScheduleHeaders
ReplaceJobScheduleMediaTypesParam
ReplaceJobScheduleQueryParam
ReplaceJobScheduleQueryParamProperties
ReplaceNodeUser200Headers
ReplaceNodeUser200Response

The request has succeeded.

ReplaceNodeUserBodyParam
ReplaceNodeUserDefaultResponse
ReplaceNodeUserHeaderParam
ReplaceNodeUserHeaders
ReplaceNodeUserMediaTypesParam
ReplaceNodeUserQueryParam
ReplaceNodeUserQueryParamProperties
ReplacePoolProperties
ReplacePoolProperties204Headers
ReplacePoolProperties204Response

There is no content to send for this request, but the headers may be useful.

ReplacePoolPropertiesBodyParam
ReplacePoolPropertiesDefaultResponse
ReplacePoolPropertiesHeaderParam
ReplacePoolPropertiesHeaders
ReplacePoolPropertiesMediaTypesParam
ReplacePoolPropertiesQueryParam
ReplacePoolPropertiesQueryParamProperties
ReplaceTask200Headers
ReplaceTask200Response

The request has succeeded.

ReplaceTaskBodyParam
ReplaceTaskDefaultResponse
ReplaceTaskHeaderParam
ReplaceTaskHeaders
ReplaceTaskMediaTypesParam
ReplaceTaskQueryParam
ReplaceTaskQueryParamProperties
ResizeErrorOutput

An error that occurred when resizing a Pool.

ResizePool
ResizePool202Headers
ResizePool202Response

The request has been accepted for processing, but processing has not yet completed.

ResizePoolBodyParam
ResizePoolDefaultResponse
ResizePoolHeaderParam
ResizePoolHeaders
ResizePoolMediaTypesParam
ResizePoolQueryParam
ResizePoolQueryParamProperties
ResourceFile

A single file or multiple files to be downloaded to a Compute Node.

ResourceFileOutput

A single file or multiple files to be downloaded to a Compute Node.

RollingUpgradePolicy

The configuration parameters used while performing a rolling upgrade.

RollingUpgradePolicyOutput

The configuration parameters used while performing a rolling upgrade.

Routes
SecurityProfile

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

SecurityProfileOutput

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.

ServiceArtifactReferenceOutput

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.

StartNode
StartNode202Headers
StartNode202Response

The request has been accepted for processing, but processing has not yet completed.

StartNodeDefaultResponse
StartNodeHeaderParam
StartNodeHeaders
StartNodeQueryParam
StartNodeQueryParamProperties
StopPoolResize
StopPoolResize202Headers
StopPoolResize202Response

The request has been accepted for processing, but processing has not yet completed.

StopPoolResizeDefaultResponse
StopPoolResizeHeaderParam
StopPoolResizeHeaders
StopPoolResizeQueryParam
StopPoolResizeQueryParamProperties
TerminateJob
TerminateJob202Headers
TerminateJob202Response

The request has been accepted for processing, but processing has not yet completed.

TerminateJobBodyParam
TerminateJobDefaultResponse
TerminateJobHeaderParam
TerminateJobHeaders
TerminateJobMediaTypesParam
TerminateJobQueryParam
TerminateJobQueryParamProperties
TerminateJobSchedule
TerminateJobSchedule202Headers
TerminateJobSchedule202Response

The request has been accepted for processing, but processing has not yet completed.

TerminateJobScheduleDefaultResponse
TerminateJobScheduleHeaderParam
TerminateJobScheduleHeaders
TerminateJobScheduleQueryParam
TerminateJobScheduleQueryParamProperties
TerminateTask
TerminateTask204Headers
TerminateTask204Response

There is no content to send for this request, but the headers may be useful.

TerminateTaskDefaultResponse
TerminateTaskHeaderParam
TerminateTaskHeaders
TerminateTaskQueryParam
TerminateTaskQueryParamProperties
UpdateJob200Headers
UpdateJob200Response

The request has succeeded.

UpdateJobBodyParam
UpdateJobDefaultResponse
UpdateJobHeaderParam
UpdateJobHeaders
UpdateJobMediaTypesParam
UpdateJobQueryParam
UpdateJobQueryParamProperties
UpdateJobSchedule200Headers
UpdateJobSchedule200Response

The request has succeeded.

UpdateJobScheduleBodyParam
UpdateJobScheduleDefaultResponse
UpdateJobScheduleHeaderParam
UpdateJobScheduleHeaders
UpdateJobScheduleMediaTypesParam
UpdateJobScheduleQueryParam
UpdateJobScheduleQueryParamProperties
UpdatePool200Headers
UpdatePool200Response

The request has succeeded.

UpdatePoolBodyParam
UpdatePoolDefaultResponse
UpdatePoolHeaderParam
UpdatePoolHeaders
UpdatePoolMediaTypesParam
UpdatePoolQueryParam
UpdatePoolQueryParamProperties
UpgradePolicy

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

UpgradePolicyOutput

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

UploadBatchServiceLogsOptions

The Azure Batch service log files upload parameters for a Compute Node.

UploadBatchServiceLogsResultOutput

The result of uploading Batch service log files from a specific Compute Node.

UploadNodeLogs
UploadNodeLogs200Headers
UploadNodeLogs200Response

The request has succeeded.

UploadNodeLogsBodyParam
UploadNodeLogsDefaultResponse
UploadNodeLogsHeaderParam
UploadNodeLogsHeaders
UploadNodeLogsMediaTypesParam
UploadNodeLogsQueryParam
UploadNodeLogsQueryParamProperties
UserAccount

Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.

UserAccountOutput

Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.

UserIdentity

The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both.

UserIdentityOutput

The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both.

VMExtension

The configuration for virtual machine extensions.

VMExtensionInstanceViewOutput

The vm extension instance view.

VMExtensionOutput

The configuration for virtual machine extensions.

VirtualMachineConfiguration

The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.

VirtualMachineConfigurationOutput

The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.

VirtualMachineInfoOutput

Info about the current state of the virtual machine.

WindowsConfiguration

Windows operating system settings to apply to the virtual machine.

WindowsConfigurationOutput

Windows operating system settings to apply to the virtual machine.

WindowsUserConfiguration

Properties used to create a user Account on a Windows Compute Node.

WindowsUserConfigurationOutput

Properties used to create a user Account on a Windows Compute Node.

Type Aliases

AllocationStateOutput

Alias for AllocationStateOutput

AutoUserScope

Alias for AutoUserScope

AutoUserScopeOutput

Alias for AutoUserScopeOutput

BatchAccessScope

Alias for BatchAccessScope

BatchAccessScopeOutput

Alias for BatchAccessScopeOutput

BatchAllTasksCompleteMode

Alias for BatchAllTasksCompleteMode

BatchAllTasksCompleteModeOutput

Alias for BatchAllTasksCompleteModeOutput

BatchClient
BatchErrorSourceCategory

Alias for BatchErrorSourceCategory

BatchErrorSourceCategoryOutput

Alias for BatchErrorSourceCategoryOutput

BatchJobActionKind

Alias for BatchJobActionKind

BatchJobActionKindOutput

Alias for BatchJobActionKindOutput

BatchJobDefaultOrder

Alias for BatchJobDefaultOrder

BatchJobDefaultOrderOutput

Alias for BatchJobDefaultOrderOutput

BatchJobPreparationTaskStateOutput

Alias for BatchJobPreparationTaskStateOutput

BatchJobReleaseTaskStateOutput

Alias for BatchJobReleaseTaskStateOutput

BatchJobScheduleState

Alias for BatchJobScheduleState

BatchJobScheduleStateOutput

Alias for BatchJobScheduleStateOutput

BatchJobState

Alias for BatchJobState

BatchJobStateOutput

Alias for BatchJobStateOutput

BatchNodeDeallocateOption

Alias for BatchNodeDeallocateOption

BatchNodeDeallocationOption

Alias for BatchNodeDeallocationOption

BatchNodeDisableSchedulingOption

Alias for BatchNodeDisableSchedulingOption

BatchNodeFillType

Alias for BatchNodeFillType

BatchNodeFillTypeOutput

Alias for BatchNodeFillTypeOutput

BatchNodePlacementPolicyType

Alias for BatchNodePlacementPolicyType

BatchNodePlacementPolicyTypeOutput

Alias for BatchNodePlacementPolicyTypeOutput

BatchNodeRebootKind

Alias for BatchNodeRebootKind

BatchNodeReimageOption

Alias for BatchNodeReimageOption

BatchNodeStateOutput

Alias for BatchNodeStateOutput

BatchPoolIdentityTypeOutput

Alias for BatchPoolIdentityTypeOutput

BatchPoolLifetimeOption

Alias for BatchPoolLifetimeOption

BatchPoolLifetimeOptionOutput

Alias for BatchPoolLifetimeOptionOutput

BatchPoolStateOutput

Alias for BatchPoolStateOutput

BatchStartTaskStateOutput

Alias for BatchStartTaskStateOutput

BatchSubtaskStateOutput

Alias for BatchSubtaskStateOutput

BatchTaskAddStatusOutput

Alias for BatchTaskAddStatusOutput

BatchTaskExecutionResult

Alias for BatchTaskExecutionResult

BatchTaskExecutionResultOutput

Alias for BatchTaskExecutionResultOutput

BatchTaskFailureMode

Alias for BatchTaskFailureMode

BatchTaskFailureModeOutput

Alias for BatchTaskFailureModeOutput

BatchTaskState

Alias for BatchTaskState

BatchTaskStateOutput

Alias for BatchTaskStateOutput

CachingType

Alias for CachingType

CachingTypeOutput

Alias for CachingTypeOutput

ContainerHostDataPath

Alias for ContainerHostDataPath

ContainerHostDataPathOutput

Alias for ContainerHostDataPathOutput

ContainerType

Alias for ContainerType

ContainerTypeOutput

Alias for ContainerTypeOutput

ContainerWorkingDirectory

Alias for ContainerWorkingDirectory

ContainerWorkingDirectoryOutput

Alias for ContainerWorkingDirectoryOutput

CreateJobParameters
CreateJobScheduleParameters
CreateNodeUserParameters
CreatePoolParameters
CreateTaskCollectionParameters
CreateTaskParameters
DeallocateNodeParameters
DeleteJobParameters
DeleteJobScheduleParameters
DeleteNodeFileParameters
DeleteNodeUserParameters
DeletePoolParameters
DeleteTaskFileParameters
DeleteTaskParameters
DependencyAction

Alias for DependencyAction

DependencyActionOutput

Alias for DependencyActionOutput

DiffDiskPlacement

Alias for DiffDiskPlacement

DiffDiskPlacementOutput

Alias for DiffDiskPlacementOutput

DisableBatchJobOption

Alias for DisableBatchJobOption

DisableJobParameters
DisableJobScheduleParameters
DisableNodeSchedulingParameters
DisablePoolAutoScaleParameters
DiskEncryptionTarget

Alias for DiskEncryptionTarget

DiskEncryptionTargetOutput

Alias for DiskEncryptionTargetOutput

DynamicVNetAssignmentScope

Alias for DynamicVNetAssignmentScope

DynamicVNetAssignmentScopeOutput

Alias for DynamicVNetAssignmentScopeOutput

ElevationLevel

Alias for ElevationLevel

ElevationLevelOutput

Alias for ElevationLevelOutput

EnableJobParameters
EnableJobScheduleParameters
EnableNodeSchedulingParameters
EnablePoolAutoScaleParameters
EvaluatePoolAutoScaleParameters
GetApplicationParameters
GetArrayType

Helper type to extract the type of an array

GetJobParameters
GetJobScheduleParameters
GetJobTaskCountsParameters
GetNodeExtensionParameters
GetNodeFileParameters
GetNodeFilePropertiesParameters
GetNodeParameters
GetNodeRemoteLoginSettingsParameters
GetPage

The type of a custom function that defines how to get a page and a link to the next one if any.

GetPoolParameters
GetTaskFileParameters
GetTaskFilePropertiesParameters
GetTaskParameters
HostEndpointSettingsModeTypes

Alias for HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypesOutput

Alias for HostEndpointSettingsModeTypesOutput

IPFamily

Alias for IPFamily

IPFamilyOutput

Alias for IPFamilyOutput

ImageVerificationTypeOutput

Alias for ImageVerificationTypeOutput

InboundEndpointProtocol

Alias for InboundEndpointProtocol

InboundEndpointProtocolOutput

Alias for InboundEndpointProtocolOutput

IpAddressProvisioningType

Alias for IpAddressProvisioningType

IpAddressProvisioningTypeOutput

Alias for IpAddressProvisioningTypeOutput

JobScheduleExistsParameters
ListApplicationsParameters
ListJobPreparationAndReleaseTaskStatusParameters
ListJobSchedulesParameters
ListJobsFromScheduleParameters
ListJobsParameters
ListNodeExtensionsParameters
ListNodeFilesParameters
ListNodesParameters
ListPoolNodeCountsParameters
ListPoolUsageMetricsParameters
ListPoolsParameters
ListSubTasksParameters
ListSupportedImagesParameters
ListTaskFilesParameters
ListTasksParameters
LoginMode

Alias for LoginMode

LoginModeOutput

Alias for LoginModeOutput

NetworkSecurityGroupRuleAccess

Alias for NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccessOutput

Alias for NetworkSecurityGroupRuleAccessOutput

OSTypeOutput

Alias for OSTypeOutput

OutputFileUploadCondition

Alias for OutputFileUploadCondition

OutputFileUploadConditionOutput

Alias for OutputFileUploadConditionOutput

PaginateReturn

Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter

PoolExistsParameters
ReactivateTaskParameters
RebootNodeParameters
ReimageNodeParameters
RemoveNodesParameters
ReplaceJobParameters
ReplaceJobScheduleParameters
ReplaceNodeUserParameters
ReplacePoolPropertiesParameters
ReplaceTaskParameters
ResizePoolParameters
SchedulingStateOutput

Alias for SchedulingStateOutput

SecurityEncryptionTypes

Alias for SecurityEncryptionTypes

SecurityEncryptionTypesOutput

Alias for SecurityEncryptionTypesOutput

SecurityTypes

Alias for SecurityTypes

SecurityTypesOutput

Alias for SecurityTypesOutput

StartNodeParameters
StatusLevelTypesOutput

Alias for StatusLevelTypesOutput

StopPoolResizeParameters
StorageAccountType

Alias for StorageAccountType

StorageAccountTypeOutput

Alias for StorageAccountTypeOutput

TerminateJobParameters
TerminateJobScheduleParameters
TerminateTaskParameters
UpdateJobParameters
UpdateJobScheduleParameters
UpdatePoolParameters
UpgradeMode

Alias for UpgradeMode

UpgradeModeOutput

Alias for UpgradeModeOutput

UploadNodeLogsParameters

Functions

default(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptions)

Initialize a new instance of BatchClient

isUnexpected(ListApplications200Response | ListApplicationsDefaultResponse)
isUnexpected(GetApplication200Response | GetApplicationDefaultResponse)
isUnexpected(ListPoolUsageMetrics200Response | ListPoolUsageMetricsDefaultResponse)
isUnexpected(CreatePool201Response | CreatePoolDefaultResponse)
isUnexpected(ListPools200Response | ListPoolsDefaultResponse)
isUnexpected(DeletePool202Response | DeletePoolDefaultResponse)
isUnexpected(PoolExists200Response | PoolExists404Response | PoolExistsDefaultResponse)
isUnexpected(GetPool200Response | GetPoolDefaultResponse)
isUnexpected(UpdatePool200Response | UpdatePoolDefaultResponse)
isUnexpected(DisablePoolAutoScale200Response | DisablePoolAutoScaleDefaultResponse)
isUnexpected(EnablePoolAutoScale200Response | EnablePoolAutoScaleDefaultResponse)
isUnexpected(EvaluatePoolAutoScale200Response | EvaluatePoolAutoScaleDefaultResponse)
isUnexpected(ResizePool202Response | ResizePoolDefaultResponse)
isUnexpected(StopPoolResize202Response | StopPoolResizeDefaultResponse)
isUnexpected(ReplacePoolProperties204Response | ReplacePoolPropertiesDefaultResponse)
isUnexpected(RemoveNodes202Response | RemoveNodesDefaultResponse)
isUnexpected(ListSupportedImages200Response | ListSupportedImagesDefaultResponse)
isUnexpected(ListPoolNodeCounts200Response | ListPoolNodeCountsDefaultResponse)
isUnexpected(DeleteJob202Response | DeleteJobDefaultResponse)
isUnexpected(GetJob200Response | GetJobDefaultResponse)
isUnexpected(UpdateJob200Response | UpdateJobDefaultResponse)
isUnexpected(ReplaceJob200Response | ReplaceJobDefaultResponse)
isUnexpected(DisableJob202Response | DisableJobDefaultResponse)
isUnexpected(EnableJob202Response | EnableJobDefaultResponse)
isUnexpected(TerminateJob202Response | TerminateJobDefaultResponse)
isUnexpected(CreateJob201Response | CreateJobDefaultResponse)
isUnexpected(ListJobs200Response | ListJobsDefaultResponse)
isUnexpected(ListJobsFromSchedule200Response | ListJobsFromScheduleDefaultResponse)
isUnexpected(ListJobPreparationAndReleaseTaskStatus200Response | ListJobPreparationAndReleaseTaskStatusDefaultResponse)
isUnexpected(GetJobTaskCounts200Response | GetJobTaskCountsDefaultResponse)
isUnexpected(JobScheduleExists200Response | JobScheduleExists404Response | JobScheduleExistsDefaultResponse)
isUnexpected(DeleteJobSchedule202Response | DeleteJobScheduleDefaultResponse)
isUnexpected(GetJobSchedule200Response | GetJobScheduleDefaultResponse)
isUnexpected(UpdateJobSchedule200Response | UpdateJobScheduleDefaultResponse)
isUnexpected(ReplaceJobSchedule200Response | ReplaceJobScheduleDefaultResponse)
isUnexpected(DisableJobSchedule204Response | DisableJobScheduleDefaultResponse)
isUnexpected(EnableJobSchedule204Response | EnableJobScheduleDefaultResponse)
isUnexpected(TerminateJobSchedule202Response | TerminateJobScheduleDefaultResponse)
isUnexpected(CreateJobSchedule201Response | CreateJobScheduleDefaultResponse)
isUnexpected(ListJobSchedules200Response | ListJobSchedulesDefaultResponse)
isUnexpected(CreateTask201Response | CreateTaskDefaultResponse)
isUnexpected(ListTasks200Response | ListTasksDefaultResponse)
isUnexpected(CreateTaskCollection200Response | CreateTaskCollectionDefaultResponse)
isUnexpected(DeleteTask200Response | DeleteTaskDefaultResponse)
isUnexpected(GetTask200Response | GetTaskDefaultResponse)
isUnexpected(ReplaceTask200Response | ReplaceTaskDefaultResponse)
isUnexpected(ListSubTasks200Response | ListSubTasksDefaultResponse)
isUnexpected(TerminateTask204Response | TerminateTaskDefaultResponse)
isUnexpected(ReactivateTask204Response | ReactivateTaskDefaultResponse)
isUnexpected(DeleteTaskFile200Response | DeleteTaskFileDefaultResponse)
isUnexpected(GetTaskFile200Response | GetTaskFileDefaultResponse)
isUnexpected(GetTaskFileProperties200Response | GetTaskFilePropertiesDefaultResponse)
isUnexpected(ListTaskFiles200Response | ListTaskFilesDefaultResponse)
isUnexpected(CreateNodeUser201Response | CreateNodeUserDefaultResponse)
isUnexpected(DeleteNodeUser200Response | DeleteNodeUserDefaultResponse)
isUnexpected(ReplaceNodeUser200Response | ReplaceNodeUserDefaultResponse)
isUnexpected(GetNode200Response | GetNodeDefaultResponse)
isUnexpected(RebootNode202Response | RebootNodeDefaultResponse)
isUnexpected(StartNode202Response | StartNodeDefaultResponse)
isUnexpected(DeallocateNode202Response | DeallocateNodeDefaultResponse)
isUnexpected(ReimageNode202Response | ReimageNodeDefaultResponse)
isUnexpected(DisableNodeScheduling200Response | DisableNodeSchedulingDefaultResponse)
isUnexpected(EnableNodeScheduling200Response | EnableNodeSchedulingDefaultResponse)
isUnexpected(GetNodeRemoteLoginSettings200Response | GetNodeRemoteLoginSettingsDefaultResponse)
isUnexpected(UploadNodeLogs200Response | UploadNodeLogsDefaultResponse)
isUnexpected(ListNodes200Response | ListNodesDefaultResponse)
isUnexpected(GetNodeExtension200Response | GetNodeExtensionDefaultResponse)
isUnexpected(ListNodeExtensions200Response | ListNodeExtensionsDefaultResponse)
isUnexpected(DeleteNodeFile200Response | DeleteNodeFileDefaultResponse)
isUnexpected(GetNodeFile200Response | GetNodeFileDefaultResponse)
isUnexpected(GetNodeFileProperties200Response | GetNodeFilePropertiesDefaultResponse)
isUnexpected(ListNodeFiles200Response | ListNodeFilesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptions)

Initialize a new instance of BatchClient

function default(endpointParam: string, credentials: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptions): BatchClient

Parameters

endpointParam

string

Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).

credentials

TokenCredential | AzureNamedKeyCredential

uniquely identify client credential

options
BatchClientOptions

the parameter for all optional parameters

Returns

isUnexpected(ListApplications200Response | ListApplicationsDefaultResponse)

function isUnexpected(response: ListApplications200Response | ListApplicationsDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetApplication200Response | GetApplicationDefaultResponse)

function isUnexpected(response: GetApplication200Response | GetApplicationDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListPoolUsageMetrics200Response | ListPoolUsageMetricsDefaultResponse)

function isUnexpected(response: ListPoolUsageMetrics200Response | ListPoolUsageMetricsDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreatePool201Response | CreatePoolDefaultResponse)

function isUnexpected(response: CreatePool201Response | CreatePoolDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListPools200Response | ListPoolsDefaultResponse)

function isUnexpected(response: ListPools200Response | ListPoolsDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeletePool202Response | DeletePoolDefaultResponse)

function isUnexpected(response: DeletePool202Response | DeletePoolDefaultResponse): response

Parameters

Returns

response

isUnexpected(PoolExists200Response | PoolExists404Response | PoolExistsDefaultResponse)

function isUnexpected(response: PoolExists200Response | PoolExists404Response | PoolExistsDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetPool200Response | GetPoolDefaultResponse)

function isUnexpected(response: GetPool200Response | GetPoolDefaultResponse): response

Parameters

Returns

response

isUnexpected(UpdatePool200Response | UpdatePoolDefaultResponse)

function isUnexpected(response: UpdatePool200Response | UpdatePoolDefaultResponse): response

Parameters

Returns

response

isUnexpected(DisablePoolAutoScale200Response | DisablePoolAutoScaleDefaultResponse)

function isUnexpected(response: DisablePoolAutoScale200Response | DisablePoolAutoScaleDefaultResponse): response

Parameters

Returns

response

isUnexpected(EnablePoolAutoScale200Response | EnablePoolAutoScaleDefaultResponse)

function isUnexpected(response: EnablePoolAutoScale200Response | EnablePoolAutoScaleDefaultResponse): response

Parameters

Returns

response

isUnexpected(EvaluatePoolAutoScale200Response | EvaluatePoolAutoScaleDefaultResponse)

function isUnexpected(response: EvaluatePoolAutoScale200Response | EvaluatePoolAutoScaleDefaultResponse): response

Parameters

Returns

response

isUnexpected(ResizePool202Response | ResizePoolDefaultResponse)

function isUnexpected(response: ResizePool202Response | ResizePoolDefaultResponse): response

Parameters

Returns

response

isUnexpected(StopPoolResize202Response | StopPoolResizeDefaultResponse)

function isUnexpected(response: StopPoolResize202Response | StopPoolResizeDefaultResponse): response

Parameters

Returns

response

isUnexpected(ReplacePoolProperties204Response | ReplacePoolPropertiesDefaultResponse)

function isUnexpected(response: ReplacePoolProperties204Response | ReplacePoolPropertiesDefaultResponse): response

Parameters

Returns

response

isUnexpected(RemoveNodes202Response | RemoveNodesDefaultResponse)

function isUnexpected(response: RemoveNodes202Response | RemoveNodesDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListSupportedImages200Response | ListSupportedImagesDefaultResponse)

function isUnexpected(response: ListSupportedImages200Response | ListSupportedImagesDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListPoolNodeCounts200Response | ListPoolNodeCountsDefaultResponse)

function isUnexpected(response: ListPoolNodeCounts200Response | ListPoolNodeCountsDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteJob202Response | DeleteJobDefaultResponse)

function isUnexpected(response: DeleteJob202Response | DeleteJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetJob200Response | GetJobDefaultResponse)

function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(UpdateJob200Response | UpdateJobDefaultResponse)

function isUnexpected(response: UpdateJob200Response | UpdateJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(ReplaceJob200Response | ReplaceJobDefaultResponse)

function isUnexpected(response: ReplaceJob200Response | ReplaceJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(DisableJob202Response | DisableJobDefaultResponse)

function isUnexpected(response: DisableJob202Response | DisableJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(EnableJob202Response | EnableJobDefaultResponse)

function isUnexpected(response: EnableJob202Response | EnableJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(TerminateJob202Response | TerminateJobDefaultResponse)

function isUnexpected(response: TerminateJob202Response | TerminateJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateJob201Response | CreateJobDefaultResponse)

function isUnexpected(response: CreateJob201Response | CreateJobDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListJobs200Response | ListJobsDefaultResponse)

function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListJobsFromSchedule200Response | ListJobsFromScheduleDefaultResponse)

function isUnexpected(response: ListJobsFromSchedule200Response | ListJobsFromScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListJobPreparationAndReleaseTaskStatus200Response | ListJobPreparationAndReleaseTaskStatusDefaultResponse)

function isUnexpected(response: ListJobPreparationAndReleaseTaskStatus200Response | ListJobPreparationAndReleaseTaskStatusDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetJobTaskCounts200Response | GetJobTaskCountsDefaultResponse)

function isUnexpected(response: GetJobTaskCounts200Response | GetJobTaskCountsDefaultResponse): response

Parameters

Returns

response

isUnexpected(JobScheduleExists200Response | JobScheduleExists404Response | JobScheduleExistsDefaultResponse)

function isUnexpected(response: JobScheduleExists200Response | JobScheduleExists404Response | JobScheduleExistsDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteJobSchedule202Response | DeleteJobScheduleDefaultResponse)

function isUnexpected(response: DeleteJobSchedule202Response | DeleteJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetJobSchedule200Response | GetJobScheduleDefaultResponse)

function isUnexpected(response: GetJobSchedule200Response | GetJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(UpdateJobSchedule200Response | UpdateJobScheduleDefaultResponse)

function isUnexpected(response: UpdateJobSchedule200Response | UpdateJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(ReplaceJobSchedule200Response | ReplaceJobScheduleDefaultResponse)

function isUnexpected(response: ReplaceJobSchedule200Response | ReplaceJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(DisableJobSchedule204Response | DisableJobScheduleDefaultResponse)

function isUnexpected(response: DisableJobSchedule204Response | DisableJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(EnableJobSchedule204Response | EnableJobScheduleDefaultResponse)

function isUnexpected(response: EnableJobSchedule204Response | EnableJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(TerminateJobSchedule202Response | TerminateJobScheduleDefaultResponse)

function isUnexpected(response: TerminateJobSchedule202Response | TerminateJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateJobSchedule201Response | CreateJobScheduleDefaultResponse)

function isUnexpected(response: CreateJobSchedule201Response | CreateJobScheduleDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListJobSchedules200Response | ListJobSchedulesDefaultResponse)

function isUnexpected(response: ListJobSchedules200Response | ListJobSchedulesDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateTask201Response | CreateTaskDefaultResponse)

function isUnexpected(response: CreateTask201Response | CreateTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListTasks200Response | ListTasksDefaultResponse)

function isUnexpected(response: ListTasks200Response | ListTasksDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateTaskCollection200Response | CreateTaskCollectionDefaultResponse)

function isUnexpected(response: CreateTaskCollection200Response | CreateTaskCollectionDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteTask200Response | DeleteTaskDefaultResponse)

function isUnexpected(response: DeleteTask200Response | DeleteTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetTask200Response | GetTaskDefaultResponse)

function isUnexpected(response: GetTask200Response | GetTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(ReplaceTask200Response | ReplaceTaskDefaultResponse)

function isUnexpected(response: ReplaceTask200Response | ReplaceTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListSubTasks200Response | ListSubTasksDefaultResponse)

function isUnexpected(response: ListSubTasks200Response | ListSubTasksDefaultResponse): response

Parameters

Returns

response

isUnexpected(TerminateTask204Response | TerminateTaskDefaultResponse)

function isUnexpected(response: TerminateTask204Response | TerminateTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(ReactivateTask204Response | ReactivateTaskDefaultResponse)

function isUnexpected(response: ReactivateTask204Response | ReactivateTaskDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteTaskFile200Response | DeleteTaskFileDefaultResponse)

function isUnexpected(response: DeleteTaskFile200Response | DeleteTaskFileDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetTaskFile200Response | GetTaskFileDefaultResponse)

function isUnexpected(response: GetTaskFile200Response | GetTaskFileDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetTaskFileProperties200Response | GetTaskFilePropertiesDefaultResponse)

function isUnexpected(response: GetTaskFileProperties200Response | GetTaskFilePropertiesDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListTaskFiles200Response | ListTaskFilesDefaultResponse)

function isUnexpected(response: ListTaskFiles200Response | ListTaskFilesDefaultResponse): response

Parameters

Returns

response

isUnexpected(CreateNodeUser201Response | CreateNodeUserDefaultResponse)

function isUnexpected(response: CreateNodeUser201Response | CreateNodeUserDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteNodeUser200Response | DeleteNodeUserDefaultResponse)

function isUnexpected(response: DeleteNodeUser200Response | DeleteNodeUserDefaultResponse): response

Parameters

Returns

response

isUnexpected(ReplaceNodeUser200Response | ReplaceNodeUserDefaultResponse)

function isUnexpected(response: ReplaceNodeUser200Response | ReplaceNodeUserDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetNode200Response | GetNodeDefaultResponse)

function isUnexpected(response: GetNode200Response | GetNodeDefaultResponse): response

Parameters

Returns

response

isUnexpected(RebootNode202Response | RebootNodeDefaultResponse)

function isUnexpected(response: RebootNode202Response | RebootNodeDefaultResponse): response

Parameters

Returns

response

isUnexpected(StartNode202Response | StartNodeDefaultResponse)

function isUnexpected(response: StartNode202Response | StartNodeDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeallocateNode202Response | DeallocateNodeDefaultResponse)

function isUnexpected(response: DeallocateNode202Response | DeallocateNodeDefaultResponse): response

Parameters

Returns

response

isUnexpected(ReimageNode202Response | ReimageNodeDefaultResponse)

function isUnexpected(response: ReimageNode202Response | ReimageNodeDefaultResponse): response

Parameters

Returns

response

isUnexpected(DisableNodeScheduling200Response | DisableNodeSchedulingDefaultResponse)

function isUnexpected(response: DisableNodeScheduling200Response | DisableNodeSchedulingDefaultResponse): response

Parameters

Returns

response

isUnexpected(EnableNodeScheduling200Response | EnableNodeSchedulingDefaultResponse)

function isUnexpected(response: EnableNodeScheduling200Response | EnableNodeSchedulingDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetNodeRemoteLoginSettings200Response | GetNodeRemoteLoginSettingsDefaultResponse)

function isUnexpected(response: GetNodeRemoteLoginSettings200Response | GetNodeRemoteLoginSettingsDefaultResponse): response

Parameters

Returns

response

isUnexpected(UploadNodeLogs200Response | UploadNodeLogsDefaultResponse)

function isUnexpected(response: UploadNodeLogs200Response | UploadNodeLogsDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListNodes200Response | ListNodesDefaultResponse)

function isUnexpected(response: ListNodes200Response | ListNodesDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetNodeExtension200Response | GetNodeExtensionDefaultResponse)

function isUnexpected(response: GetNodeExtension200Response | GetNodeExtensionDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListNodeExtensions200Response | ListNodeExtensionsDefaultResponse)

function isUnexpected(response: ListNodeExtensions200Response | ListNodeExtensionsDefaultResponse): response

Parameters

Returns

response

isUnexpected(DeleteNodeFile200Response | DeleteNodeFileDefaultResponse)

function isUnexpected(response: DeleteNodeFile200Response | DeleteNodeFileDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetNodeFile200Response | GetNodeFileDefaultResponse)

function isUnexpected(response: GetNodeFile200Response | GetNodeFileDefaultResponse): response

Parameters

Returns

response

isUnexpected(GetNodeFileProperties200Response | GetNodeFilePropertiesDefaultResponse)

function isUnexpected(response: GetNodeFileProperties200Response | GetNodeFilePropertiesDefaultResponse): response

Parameters

Returns

response

isUnexpected(ListNodeFiles200Response | ListNodeFilesDefaultResponse)

function isUnexpected(response: ListNodeFiles200Response | ListNodeFilesDefaultResponse): response

Parameters

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client
Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

  • PagedAsyncIterableIterator to iterate the elements