Package com.azure.compute.batch

Class BatchAsyncClient

java.lang.Object
com.azure.compute.batch.BatchAsyncClient
public final class BatchAsyncClient extends Object
Initializes a new instance of the asynchronous BatchClient type.

  • Method Details

    • createTasks

      public Mono<Void> createTasks(String jobId, List<BatchTaskCreateContent> taskList)
      Adds multiple tasks to a job.
      Parameters:
      jobId - The ID of the job to which to add the task.
      taskList - A list of tasks to add.
      Returns:
      A Mono that completes when a successful response is received.

    • createTasks

      public Mono<Void> createTasks(String jobId, List<BatchTaskCreateContent> taskList, BatchClientParallelOptions batchClientParallelOptions)
      Creates a collection of Tasks to the specified Job.

      Note that each Task must have a unique ID.This method can work with multiple threads. The parallel degree can be specified by the user. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

      Parameters:
      jobId - The ID of the job to which to add the task.
      taskList - A list of tasks to add.
      batchClientParallelOptions - Option that configure the parallelization of the method.
      Returns:
      A Mono that completes when a successful response is received.

    • listApplications

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listApplications(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the applications available in the specified Account. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Required)
     displayName: String (Required)
     versions (Required): [
         String (Required)
     ]
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the applications available in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getApplicationWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getApplicationWithResponse(String applicationId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Application. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about Applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Required)
     displayName: String (Required)
     versions (Required): [
         String (Required)
     ]
 }
      Parameters:
      applicationId - The ID of the Application.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Application. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listPoolUsageMetrics

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listPoolUsageMetrics(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account. If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      startTimeOffsetDateTimeNoThe earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.
      endtimeOffsetDateTimeNoThe latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     poolId: String (Required)
     startTime: OffsetDateTime (Required)
     endTime: OffsetDateTime (Required)
     vmSize: String (Required)
     totalCoreHours: double (Required)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of a listing the usage metrics for an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createPoolWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> createPoolWithResponse(com.azure.core.util.BinaryData pool, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates a Pool to the specified Account. When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Required)
     displayName: String (Optional)
     vmSize: String (Required)
     virtualMachineConfiguration (Optional): {
         imageReference (Required): {
             publisher: String (Optional)
             offer: String (Optional)
             sku: String (Optional)
             version: String (Optional)
             virtualMachineImageId: String (Optional)
             exactVersion: String (Optional)
             sharedGalleryImageId: String (Optional)
             communityGalleryImageId: String (Optional)
         }
         nodeAgentSKUId: String (Required)
         windowsConfiguration (Optional): {
             enableAutomaticUpdates: Boolean (Optional)
         }
         dataDisks (Optional): [
              (Optional){
                 lun: int (Required)
                 caching: String(none/readonly/readwrite) (Optional)
                 diskSizeGB: int (Required)
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
             }
         ]
         licenseType: String (Optional)
         containerConfiguration (Optional): {
             type: String(dockerCompatible/criCompatible) (Required)
             containerImageNames (Optional): [
                 String (Optional)
             ]
             containerRegistries (Optional): [
                  (Optional){
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
             ]
         }
         diskEncryptionConfiguration (Optional): {
             targets (Optional): [
                 String(osdisk/temporarydisk) (Optional)
             ]
         }
         nodePlacementConfiguration (Optional): {
             policy: String(regional/zonal) (Optional)
         }
         extensions (Optional): [
              (Optional){
                 name: String (Required)
                 publisher: String (Required)
                 type: String (Required)
                 typeHandlerVersion: String (Optional)
                 autoUpgradeMinorVersion: Boolean (Optional)
                 enableAutomaticUpgrade: Boolean (Optional)
                 settings (Optional): {
                     String: String (Required)
                 }
                 protectedSettings (Optional): {
                     String: String (Required)
                 }
                 provisionAfterExtensions (Optional): [
                     String (Optional)
                 ]
             }
         ]
         osDisk (Optional): {
             ephemeralOSDiskSettings (Optional): {
                 placement: String(cachedisk) (Optional)
             }
             caching: String(none/readonly/readwrite) (Optional)
             diskSizeGB: Integer (Optional)
             managedDisk (Optional): {
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                 securityProfile (Optional): {
                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                 }
             }
             writeAcceleratorEnabled: Boolean (Optional)
         }
         securityProfile (Optional): {
             encryptionAtHost: boolean (Required)
             securityType: String(trustedLaunch/confidentialVM) (Required)
             uefiSettings (Required): {
                 secureBootEnabled: Boolean (Optional)
                 vTpmEnabled: Boolean (Optional)
             }
         }
         serviceArtifactReference (Optional): {
             id: String (Required)
         }
     }
     resizeTimeout: Duration (Optional)
     resourceTags (Optional): {
         String: String (Required)
     }
     targetDedicatedNodes: Integer (Optional)
     targetLowPriorityNodes: Integer (Optional)
     enableAutoScale: Boolean (Optional)
     autoScaleFormula: String (Optional)
     autoScaleEvaluationInterval: Duration (Optional)
     enableInterNodeCommunication: Boolean (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Optional)
         dynamicVNetAssignmentScope: String(none/job) (Optional)
         endpointConfiguration (Optional): {
             inboundNATPools (Required): [
                  (Required){
                     name: String (Required)
                     protocol: String(tcp/udp) (Required)
                     backendPort: int (Required)
                     frontendPortRangeStart: int (Required)
                     frontendPortRangeEnd: int (Required)
                     networkSecurityGroupRules (Optional): [
                          (Optional){
                             priority: int (Required)
                             access: String(allow/deny) (Required)
                             sourceAddressPrefix: String (Required)
                             sourcePortRanges (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                 }
             ]
         }
         publicIPAddressConfiguration (Optional): {
             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
             ipAddressIds (Optional): [
                 String (Optional)
             ]
         }
         enableAcceleratedNetworking: Boolean (Optional)
     }
     startTask (Optional): {
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): (recursive schema, see registry above)
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         maxTaskRetryCount: Integer (Optional)
         waitForSuccess: Boolean (Optional)
     }
     certificateReferences (Optional): [
          (Optional){
             thumbprint: String (Required)
             thumbprintAlgorithm: String (Required)
             storeLocation: String(currentuser/localmachine) (Optional)
             storeName: String (Optional)
             visibility (Optional): [
                 String(starttask/task/remoteuser) (Optional)
             ]
         }
     ]
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     taskSlotsPerNode: Integer (Optional)
     taskSchedulingPolicy (Optional): {
         nodeFillType: String(spread/pack) (Required)
     }
     userAccounts (Optional): [
          (Optional){
             name: String (Required)
             password: String (Required)
             elevationLevel: String(nonadmin/admin) (Optional)
             linuxUserConfiguration (Optional): {
                 uid: Integer (Optional)
                 gid: Integer (Optional)
                 sshPrivateKey: String (Optional)
             }
             windowsUserConfiguration (Optional): {
                 loginMode: String(batch/interactive) (Optional)
             }
         }
     ]
     metadata (Optional): [
          (Optional){
             name: String (Required)
             value: String (Required)
         }
     ]
     mountConfiguration (Optional): [
          (Optional){
             azureBlobFileSystemConfiguration (Optional): {
                 accountName: String (Required)
                 containerName: String (Required)
                 accountKey: String (Optional)
                 sasKey: String (Optional)
                 blobfuseOptions: String (Optional)
                 relativeMountPath: String (Required)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
             nfsMountConfiguration (Optional): {
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
             cifsMountConfiguration (Optional): {
                 username: String (Required)
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
                 password: String (Required)
             }
             azureFileShareConfiguration (Optional): {
                 accountName: String (Required)
                 azureFileUrl: String (Required)
                 accountKey: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
         }
     ]
     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
     upgradePolicy (Optional): {
         mode: String(automatic/manual/rolling) (Required)
         automaticOSUpgradePolicy (Optional): {
             disableAutomaticRollback: Boolean (Optional)
             enableAutomaticOSUpgrade: Boolean (Optional)
             useRollingUpgradePolicy: Boolean (Optional)
             osRollingUpgradeDeferral: Boolean (Optional)
         }
         rollingUpgradePolicy (Optional): {
             enableCrossZoneUpgrade: Boolean (Optional)
             maxBatchInstancePercent: Integer (Optional)
             maxUnhealthyInstancePercent: Integer (Optional)
             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
             pauseTimeBetweenBatches: Duration (Optional)
             prioritizeUnhealthyInstances: Boolean (Optional)
             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
         }
     }
 }
      Parameters:
      pool - The Pool to be created.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listPools

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listPools(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the Pools which be mounted.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     allocationState: String(steady/resizing/stopping) (Optional)
     allocationStateTransitionTime: OffsetDateTime (Optional)
     vmSize: String (Optional)
     virtualMachineConfiguration (Optional): {
         imageReference (Required): {
             publisher: String (Optional)
             offer: String (Optional)
             sku: String (Optional)
             version: String (Optional)
             virtualMachineImageId: String (Optional)
             exactVersion: String (Optional)
             sharedGalleryImageId: String (Optional)
             communityGalleryImageId: String (Optional)
         }
         nodeAgentSKUId: String (Required)
         windowsConfiguration (Optional): {
             enableAutomaticUpdates: Boolean (Optional)
         }
         dataDisks (Optional): [
              (Optional){
                 lun: int (Required)
                 caching: String(none/readonly/readwrite) (Optional)
                 diskSizeGB: int (Required)
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
             }
         ]
         licenseType: String (Optional)
         containerConfiguration (Optional): {
             type: String(dockerCompatible/criCompatible) (Required)
             containerImageNames (Optional): [
                 String (Optional)
             ]
             containerRegistries (Optional): [
                  (Optional){
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
             ]
         }
         diskEncryptionConfiguration (Optional): {
             targets (Optional): [
                 String(osdisk/temporarydisk) (Optional)
             ]
         }
         nodePlacementConfiguration (Optional): {
             policy: String(regional/zonal) (Optional)
         }
         extensions (Optional): [
              (Optional){
                 name: String (Required)
                 publisher: String (Required)
                 type: String (Required)
                 typeHandlerVersion: String (Optional)
                 autoUpgradeMinorVersion: Boolean (Optional)
                 enableAutomaticUpgrade: Boolean (Optional)
                 settings (Optional): {
                     String: String (Required)
                 }
                 protectedSettings (Optional): {
                     String: String (Required)
                 }
                 provisionAfterExtensions (Optional): [
                     String (Optional)
                 ]
             }
         ]
         osDisk (Optional): {
             ephemeralOSDiskSettings (Optional): {
                 placement: String(cachedisk) (Optional)
             }
             caching: String(none/readonly/readwrite) (Optional)
             diskSizeGB: Integer (Optional)
             managedDisk (Optional): {
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                 securityProfile (Optional): {
                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                 }
             }
             writeAcceleratorEnabled: Boolean (Optional)
         }
         securityProfile (Optional): {
             encryptionAtHost: boolean (Required)
             securityType: String(trustedLaunch/confidentialVM) (Required)
             uefiSettings (Required): {
                 secureBootEnabled: Boolean (Optional)
                 vTpmEnabled: Boolean (Optional)
             }
         }
         serviceArtifactReference (Optional): {
             id: String (Required)
         }
     }
     resizeTimeout: Duration (Optional)
     resizeErrors (Optional): [
          (Optional){
             code: String (Optional)
             message: String (Optional)
             values (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
     ]
     resourceTags (Optional): {
         String: String (Required)
     }
     currentDedicatedNodes: Integer (Optional)
     currentLowPriorityNodes: Integer (Optional)
     targetDedicatedNodes: Integer (Optional)
     targetLowPriorityNodes: Integer (Optional)
     enableAutoScale: Boolean (Optional)
     autoScaleFormula: String (Optional)
     autoScaleEvaluationInterval: Duration (Optional)
     autoScaleRun (Optional): {
         timestamp: OffsetDateTime (Required)
         results: String (Optional)
         error (Optional): {
             code: String (Optional)
             message: String (Optional)
             values (Optional): [
                 (recursive schema, see above)
             ]
         }
     }
     enableInterNodeCommunication: Boolean (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Optional)
         dynamicVNetAssignmentScope: String(none/job) (Optional)
         endpointConfiguration (Optional): {
             inboundNATPools (Required): [
                  (Required){
                     name: String (Required)
                     protocol: String(tcp/udp) (Required)
                     backendPort: int (Required)
                     frontendPortRangeStart: int (Required)
                     frontendPortRangeEnd: int (Required)
                     networkSecurityGroupRules (Optional): [
                          (Optional){
                             priority: int (Required)
                             access: String(allow/deny) (Required)
                             sourceAddressPrefix: String (Required)
                             sourcePortRanges (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                 }
             ]
         }
         publicIPAddressConfiguration (Optional): {
             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
             ipAddressIds (Optional): [
                 String (Optional)
             ]
         }
         enableAcceleratedNetworking: Boolean (Optional)
     }
     startTask (Optional): {
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): (recursive schema, see registry above)
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         maxTaskRetryCount: Integer (Optional)
         waitForSuccess: Boolean (Optional)
     }
     certificateReferences (Optional): [
          (Optional){
             thumbprint: String (Required)
             thumbprintAlgorithm: String (Required)
             storeLocation: String(currentuser/localmachine) (Optional)
             storeName: String (Optional)
             visibility (Optional): [
                 String(starttask/task/remoteuser) (Optional)
             ]
         }
     ]
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     taskSlotsPerNode: Integer (Optional)
     taskSchedulingPolicy (Optional): {
         nodeFillType: String(spread/pack) (Required)
     }
     userAccounts (Optional): [
          (Optional){
             name: String (Required)
             password: String (Required)
             elevationLevel: String(nonadmin/admin) (Optional)
             linuxUserConfiguration (Optional): {
                 uid: Integer (Optional)
                 gid: Integer (Optional)
                 sshPrivateKey: String (Optional)
             }
             windowsUserConfiguration (Optional): {
                 loginMode: String(batch/interactive) (Optional)
             }
         }
     ]
     metadata (Optional): [
          (Optional){
             name: String (Required)
             value: String (Required)
         }
     ]
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         usageStats (Optional): {
             startTime: OffsetDateTime (Required)
             lastUpdateTime: OffsetDateTime (Required)
             dedicatedCoreTime: Duration (Required)
         }
         resourceStats (Optional): {
             startTime: OffsetDateTime (Required)
             lastUpdateTime: OffsetDateTime (Required)
             avgCPUPercentage: double (Required)
             avgMemoryGiB: double (Required)
             peakMemoryGiB: double (Required)
             avgDiskGiB: double (Required)
             peakDiskGiB: double (Required)
             diskReadIOps: long (Required)
             diskWriteIOps: long (Required)
             diskReadGiB: double (Required)
             diskWriteGiB: double (Required)
             networkReadGiB: double (Required)
             networkWriteGiB: double (Required)
         }
     }
     mountConfiguration (Optional): [
          (Optional){
             azureBlobFileSystemConfiguration (Optional): {
                 accountName: String (Required)
                 containerName: String (Required)
                 accountKey: String (Optional)
                 sasKey: String (Optional)
                 blobfuseOptions: String (Optional)
                 relativeMountPath: String (Required)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
             nfsMountConfiguration (Optional): {
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
             cifsMountConfiguration (Optional): {
                 username: String (Required)
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
                 password: String (Required)
             }
             azureFileShareConfiguration (Optional): {
                 accountName: String (Required)
                 azureFileUrl: String (Required)
                 accountKey: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
         }
     ]
     identity (Optional): {
         type: String(UserAssigned/None) (Required)
         userAssignedIdentities (Optional): [
              (Optional){
                 resourceId: String (Required)
                 clientId: String (Optional)
                 principalId: String (Optional)
             }
         ]
     }
     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
     currentNodeCommunicationMode: String(default/classic/simplified) (Optional)
     upgradePolicy (Optional): {
         mode: String(automatic/manual/rolling) (Required)
         automaticOSUpgradePolicy (Optional): {
             disableAutomaticRollback: Boolean (Optional)
             enableAutomaticOSUpgrade: Boolean (Optional)
             useRollingUpgradePolicy: Boolean (Optional)
             osRollingUpgradeDeferral: Boolean (Optional)
         }
         rollingUpgradePolicy (Optional): {
             enableCrossZoneUpgrade: Boolean (Optional)
             maxBatchInstancePercent: Integer (Optional)
             maxUnhealthyInstancePercent: Integer (Optional)
             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
             pauseTimeBetweenBatches: Duration (Optional)
             prioritizeUnhealthyInstances: Boolean (Optional)
             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
         }
     }
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Pools in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deletePoolWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deletePoolWithResponse(String poolId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a Pool from the specified Account. When you request that a Pool be deleted, the following actions occur: the Pool state is set to deleting; any ongoing resize operation on the Pool are stopped; the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks running on existing Compute Nodes are terminated and requeued (as if a resize Pool operation had been requested with the default requeue option); finally, the Pool is removed from the system. Because running Tasks are requeued, the user can rerun these Tasks by updating their Job to target a different Pool. The Tasks can then run on the new Pool. If you want to override the requeue behavior, then you should call resize Pool explicitly to shrink the Pool to zero size before deleting the Pool. If you call an Update, Patch or Delete API on a Pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool to get.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • poolExistsWithResponse

      public Mono<com.azure.core.http.rest.Response<Boolean>> poolExistsWithResponse(String poolId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets basic properties of a Pool.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 boolean
      Parameters:
      poolId - The ID of the Pool to get.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      basic properties of a Pool along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getPoolWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getPoolWithResponse(String poolId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Pool.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     allocationState: String(steady/resizing/stopping) (Optional)
     allocationStateTransitionTime: OffsetDateTime (Optional)
     vmSize: String (Optional)
     virtualMachineConfiguration (Optional): {
         imageReference (Required): {
             publisher: String (Optional)
             offer: String (Optional)
             sku: String (Optional)
             version: String (Optional)
             virtualMachineImageId: String (Optional)
             exactVersion: String (Optional)
             sharedGalleryImageId: String (Optional)
             communityGalleryImageId: String (Optional)
         }
         nodeAgentSKUId: String (Required)
         windowsConfiguration (Optional): {
             enableAutomaticUpdates: Boolean (Optional)
         }
         dataDisks (Optional): [
              (Optional){
                 lun: int (Required)
                 caching: String(none/readonly/readwrite) (Optional)
                 diskSizeGB: int (Required)
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
             }
         ]
         licenseType: String (Optional)
         containerConfiguration (Optional): {
             type: String(dockerCompatible/criCompatible) (Required)
             containerImageNames (Optional): [
                 String (Optional)
             ]
             containerRegistries (Optional): [
                  (Optional){
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
             ]
         }
         diskEncryptionConfiguration (Optional): {
             targets (Optional): [
                 String(osdisk/temporarydisk) (Optional)
             ]
         }
         nodePlacementConfiguration (Optional): {
             policy: String(regional/zonal) (Optional)
         }
         extensions (Optional): [
              (Optional){
                 name: String (Required)
                 publisher: String (Required)
                 type: String (Required)
                 typeHandlerVersion: String (Optional)
                 autoUpgradeMinorVersion: Boolean (Optional)
                 enableAutomaticUpgrade: Boolean (Optional)
                 settings (Optional): {
                     String: String (Required)
                 }
                 protectedSettings (Optional): {
                     String: String (Required)
                 }
                 provisionAfterExtensions (Optional): [
                     String (Optional)
                 ]
             }
         ]
         osDisk (Optional): {
             ephemeralOSDiskSettings (Optional): {
                 placement: String(cachedisk) (Optional)
             }
             caching: String(none/readonly/readwrite) (Optional)
             diskSizeGB: Integer (Optional)
             managedDisk (Optional): {
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                 securityProfile (Optional): {
                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                 }
             }
             writeAcceleratorEnabled: Boolean (Optional)
         }
         securityProfile (Optional): {
             encryptionAtHost: boolean (Required)
             securityType: String(trustedLaunch/confidentialVM) (Required)
             uefiSettings (Required): {
                 secureBootEnabled: Boolean (Optional)
                 vTpmEnabled: Boolean (Optional)
             }
         }
         serviceArtifactReference (Optional): {
             id: String (Required)
         }
     }
     resizeTimeout: Duration (Optional)
     resizeErrors (Optional): [
          (Optional){
             code: String (Optional)
             message: String (Optional)
             values (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
     ]
     resourceTags (Optional): {
         String: String (Required)
     }
     currentDedicatedNodes: Integer (Optional)
     currentLowPriorityNodes: Integer (Optional)
     targetDedicatedNodes: Integer (Optional)
     targetLowPriorityNodes: Integer (Optional)
     enableAutoScale: Boolean (Optional)
     autoScaleFormula: String (Optional)
     autoScaleEvaluationInterval: Duration (Optional)
     autoScaleRun (Optional): {
         timestamp: OffsetDateTime (Required)
         results: String (Optional)
         error (Optional): {
             code: String (Optional)
             message: String (Optional)
             values (Optional): [
                 (recursive schema, see above)
             ]
         }
     }
     enableInterNodeCommunication: Boolean (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Optional)
         dynamicVNetAssignmentScope: String(none/job) (Optional)
         endpointConfiguration (Optional): {
             inboundNATPools (Required): [
                  (Required){
                     name: String (Required)
                     protocol: String(tcp/udp) (Required)
                     backendPort: int (Required)
                     frontendPortRangeStart: int (Required)
                     frontendPortRangeEnd: int (Required)
                     networkSecurityGroupRules (Optional): [
                          (Optional){
                             priority: int (Required)
                             access: String(allow/deny) (Required)
                             sourceAddressPrefix: String (Required)
                             sourcePortRanges (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                 }
             ]
         }
         publicIPAddressConfiguration (Optional): {
             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
             ipAddressIds (Optional): [
                 String (Optional)
             ]
         }
         enableAcceleratedNetworking: Boolean (Optional)
     }
     startTask (Optional): {
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): (recursive schema, see registry above)
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         maxTaskRetryCount: Integer (Optional)
         waitForSuccess: Boolean (Optional)
     }
     certificateReferences (Optional): [
          (Optional){
             thumbprint: String (Required)
             thumbprintAlgorithm: String (Required)
             storeLocation: String(currentuser/localmachine) (Optional)
             storeName: String (Optional)
             visibility (Optional): [
                 String(starttask/task/remoteuser) (Optional)
             ]
         }
     ]
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     taskSlotsPerNode: Integer (Optional)
     taskSchedulingPolicy (Optional): {
         nodeFillType: String(spread/pack) (Required)
     }
     userAccounts (Optional): [
          (Optional){
             name: String (Required)
             password: String (Required)
             elevationLevel: String(nonadmin/admin) (Optional)
             linuxUserConfiguration (Optional): {
                 uid: Integer (Optional)
                 gid: Integer (Optional)
                 sshPrivateKey: String (Optional)
             }
             windowsUserConfiguration (Optional): {
                 loginMode: String(batch/interactive) (Optional)
             }
         }
     ]
     metadata (Optional): [
          (Optional){
             name: String (Required)
             value: String (Required)
         }
     ]
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         usageStats (Optional): {
             startTime: OffsetDateTime (Required)
             lastUpdateTime: OffsetDateTime (Required)
             dedicatedCoreTime: Duration (Required)
         }
         resourceStats (Optional): {
             startTime: OffsetDateTime (Required)
             lastUpdateTime: OffsetDateTime (Required)
             avgCPUPercentage: double (Required)
             avgMemoryGiB: double (Required)
             peakMemoryGiB: double (Required)
             avgDiskGiB: double (Required)
             peakDiskGiB: double (Required)
             diskReadIOps: long (Required)
             diskWriteIOps: long (Required)
             diskReadGiB: double (Required)
             diskWriteGiB: double (Required)
             networkReadGiB: double (Required)
             networkWriteGiB: double (Required)
         }
     }
     mountConfiguration (Optional): [
          (Optional){
             azureBlobFileSystemConfiguration (Optional): {
                 accountName: String (Required)
                 containerName: String (Required)
                 accountKey: String (Optional)
                 sasKey: String (Optional)
                 blobfuseOptions: String (Optional)
                 relativeMountPath: String (Required)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
             nfsMountConfiguration (Optional): {
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
             cifsMountConfiguration (Optional): {
                 username: String (Required)
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
                 password: String (Required)
             }
             azureFileShareConfiguration (Optional): {
                 accountName: String (Required)
                 azureFileUrl: String (Required)
                 accountKey: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
         }
     ]
     identity (Optional): {
         type: String(UserAssigned/None) (Required)
         userAssignedIdentities (Optional): [
              (Optional){
                 resourceId: String (Required)
                 clientId: String (Optional)
                 principalId: String (Optional)
             }
         ]
     }
     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
     currentNodeCommunicationMode: String(default/classic/simplified) (Optional)
     upgradePolicy (Optional): {
         mode: String(automatic/manual/rolling) (Required)
         automaticOSUpgradePolicy (Optional): {
             disableAutomaticRollback: Boolean (Optional)
             enableAutomaticOSUpgrade: Boolean (Optional)
             useRollingUpgradePolicy: Boolean (Optional)
             osRollingUpgradeDeferral: Boolean (Optional)
         }
         rollingUpgradePolicy (Optional): {
             enableCrossZoneUpgrade: Boolean (Optional)
             maxBatchInstancePercent: Integer (Optional)
             maxUnhealthyInstancePercent: Integer (Optional)
             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
             pauseTimeBetweenBatches: Duration (Optional)
             prioritizeUnhealthyInstances: Boolean (Optional)
             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
         }
     }
 }
      Parameters:
      poolId - The ID of the Pool to get.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Pool along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • updatePoolWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> updatePoolWithResponse(String poolId, com.azure.core.util.BinaryData pool, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the properties of the specified Pool. This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     displayName: String (Optional)
     vmSize: String (Optional)
     enableInterNodeCommunication: Boolean (Optional)
     startTask (Optional): {
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         maxTaskRetryCount: Integer (Optional)
         waitForSuccess: Boolean (Optional)
     }
     certificateReferences (Optional): [
          (Optional){
             thumbprint: String (Required)
             thumbprintAlgorithm: String (Required)
             storeLocation: String(currentuser/localmachine) (Optional)
             storeName: String (Optional)
             visibility (Optional): [
                 String(starttask/task/remoteuser) (Optional)
             ]
         }
     ]
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     metadata (Optional): [
          (Optional){
             name: String (Required)
             value: String (Required)
         }
     ]
     virtualMachineConfiguration (Optional): {
         imageReference (Required): {
             publisher: String (Optional)
             offer: String (Optional)
             sku: String (Optional)
             version: String (Optional)
             virtualMachineImageId: String (Optional)
             exactVersion: String (Optional)
             sharedGalleryImageId: String (Optional)
             communityGalleryImageId: String (Optional)
         }
         nodeAgentSKUId: String (Required)
         windowsConfiguration (Optional): {
             enableAutomaticUpdates: Boolean (Optional)
         }
         dataDisks (Optional): [
              (Optional){
                 lun: int (Required)
                 caching: String(none/readonly/readwrite) (Optional)
                 diskSizeGB: int (Required)
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
             }
         ]
         licenseType: String (Optional)
         containerConfiguration (Optional): {
             type: String(dockerCompatible/criCompatible) (Required)
             containerImageNames (Optional): [
                 String (Optional)
             ]
             containerRegistries (Optional): [
                 (recursive schema, see above)
             ]
         }
         diskEncryptionConfiguration (Optional): {
             targets (Optional): [
                 String(osdisk/temporarydisk) (Optional)
             ]
         }
         nodePlacementConfiguration (Optional): {
             policy: String(regional/zonal) (Optional)
         }
         extensions (Optional): [
              (Optional){
                 name: String (Required)
                 publisher: String (Required)
                 type: String (Required)
                 typeHandlerVersion: String (Optional)
                 autoUpgradeMinorVersion: Boolean (Optional)
                 enableAutomaticUpgrade: Boolean (Optional)
                 settings (Optional): {
                     String: String (Required)
                 }
                 protectedSettings (Optional): {
                     String: String (Required)
                 }
                 provisionAfterExtensions (Optional): [
                     String (Optional)
                 ]
             }
         ]
         osDisk (Optional): {
             ephemeralOSDiskSettings (Optional): {
                 placement: String(cachedisk) (Optional)
             }
             caching: String(none/readonly/readwrite) (Optional)
             diskSizeGB: Integer (Optional)
             managedDisk (Optional): {
                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                 securityProfile (Optional): {
                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                 }
             }
             writeAcceleratorEnabled: Boolean (Optional)
         }
         securityProfile (Optional): {
             encryptionAtHost: boolean (Required)
             securityType: String(trustedLaunch/confidentialVM) (Required)
             uefiSettings (Required): {
                 secureBootEnabled: Boolean (Optional)
                 vTpmEnabled: Boolean (Optional)
             }
         }
         serviceArtifactReference (Optional): {
             id: String (Required)
         }
     }
     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
     taskSlotsPerNode: Integer (Optional)
     taskSchedulingPolicy (Optional): {
         nodeFillType: String(spread/pack) (Required)
     }
     networkConfiguration (Optional): {
         subnetId: String (Optional)
         dynamicVNetAssignmentScope: String(none/job) (Optional)
         endpointConfiguration (Optional): {
             inboundNATPools (Required): [
                  (Required){
                     name: String (Required)
                     protocol: String(tcp/udp) (Required)
                     backendPort: int (Required)
                     frontendPortRangeStart: int (Required)
                     frontendPortRangeEnd: int (Required)
                     networkSecurityGroupRules (Optional): [
                          (Optional){
                             priority: int (Required)
                             access: String(allow/deny) (Required)
                             sourceAddressPrefix: String (Required)
                             sourcePortRanges (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                 }
             ]
         }
         publicIPAddressConfiguration (Optional): {
             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
             ipAddressIds (Optional): [
                 String (Optional)
             ]
         }
         enableAcceleratedNetworking: Boolean (Optional)
     }
     resourceTags (Optional): {
         String: String (Required)
     }
     userAccounts (Optional): [
          (Optional){
             name: String (Required)
             password: String (Required)
             elevationLevel: String(nonadmin/admin) (Optional)
             linuxUserConfiguration (Optional): {
                 uid: Integer (Optional)
                 gid: Integer (Optional)
                 sshPrivateKey: String (Optional)
             }
             windowsUserConfiguration (Optional): {
                 loginMode: String(batch/interactive) (Optional)
             }
         }
     ]
     mountConfiguration (Optional): [
          (Optional){
             azureBlobFileSystemConfiguration (Optional): {
                 accountName: String (Required)
                 containerName: String (Required)
                 accountKey: String (Optional)
                 sasKey: String (Optional)
                 blobfuseOptions: String (Optional)
                 relativeMountPath: String (Required)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
             nfsMountConfiguration (Optional): {
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
             cifsMountConfiguration (Optional): {
                 username: String (Required)
                 source: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
                 password: String (Required)
             }
             azureFileShareConfiguration (Optional): {
                 accountName: String (Required)
                 azureFileUrl: String (Required)
                 accountKey: String (Required)
                 relativeMountPath: String (Required)
                 mountOptions: String (Optional)
             }
         }
     ]
     upgradePolicy (Optional): {
         mode: String(automatic/manual/rolling) (Required)
         automaticOSUpgradePolicy (Optional): {
             disableAutomaticRollback: Boolean (Optional)
             enableAutomaticOSUpgrade: Boolean (Optional)
             useRollingUpgradePolicy: Boolean (Optional)
             osRollingUpgradeDeferral: Boolean (Optional)
         }
         rollingUpgradePolicy (Optional): {
             enableCrossZoneUpgrade: Boolean (Optional)
             maxBatchInstancePercent: Integer (Optional)
             maxUnhealthyInstancePercent: Integer (Optional)
             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
             pauseTimeBetweenBatches: Duration (Optional)
             prioritizeUnhealthyInstances: Boolean (Optional)
             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
         }
     }
 }
      Parameters:
      poolId - The ID of the Pool to get.
      pool - The pool properties to update.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • disablePoolAutoScaleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> disablePoolAutoScaleWithResponse(String poolId, com.azure.core.http.rest.RequestOptions requestOptions)
      Disables automatic scaling for a Pool.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool on which to disable automatic scaling.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • enablePoolAutoScaleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> enablePoolAutoScaleWithResponse(String poolId, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
      Enables automatic scaling for a Pool. You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the Pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same Pool more than once every 30 seconds.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     autoScaleFormula: String (Optional)
     autoScaleEvaluationInterval: Duration (Optional)
 }
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for enabling automatic scaling.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • evaluatePoolAutoScaleWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> evaluatePoolAutoScaleWithResponse(String poolId, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     autoScaleFormula: String (Required)
 }

      Response Body Schema

       
 {
     timestamp: OffsetDateTime (Required)
     results: String (Optional)
     error (Optional): {
         code: String (Optional)
         message: String (Optional)
         values (Optional): [
              (Optional){
                 name: String (Optional)
                 value: String (Optional)
             }
         ]
     }
 }
      Parameters:
      poolId - The ID of the Pool on which to evaluate the automatic scaling formula.
      content - The options to use for evaluating the automatic scaling formula.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • resizePoolWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> resizePoolWithResponse(String poolId, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
      Changes the number of Compute Nodes that are assigned to a Pool. You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a Pool, the Pool's allocation state changes from steady to resizing. You cannot resize Pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a Pool downwards, the Batch service chooses which Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     targetDedicatedNodes: Integer (Optional)
     targetLowPriorityNodes: Integer (Optional)
     resizeTimeout: Duration (Optional)
     nodeDeallocationOption: String(requeue/terminate/taskcompletion/retaineddata) (Optional)
 }
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for resizing the pool.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • stopPoolResizeWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> stopPoolResizeWithResponse(String poolId, com.azure.core.http.rest.RequestOptions requestOptions)
      Stops an ongoing resize operation on the Pool. This does not restore the Pool to its previous state before the resize operation: it only stops any further changes being made, and the Pool maintains its current state. After stopping, the Pool stabilizes at the number of Compute Nodes it was at when the stop operation was done. During the stop operation, the Pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize Pool request; this API can also be used to halt the initial sizing of the Pool when it is created.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool to get.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • replacePoolPropertiesWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> replacePoolPropertiesWithResponse(String poolId, com.azure.core.util.BinaryData pool, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the properties of the specified Pool. This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     startTask (Optional): {
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         maxTaskRetryCount: Integer (Optional)
         waitForSuccess: Boolean (Optional)
     }
     certificateReferences (Required): [
          (Required){
             thumbprint: String (Required)
             thumbprintAlgorithm: String (Required)
             storeLocation: String(currentuser/localmachine) (Optional)
             storeName: String (Optional)
             visibility (Optional): [
                 String(starttask/task/remoteuser) (Optional)
             ]
         }
     ]
     applicationPackageReferences (Required): [
          (Required){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     metadata (Required): [
          (Required){
             name: String (Required)
             value: String (Required)
         }
     ]
     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
 }
      Parameters:
      poolId - The ID of the Pool to update.
      pool - The options to use for replacing properties on the pool.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • removeNodesWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> removeNodesWithResponse(String poolId, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
      Removes Compute Nodes from the specified Pool. This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     nodeList (Required): [
         String (Required)
     ]
     resizeTimeout: Duration (Optional)
     nodeDeallocationOption: String(requeue/terminate/taskcompletion/retaineddata) (Optional)
 }
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for removing the node.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listSupportedImages

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listSupportedImages(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all Virtual Machine Images supported by the Azure Batch service.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     nodeAgentSKUId: String (Required)
     imageReference (Required): {
         publisher: String (Optional)
         offer: String (Optional)
         sku: String (Optional)
         version: String (Optional)
         virtualMachineImageId: String (Optional)
         exactVersion: String (Optional)
         sharedGalleryImageId: String (Optional)
         communityGalleryImageId: String (Optional)
     }
     osType: String(linux/windows) (Required)
     capabilities (Optional): [
         String (Optional)
     ]
     batchSupportEndOfLife: OffsetDateTime (Optional)
     verificationType: String(verified/unverified) (Required)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the supported Virtual Machine Images as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listPoolNodeCounts

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listPoolNodeCounts(com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     poolId: String (Required)
     dedicated (Optional): {
         creating: int (Required)
         idle: int (Required)
         offline: int (Required)
         preempted: int (Required)
         rebooting: int (Required)
         reimaging: int (Required)
         running: int (Required)
         starting: int (Required)
         startTaskFailed: int (Required)
         leavingPool: int (Required)
         unknown: int (Required)
         unusable: int (Required)
         waitingForStartTask: int (Required)
         deallocated: int (Required)
         deallocating: int (Required)
         total: int (Required)
         upgradingOS: int (Required)
     }
     lowPriority (Optional): (recursive schema, see lowPriority above)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the number of Compute Nodes in each state, grouped by Pool as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteJobWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteJobWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a Job. Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      forceBooleanNoIf true, the server will delete the Job even if the corresponding nodes have not fully processed the deletion. The default value is false.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobId - The ID of the Job to delete.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getJobWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getJobWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Job.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     usesTaskDependencies: Boolean (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     priority: Integer (Optional)
     allowTaskPreemption: Boolean (Optional)
     maxParallelTasks: Integer (Optional)
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     jobManagerTask (Optional): {
         id: String (Required)
         displayName: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         outputFiles (Optional): [
              (Optional){
                 filePattern: String (Required)
                 destination (Required): {
                     container (Optional): {
                         path: String (Optional)
                         containerUrl: String (Required)
                         identityReference (Optional): (recursive schema, see identityReference above)
                         uploadHeaders (Optional): [
                              (Optional){
                                 name: String (Required)
                                 value: String (Optional)
                             }
                         ]
                     }
                 }
                 uploadOptions (Required): {
                     uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                 }
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         requiredSlots: Integer (Optional)
         killJobOnCompletion: Boolean (Optional)
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         runExclusive: Boolean (Optional)
         applicationPackageReferences (Optional): [
              (Optional){
                 applicationId: String (Required)
                 version: String (Optional)
             }
         ]
         authenticationTokenSettings (Optional): {
             access (Optional): [
                 String(job) (Optional)
             ]
         }
         allowLowPriorityNode: Boolean (Optional)
     }
     jobPreparationTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         constraints (Optional): (recursive schema, see constraints above)
         waitForSuccess: Boolean (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
         rerunOnNodeRebootAfterSuccess: Boolean (Optional)
     }
     jobReleaseTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
     }
     commonEnvironmentSettings (Optional): [
         (recursive schema, see above)
     ]
     poolInfo (Required): {
         poolId: String (Optional)
         autoPoolSpecification (Optional): {
             autoPoolIdPrefix: String (Optional)
             poolLifetimeOption: String(jobschedule/job) (Required)
             keepAlive: Boolean (Optional)
             pool (Optional): {
                 displayName: String (Optional)
                 vmSize: String (Required)
                 virtualMachineConfiguration (Optional): {
                     imageReference (Required): {
                         publisher: String (Optional)
                         offer: String (Optional)
                         sku: String (Optional)
                         version: String (Optional)
                         virtualMachineImageId: String (Optional)
                         exactVersion: String (Optional)
                         sharedGalleryImageId: String (Optional)
                         communityGalleryImageId: String (Optional)
                     }
                     nodeAgentSKUId: String (Required)
                     windowsConfiguration (Optional): {
                         enableAutomaticUpdates: Boolean (Optional)
                     }
                     dataDisks (Optional): [
                          (Optional){
                             lun: int (Required)
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: int (Required)
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                         }
                     ]
                     licenseType: String (Optional)
                     containerConfiguration (Optional): {
                         type: String(dockerCompatible/criCompatible) (Required)
                         containerImageNames (Optional): [
                             String (Optional)
                         ]
                         containerRegistries (Optional): [
                             (recursive schema, see above)
                         ]
                     }
                     diskEncryptionConfiguration (Optional): {
                         targets (Optional): [
                             String(osdisk/temporarydisk) (Optional)
                         ]
                     }
                     nodePlacementConfiguration (Optional): {
                         policy: String(regional/zonal) (Optional)
                     }
                     extensions (Optional): [
                          (Optional){
                             name: String (Required)
                             publisher: String (Required)
                             type: String (Required)
                             typeHandlerVersion: String (Optional)
                             autoUpgradeMinorVersion: Boolean (Optional)
                             enableAutomaticUpgrade: Boolean (Optional)
                             settings (Optional): {
                                 String: String (Required)
                             }
                             protectedSettings (Optional): {
                                 String: String (Required)
                             }
                             provisionAfterExtensions (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                     osDisk (Optional): {
                         ephemeralOSDiskSettings (Optional): {
                             placement: String(cachedisk) (Optional)
                         }
                         caching: String(none/readonly/readwrite) (Optional)
                         diskSizeGB: Integer (Optional)
                         managedDisk (Optional): {
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             securityProfile (Optional): {
                                 securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                             }
                         }
                         writeAcceleratorEnabled: Boolean (Optional)
                     }
                     securityProfile (Optional): {
                         encryptionAtHost: boolean (Required)
                         securityType: String(trustedLaunch/confidentialVM) (Required)
                         uefiSettings (Required): {
                             secureBootEnabled: Boolean (Optional)
                             vTpmEnabled: Boolean (Optional)
                         }
                     }
                     serviceArtifactReference (Optional): {
                         id: String (Required)
                     }
                 }
                 taskSlotsPerNode: Integer (Optional)
                 taskSchedulingPolicy (Optional): {
                     nodeFillType: String(spread/pack) (Required)
                 }
                 resizeTimeout: Duration (Optional)
                 resourceTags: String (Optional)
                 targetDedicatedNodes: Integer (Optional)
                 targetLowPriorityNodes: Integer (Optional)
                 enableAutoScale: Boolean (Optional)
                 autoScaleFormula: String (Optional)
                 autoScaleEvaluationInterval: Duration (Optional)
                 enableInterNodeCommunication: Boolean (Optional)
                 networkConfiguration (Optional): {
                     subnetId: String (Optional)
                     dynamicVNetAssignmentScope: String(none/job) (Optional)
                     endpointConfiguration (Optional): {
                         inboundNATPools (Required): [
                              (Required){
                                 name: String (Required)
                                 protocol: String(tcp/udp) (Required)
                                 backendPort: int (Required)
                                 frontendPortRangeStart: int (Required)
                                 frontendPortRangeEnd: int (Required)
                                 networkSecurityGroupRules (Optional): [
                                      (Optional){
                                         priority: int (Required)
                                         access: String(allow/deny) (Required)
                                         sourceAddressPrefix: String (Required)
                                         sourcePortRanges (Optional): [
                                             String (Optional)
                                         ]
                                     }
                                 ]
                             }
                         ]
                     }
                     publicIPAddressConfiguration (Optional): {
                         provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                         ipAddressIds (Optional): [
                             String (Optional)
                         ]
                     }
                     enableAcceleratedNetworking: Boolean (Optional)
                 }
                 startTask (Optional): {
                     commandLine: String (Required)
                     containerSettings (Optional): (recursive schema, see containerSettings above)
                     resourceFiles (Optional): [
                         (recursive schema, see above)
                     ]
                     environmentSettings (Optional): [
                         (recursive schema, see above)
                     ]
                     userIdentity (Optional): (recursive schema, see userIdentity above)
                     maxTaskRetryCount: Integer (Optional)
                     waitForSuccess: Boolean (Optional)
                 }
                 certificateReferences (Optional): [
                      (Optional){
                         thumbprint: String (Required)
                         thumbprintAlgorithm: String (Required)
                         storeLocation: String(currentuser/localmachine) (Optional)
                         storeName: String (Optional)
                         visibility (Optional): [
                             String(starttask/task/remoteuser) (Optional)
                         ]
                     }
                 ]
                 applicationPackageReferences (Optional): [
                     (recursive schema, see above)
                 ]
                 userAccounts (Optional): [
                      (Optional){
                         name: String (Required)
                         password: String (Required)
                         elevationLevel: String(nonadmin/admin) (Optional)
                         linuxUserConfiguration (Optional): {
                             uid: Integer (Optional)
                             gid: Integer (Optional)
                             sshPrivateKey: String (Optional)
                         }
                         windowsUserConfiguration (Optional): {
                             loginMode: String(batch/interactive) (Optional)
                         }
                     }
                 ]
                 metadata (Optional): [
                      (Optional){
                         name: String (Required)
                         value: String (Required)
                     }
                 ]
                 mountConfiguration (Optional): [
                      (Optional){
                         azureBlobFileSystemConfiguration (Optional): {
                             accountName: String (Required)
                             containerName: String (Required)
                             accountKey: String (Optional)
                             sasKey: String (Optional)
                             blobfuseOptions: String (Optional)
                             relativeMountPath: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                         }
                         nfsMountConfiguration (Optional): {
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                         cifsMountConfiguration (Optional): {
                             username: String (Required)
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                             password: String (Required)
                         }
                         azureFileShareConfiguration (Optional): {
                             accountName: String (Required)
                             azureFileUrl: String (Required)
                             accountKey: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                     }
                 ]
                 targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                 upgradePolicy (Optional): {
                     mode: String(automatic/manual/rolling) (Required)
                     automaticOSUpgradePolicy (Optional): {
                         disableAutomaticRollback: Boolean (Optional)
                         enableAutomaticOSUpgrade: Boolean (Optional)
                         useRollingUpgradePolicy: Boolean (Optional)
                         osRollingUpgradeDeferral: Boolean (Optional)
                     }
                     rollingUpgradePolicy (Optional): {
                         enableCrossZoneUpgrade: Boolean (Optional)
                         maxBatchInstancePercent: Integer (Optional)
                         maxUnhealthyInstancePercent: Integer (Optional)
                         maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                         pauseTimeBetweenBatches: Duration (Optional)
                         prioritizeUnhealthyInstances: Boolean (Optional)
                         rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                     }
                 }
             }
         }
     }
     onAllTasksComplete: String(noaction/terminatejob) (Optional)
     onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Required)
         skipWithdrawFromVNet: boolean (Required)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
     executionInfo (Optional): {
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         poolId: String (Optional)
         schedulingError (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         terminateReason: String (Optional)
     }
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         numSucceededTasks: long (Required)
         numFailedTasks: long (Required)
         numTaskRetries: long (Required)
         waitTime: Duration (Required)
     }
 }
      Parameters:
      jobId - The ID of the Job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Job along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • updateJobWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> updateJobWithResponse(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the properties of the specified Job. This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     priority: Integer (Optional)
     allowTaskPreemption: Boolean (Optional)
     maxParallelTasks: Integer (Optional)
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     poolInfo (Optional): {
         poolId: String (Optional)
         autoPoolSpecification (Optional): {
             autoPoolIdPrefix: String (Optional)
             poolLifetimeOption: String(jobschedule/job) (Required)
             keepAlive: Boolean (Optional)
             pool (Optional): {
                 displayName: String (Optional)
                 vmSize: String (Required)
                 virtualMachineConfiguration (Optional): {
                     imageReference (Required): {
                         publisher: String (Optional)
                         offer: String (Optional)
                         sku: String (Optional)
                         version: String (Optional)
                         virtualMachineImageId: String (Optional)
                         exactVersion: String (Optional)
                         sharedGalleryImageId: String (Optional)
                         communityGalleryImageId: String (Optional)
                     }
                     nodeAgentSKUId: String (Required)
                     windowsConfiguration (Optional): {
                         enableAutomaticUpdates: Boolean (Optional)
                     }
                     dataDisks (Optional): [
                          (Optional){
                             lun: int (Required)
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: int (Required)
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                         }
                     ]
                     licenseType: String (Optional)
                     containerConfiguration (Optional): {
                         type: String(dockerCompatible/criCompatible) (Required)
                         containerImageNames (Optional): [
                             String (Optional)
                         ]
                         containerRegistries (Optional): [
                              (Optional){
                                 username: String (Optional)
                                 password: String (Optional)
                                 registryServer: String (Optional)
                                 identityReference (Optional): {
                                     resourceId: String (Optional)
                                 }
                             }
                         ]
                     }
                     diskEncryptionConfiguration (Optional): {
                         targets (Optional): [
                             String(osdisk/temporarydisk) (Optional)
                         ]
                     }
                     nodePlacementConfiguration (Optional): {
                         policy: String(regional/zonal) (Optional)
                     }
                     extensions (Optional): [
                          (Optional){
                             name: String (Required)
                             publisher: String (Required)
                             type: String (Required)
                             typeHandlerVersion: String (Optional)
                             autoUpgradeMinorVersion: Boolean (Optional)
                             enableAutomaticUpgrade: Boolean (Optional)
                             settings (Optional): {
                                 String: String (Required)
                             }
                             protectedSettings (Optional): {
                                 String: String (Required)
                             }
                             provisionAfterExtensions (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                     osDisk (Optional): {
                         ephemeralOSDiskSettings (Optional): {
                             placement: String(cachedisk) (Optional)
                         }
                         caching: String(none/readonly/readwrite) (Optional)
                         diskSizeGB: Integer (Optional)
                         managedDisk (Optional): {
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             securityProfile (Optional): {
                                 securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                             }
                         }
                         writeAcceleratorEnabled: Boolean (Optional)
                     }
                     securityProfile (Optional): {
                         encryptionAtHost: boolean (Required)
                         securityType: String(trustedLaunch/confidentialVM) (Required)
                         uefiSettings (Required): {
                             secureBootEnabled: Boolean (Optional)
                             vTpmEnabled: Boolean (Optional)
                         }
                     }
                     serviceArtifactReference (Optional): {
                         id: String (Required)
                     }
                 }
                 taskSlotsPerNode: Integer (Optional)
                 taskSchedulingPolicy (Optional): {
                     nodeFillType: String(spread/pack) (Required)
                 }
                 resizeTimeout: Duration (Optional)
                 resourceTags: String (Optional)
                 targetDedicatedNodes: Integer (Optional)
                 targetLowPriorityNodes: Integer (Optional)
                 enableAutoScale: Boolean (Optional)
                 autoScaleFormula: String (Optional)
                 autoScaleEvaluationInterval: Duration (Optional)
                 enableInterNodeCommunication: Boolean (Optional)
                 networkConfiguration (Optional): {
                     subnetId: String (Optional)
                     dynamicVNetAssignmentScope: String(none/job) (Optional)
                     endpointConfiguration (Optional): {
                         inboundNATPools (Required): [
                              (Required){
                                 name: String (Required)
                                 protocol: String(tcp/udp) (Required)
                                 backendPort: int (Required)
                                 frontendPortRangeStart: int (Required)
                                 frontendPortRangeEnd: int (Required)
                                 networkSecurityGroupRules (Optional): [
                                      (Optional){
                                         priority: int (Required)
                                         access: String(allow/deny) (Required)
                                         sourceAddressPrefix: String (Required)
                                         sourcePortRanges (Optional): [
                                             String (Optional)
                                         ]
                                     }
                                 ]
                             }
                         ]
                     }
                     publicIPAddressConfiguration (Optional): {
                         provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                         ipAddressIds (Optional): [
                             String (Optional)
                         ]
                     }
                     enableAcceleratedNetworking: Boolean (Optional)
                 }
                 startTask (Optional): {
                     commandLine: String (Required)
                     containerSettings (Optional): {
                         containerRunOptions: String (Optional)
                         imageName: String (Required)
                         registry (Optional): (recursive schema, see registry above)
                         workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
                         containerHostBatchBindMounts (Optional): [
                              (Optional){
                                 source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                                 isReadOnly: Boolean (Optional)
                             }
                         ]
                     }
                     resourceFiles (Optional): [
                          (Optional){
                             autoStorageContainerName: String (Optional)
                             storageContainerUrl: String (Optional)
                             httpUrl: String (Optional)
                             blobPrefix: String (Optional)
                             filePath: String (Optional)
                             fileMode: String (Optional)
                             identityReference (Optional): (recursive schema, see identityReference above)
                         }
                     ]
                     environmentSettings (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Optional)
                         }
                     ]
                     userIdentity (Optional): {
                         username: String (Optional)
                         autoUser (Optional): {
                             scope: String(task/pool) (Optional)
                             elevationLevel: String(nonadmin/admin) (Optional)
                         }
                     }
                     maxTaskRetryCount: Integer (Optional)
                     waitForSuccess: Boolean (Optional)
                 }
                 certificateReferences (Optional): [
                      (Optional){
                         thumbprint: String (Required)
                         thumbprintAlgorithm: String (Required)
                         storeLocation: String(currentuser/localmachine) (Optional)
                         storeName: String (Optional)
                         visibility (Optional): [
                             String(starttask/task/remoteuser) (Optional)
                         ]
                     }
                 ]
                 applicationPackageReferences (Optional): [
                      (Optional){
                         applicationId: String (Required)
                         version: String (Optional)
                     }
                 ]
                 userAccounts (Optional): [
                      (Optional){
                         name: String (Required)
                         password: String (Required)
                         elevationLevel: String(nonadmin/admin) (Optional)
                         linuxUserConfiguration (Optional): {
                             uid: Integer (Optional)
                             gid: Integer (Optional)
                             sshPrivateKey: String (Optional)
                         }
                         windowsUserConfiguration (Optional): {
                             loginMode: String(batch/interactive) (Optional)
                         }
                     }
                 ]
                 metadata (Optional): [
                      (Optional){
                         name: String (Required)
                         value: String (Required)
                     }
                 ]
                 mountConfiguration (Optional): [
                      (Optional){
                         azureBlobFileSystemConfiguration (Optional): {
                             accountName: String (Required)
                             containerName: String (Required)
                             accountKey: String (Optional)
                             sasKey: String (Optional)
                             blobfuseOptions: String (Optional)
                             relativeMountPath: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                         }
                         nfsMountConfiguration (Optional): {
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                         cifsMountConfiguration (Optional): {
                             username: String (Required)
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                             password: String (Required)
                         }
                         azureFileShareConfiguration (Optional): {
                             accountName: String (Required)
                             azureFileUrl: String (Required)
                             accountKey: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                     }
                 ]
                 targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                 upgradePolicy (Optional): {
                     mode: String(automatic/manual/rolling) (Required)
                     automaticOSUpgradePolicy (Optional): {
                         disableAutomaticRollback: Boolean (Optional)
                         enableAutomaticOSUpgrade: Boolean (Optional)
                         useRollingUpgradePolicy: Boolean (Optional)
                         osRollingUpgradeDeferral: Boolean (Optional)
                     }
                     rollingUpgradePolicy (Optional): {
                         enableCrossZoneUpgrade: Boolean (Optional)
                         maxBatchInstancePercent: Integer (Optional)
                         maxUnhealthyInstancePercent: Integer (Optional)
                         maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                         pauseTimeBetweenBatches: Duration (Optional)
                         prioritizeUnhealthyInstances: Boolean (Optional)
                         rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                     }
                 }
             }
         }
     }
     onAllTasksComplete: String(noaction/terminatejob) (Optional)
     metadata (Optional): [
         (recursive schema, see above)
     ]
     networkConfiguration (Optional): {
         subnetId: String (Required)
         skipWithdrawFromVNet: boolean (Required)
     }
 }
      Parameters:
      jobId - The ID of the Job whose properties you want to update.
      job - The options to use for updating the Job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • replaceJobWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> replaceJobWithResponse(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the properties of the specified Job. This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     usesTaskDependencies: Boolean (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     priority: Integer (Optional)
     allowTaskPreemption: Boolean (Optional)
     maxParallelTasks: Integer (Optional)
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     jobManagerTask (Optional): {
         id: String (Required)
         displayName: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         outputFiles (Optional): [
              (Optional){
                 filePattern: String (Required)
                 destination (Required): {
                     container (Optional): {
                         path: String (Optional)
                         containerUrl: String (Required)
                         identityReference (Optional): (recursive schema, see identityReference above)
                         uploadHeaders (Optional): [
                              (Optional){
                                 name: String (Required)
                                 value: String (Optional)
                             }
                         ]
                     }
                 }
                 uploadOptions (Required): {
                     uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                 }
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         requiredSlots: Integer (Optional)
         killJobOnCompletion: Boolean (Optional)
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         runExclusive: Boolean (Optional)
         applicationPackageReferences (Optional): [
              (Optional){
                 applicationId: String (Required)
                 version: String (Optional)
             }
         ]
         authenticationTokenSettings (Optional): {
             access (Optional): [
                 String(job) (Optional)
             ]
         }
         allowLowPriorityNode: Boolean (Optional)
     }
     jobPreparationTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         constraints (Optional): (recursive schema, see constraints above)
         waitForSuccess: Boolean (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
         rerunOnNodeRebootAfterSuccess: Boolean (Optional)
     }
     jobReleaseTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
     }
     commonEnvironmentSettings (Optional): [
         (recursive schema, see above)
     ]
     poolInfo (Required): {
         poolId: String (Optional)
         autoPoolSpecification (Optional): {
             autoPoolIdPrefix: String (Optional)
             poolLifetimeOption: String(jobschedule/job) (Required)
             keepAlive: Boolean (Optional)
             pool (Optional): {
                 displayName: String (Optional)
                 vmSize: String (Required)
                 virtualMachineConfiguration (Optional): {
                     imageReference (Required): {
                         publisher: String (Optional)
                         offer: String (Optional)
                         sku: String (Optional)
                         version: String (Optional)
                         virtualMachineImageId: String (Optional)
                         exactVersion: String (Optional)
                         sharedGalleryImageId: String (Optional)
                         communityGalleryImageId: String (Optional)
                     }
                     nodeAgentSKUId: String (Required)
                     windowsConfiguration (Optional): {
                         enableAutomaticUpdates: Boolean (Optional)
                     }
                     dataDisks (Optional): [
                          (Optional){
                             lun: int (Required)
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: int (Required)
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                         }
                     ]
                     licenseType: String (Optional)
                     containerConfiguration (Optional): {
                         type: String(dockerCompatible/criCompatible) (Required)
                         containerImageNames (Optional): [
                             String (Optional)
                         ]
                         containerRegistries (Optional): [
                             (recursive schema, see above)
                         ]
                     }
                     diskEncryptionConfiguration (Optional): {
                         targets (Optional): [
                             String(osdisk/temporarydisk) (Optional)
                         ]
                     }
                     nodePlacementConfiguration (Optional): {
                         policy: String(regional/zonal) (Optional)
                     }
                     extensions (Optional): [
                          (Optional){
                             name: String (Required)
                             publisher: String (Required)
                             type: String (Required)
                             typeHandlerVersion: String (Optional)
                             autoUpgradeMinorVersion: Boolean (Optional)
                             enableAutomaticUpgrade: Boolean (Optional)
                             settings (Optional): {
                                 String: String (Required)
                             }
                             protectedSettings (Optional): {
                                 String: String (Required)
                             }
                             provisionAfterExtensions (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                     osDisk (Optional): {
                         ephemeralOSDiskSettings (Optional): {
                             placement: String(cachedisk) (Optional)
                         }
                         caching: String(none/readonly/readwrite) (Optional)
                         diskSizeGB: Integer (Optional)
                         managedDisk (Optional): {
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             securityProfile (Optional): {
                                 securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                             }
                         }
                         writeAcceleratorEnabled: Boolean (Optional)
                     }
                     securityProfile (Optional): {
                         encryptionAtHost: boolean (Required)
                         securityType: String(trustedLaunch/confidentialVM) (Required)
                         uefiSettings (Required): {
                             secureBootEnabled: Boolean (Optional)
                             vTpmEnabled: Boolean (Optional)
                         }
                     }
                     serviceArtifactReference (Optional): {
                         id: String (Required)
                     }
                 }
                 taskSlotsPerNode: Integer (Optional)
                 taskSchedulingPolicy (Optional): {
                     nodeFillType: String(spread/pack) (Required)
                 }
                 resizeTimeout: Duration (Optional)
                 resourceTags: String (Optional)
                 targetDedicatedNodes: Integer (Optional)
                 targetLowPriorityNodes: Integer (Optional)
                 enableAutoScale: Boolean (Optional)
                 autoScaleFormula: String (Optional)
                 autoScaleEvaluationInterval: Duration (Optional)
                 enableInterNodeCommunication: Boolean (Optional)
                 networkConfiguration (Optional): {
                     subnetId: String (Optional)
                     dynamicVNetAssignmentScope: String(none/job) (Optional)
                     endpointConfiguration (Optional): {
                         inboundNATPools (Required): [
                              (Required){
                                 name: String (Required)
                                 protocol: String(tcp/udp) (Required)
                                 backendPort: int (Required)
                                 frontendPortRangeStart: int (Required)
                                 frontendPortRangeEnd: int (Required)
                                 networkSecurityGroupRules (Optional): [
                                      (Optional){
                                         priority: int (Required)
                                         access: String(allow/deny) (Required)
                                         sourceAddressPrefix: String (Required)
                                         sourcePortRanges (Optional): [
                                             String (Optional)
                                         ]
                                     }
                                 ]
                             }
                         ]
                     }
                     publicIPAddressConfiguration (Optional): {
                         provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                         ipAddressIds (Optional): [
                             String (Optional)
                         ]
                     }
                     enableAcceleratedNetworking: Boolean (Optional)
                 }
                 startTask (Optional): {
                     commandLine: String (Required)
                     containerSettings (Optional): (recursive schema, see containerSettings above)
                     resourceFiles (Optional): [
                         (recursive schema, see above)
                     ]
                     environmentSettings (Optional): [
                         (recursive schema, see above)
                     ]
                     userIdentity (Optional): (recursive schema, see userIdentity above)
                     maxTaskRetryCount: Integer (Optional)
                     waitForSuccess: Boolean (Optional)
                 }
                 certificateReferences (Optional): [
                      (Optional){
                         thumbprint: String (Required)
                         thumbprintAlgorithm: String (Required)
                         storeLocation: String(currentuser/localmachine) (Optional)
                         storeName: String (Optional)
                         visibility (Optional): [
                             String(starttask/task/remoteuser) (Optional)
                         ]
                     }
                 ]
                 applicationPackageReferences (Optional): [
                     (recursive schema, see above)
                 ]
                 userAccounts (Optional): [
                      (Optional){
                         name: String (Required)
                         password: String (Required)
                         elevationLevel: String(nonadmin/admin) (Optional)
                         linuxUserConfiguration (Optional): {
                             uid: Integer (Optional)
                             gid: Integer (Optional)
                             sshPrivateKey: String (Optional)
                         }
                         windowsUserConfiguration (Optional): {
                             loginMode: String(batch/interactive) (Optional)
                         }
                     }
                 ]
                 metadata (Optional): [
                      (Optional){
                         name: String (Required)
                         value: String (Required)
                     }
                 ]
                 mountConfiguration (Optional): [
                      (Optional){
                         azureBlobFileSystemConfiguration (Optional): {
                             accountName: String (Required)
                             containerName: String (Required)
                             accountKey: String (Optional)
                             sasKey: String (Optional)
                             blobfuseOptions: String (Optional)
                             relativeMountPath: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                         }
                         nfsMountConfiguration (Optional): {
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                         cifsMountConfiguration (Optional): {
                             username: String (Required)
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                             password: String (Required)
                         }
                         azureFileShareConfiguration (Optional): {
                             accountName: String (Required)
                             azureFileUrl: String (Required)
                             accountKey: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                     }
                 ]
                 targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                 upgradePolicy (Optional): {
                     mode: String(automatic/manual/rolling) (Required)
                     automaticOSUpgradePolicy (Optional): {
                         disableAutomaticRollback: Boolean (Optional)
                         enableAutomaticOSUpgrade: Boolean (Optional)
                         useRollingUpgradePolicy: Boolean (Optional)
                         osRollingUpgradeDeferral: Boolean (Optional)
                     }
                     rollingUpgradePolicy (Optional): {
                         enableCrossZoneUpgrade: Boolean (Optional)
                         maxBatchInstancePercent: Integer (Optional)
                         maxUnhealthyInstancePercent: Integer (Optional)
                         maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                         pauseTimeBetweenBatches: Duration (Optional)
                         prioritizeUnhealthyInstances: Boolean (Optional)
                         rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                     }
                 }
             }
         }
     }
     onAllTasksComplete: String(noaction/terminatejob) (Optional)
     onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Required)
         skipWithdrawFromVNet: boolean (Required)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
     executionInfo (Optional): {
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         poolId: String (Optional)
         schedulingError (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         terminateReason: String (Optional)
     }
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         numSucceededTasks: long (Required)
         numFailedTasks: long (Required)
         numTaskRetries: long (Required)
         waitTime: Duration (Required)
     }
 }
      Parameters:
      jobId - The ID of the Job whose properties you want to update.
      job - A job with updated properties.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • disableJobWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> disableJobWithResponse(String jobId, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
      Disables the specified Job, preventing new Tasks from running. The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     disableTasks: String(requeue/terminate/wait) (Required)
 }
      Parameters:
      jobId - The ID of the Job to disable.
      content - The options to use for disabling the Job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • enableJobWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> enableJobWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Enables the specified Job, allowing new Tasks to run. When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobId - The ID of the Job to enable.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • terminateJobWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> terminateJobWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Terminates the specified Job, marking it as completed. When a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      forceBooleanNoIf true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination. The default value is false.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      Content-TypeStringNoThe content type. Allowed values: "application/json; odata=minimalmetadata".
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     terminateReason: String (Optional)
 }
      Parameters:
      jobId - The ID of the Job to terminate.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createJobWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> createJobWithResponse(com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates a Job to the specified Account. The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Required)
     displayName: String (Optional)
     usesTaskDependencies: Boolean (Optional)
     priority: Integer (Optional)
     allowTaskPreemption: Boolean (Optional)
     maxParallelTasks: Integer (Optional)
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     jobManagerTask (Optional): {
         id: String (Required)
         displayName: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         outputFiles (Optional): [
              (Optional){
                 filePattern: String (Required)
                 destination (Required): {
                     container (Optional): {
                         path: String (Optional)
                         containerUrl: String (Required)
                         identityReference (Optional): (recursive schema, see identityReference above)
                         uploadHeaders (Optional): [
                              (Optional){
                                 name: String (Required)
                                 value: String (Optional)
                             }
                         ]
                     }
                 }
                 uploadOptions (Required): {
                     uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                 }
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         requiredSlots: Integer (Optional)
         killJobOnCompletion: Boolean (Optional)
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         runExclusive: Boolean (Optional)
         applicationPackageReferences (Optional): [
              (Optional){
                 applicationId: String (Required)
                 version: String (Optional)
             }
         ]
         authenticationTokenSettings (Optional): {
             access (Optional): [
                 String(job) (Optional)
             ]
         }
         allowLowPriorityNode: Boolean (Optional)
     }
     jobPreparationTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         constraints (Optional): (recursive schema, see constraints above)
         waitForSuccess: Boolean (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
         rerunOnNodeRebootAfterSuccess: Boolean (Optional)
     }
     jobReleaseTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
     }
     commonEnvironmentSettings (Optional): [
         (recursive schema, see above)
     ]
     poolInfo (Required): {
         poolId: String (Optional)
         autoPoolSpecification (Optional): {
             autoPoolIdPrefix: String (Optional)
             poolLifetimeOption: String(jobschedule/job) (Required)
             keepAlive: Boolean (Optional)
             pool (Optional): {
                 displayName: String (Optional)
                 vmSize: String (Required)
                 virtualMachineConfiguration (Optional): {
                     imageReference (Required): {
                         publisher: String (Optional)
                         offer: String (Optional)
                         sku: String (Optional)
                         version: String (Optional)
                         virtualMachineImageId: String (Optional)
                         exactVersion: String (Optional)
                         sharedGalleryImageId: String (Optional)
                         communityGalleryImageId: String (Optional)
                     }
                     nodeAgentSKUId: String (Required)
                     windowsConfiguration (Optional): {
                         enableAutomaticUpdates: Boolean (Optional)
                     }
                     dataDisks (Optional): [
                          (Optional){
                             lun: int (Required)
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: int (Required)
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                         }
                     ]
                     licenseType: String (Optional)
                     containerConfiguration (Optional): {
                         type: String(dockerCompatible/criCompatible) (Required)
                         containerImageNames (Optional): [
                             String (Optional)
                         ]
                         containerRegistries (Optional): [
                             (recursive schema, see above)
                         ]
                     }
                     diskEncryptionConfiguration (Optional): {
                         targets (Optional): [
                             String(osdisk/temporarydisk) (Optional)
                         ]
                     }
                     nodePlacementConfiguration (Optional): {
                         policy: String(regional/zonal) (Optional)
                     }
                     extensions (Optional): [
                          (Optional){
                             name: String (Required)
                             publisher: String (Required)
                             type: String (Required)
                             typeHandlerVersion: String (Optional)
                             autoUpgradeMinorVersion: Boolean (Optional)
                             enableAutomaticUpgrade: Boolean (Optional)
                             settings (Optional): {
                                 String: String (Required)
                             }
                             protectedSettings (Optional): {
                                 String: String (Required)
                             }
                             provisionAfterExtensions (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                     osDisk (Optional): {
                         ephemeralOSDiskSettings (Optional): {
                             placement: String(cachedisk) (Optional)
                         }
                         caching: String(none/readonly/readwrite) (Optional)
                         diskSizeGB: Integer (Optional)
                         managedDisk (Optional): {
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             securityProfile (Optional): {
                                 securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                             }
                         }
                         writeAcceleratorEnabled: Boolean (Optional)
                     }
                     securityProfile (Optional): {
                         encryptionAtHost: boolean (Required)
                         securityType: String(trustedLaunch/confidentialVM) (Required)
                         uefiSettings (Required): {
                             secureBootEnabled: Boolean (Optional)
                             vTpmEnabled: Boolean (Optional)
                         }
                     }
                     serviceArtifactReference (Optional): {
                         id: String (Required)
                     }
                 }
                 taskSlotsPerNode: Integer (Optional)
                 taskSchedulingPolicy (Optional): {
                     nodeFillType: String(spread/pack) (Required)
                 }
                 resizeTimeout: Duration (Optional)
                 resourceTags: String (Optional)
                 targetDedicatedNodes: Integer (Optional)
                 targetLowPriorityNodes: Integer (Optional)
                 enableAutoScale: Boolean (Optional)
                 autoScaleFormula: String (Optional)
                 autoScaleEvaluationInterval: Duration (Optional)
                 enableInterNodeCommunication: Boolean (Optional)
                 networkConfiguration (Optional): {
                     subnetId: String (Optional)
                     dynamicVNetAssignmentScope: String(none/job) (Optional)
                     endpointConfiguration (Optional): {
                         inboundNATPools (Required): [
                              (Required){
                                 name: String (Required)
                                 protocol: String(tcp/udp) (Required)
                                 backendPort: int (Required)
                                 frontendPortRangeStart: int (Required)
                                 frontendPortRangeEnd: int (Required)
                                 networkSecurityGroupRules (Optional): [
                                      (Optional){
                                         priority: int (Required)
                                         access: String(allow/deny) (Required)
                                         sourceAddressPrefix: String (Required)
                                         sourcePortRanges (Optional): [
                                             String (Optional)
                                         ]
                                     }
                                 ]
                             }
                         ]
                     }
                     publicIPAddressConfiguration (Optional): {
                         provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                         ipAddressIds (Optional): [
                             String (Optional)
                         ]
                     }
                     enableAcceleratedNetworking: Boolean (Optional)
                 }
                 startTask (Optional): {
                     commandLine: String (Required)
                     containerSettings (Optional): (recursive schema, see containerSettings above)
                     resourceFiles (Optional): [
                         (recursive schema, see above)
                     ]
                     environmentSettings (Optional): [
                         (recursive schema, see above)
                     ]
                     userIdentity (Optional): (recursive schema, see userIdentity above)
                     maxTaskRetryCount: Integer (Optional)
                     waitForSuccess: Boolean (Optional)
                 }
                 certificateReferences (Optional): [
                      (Optional){
                         thumbprint: String (Required)
                         thumbprintAlgorithm: String (Required)
                         storeLocation: String(currentuser/localmachine) (Optional)
                         storeName: String (Optional)
                         visibility (Optional): [
                             String(starttask/task/remoteuser) (Optional)
                         ]
                     }
                 ]
                 applicationPackageReferences (Optional): [
                     (recursive schema, see above)
                 ]
                 userAccounts (Optional): [
                      (Optional){
                         name: String (Required)
                         password: String (Required)
                         elevationLevel: String(nonadmin/admin) (Optional)
                         linuxUserConfiguration (Optional): {
                             uid: Integer (Optional)
                             gid: Integer (Optional)
                             sshPrivateKey: String (Optional)
                         }
                         windowsUserConfiguration (Optional): {
                             loginMode: String(batch/interactive) (Optional)
                         }
                     }
                 ]
                 metadata (Optional): [
                      (Optional){
                         name: String (Required)
                         value: String (Required)
                     }
                 ]
                 mountConfiguration (Optional): [
                      (Optional){
                         azureBlobFileSystemConfiguration (Optional): {
                             accountName: String (Required)
                             containerName: String (Required)
                             accountKey: String (Optional)
                             sasKey: String (Optional)
                             blobfuseOptions: String (Optional)
                             relativeMountPath: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                         }
                         nfsMountConfiguration (Optional): {
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                         cifsMountConfiguration (Optional): {
                             username: String (Required)
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                             password: String (Required)
                         }
                         azureFileShareConfiguration (Optional): {
                             accountName: String (Required)
                             azureFileUrl: String (Required)
                             accountKey: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                     }
                 ]
                 targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                 upgradePolicy (Optional): {
                     mode: String(automatic/manual/rolling) (Required)
                     automaticOSUpgradePolicy (Optional): {
                         disableAutomaticRollback: Boolean (Optional)
                         enableAutomaticOSUpgrade: Boolean (Optional)
                         useRollingUpgradePolicy: Boolean (Optional)
                         osRollingUpgradeDeferral: Boolean (Optional)
                     }
                     rollingUpgradePolicy (Optional): {
                         enableCrossZoneUpgrade: Boolean (Optional)
                         maxBatchInstancePercent: Integer (Optional)
                         maxUnhealthyInstancePercent: Integer (Optional)
                         maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                         pauseTimeBetweenBatches: Duration (Optional)
                         prioritizeUnhealthyInstances: Boolean (Optional)
                         rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                     }
                 }
             }
         }
     }
     onAllTasksComplete: String(noaction/terminatejob) (Optional)
     onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Required)
         skipWithdrawFromVNet: boolean (Required)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
 }
      Parameters:
      job - The Job to be created.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listJobs

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listJobs(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the Jobs in the specified Account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     usesTaskDependencies: Boolean (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     priority: Integer (Optional)
     allowTaskPreemption: Boolean (Optional)
     maxParallelTasks: Integer (Optional)
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     jobManagerTask (Optional): {
         id: String (Required)
         displayName: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         outputFiles (Optional): [
              (Optional){
                 filePattern: String (Required)
                 destination (Required): {
                     container (Optional): {
                         path: String (Optional)
                         containerUrl: String (Required)
                         identityReference (Optional): (recursive schema, see identityReference above)
                         uploadHeaders (Optional): [
                              (Optional){
                                 name: String (Required)
                                 value: String (Optional)
                             }
                         ]
                     }
                 }
                 uploadOptions (Required): {
                     uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                 }
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         requiredSlots: Integer (Optional)
         killJobOnCompletion: Boolean (Optional)
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         runExclusive: Boolean (Optional)
         applicationPackageReferences (Optional): [
              (Optional){
                 applicationId: String (Required)
                 version: String (Optional)
             }
         ]
         authenticationTokenSettings (Optional): {
             access (Optional): [
                 String(job) (Optional)
             ]
         }
         allowLowPriorityNode: Boolean (Optional)
     }
     jobPreparationTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         constraints (Optional): (recursive schema, see constraints above)
         waitForSuccess: Boolean (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
         rerunOnNodeRebootAfterSuccess: Boolean (Optional)
     }
     jobReleaseTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
     }
     commonEnvironmentSettings (Optional): [
         (recursive schema, see above)
     ]
     poolInfo (Required): {
         poolId: String (Optional)
         autoPoolSpecification (Optional): {
             autoPoolIdPrefix: String (Optional)
             poolLifetimeOption: String(jobschedule/job) (Required)
             keepAlive: Boolean (Optional)
             pool (Optional): {
                 displayName: String (Optional)
                 vmSize: String (Required)
                 virtualMachineConfiguration (Optional): {
                     imageReference (Required): {
                         publisher: String (Optional)
                         offer: String (Optional)
                         sku: String (Optional)
                         version: String (Optional)
                         virtualMachineImageId: String (Optional)
                         exactVersion: String (Optional)
                         sharedGalleryImageId: String (Optional)
                         communityGalleryImageId: String (Optional)
                     }
                     nodeAgentSKUId: String (Required)
                     windowsConfiguration (Optional): {
                         enableAutomaticUpdates: Boolean (Optional)
                     }
                     dataDisks (Optional): [
                          (Optional){
                             lun: int (Required)
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: int (Required)
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                         }
                     ]
                     licenseType: String (Optional)
                     containerConfiguration (Optional): {
                         type: String(dockerCompatible/criCompatible) (Required)
                         containerImageNames (Optional): [
                             String (Optional)
                         ]
                         containerRegistries (Optional): [
                             (recursive schema, see above)
                         ]
                     }
                     diskEncryptionConfiguration (Optional): {
                         targets (Optional): [
                             String(osdisk/temporarydisk) (Optional)
                         ]
                     }
                     nodePlacementConfiguration (Optional): {
                         policy: String(regional/zonal) (Optional)
                     }
                     extensions (Optional): [
                          (Optional){
                             name: String (Required)
                             publisher: String (Required)
                             type: String (Required)
                             typeHandlerVersion: String (Optional)
                             autoUpgradeMinorVersion: Boolean (Optional)
                             enableAutomaticUpgrade: Boolean (Optional)
                             settings (Optional): {
                                 String: String (Required)
                             }
                             protectedSettings (Optional): {
                                 String: String (Required)
                             }
                             provisionAfterExtensions (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                     osDisk (Optional): {
                         ephemeralOSDiskSettings (Optional): {
                             placement: String(cachedisk) (Optional)
                         }
                         caching: String(none/readonly/readwrite) (Optional)
                         diskSizeGB: Integer (Optional)
                         managedDisk (Optional): {
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             securityProfile (Optional): {
                                 securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                             }
                         }
                         writeAcceleratorEnabled: Boolean (Optional)
                     }
                     securityProfile (Optional): {
                         encryptionAtHost: boolean (Required)
                         securityType: String(trustedLaunch/confidentialVM) (Required)
                         uefiSettings (Required): {
                             secureBootEnabled: Boolean (Optional)
                             vTpmEnabled: Boolean (Optional)
                         }
                     }
                     serviceArtifactReference (Optional): {
                         id: String (Required)
                     }
                 }
                 taskSlotsPerNode: Integer (Optional)
                 taskSchedulingPolicy (Optional): {
                     nodeFillType: String(spread/pack) (Required)
                 }
                 resizeTimeout: Duration (Optional)
                 resourceTags: String (Optional)
                 targetDedicatedNodes: Integer (Optional)
                 targetLowPriorityNodes: Integer (Optional)
                 enableAutoScale: Boolean (Optional)
                 autoScaleFormula: String (Optional)
                 autoScaleEvaluationInterval: Duration (Optional)
                 enableInterNodeCommunication: Boolean (Optional)
                 networkConfiguration (Optional): {
                     subnetId: String (Optional)
                     dynamicVNetAssignmentScope: String(none/job) (Optional)
                     endpointConfiguration (Optional): {
                         inboundNATPools (Required): [
                              (Required){
                                 name: String (Required)
                                 protocol: String(tcp/udp) (Required)
                                 backendPort: int (Required)
                                 frontendPortRangeStart: int (Required)
                                 frontendPortRangeEnd: int (Required)
                                 networkSecurityGroupRules (Optional): [
                                      (Optional){
                                         priority: int (Required)
                                         access: String(allow/deny) (Required)
                                         sourceAddressPrefix: String (Required)
                                         sourcePortRanges (Optional): [
                                             String (Optional)
                                         ]
                                     }
                                 ]
                             }
                         ]
                     }
                     publicIPAddressConfiguration (Optional): {
                         provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                         ipAddressIds (Optional): [
                             String (Optional)
                         ]
                     }
                     enableAcceleratedNetworking: Boolean (Optional)
                 }
                 startTask (Optional): {
                     commandLine: String (Required)
                     containerSettings (Optional): (recursive schema, see containerSettings above)
                     resourceFiles (Optional): [
                         (recursive schema, see above)
                     ]
                     environmentSettings (Optional): [
                         (recursive schema, see above)
                     ]
                     userIdentity (Optional): (recursive schema, see userIdentity above)
                     maxTaskRetryCount: Integer (Optional)
                     waitForSuccess: Boolean (Optional)
                 }
                 certificateReferences (Optional): [
                      (Optional){
                         thumbprint: String (Required)
                         thumbprintAlgorithm: String (Required)
                         storeLocation: String(currentuser/localmachine) (Optional)
                         storeName: String (Optional)
                         visibility (Optional): [
                             String(starttask/task/remoteuser) (Optional)
                         ]
                     }
                 ]
                 applicationPackageReferences (Optional): [
                     (recursive schema, see above)
                 ]
                 userAccounts (Optional): [
                      (Optional){
                         name: String (Required)
                         password: String (Required)
                         elevationLevel: String(nonadmin/admin) (Optional)
                         linuxUserConfiguration (Optional): {
                             uid: Integer (Optional)
                             gid: Integer (Optional)
                             sshPrivateKey: String (Optional)
                         }
                         windowsUserConfiguration (Optional): {
                             loginMode: String(batch/interactive) (Optional)
                         }
                     }
                 ]
                 metadata (Optional): [
                      (Optional){
                         name: String (Required)
                         value: String (Required)
                     }
                 ]
                 mountConfiguration (Optional): [
                      (Optional){
                         azureBlobFileSystemConfiguration (Optional): {
                             accountName: String (Required)
                             containerName: String (Required)
                             accountKey: String (Optional)
                             sasKey: String (Optional)
                             blobfuseOptions: String (Optional)
                             relativeMountPath: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                         }
                         nfsMountConfiguration (Optional): {
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                         cifsMountConfiguration (Optional): {
                             username: String (Required)
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                             password: String (Required)
                         }
                         azureFileShareConfiguration (Optional): {
                             accountName: String (Required)
                             azureFileUrl: String (Required)
                             accountKey: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                     }
                 ]
                 targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                 upgradePolicy (Optional): {
                     mode: String(automatic/manual/rolling) (Required)
                     automaticOSUpgradePolicy (Optional): {
                         disableAutomaticRollback: Boolean (Optional)
                         enableAutomaticOSUpgrade: Boolean (Optional)
                         useRollingUpgradePolicy: Boolean (Optional)
                         osRollingUpgradeDeferral: Boolean (Optional)
                     }
                     rollingUpgradePolicy (Optional): {
                         enableCrossZoneUpgrade: Boolean (Optional)
                         maxBatchInstancePercent: Integer (Optional)
                         maxUnhealthyInstancePercent: Integer (Optional)
                         maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                         pauseTimeBetweenBatches: Duration (Optional)
                         prioritizeUnhealthyInstances: Boolean (Optional)
                         rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                     }
                 }
             }
         }
     }
     onAllTasksComplete: String(noaction/terminatejob) (Optional)
     onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Required)
         skipWithdrawFromVNet: boolean (Required)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
     executionInfo (Optional): {
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         poolId: String (Optional)
         schedulingError (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         terminateReason: String (Optional)
     }
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         numSucceededTasks: long (Required)
         numFailedTasks: long (Required)
         numTaskRetries: long (Required)
         waitTime: Duration (Required)
     }
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Jobs in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listJobsFromSchedule

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listJobsFromSchedule(String jobScheduleId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the Jobs that have been created under the specified Job Schedule.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     usesTaskDependencies: Boolean (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/disabling/disabled/enabling/terminating/completed/deleting) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     priority: Integer (Optional)
     allowTaskPreemption: Boolean (Optional)
     maxParallelTasks: Integer (Optional)
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     jobManagerTask (Optional): {
         id: String (Required)
         displayName: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         outputFiles (Optional): [
              (Optional){
                 filePattern: String (Required)
                 destination (Required): {
                     container (Optional): {
                         path: String (Optional)
                         containerUrl: String (Required)
                         identityReference (Optional): (recursive schema, see identityReference above)
                         uploadHeaders (Optional): [
                              (Optional){
                                 name: String (Required)
                                 value: String (Optional)
                             }
                         ]
                     }
                 }
                 uploadOptions (Required): {
                     uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                 }
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         requiredSlots: Integer (Optional)
         killJobOnCompletion: Boolean (Optional)
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         runExclusive: Boolean (Optional)
         applicationPackageReferences (Optional): [
              (Optional){
                 applicationId: String (Required)
                 version: String (Optional)
             }
         ]
         authenticationTokenSettings (Optional): {
             access (Optional): [
                 String(job) (Optional)
             ]
         }
         allowLowPriorityNode: Boolean (Optional)
     }
     jobPreparationTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         constraints (Optional): (recursive schema, see constraints above)
         waitForSuccess: Boolean (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
         rerunOnNodeRebootAfterSuccess: Boolean (Optional)
     }
     jobReleaseTask (Optional): {
         id: String (Optional)
         commandLine: String (Required)
         containerSettings (Optional): (recursive schema, see containerSettings above)
         resourceFiles (Optional): [
             (recursive schema, see above)
         ]
         environmentSettings (Optional): [
             (recursive schema, see above)
         ]
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         userIdentity (Optional): (recursive schema, see userIdentity above)
     }
     commonEnvironmentSettings (Optional): [
         (recursive schema, see above)
     ]
     poolInfo (Required): {
         poolId: String (Optional)
         autoPoolSpecification (Optional): {
             autoPoolIdPrefix: String (Optional)
             poolLifetimeOption: String(jobschedule/job) (Required)
             keepAlive: Boolean (Optional)
             pool (Optional): {
                 displayName: String (Optional)
                 vmSize: String (Required)
                 virtualMachineConfiguration (Optional): {
                     imageReference (Required): {
                         publisher: String (Optional)
                         offer: String (Optional)
                         sku: String (Optional)
                         version: String (Optional)
                         virtualMachineImageId: String (Optional)
                         exactVersion: String (Optional)
                         sharedGalleryImageId: String (Optional)
                         communityGalleryImageId: String (Optional)
                     }
                     nodeAgentSKUId: String (Required)
                     windowsConfiguration (Optional): {
                         enableAutomaticUpdates: Boolean (Optional)
                     }
                     dataDisks (Optional): [
                          (Optional){
                             lun: int (Required)
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: int (Required)
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                         }
                     ]
                     licenseType: String (Optional)
                     containerConfiguration (Optional): {
                         type: String(dockerCompatible/criCompatible) (Required)
                         containerImageNames (Optional): [
                             String (Optional)
                         ]
                         containerRegistries (Optional): [
                             (recursive schema, see above)
                         ]
                     }
                     diskEncryptionConfiguration (Optional): {
                         targets (Optional): [
                             String(osdisk/temporarydisk) (Optional)
                         ]
                     }
                     nodePlacementConfiguration (Optional): {
                         policy: String(regional/zonal) (Optional)
                     }
                     extensions (Optional): [
                          (Optional){
                             name: String (Required)
                             publisher: String (Required)
                             type: String (Required)
                             typeHandlerVersion: String (Optional)
                             autoUpgradeMinorVersion: Boolean (Optional)
                             enableAutomaticUpgrade: Boolean (Optional)
                             settings (Optional): {
                                 String: String (Required)
                             }
                             protectedSettings (Optional): {
                                 String: String (Required)
                             }
                             provisionAfterExtensions (Optional): [
                                 String (Optional)
                             ]
                         }
                     ]
                     osDisk (Optional): {
                         ephemeralOSDiskSettings (Optional): {
                             placement: String(cachedisk) (Optional)
                         }
                         caching: String(none/readonly/readwrite) (Optional)
                         diskSizeGB: Integer (Optional)
                         managedDisk (Optional): {
                             storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             securityProfile (Optional): {
                                 securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                             }
                         }
                         writeAcceleratorEnabled: Boolean (Optional)
                     }
                     securityProfile (Optional): {
                         encryptionAtHost: boolean (Required)
                         securityType: String(trustedLaunch/confidentialVM) (Required)
                         uefiSettings (Required): {
                             secureBootEnabled: Boolean (Optional)
                             vTpmEnabled: Boolean (Optional)
                         }
                     }
                     serviceArtifactReference (Optional): {
                         id: String (Required)
                     }
                 }
                 taskSlotsPerNode: Integer (Optional)
                 taskSchedulingPolicy (Optional): {
                     nodeFillType: String(spread/pack) (Required)
                 }
                 resizeTimeout: Duration (Optional)
                 resourceTags: String (Optional)
                 targetDedicatedNodes: Integer (Optional)
                 targetLowPriorityNodes: Integer (Optional)
                 enableAutoScale: Boolean (Optional)
                 autoScaleFormula: String (Optional)
                 autoScaleEvaluationInterval: Duration (Optional)
                 enableInterNodeCommunication: Boolean (Optional)
                 networkConfiguration (Optional): {
                     subnetId: String (Optional)
                     dynamicVNetAssignmentScope: String(none/job) (Optional)
                     endpointConfiguration (Optional): {
                         inboundNATPools (Required): [
                              (Required){
                                 name: String (Required)
                                 protocol: String(tcp/udp) (Required)
                                 backendPort: int (Required)
                                 frontendPortRangeStart: int (Required)
                                 frontendPortRangeEnd: int (Required)
                                 networkSecurityGroupRules (Optional): [
                                      (Optional){
                                         priority: int (Required)
                                         access: String(allow/deny) (Required)
                                         sourceAddressPrefix: String (Required)
                                         sourcePortRanges (Optional): [
                                             String (Optional)
                                         ]
                                     }
                                 ]
                             }
                         ]
                     }
                     publicIPAddressConfiguration (Optional): {
                         provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                         ipAddressIds (Optional): [
                             String (Optional)
                         ]
                     }
                     enableAcceleratedNetworking: Boolean (Optional)
                 }
                 startTask (Optional): {
                     commandLine: String (Required)
                     containerSettings (Optional): (recursive schema, see containerSettings above)
                     resourceFiles (Optional): [
                         (recursive schema, see above)
                     ]
                     environmentSettings (Optional): [
                         (recursive schema, see above)
                     ]
                     userIdentity (Optional): (recursive schema, see userIdentity above)
                     maxTaskRetryCount: Integer (Optional)
                     waitForSuccess: Boolean (Optional)
                 }
                 certificateReferences (Optional): [
                      (Optional){
                         thumbprint: String (Required)
                         thumbprintAlgorithm: String (Required)
                         storeLocation: String(currentuser/localmachine) (Optional)
                         storeName: String (Optional)
                         visibility (Optional): [
                             String(starttask/task/remoteuser) (Optional)
                         ]
                     }
                 ]
                 applicationPackageReferences (Optional): [
                     (recursive schema, see above)
                 ]
                 userAccounts (Optional): [
                      (Optional){
                         name: String (Required)
                         password: String (Required)
                         elevationLevel: String(nonadmin/admin) (Optional)
                         linuxUserConfiguration (Optional): {
                             uid: Integer (Optional)
                             gid: Integer (Optional)
                             sshPrivateKey: String (Optional)
                         }
                         windowsUserConfiguration (Optional): {
                             loginMode: String(batch/interactive) (Optional)
                         }
                     }
                 ]
                 metadata (Optional): [
                      (Optional){
                         name: String (Required)
                         value: String (Required)
                     }
                 ]
                 mountConfiguration (Optional): [
                      (Optional){
                         azureBlobFileSystemConfiguration (Optional): {
                             accountName: String (Required)
                             containerName: String (Required)
                             accountKey: String (Optional)
                             sasKey: String (Optional)
                             blobfuseOptions: String (Optional)
                             relativeMountPath: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                         }
                         nfsMountConfiguration (Optional): {
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                         cifsMountConfiguration (Optional): {
                             username: String (Required)
                             source: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                             password: String (Required)
                         }
                         azureFileShareConfiguration (Optional): {
                             accountName: String (Required)
                             azureFileUrl: String (Required)
                             accountKey: String (Required)
                             relativeMountPath: String (Required)
                             mountOptions: String (Optional)
                         }
                     }
                 ]
                 targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                 upgradePolicy (Optional): {
                     mode: String(automatic/manual/rolling) (Required)
                     automaticOSUpgradePolicy (Optional): {
                         disableAutomaticRollback: Boolean (Optional)
                         enableAutomaticOSUpgrade: Boolean (Optional)
                         useRollingUpgradePolicy: Boolean (Optional)
                         osRollingUpgradeDeferral: Boolean (Optional)
                     }
                     rollingUpgradePolicy (Optional): {
                         enableCrossZoneUpgrade: Boolean (Optional)
                         maxBatchInstancePercent: Integer (Optional)
                         maxUnhealthyInstancePercent: Integer (Optional)
                         maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                         pauseTimeBetweenBatches: Duration (Optional)
                         prioritizeUnhealthyInstances: Boolean (Optional)
                         rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                     }
                 }
             }
         }
     }
     onAllTasksComplete: String(noaction/terminatejob) (Optional)
     onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
     networkConfiguration (Optional): {
         subnetId: String (Required)
         skipWithdrawFromVNet: boolean (Required)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
     executionInfo (Optional): {
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         poolId: String (Optional)
         schedulingError (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         terminateReason: String (Optional)
     }
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         numSucceededTasks: long (Required)
         numFailedTasks: long (Required)
         numTaskRetries: long (Required)
         waitTime: Duration (Required)
     }
 }
      Parameters:
      jobScheduleId - The ID of the Job Schedule from which you want to get a list of Jobs.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Jobs in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listJobPreparationAndReleaseTaskStatus

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listJobPreparationAndReleaseTaskStatus(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run. This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     poolId: String (Optional)
     nodeId: String (Optional)
     nodeUrl: String (Optional)
     jobPreparationTaskExecutionInfo (Optional): {
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         state: String(running/completed) (Required)
         taskRootDirectory: String (Optional)
         taskRootDirectoryUrl: String (Optional)
         exitCode: Integer (Optional)
         containerInfo (Optional): {
             containerId: String (Optional)
             state: String (Optional)
             error: String (Optional)
         }
         failureInfo (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         retryCount: int (Required)
         lastRetryTime: OffsetDateTime (Optional)
         result: String(success/failure) (Optional)
     }
     jobReleaseTaskExecutionInfo (Optional): {
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         state: String(running/completed) (Required)
         taskRootDirectory: String (Optional)
         taskRootDirectoryUrl: String (Optional)
         exitCode: Integer (Optional)
         containerInfo (Optional): (recursive schema, see containerInfo above)
         failureInfo (Optional): (recursive schema, see failureInfo above)
         result: String(success/failure) (Optional)
     }
 }
      Parameters:
      jobId - The ID of the Job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the status of the Job Preparation and Job Release Tasks for a Job as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getJobTaskCountsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getJobTaskCountsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     taskCounts (Required): {
         active: int (Required)
         running: int (Required)
         completed: int (Required)
         succeeded: int (Required)
         failed: int (Required)
     }
     taskSlotCounts (Required): {
         active: int (Required)
         running: int (Required)
         completed: int (Required)
         succeeded: int (Required)
         failed: int (Required)
     }
 }
      Parameters:
      jobId - The ID of the Job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createCertificateWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> createCertificateWithResponse(com.azure.core.util.BinaryData certificate, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates a Certificate to the specified Account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     thumbprint: String (Required)
     thumbprintAlgorithm: String (Required)
     url: String (Optional)
     state: String(active/deleting/deletefailed) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/deleting/deletefailed) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     publicData: String (Optional)
     deleteCertificateError (Optional): {
         code: String (Optional)
         message: String (Optional)
         values (Optional): [
              (Optional){
                 name: String (Optional)
                 value: String (Optional)
             }
         ]
     }
     data: String (Required)
     certificateFormat: String(pfx/cer) (Optional)
     password: String (Optional)
 }
      Parameters:
      certificate - The Certificate to be created.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listCertificates

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listCertificates(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the Certificates that have been added to the specified Account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     thumbprint: String (Required)
     thumbprintAlgorithm: String (Required)
     url: String (Optional)
     state: String(active/deleting/deletefailed) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/deleting/deletefailed) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     publicData: String (Optional)
     deleteCertificateError (Optional): {
         code: String (Optional)
         message: String (Optional)
         values (Optional): [
              (Optional){
                 name: String (Optional)
                 value: String (Optional)
             }
         ]
     }
     data: String (Required)
     certificateFormat: String(pfx/cer) (Optional)
     password: String (Optional)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Certificates in the Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • cancelCertificateDeletionWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> cancelCertificateDeletionWithResponse(String thumbprintAlgorithm, String thumbprint, com.azure.core.http.rest.RequestOptions requestOptions)
      Cancels a failed deletion of a Certificate from the specified Account. If you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate being deleted.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteCertificateWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteCertificateWithResponse(String thumbprintAlgorithm, String thumbprint, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a Certificate from the specified Account. You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate to be deleted.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getCertificateWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getCertificateWithResponse(String thumbprintAlgorithm, String thumbprint, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Certificate.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     thumbprint: String (Required)
     thumbprintAlgorithm: String (Required)
     url: String (Optional)
     state: String(active/deleting/deletefailed) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/deleting/deletefailed) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     publicData: String (Optional)
     deleteCertificateError (Optional): {
         code: String (Optional)
         message: String (Optional)
         values (Optional): [
              (Optional){
                 name: String (Optional)
                 value: String (Optional)
             }
         ]
     }
 }
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate to get.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Certificate along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • jobScheduleExistsWithResponse

      public Mono<com.azure.core.http.rest.Response<Boolean>> jobScheduleExistsWithResponse(String jobScheduleId, com.azure.core.http.rest.RequestOptions requestOptions)
      Checks the specified Job Schedule exists.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 boolean
      Parameters:
      jobScheduleId - The ID of the Job Schedule which you want to check.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      whether resource exists along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteJobScheduleWithResponse(String jobScheduleId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a Job Schedule from the specified Account. When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      forceBooleanNoIf true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. The default value is false.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobScheduleId - The ID of the Job Schedule to delete.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getJobScheduleWithResponse(String jobScheduleId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Job Schedule.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/completed/disabled/terminating/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/completed/disabled/terminating/deleting) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     schedule (Optional): {
         doNotRunUntil: OffsetDateTime (Optional)
         doNotRunAfter: OffsetDateTime (Optional)
         startWindow: Duration (Optional)
         recurrenceInterval: Duration (Optional)
     }
     jobSpecification (Required): {
         priority: Integer (Optional)
         allowTaskPreemption: Boolean (Optional)
         maxParallelTasks: Integer (Optional)
         displayName: String (Optional)
         usesTaskDependencies: Boolean (Optional)
         onAllTasksComplete: String(noaction/terminatejob) (Optional)
         onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
         networkConfiguration (Optional): {
             subnetId: String (Required)
             skipWithdrawFromVNet: boolean (Required)
         }
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         jobManagerTask (Optional): {
             id: String (Required)
             displayName: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): {
                 containerRunOptions: String (Optional)
                 imageName: String (Required)
                 registry (Optional): {
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
                 workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
                 containerHostBatchBindMounts (Optional): [
                      (Optional){
                         source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                         isReadOnly: Boolean (Optional)
                     }
                 ]
             }
             resourceFiles (Optional): [
                  (Optional){
                     autoStorageContainerName: String (Optional)
                     storageContainerUrl: String (Optional)
                     httpUrl: String (Optional)
                     blobPrefix: String (Optional)
                     filePath: String (Optional)
                     fileMode: String (Optional)
                     identityReference (Optional): (recursive schema, see identityReference above)
                 }
             ]
             outputFiles (Optional): [
                  (Optional){
                     filePattern: String (Required)
                     destination (Required): {
                         container (Optional): {
                             path: String (Optional)
                             containerUrl: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                             uploadHeaders (Optional): [
                                  (Optional){
                                     name: String (Required)
                                     value: String (Optional)
                                 }
                             ]
                         }
                     }
                     uploadOptions (Required): {
                         uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                     }
                 }
             ]
             environmentSettings (Optional): [
                  (Optional){
                     name: String (Required)
                     value: String (Optional)
                 }
             ]
             constraints (Optional): {
                 maxWallClockTime: Duration (Optional)
                 retentionTime: Duration (Optional)
                 maxTaskRetryCount: Integer (Optional)
             }
             requiredSlots: Integer (Optional)
             killJobOnCompletion: Boolean (Optional)
             userIdentity (Optional): {
                 username: String (Optional)
                 autoUser (Optional): {
                     scope: String(task/pool) (Optional)
                     elevationLevel: String(nonadmin/admin) (Optional)
                 }
             }
             runExclusive: Boolean (Optional)
             applicationPackageReferences (Optional): [
                  (Optional){
                     applicationId: String (Required)
                     version: String (Optional)
                 }
             ]
             authenticationTokenSettings (Optional): {
                 access (Optional): [
                     String(job) (Optional)
                 ]
             }
             allowLowPriorityNode: Boolean (Optional)
         }
         jobPreparationTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             constraints (Optional): (recursive schema, see constraints above)
             waitForSuccess: Boolean (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
             rerunOnNodeRebootAfterSuccess: Boolean (Optional)
         }
         jobReleaseTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
         }
         commonEnvironmentSettings (Optional): [
             (recursive schema, see above)
         ]
         poolInfo (Required): {
             poolId: String (Optional)
             autoPoolSpecification (Optional): {
                 autoPoolIdPrefix: String (Optional)
                 poolLifetimeOption: String(jobschedule/job) (Required)
                 keepAlive: Boolean (Optional)
                 pool (Optional): {
                     displayName: String (Optional)
                     vmSize: String (Required)
                     virtualMachineConfiguration (Optional): {
                         imageReference (Required): {
                             publisher: String (Optional)
                             offer: String (Optional)
                             sku: String (Optional)
                             version: String (Optional)
                             virtualMachineImageId: String (Optional)
                             exactVersion: String (Optional)
                             sharedGalleryImageId: String (Optional)
                             communityGalleryImageId: String (Optional)
                         }
                         nodeAgentSKUId: String (Required)
                         windowsConfiguration (Optional): {
                             enableAutomaticUpdates: Boolean (Optional)
                         }
                         dataDisks (Optional): [
                              (Optional){
                                 lun: int (Required)
                                 caching: String(none/readonly/readwrite) (Optional)
                                 diskSizeGB: int (Required)
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             }
                         ]
                         licenseType: String (Optional)
                         containerConfiguration (Optional): {
                             type: String(dockerCompatible/criCompatible) (Required)
                             containerImageNames (Optional): [
                                 String (Optional)
                             ]
                             containerRegistries (Optional): [
                                 (recursive schema, see above)
                             ]
                         }
                         diskEncryptionConfiguration (Optional): {
                             targets (Optional): [
                                 String(osdisk/temporarydisk) (Optional)
                             ]
                         }
                         nodePlacementConfiguration (Optional): {
                             policy: String(regional/zonal) (Optional)
                         }
                         extensions (Optional): [
                              (Optional){
                                 name: String (Required)
                                 publisher: String (Required)
                                 type: String (Required)
                                 typeHandlerVersion: String (Optional)
                                 autoUpgradeMinorVersion: Boolean (Optional)
                                 enableAutomaticUpgrade: Boolean (Optional)
                                 settings (Optional): {
                                     String: String (Required)
                                 }
                                 protectedSettings (Optional): {
                                     String: String (Required)
                                 }
                                 provisionAfterExtensions (Optional): [
                                     String (Optional)
                                 ]
                             }
                         ]
                         osDisk (Optional): {
                             ephemeralOSDiskSettings (Optional): {
                                 placement: String(cachedisk) (Optional)
                             }
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: Integer (Optional)
                             managedDisk (Optional): {
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                                 securityProfile (Optional): {
                                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                                 }
                             }
                             writeAcceleratorEnabled: Boolean (Optional)
                         }
                         securityProfile (Optional): {
                             encryptionAtHost: boolean (Required)
                             securityType: String(trustedLaunch/confidentialVM) (Required)
                             uefiSettings (Required): {
                                 secureBootEnabled: Boolean (Optional)
                                 vTpmEnabled: Boolean (Optional)
                             }
                         }
                         serviceArtifactReference (Optional): {
                             id: String (Required)
                         }
                     }
                     taskSlotsPerNode: Integer (Optional)
                     taskSchedulingPolicy (Optional): {
                         nodeFillType: String(spread/pack) (Required)
                     }
                     resizeTimeout: Duration (Optional)
                     resourceTags: String (Optional)
                     targetDedicatedNodes: Integer (Optional)
                     targetLowPriorityNodes: Integer (Optional)
                     enableAutoScale: Boolean (Optional)
                     autoScaleFormula: String (Optional)
                     autoScaleEvaluationInterval: Duration (Optional)
                     enableInterNodeCommunication: Boolean (Optional)
                     networkConfiguration (Optional): {
                         subnetId: String (Optional)
                         dynamicVNetAssignmentScope: String(none/job) (Optional)
                         endpointConfiguration (Optional): {
                             inboundNATPools (Required): [
                                  (Required){
                                     name: String (Required)
                                     protocol: String(tcp/udp) (Required)
                                     backendPort: int (Required)
                                     frontendPortRangeStart: int (Required)
                                     frontendPortRangeEnd: int (Required)
                                     networkSecurityGroupRules (Optional): [
                                          (Optional){
                                             priority: int (Required)
                                             access: String(allow/deny) (Required)
                                             sourceAddressPrefix: String (Required)
                                             sourcePortRanges (Optional): [
                                                 String (Optional)
                                             ]
                                         }
                                     ]
                                 }
                             ]
                         }
                         publicIPAddressConfiguration (Optional): {
                             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                             ipAddressIds (Optional): [
                                 String (Optional)
                             ]
                         }
                         enableAcceleratedNetworking: Boolean (Optional)
                     }
                     startTask (Optional): {
                         commandLine: String (Required)
                         containerSettings (Optional): (recursive schema, see containerSettings above)
                         resourceFiles (Optional): [
                             (recursive schema, see above)
                         ]
                         environmentSettings (Optional): [
                             (recursive schema, see above)
                         ]
                         userIdentity (Optional): (recursive schema, see userIdentity above)
                         maxTaskRetryCount: Integer (Optional)
                         waitForSuccess: Boolean (Optional)
                     }
                     certificateReferences (Optional): [
                          (Optional){
                             thumbprint: String (Required)
                             thumbprintAlgorithm: String (Required)
                             storeLocation: String(currentuser/localmachine) (Optional)
                             storeName: String (Optional)
                             visibility (Optional): [
                                 String(starttask/task/remoteuser) (Optional)
                             ]
                         }
                     ]
                     applicationPackageReferences (Optional): [
                         (recursive schema, see above)
                     ]
                     userAccounts (Optional): [
                          (Optional){
                             name: String (Required)
                             password: String (Required)
                             elevationLevel: String(nonadmin/admin) (Optional)
                             linuxUserConfiguration (Optional): {
                                 uid: Integer (Optional)
                                 gid: Integer (Optional)
                                 sshPrivateKey: String (Optional)
                             }
                             windowsUserConfiguration (Optional): {
                                 loginMode: String(batch/interactive) (Optional)
                             }
                         }
                     ]
                     metadata (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Required)
                         }
                     ]
                     mountConfiguration (Optional): [
                          (Optional){
                             azureBlobFileSystemConfiguration (Optional): {
                                 accountName: String (Required)
                                 containerName: String (Required)
                                 accountKey: String (Optional)
                                 sasKey: String (Optional)
                                 blobfuseOptions: String (Optional)
                                 relativeMountPath: String (Required)
                                 identityReference (Optional): (recursive schema, see identityReference above)
                             }
                             nfsMountConfiguration (Optional): {
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                             cifsMountConfiguration (Optional): {
                                 username: String (Required)
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                                 password: String (Required)
                             }
                             azureFileShareConfiguration (Optional): {
                                 accountName: String (Required)
                                 azureFileUrl: String (Required)
                                 accountKey: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                         }
                     ]
                     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                     upgradePolicy (Optional): {
                         mode: String(automatic/manual/rolling) (Required)
                         automaticOSUpgradePolicy (Optional): {
                             disableAutomaticRollback: Boolean (Optional)
                             enableAutomaticOSUpgrade: Boolean (Optional)
                             useRollingUpgradePolicy: Boolean (Optional)
                             osRollingUpgradeDeferral: Boolean (Optional)
                         }
                         rollingUpgradePolicy (Optional): {
                             enableCrossZoneUpgrade: Boolean (Optional)
                             maxBatchInstancePercent: Integer (Optional)
                             maxUnhealthyInstancePercent: Integer (Optional)
                             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                             pauseTimeBetweenBatches: Duration (Optional)
                             prioritizeUnhealthyInstances: Boolean (Optional)
                             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                         }
                     }
                 }
             }
         }
         metadata (Optional): [
             (recursive schema, see above)
         ]
     }
     executionInfo (Optional): {
         nextRunTime: OffsetDateTime (Optional)
         recentJob (Optional): {
             id: String (Optional)
             url: String (Optional)
         }
         endTime: OffsetDateTime (Optional)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         numSucceededTasks: long (Required)
         numFailedTasks: long (Required)
         numTaskRetries: long (Required)
         waitTime: Duration (Required)
     }
 }
      Parameters:
      jobScheduleId - The ID of the Job Schedule to get.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Job Schedule along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • updateJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> updateJobScheduleWithResponse(String jobScheduleId, com.azure.core.util.BinaryData jobSchedule, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the properties of the specified Job Schedule. This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     schedule (Optional): {
         doNotRunUntil: OffsetDateTime (Optional)
         doNotRunAfter: OffsetDateTime (Optional)
         startWindow: Duration (Optional)
         recurrenceInterval: Duration (Optional)
     }
     jobSpecification (Optional): {
         priority: Integer (Optional)
         allowTaskPreemption: Boolean (Optional)
         maxParallelTasks: Integer (Optional)
         displayName: String (Optional)
         usesTaskDependencies: Boolean (Optional)
         onAllTasksComplete: String(noaction/terminatejob) (Optional)
         onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
         networkConfiguration (Optional): {
             subnetId: String (Required)
             skipWithdrawFromVNet: boolean (Required)
         }
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         jobManagerTask (Optional): {
             id: String (Required)
             displayName: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): {
                 containerRunOptions: String (Optional)
                 imageName: String (Required)
                 registry (Optional): {
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
                 workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
                 containerHostBatchBindMounts (Optional): [
                      (Optional){
                         source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                         isReadOnly: Boolean (Optional)
                     }
                 ]
             }
             resourceFiles (Optional): [
                  (Optional){
                     autoStorageContainerName: String (Optional)
                     storageContainerUrl: String (Optional)
                     httpUrl: String (Optional)
                     blobPrefix: String (Optional)
                     filePath: String (Optional)
                     fileMode: String (Optional)
                     identityReference (Optional): (recursive schema, see identityReference above)
                 }
             ]
             outputFiles (Optional): [
                  (Optional){
                     filePattern: String (Required)
                     destination (Required): {
                         container (Optional): {
                             path: String (Optional)
                             containerUrl: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                             uploadHeaders (Optional): [
                                  (Optional){
                                     name: String (Required)
                                     value: String (Optional)
                                 }
                             ]
                         }
                     }
                     uploadOptions (Required): {
                         uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                     }
                 }
             ]
             environmentSettings (Optional): [
                  (Optional){
                     name: String (Required)
                     value: String (Optional)
                 }
             ]
             constraints (Optional): {
                 maxWallClockTime: Duration (Optional)
                 retentionTime: Duration (Optional)
                 maxTaskRetryCount: Integer (Optional)
             }
             requiredSlots: Integer (Optional)
             killJobOnCompletion: Boolean (Optional)
             userIdentity (Optional): {
                 username: String (Optional)
                 autoUser (Optional): {
                     scope: String(task/pool) (Optional)
                     elevationLevel: String(nonadmin/admin) (Optional)
                 }
             }
             runExclusive: Boolean (Optional)
             applicationPackageReferences (Optional): [
                  (Optional){
                     applicationId: String (Required)
                     version: String (Optional)
                 }
             ]
             authenticationTokenSettings (Optional): {
                 access (Optional): [
                     String(job) (Optional)
                 ]
             }
             allowLowPriorityNode: Boolean (Optional)
         }
         jobPreparationTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             constraints (Optional): (recursive schema, see constraints above)
             waitForSuccess: Boolean (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
             rerunOnNodeRebootAfterSuccess: Boolean (Optional)
         }
         jobReleaseTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
         }
         commonEnvironmentSettings (Optional): [
             (recursive schema, see above)
         ]
         poolInfo (Required): {
             poolId: String (Optional)
             autoPoolSpecification (Optional): {
                 autoPoolIdPrefix: String (Optional)
                 poolLifetimeOption: String(jobschedule/job) (Required)
                 keepAlive: Boolean (Optional)
                 pool (Optional): {
                     displayName: String (Optional)
                     vmSize: String (Required)
                     virtualMachineConfiguration (Optional): {
                         imageReference (Required): {
                             publisher: String (Optional)
                             offer: String (Optional)
                             sku: String (Optional)
                             version: String (Optional)
                             virtualMachineImageId: String (Optional)
                             exactVersion: String (Optional)
                             sharedGalleryImageId: String (Optional)
                             communityGalleryImageId: String (Optional)
                         }
                         nodeAgentSKUId: String (Required)
                         windowsConfiguration (Optional): {
                             enableAutomaticUpdates: Boolean (Optional)
                         }
                         dataDisks (Optional): [
                              (Optional){
                                 lun: int (Required)
                                 caching: String(none/readonly/readwrite) (Optional)
                                 diskSizeGB: int (Required)
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             }
                         ]
                         licenseType: String (Optional)
                         containerConfiguration (Optional): {
                             type: String(dockerCompatible/criCompatible) (Required)
                             containerImageNames (Optional): [
                                 String (Optional)
                             ]
                             containerRegistries (Optional): [
                                 (recursive schema, see above)
                             ]
                         }
                         diskEncryptionConfiguration (Optional): {
                             targets (Optional): [
                                 String(osdisk/temporarydisk) (Optional)
                             ]
                         }
                         nodePlacementConfiguration (Optional): {
                             policy: String(regional/zonal) (Optional)
                         }
                         extensions (Optional): [
                              (Optional){
                                 name: String (Required)
                                 publisher: String (Required)
                                 type: String (Required)
                                 typeHandlerVersion: String (Optional)
                                 autoUpgradeMinorVersion: Boolean (Optional)
                                 enableAutomaticUpgrade: Boolean (Optional)
                                 settings (Optional): {
                                     String: String (Required)
                                 }
                                 protectedSettings (Optional): {
                                     String: String (Required)
                                 }
                                 provisionAfterExtensions (Optional): [
                                     String (Optional)
                                 ]
                             }
                         ]
                         osDisk (Optional): {
                             ephemeralOSDiskSettings (Optional): {
                                 placement: String(cachedisk) (Optional)
                             }
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: Integer (Optional)
                             managedDisk (Optional): {
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                                 securityProfile (Optional): {
                                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                                 }
                             }
                             writeAcceleratorEnabled: Boolean (Optional)
                         }
                         securityProfile (Optional): {
                             encryptionAtHost: boolean (Required)
                             securityType: String(trustedLaunch/confidentialVM) (Required)
                             uefiSettings (Required): {
                                 secureBootEnabled: Boolean (Optional)
                                 vTpmEnabled: Boolean (Optional)
                             }
                         }
                         serviceArtifactReference (Optional): {
                             id: String (Required)
                         }
                     }
                     taskSlotsPerNode: Integer (Optional)
                     taskSchedulingPolicy (Optional): {
                         nodeFillType: String(spread/pack) (Required)
                     }
                     resizeTimeout: Duration (Optional)
                     resourceTags: String (Optional)
                     targetDedicatedNodes: Integer (Optional)
                     targetLowPriorityNodes: Integer (Optional)
                     enableAutoScale: Boolean (Optional)
                     autoScaleFormula: String (Optional)
                     autoScaleEvaluationInterval: Duration (Optional)
                     enableInterNodeCommunication: Boolean (Optional)
                     networkConfiguration (Optional): {
                         subnetId: String (Optional)
                         dynamicVNetAssignmentScope: String(none/job) (Optional)
                         endpointConfiguration (Optional): {
                             inboundNATPools (Required): [
                                  (Required){
                                     name: String (Required)
                                     protocol: String(tcp/udp) (Required)
                                     backendPort: int (Required)
                                     frontendPortRangeStart: int (Required)
                                     frontendPortRangeEnd: int (Required)
                                     networkSecurityGroupRules (Optional): [
                                          (Optional){
                                             priority: int (Required)
                                             access: String(allow/deny) (Required)
                                             sourceAddressPrefix: String (Required)
                                             sourcePortRanges (Optional): [
                                                 String (Optional)
                                             ]
                                         }
                                     ]
                                 }
                             ]
                         }
                         publicIPAddressConfiguration (Optional): {
                             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                             ipAddressIds (Optional): [
                                 String (Optional)
                             ]
                         }
                         enableAcceleratedNetworking: Boolean (Optional)
                     }
                     startTask (Optional): {
                         commandLine: String (Required)
                         containerSettings (Optional): (recursive schema, see containerSettings above)
                         resourceFiles (Optional): [
                             (recursive schema, see above)
                         ]
                         environmentSettings (Optional): [
                             (recursive schema, see above)
                         ]
                         userIdentity (Optional): (recursive schema, see userIdentity above)
                         maxTaskRetryCount: Integer (Optional)
                         waitForSuccess: Boolean (Optional)
                     }
                     certificateReferences (Optional): [
                          (Optional){
                             thumbprint: String (Required)
                             thumbprintAlgorithm: String (Required)
                             storeLocation: String(currentuser/localmachine) (Optional)
                             storeName: String (Optional)
                             visibility (Optional): [
                                 String(starttask/task/remoteuser) (Optional)
                             ]
                         }
                     ]
                     applicationPackageReferences (Optional): [
                         (recursive schema, see above)
                     ]
                     userAccounts (Optional): [
                          (Optional){
                             name: String (Required)
                             password: String (Required)
                             elevationLevel: String(nonadmin/admin) (Optional)
                             linuxUserConfiguration (Optional): {
                                 uid: Integer (Optional)
                                 gid: Integer (Optional)
                                 sshPrivateKey: String (Optional)
                             }
                             windowsUserConfiguration (Optional): {
                                 loginMode: String(batch/interactive) (Optional)
                             }
                         }
                     ]
                     metadata (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Required)
                         }
                     ]
                     mountConfiguration (Optional): [
                          (Optional){
                             azureBlobFileSystemConfiguration (Optional): {
                                 accountName: String (Required)
                                 containerName: String (Required)
                                 accountKey: String (Optional)
                                 sasKey: String (Optional)
                                 blobfuseOptions: String (Optional)
                                 relativeMountPath: String (Required)
                                 identityReference (Optional): (recursive schema, see identityReference above)
                             }
                             nfsMountConfiguration (Optional): {
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                             cifsMountConfiguration (Optional): {
                                 username: String (Required)
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                                 password: String (Required)
                             }
                             azureFileShareConfiguration (Optional): {
                                 accountName: String (Required)
                                 azureFileUrl: String (Required)
                                 accountKey: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                         }
                     ]
                     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                     upgradePolicy (Optional): {
                         mode: String(automatic/manual/rolling) (Required)
                         automaticOSUpgradePolicy (Optional): {
                             disableAutomaticRollback: Boolean (Optional)
                             enableAutomaticOSUpgrade: Boolean (Optional)
                             useRollingUpgradePolicy: Boolean (Optional)
                             osRollingUpgradeDeferral: Boolean (Optional)
                         }
                         rollingUpgradePolicy (Optional): {
                             enableCrossZoneUpgrade: Boolean (Optional)
                             maxBatchInstancePercent: Integer (Optional)
                             maxUnhealthyInstancePercent: Integer (Optional)
                             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                             pauseTimeBetweenBatches: Duration (Optional)
                             prioritizeUnhealthyInstances: Boolean (Optional)
                             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                         }
                     }
                 }
             }
         }
         metadata (Optional): [
             (recursive schema, see above)
         ]
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
 }
      Parameters:
      jobScheduleId - The ID of the Job Schedule to update.
      jobSchedule - The options to use for updating the Job Schedule.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • replaceJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> replaceJobScheduleWithResponse(String jobScheduleId, com.azure.core.util.BinaryData jobSchedule, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the properties of the specified Job Schedule. This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/completed/disabled/terminating/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/completed/disabled/terminating/deleting) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     schedule (Optional): {
         doNotRunUntil: OffsetDateTime (Optional)
         doNotRunAfter: OffsetDateTime (Optional)
         startWindow: Duration (Optional)
         recurrenceInterval: Duration (Optional)
     }
     jobSpecification (Required): {
         priority: Integer (Optional)
         allowTaskPreemption: Boolean (Optional)
         maxParallelTasks: Integer (Optional)
         displayName: String (Optional)
         usesTaskDependencies: Boolean (Optional)
         onAllTasksComplete: String(noaction/terminatejob) (Optional)
         onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
         networkConfiguration (Optional): {
             subnetId: String (Required)
             skipWithdrawFromVNet: boolean (Required)
         }
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         jobManagerTask (Optional): {
             id: String (Required)
             displayName: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): {
                 containerRunOptions: String (Optional)
                 imageName: String (Required)
                 registry (Optional): {
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
                 workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
                 containerHostBatchBindMounts (Optional): [
                      (Optional){
                         source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                         isReadOnly: Boolean (Optional)
                     }
                 ]
             }
             resourceFiles (Optional): [
                  (Optional){
                     autoStorageContainerName: String (Optional)
                     storageContainerUrl: String (Optional)
                     httpUrl: String (Optional)
                     blobPrefix: String (Optional)
                     filePath: String (Optional)
                     fileMode: String (Optional)
                     identityReference (Optional): (recursive schema, see identityReference above)
                 }
             ]
             outputFiles (Optional): [
                  (Optional){
                     filePattern: String (Required)
                     destination (Required): {
                         container (Optional): {
                             path: String (Optional)
                             containerUrl: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                             uploadHeaders (Optional): [
                                  (Optional){
                                     name: String (Required)
                                     value: String (Optional)
                                 }
                             ]
                         }
                     }
                     uploadOptions (Required): {
                         uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                     }
                 }
             ]
             environmentSettings (Optional): [
                  (Optional){
                     name: String (Required)
                     value: String (Optional)
                 }
             ]
             constraints (Optional): {
                 maxWallClockTime: Duration (Optional)
                 retentionTime: Duration (Optional)
                 maxTaskRetryCount: Integer (Optional)
             }
             requiredSlots: Integer (Optional)
             killJobOnCompletion: Boolean (Optional)
             userIdentity (Optional): {
                 username: String (Optional)
                 autoUser (Optional): {
                     scope: String(task/pool) (Optional)
                     elevationLevel: String(nonadmin/admin) (Optional)
                 }
             }
             runExclusive: Boolean (Optional)
             applicationPackageReferences (Optional): [
                  (Optional){
                     applicationId: String (Required)
                     version: String (Optional)
                 }
             ]
             authenticationTokenSettings (Optional): {
                 access (Optional): [
                     String(job) (Optional)
                 ]
             }
             allowLowPriorityNode: Boolean (Optional)
         }
         jobPreparationTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             constraints (Optional): (recursive schema, see constraints above)
             waitForSuccess: Boolean (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
             rerunOnNodeRebootAfterSuccess: Boolean (Optional)
         }
         jobReleaseTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
         }
         commonEnvironmentSettings (Optional): [
             (recursive schema, see above)
         ]
         poolInfo (Required): {
             poolId: String (Optional)
             autoPoolSpecification (Optional): {
                 autoPoolIdPrefix: String (Optional)
                 poolLifetimeOption: String(jobschedule/job) (Required)
                 keepAlive: Boolean (Optional)
                 pool (Optional): {
                     displayName: String (Optional)
                     vmSize: String (Required)
                     virtualMachineConfiguration (Optional): {
                         imageReference (Required): {
                             publisher: String (Optional)
                             offer: String (Optional)
                             sku: String (Optional)
                             version: String (Optional)
                             virtualMachineImageId: String (Optional)
                             exactVersion: String (Optional)
                             sharedGalleryImageId: String (Optional)
                             communityGalleryImageId: String (Optional)
                         }
                         nodeAgentSKUId: String (Required)
                         windowsConfiguration (Optional): {
                             enableAutomaticUpdates: Boolean (Optional)
                         }
                         dataDisks (Optional): [
                              (Optional){
                                 lun: int (Required)
                                 caching: String(none/readonly/readwrite) (Optional)
                                 diskSizeGB: int (Required)
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             }
                         ]
                         licenseType: String (Optional)
                         containerConfiguration (Optional): {
                             type: String(dockerCompatible/criCompatible) (Required)
                             containerImageNames (Optional): [
                                 String (Optional)
                             ]
                             containerRegistries (Optional): [
                                 (recursive schema, see above)
                             ]
                         }
                         diskEncryptionConfiguration (Optional): {
                             targets (Optional): [
                                 String(osdisk/temporarydisk) (Optional)
                             ]
                         }
                         nodePlacementConfiguration (Optional): {
                             policy: String(regional/zonal) (Optional)
                         }
                         extensions (Optional): [
                              (Optional){
                                 name: String (Required)
                                 publisher: String (Required)
                                 type: String (Required)
                                 typeHandlerVersion: String (Optional)
                                 autoUpgradeMinorVersion: Boolean (Optional)
                                 enableAutomaticUpgrade: Boolean (Optional)
                                 settings (Optional): {
                                     String: String (Required)
                                 }
                                 protectedSettings (Optional): {
                                     String: String (Required)
                                 }
                                 provisionAfterExtensions (Optional): [
                                     String (Optional)
                                 ]
                             }
                         ]
                         osDisk (Optional): {
                             ephemeralOSDiskSettings (Optional): {
                                 placement: String(cachedisk) (Optional)
                             }
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: Integer (Optional)
                             managedDisk (Optional): {
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                                 securityProfile (Optional): {
                                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                                 }
                             }
                             writeAcceleratorEnabled: Boolean (Optional)
                         }
                         securityProfile (Optional): {
                             encryptionAtHost: boolean (Required)
                             securityType: String(trustedLaunch/confidentialVM) (Required)
                             uefiSettings (Required): {
                                 secureBootEnabled: Boolean (Optional)
                                 vTpmEnabled: Boolean (Optional)
                             }
                         }
                         serviceArtifactReference (Optional): {
                             id: String (Required)
                         }
                     }
                     taskSlotsPerNode: Integer (Optional)
                     taskSchedulingPolicy (Optional): {
                         nodeFillType: String(spread/pack) (Required)
                     }
                     resizeTimeout: Duration (Optional)
                     resourceTags: String (Optional)
                     targetDedicatedNodes: Integer (Optional)
                     targetLowPriorityNodes: Integer (Optional)
                     enableAutoScale: Boolean (Optional)
                     autoScaleFormula: String (Optional)
                     autoScaleEvaluationInterval: Duration (Optional)
                     enableInterNodeCommunication: Boolean (Optional)
                     networkConfiguration (Optional): {
                         subnetId: String (Optional)
                         dynamicVNetAssignmentScope: String(none/job) (Optional)
                         endpointConfiguration (Optional): {
                             inboundNATPools (Required): [
                                  (Required){
                                     name: String (Required)
                                     protocol: String(tcp/udp) (Required)
                                     backendPort: int (Required)
                                     frontendPortRangeStart: int (Required)
                                     frontendPortRangeEnd: int (Required)
                                     networkSecurityGroupRules (Optional): [
                                          (Optional){
                                             priority: int (Required)
                                             access: String(allow/deny) (Required)
                                             sourceAddressPrefix: String (Required)
                                             sourcePortRanges (Optional): [
                                                 String (Optional)
                                             ]
                                         }
                                     ]
                                 }
                             ]
                         }
                         publicIPAddressConfiguration (Optional): {
                             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                             ipAddressIds (Optional): [
                                 String (Optional)
                             ]
                         }
                         enableAcceleratedNetworking: Boolean (Optional)
                     }
                     startTask (Optional): {
                         commandLine: String (Required)
                         containerSettings (Optional): (recursive schema, see containerSettings above)
                         resourceFiles (Optional): [
                             (recursive schema, see above)
                         ]
                         environmentSettings (Optional): [
                             (recursive schema, see above)
                         ]
                         userIdentity (Optional): (recursive schema, see userIdentity above)
                         maxTaskRetryCount: Integer (Optional)
                         waitForSuccess: Boolean (Optional)
                     }
                     certificateReferences (Optional): [
                          (Optional){
                             thumbprint: String (Required)
                             thumbprintAlgorithm: String (Required)
                             storeLocation: String(currentuser/localmachine) (Optional)
                             storeName: String (Optional)
                             visibility (Optional): [
                                 String(starttask/task/remoteuser) (Optional)
                             ]
                         }
                     ]
                     applicationPackageReferences (Optional): [
                         (recursive schema, see above)
                     ]
                     userAccounts (Optional): [
                          (Optional){
                             name: String (Required)
                             password: String (Required)
                             elevationLevel: String(nonadmin/admin) (Optional)
                             linuxUserConfiguration (Optional): {
                                 uid: Integer (Optional)
                                 gid: Integer (Optional)
                                 sshPrivateKey: String (Optional)
                             }
                             windowsUserConfiguration (Optional): {
                                 loginMode: String(batch/interactive) (Optional)
                             }
                         }
                     ]
                     metadata (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Required)
                         }
                     ]
                     mountConfiguration (Optional): [
                          (Optional){
                             azureBlobFileSystemConfiguration (Optional): {
                                 accountName: String (Required)
                                 containerName: String (Required)
                                 accountKey: String (Optional)
                                 sasKey: String (Optional)
                                 blobfuseOptions: String (Optional)
                                 relativeMountPath: String (Required)
                                 identityReference (Optional): (recursive schema, see identityReference above)
                             }
                             nfsMountConfiguration (Optional): {
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                             cifsMountConfiguration (Optional): {
                                 username: String (Required)
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                                 password: String (Required)
                             }
                             azureFileShareConfiguration (Optional): {
                                 accountName: String (Required)
                                 azureFileUrl: String (Required)
                                 accountKey: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                         }
                     ]
                     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                     upgradePolicy (Optional): {
                         mode: String(automatic/manual/rolling) (Required)
                         automaticOSUpgradePolicy (Optional): {
                             disableAutomaticRollback: Boolean (Optional)
                             enableAutomaticOSUpgrade: Boolean (Optional)
                             useRollingUpgradePolicy: Boolean (Optional)
                             osRollingUpgradeDeferral: Boolean (Optional)
                         }
                         rollingUpgradePolicy (Optional): {
                             enableCrossZoneUpgrade: Boolean (Optional)
                             maxBatchInstancePercent: Integer (Optional)
                             maxUnhealthyInstancePercent: Integer (Optional)
                             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                             pauseTimeBetweenBatches: Duration (Optional)
                             prioritizeUnhealthyInstances: Boolean (Optional)
                             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                         }
                     }
                 }
             }
         }
         metadata (Optional): [
             (recursive schema, see above)
         ]
     }
     executionInfo (Optional): {
         nextRunTime: OffsetDateTime (Optional)
         recentJob (Optional): {
             id: String (Optional)
             url: String (Optional)
         }
         endTime: OffsetDateTime (Optional)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         numSucceededTasks: long (Required)
         numFailedTasks: long (Required)
         numTaskRetries: long (Required)
         waitTime: Duration (Required)
     }
 }
      Parameters:
      jobScheduleId - The ID of the Job Schedule to update.
      jobSchedule - A Job Schedule with updated properties.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • disableJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> disableJobScheduleWithResponse(String jobScheduleId, com.azure.core.http.rest.RequestOptions requestOptions)
      Disables a Job Schedule. No new Jobs will be created until the Job Schedule is enabled again.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobScheduleId - The ID of the Job Schedule to disable.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • enableJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> enableJobScheduleWithResponse(String jobScheduleId, com.azure.core.http.rest.RequestOptions requestOptions)
      Enables a Job Schedule.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobScheduleId - The ID of the Job Schedule to enable.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • terminateJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> terminateJobScheduleWithResponse(String jobScheduleId, com.azure.core.http.rest.RequestOptions requestOptions)
      Terminates a Job Schedule.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      forceBooleanNoIf true, the server will terminate the JobSchedule even if the corresponding nodes have not fully processed the termination. The default value is false.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobScheduleId - The ID of the Job Schedule to terminates.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createJobScheduleWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> createJobScheduleWithResponse(com.azure.core.util.BinaryData jobSchedule, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates a Job Schedule to the specified Account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Required)
     displayName: String (Optional)
     schedule (Required): {
         doNotRunUntil: OffsetDateTime (Optional)
         doNotRunAfter: OffsetDateTime (Optional)
         startWindow: Duration (Optional)
         recurrenceInterval: Duration (Optional)
     }
     jobSpecification (Required): {
         priority: Integer (Optional)
         allowTaskPreemption: Boolean (Optional)
         maxParallelTasks: Integer (Optional)
         displayName: String (Optional)
         usesTaskDependencies: Boolean (Optional)
         onAllTasksComplete: String(noaction/terminatejob) (Optional)
         onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
         networkConfiguration (Optional): {
             subnetId: String (Required)
             skipWithdrawFromVNet: boolean (Required)
         }
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         jobManagerTask (Optional): {
             id: String (Required)
             displayName: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): {
                 containerRunOptions: String (Optional)
                 imageName: String (Required)
                 registry (Optional): {
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
                 workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
                 containerHostBatchBindMounts (Optional): [
                      (Optional){
                         source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                         isReadOnly: Boolean (Optional)
                     }
                 ]
             }
             resourceFiles (Optional): [
                  (Optional){
                     autoStorageContainerName: String (Optional)
                     storageContainerUrl: String (Optional)
                     httpUrl: String (Optional)
                     blobPrefix: String (Optional)
                     filePath: String (Optional)
                     fileMode: String (Optional)
                     identityReference (Optional): (recursive schema, see identityReference above)
                 }
             ]
             outputFiles (Optional): [
                  (Optional){
                     filePattern: String (Required)
                     destination (Required): {
                         container (Optional): {
                             path: String (Optional)
                             containerUrl: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                             uploadHeaders (Optional): [
                                  (Optional){
                                     name: String (Required)
                                     value: String (Optional)
                                 }
                             ]
                         }
                     }
                     uploadOptions (Required): {
                         uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                     }
                 }
             ]
             environmentSettings (Optional): [
                  (Optional){
                     name: String (Required)
                     value: String (Optional)
                 }
             ]
             constraints (Optional): {
                 maxWallClockTime: Duration (Optional)
                 retentionTime: Duration (Optional)
                 maxTaskRetryCount: Integer (Optional)
             }
             requiredSlots: Integer (Optional)
             killJobOnCompletion: Boolean (Optional)
             userIdentity (Optional): {
                 username: String (Optional)
                 autoUser (Optional): {
                     scope: String(task/pool) (Optional)
                     elevationLevel: String(nonadmin/admin) (Optional)
                 }
             }
             runExclusive: Boolean (Optional)
             applicationPackageReferences (Optional): [
                  (Optional){
                     applicationId: String (Required)
                     version: String (Optional)
                 }
             ]
             authenticationTokenSettings (Optional): {
                 access (Optional): [
                     String(job) (Optional)
                 ]
             }
             allowLowPriorityNode: Boolean (Optional)
         }
         jobPreparationTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             constraints (Optional): (recursive schema, see constraints above)
             waitForSuccess: Boolean (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
             rerunOnNodeRebootAfterSuccess: Boolean (Optional)
         }
         jobReleaseTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
         }
         commonEnvironmentSettings (Optional): [
             (recursive schema, see above)
         ]
         poolInfo (Required): {
             poolId: String (Optional)
             autoPoolSpecification (Optional): {
                 autoPoolIdPrefix: String (Optional)
                 poolLifetimeOption: String(jobschedule/job) (Required)
                 keepAlive: Boolean (Optional)
                 pool (Optional): {
                     displayName: String (Optional)
                     vmSize: String (Required)
                     virtualMachineConfiguration (Optional): {
                         imageReference (Required): {
                             publisher: String (Optional)
                             offer: String (Optional)
                             sku: String (Optional)
                             version: String (Optional)
                             virtualMachineImageId: String (Optional)
                             exactVersion: String (Optional)
                             sharedGalleryImageId: String (Optional)
                             communityGalleryImageId: String (Optional)
                         }
                         nodeAgentSKUId: String (Required)
                         windowsConfiguration (Optional): {
                             enableAutomaticUpdates: Boolean (Optional)
                         }
                         dataDisks (Optional): [
                              (Optional){
                                 lun: int (Required)
                                 caching: String(none/readonly/readwrite) (Optional)
                                 diskSizeGB: int (Required)
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             }
                         ]
                         licenseType: String (Optional)
                         containerConfiguration (Optional): {
                             type: String(dockerCompatible/criCompatible) (Required)
                             containerImageNames (Optional): [
                                 String (Optional)
                             ]
                             containerRegistries (Optional): [
                                 (recursive schema, see above)
                             ]
                         }
                         diskEncryptionConfiguration (Optional): {
                             targets (Optional): [
                                 String(osdisk/temporarydisk) (Optional)
                             ]
                         }
                         nodePlacementConfiguration (Optional): {
                             policy: String(regional/zonal) (Optional)
                         }
                         extensions (Optional): [
                              (Optional){
                                 name: String (Required)
                                 publisher: String (Required)
                                 type: String (Required)
                                 typeHandlerVersion: String (Optional)
                                 autoUpgradeMinorVersion: Boolean (Optional)
                                 enableAutomaticUpgrade: Boolean (Optional)
                                 settings (Optional): {
                                     String: String (Required)
                                 }
                                 protectedSettings (Optional): {
                                     String: String (Required)
                                 }
                                 provisionAfterExtensions (Optional): [
                                     String (Optional)
                                 ]
                             }
                         ]
                         osDisk (Optional): {
                             ephemeralOSDiskSettings (Optional): {
                                 placement: String(cachedisk) (Optional)
                             }
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: Integer (Optional)
                             managedDisk (Optional): {
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                                 securityProfile (Optional): {
                                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                                 }
                             }
                             writeAcceleratorEnabled: Boolean (Optional)
                         }
                         securityProfile (Optional): {
                             encryptionAtHost: boolean (Required)
                             securityType: String(trustedLaunch/confidentialVM) (Required)
                             uefiSettings (Required): {
                                 secureBootEnabled: Boolean (Optional)
                                 vTpmEnabled: Boolean (Optional)
                             }
                         }
                         serviceArtifactReference (Optional): {
                             id: String (Required)
                         }
                     }
                     taskSlotsPerNode: Integer (Optional)
                     taskSchedulingPolicy (Optional): {
                         nodeFillType: String(spread/pack) (Required)
                     }
                     resizeTimeout: Duration (Optional)
                     resourceTags: String (Optional)
                     targetDedicatedNodes: Integer (Optional)
                     targetLowPriorityNodes: Integer (Optional)
                     enableAutoScale: Boolean (Optional)
                     autoScaleFormula: String (Optional)
                     autoScaleEvaluationInterval: Duration (Optional)
                     enableInterNodeCommunication: Boolean (Optional)
                     networkConfiguration (Optional): {
                         subnetId: String (Optional)
                         dynamicVNetAssignmentScope: String(none/job) (Optional)
                         endpointConfiguration (Optional): {
                             inboundNATPools (Required): [
                                  (Required){
                                     name: String (Required)
                                     protocol: String(tcp/udp) (Required)
                                     backendPort: int (Required)
                                     frontendPortRangeStart: int (Required)
                                     frontendPortRangeEnd: int (Required)
                                     networkSecurityGroupRules (Optional): [
                                          (Optional){
                                             priority: int (Required)
                                             access: String(allow/deny) (Required)
                                             sourceAddressPrefix: String (Required)
                                             sourcePortRanges (Optional): [
                                                 String (Optional)
                                             ]
                                         }
                                     ]
                                 }
                             ]
                         }
                         publicIPAddressConfiguration (Optional): {
                             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                             ipAddressIds (Optional): [
                                 String (Optional)
                             ]
                         }
                         enableAcceleratedNetworking: Boolean (Optional)
                     }
                     startTask (Optional): {
                         commandLine: String (Required)
                         containerSettings (Optional): (recursive schema, see containerSettings above)
                         resourceFiles (Optional): [
                             (recursive schema, see above)
                         ]
                         environmentSettings (Optional): [
                             (recursive schema, see above)
                         ]
                         userIdentity (Optional): (recursive schema, see userIdentity above)
                         maxTaskRetryCount: Integer (Optional)
                         waitForSuccess: Boolean (Optional)
                     }
                     certificateReferences (Optional): [
                          (Optional){
                             thumbprint: String (Required)
                             thumbprintAlgorithm: String (Required)
                             storeLocation: String(currentuser/localmachine) (Optional)
                             storeName: String (Optional)
                             visibility (Optional): [
                                 String(starttask/task/remoteuser) (Optional)
                             ]
                         }
                     ]
                     applicationPackageReferences (Optional): [
                         (recursive schema, see above)
                     ]
                     userAccounts (Optional): [
                          (Optional){
                             name: String (Required)
                             password: String (Required)
                             elevationLevel: String(nonadmin/admin) (Optional)
                             linuxUserConfiguration (Optional): {
                                 uid: Integer (Optional)
                                 gid: Integer (Optional)
                                 sshPrivateKey: String (Optional)
                             }
                             windowsUserConfiguration (Optional): {
                                 loginMode: String(batch/interactive) (Optional)
                             }
                         }
                     ]
                     metadata (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Required)
                         }
                     ]
                     mountConfiguration (Optional): [
                          (Optional){
                             azureBlobFileSystemConfiguration (Optional): {
                                 accountName: String (Required)
                                 containerName: String (Required)
                                 accountKey: String (Optional)
                                 sasKey: String (Optional)
                                 blobfuseOptions: String (Optional)
                                 relativeMountPath: String (Required)
                                 identityReference (Optional): (recursive schema, see identityReference above)
                             }
                             nfsMountConfiguration (Optional): {
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                             cifsMountConfiguration (Optional): {
                                 username: String (Required)
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                                 password: String (Required)
                             }
                             azureFileShareConfiguration (Optional): {
                                 accountName: String (Required)
                                 azureFileUrl: String (Required)
                                 accountKey: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                         }
                     ]
                     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                     upgradePolicy (Optional): {
                         mode: String(automatic/manual/rolling) (Required)
                         automaticOSUpgradePolicy (Optional): {
                             disableAutomaticRollback: Boolean (Optional)
                             enableAutomaticOSUpgrade: Boolean (Optional)
                             useRollingUpgradePolicy: Boolean (Optional)
                             osRollingUpgradeDeferral: Boolean (Optional)
                         }
                         rollingUpgradePolicy (Optional): {
                             enableCrossZoneUpgrade: Boolean (Optional)
                             maxBatchInstancePercent: Integer (Optional)
                             maxUnhealthyInstancePercent: Integer (Optional)
                             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                             pauseTimeBetweenBatches: Duration (Optional)
                             prioritizeUnhealthyInstances: Boolean (Optional)
                             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                         }
                     }
                 }
             }
         }
         metadata (Optional): [
             (recursive schema, see above)
         ]
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
 }
      Parameters:
      jobSchedule - The Job Schedule to be created.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listJobSchedules

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listJobSchedules(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the Job Schedules in the specified Account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     state: String(active/completed/disabled/terminating/deleting) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/completed/disabled/terminating/deleting) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     schedule (Optional): {
         doNotRunUntil: OffsetDateTime (Optional)
         doNotRunAfter: OffsetDateTime (Optional)
         startWindow: Duration (Optional)
         recurrenceInterval: Duration (Optional)
     }
     jobSpecification (Required): {
         priority: Integer (Optional)
         allowTaskPreemption: Boolean (Optional)
         maxParallelTasks: Integer (Optional)
         displayName: String (Optional)
         usesTaskDependencies: Boolean (Optional)
         onAllTasksComplete: String(noaction/terminatejob) (Optional)
         onTaskFailure: String(noaction/performexitoptionsjobaction) (Optional)
         networkConfiguration (Optional): {
             subnetId: String (Required)
             skipWithdrawFromVNet: boolean (Required)
         }
         constraints (Optional): {
             maxWallClockTime: Duration (Optional)
             maxTaskRetryCount: Integer (Optional)
         }
         jobManagerTask (Optional): {
             id: String (Required)
             displayName: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): {
                 containerRunOptions: String (Optional)
                 imageName: String (Required)
                 registry (Optional): {
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
                 workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
                 containerHostBatchBindMounts (Optional): [
                      (Optional){
                         source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                         isReadOnly: Boolean (Optional)
                     }
                 ]
             }
             resourceFiles (Optional): [
                  (Optional){
                     autoStorageContainerName: String (Optional)
                     storageContainerUrl: String (Optional)
                     httpUrl: String (Optional)
                     blobPrefix: String (Optional)
                     filePath: String (Optional)
                     fileMode: String (Optional)
                     identityReference (Optional): (recursive schema, see identityReference above)
                 }
             ]
             outputFiles (Optional): [
                  (Optional){
                     filePattern: String (Required)
                     destination (Required): {
                         container (Optional): {
                             path: String (Optional)
                             containerUrl: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                             uploadHeaders (Optional): [
                                  (Optional){
                                     name: String (Required)
                                     value: String (Optional)
                                 }
                             ]
                         }
                     }
                     uploadOptions (Required): {
                         uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                     }
                 }
             ]
             environmentSettings (Optional): [
                  (Optional){
                     name: String (Required)
                     value: String (Optional)
                 }
             ]
             constraints (Optional): {
                 maxWallClockTime: Duration (Optional)
                 retentionTime: Duration (Optional)
                 maxTaskRetryCount: Integer (Optional)
             }
             requiredSlots: Integer (Optional)
             killJobOnCompletion: Boolean (Optional)
             userIdentity (Optional): {
                 username: String (Optional)
                 autoUser (Optional): {
                     scope: String(task/pool) (Optional)
                     elevationLevel: String(nonadmin/admin) (Optional)
                 }
             }
             runExclusive: Boolean (Optional)
             applicationPackageReferences (Optional): [
                  (Optional){
                     applicationId: String (Required)
                     version: String (Optional)
                 }
             ]
             authenticationTokenSettings (Optional): {
                 access (Optional): [
                     String(job) (Optional)
                 ]
             }
             allowLowPriorityNode: Boolean (Optional)
         }
         jobPreparationTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             constraints (Optional): (recursive schema, see constraints above)
             waitForSuccess: Boolean (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
             rerunOnNodeRebootAfterSuccess: Boolean (Optional)
         }
         jobReleaseTask (Optional): {
             id: String (Optional)
             commandLine: String (Required)
             containerSettings (Optional): (recursive schema, see containerSettings above)
             resourceFiles (Optional): [
                 (recursive schema, see above)
             ]
             environmentSettings (Optional): [
                 (recursive schema, see above)
             ]
             maxWallClockTime: Duration (Optional)
             retentionTime: Duration (Optional)
             userIdentity (Optional): (recursive schema, see userIdentity above)
         }
         commonEnvironmentSettings (Optional): [
             (recursive schema, see above)
         ]
         poolInfo (Required): {
             poolId: String (Optional)
             autoPoolSpecification (Optional): {
                 autoPoolIdPrefix: String (Optional)
                 poolLifetimeOption: String(jobschedule/job) (Required)
                 keepAlive: Boolean (Optional)
                 pool (Optional): {
                     displayName: String (Optional)
                     vmSize: String (Required)
                     virtualMachineConfiguration (Optional): {
                         imageReference (Required): {
                             publisher: String (Optional)
                             offer: String (Optional)
                             sku: String (Optional)
                             version: String (Optional)
                             virtualMachineImageId: String (Optional)
                             exactVersion: String (Optional)
                             sharedGalleryImageId: String (Optional)
                             communityGalleryImageId: String (Optional)
                         }
                         nodeAgentSKUId: String (Required)
                         windowsConfiguration (Optional): {
                             enableAutomaticUpdates: Boolean (Optional)
                         }
                         dataDisks (Optional): [
                              (Optional){
                                 lun: int (Required)
                                 caching: String(none/readonly/readwrite) (Optional)
                                 diskSizeGB: int (Required)
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                             }
                         ]
                         licenseType: String (Optional)
                         containerConfiguration (Optional): {
                             type: String(dockerCompatible/criCompatible) (Required)
                             containerImageNames (Optional): [
                                 String (Optional)
                             ]
                             containerRegistries (Optional): [
                                 (recursive schema, see above)
                             ]
                         }
                         diskEncryptionConfiguration (Optional): {
                             targets (Optional): [
                                 String(osdisk/temporarydisk) (Optional)
                             ]
                         }
                         nodePlacementConfiguration (Optional): {
                             policy: String(regional/zonal) (Optional)
                         }
                         extensions (Optional): [
                              (Optional){
                                 name: String (Required)
                                 publisher: String (Required)
                                 type: String (Required)
                                 typeHandlerVersion: String (Optional)
                                 autoUpgradeMinorVersion: Boolean (Optional)
                                 enableAutomaticUpgrade: Boolean (Optional)
                                 settings (Optional): {
                                     String: String (Required)
                                 }
                                 protectedSettings (Optional): {
                                     String: String (Required)
                                 }
                                 provisionAfterExtensions (Optional): [
                                     String (Optional)
                                 ]
                             }
                         ]
                         osDisk (Optional): {
                             ephemeralOSDiskSettings (Optional): {
                                 placement: String(cachedisk) (Optional)
                             }
                             caching: String(none/readonly/readwrite) (Optional)
                             diskSizeGB: Integer (Optional)
                             managedDisk (Optional): {
                                 storageAccountType: String(standard_lrs/premium_lrs/standardssd_lrs) (Optional)
                                 securityProfile (Optional): {
                                     securityEncryptionType: String(NonPersistedTPM/VMGuestStateOnly) (Optional)
                                 }
                             }
                             writeAcceleratorEnabled: Boolean (Optional)
                         }
                         securityProfile (Optional): {
                             encryptionAtHost: boolean (Required)
                             securityType: String(trustedLaunch/confidentialVM) (Required)
                             uefiSettings (Required): {
                                 secureBootEnabled: Boolean (Optional)
                                 vTpmEnabled: Boolean (Optional)
                             }
                         }
                         serviceArtifactReference (Optional): {
                             id: String (Required)
                         }
                     }
                     taskSlotsPerNode: Integer (Optional)
                     taskSchedulingPolicy (Optional): {
                         nodeFillType: String(spread/pack) (Required)
                     }
                     resizeTimeout: Duration (Optional)
                     resourceTags: String (Optional)
                     targetDedicatedNodes: Integer (Optional)
                     targetLowPriorityNodes: Integer (Optional)
                     enableAutoScale: Boolean (Optional)
                     autoScaleFormula: String (Optional)
                     autoScaleEvaluationInterval: Duration (Optional)
                     enableInterNodeCommunication: Boolean (Optional)
                     networkConfiguration (Optional): {
                         subnetId: String (Optional)
                         dynamicVNetAssignmentScope: String(none/job) (Optional)
                         endpointConfiguration (Optional): {
                             inboundNATPools (Required): [
                                  (Required){
                                     name: String (Required)
                                     protocol: String(tcp/udp) (Required)
                                     backendPort: int (Required)
                                     frontendPortRangeStart: int (Required)
                                     frontendPortRangeEnd: int (Required)
                                     networkSecurityGroupRules (Optional): [
                                          (Optional){
                                             priority: int (Required)
                                             access: String(allow/deny) (Required)
                                             sourceAddressPrefix: String (Required)
                                             sourcePortRanges (Optional): [
                                                 String (Optional)
                                             ]
                                         }
                                     ]
                                 }
                             ]
                         }
                         publicIPAddressConfiguration (Optional): {
                             provision: String(batchmanaged/usermanaged/nopublicipaddresses) (Optional)
                             ipAddressIds (Optional): [
                                 String (Optional)
                             ]
                         }
                         enableAcceleratedNetworking: Boolean (Optional)
                     }
                     startTask (Optional): {
                         commandLine: String (Required)
                         containerSettings (Optional): (recursive schema, see containerSettings above)
                         resourceFiles (Optional): [
                             (recursive schema, see above)
                         ]
                         environmentSettings (Optional): [
                             (recursive schema, see above)
                         ]
                         userIdentity (Optional): (recursive schema, see userIdentity above)
                         maxTaskRetryCount: Integer (Optional)
                         waitForSuccess: Boolean (Optional)
                     }
                     certificateReferences (Optional): [
                          (Optional){
                             thumbprint: String (Required)
                             thumbprintAlgorithm: String (Required)
                             storeLocation: String(currentuser/localmachine) (Optional)
                             storeName: String (Optional)
                             visibility (Optional): [
                                 String(starttask/task/remoteuser) (Optional)
                             ]
                         }
                     ]
                     applicationPackageReferences (Optional): [
                         (recursive schema, see above)
                     ]
                     userAccounts (Optional): [
                          (Optional){
                             name: String (Required)
                             password: String (Required)
                             elevationLevel: String(nonadmin/admin) (Optional)
                             linuxUserConfiguration (Optional): {
                                 uid: Integer (Optional)
                                 gid: Integer (Optional)
                                 sshPrivateKey: String (Optional)
                             }
                             windowsUserConfiguration (Optional): {
                                 loginMode: String(batch/interactive) (Optional)
                             }
                         }
                     ]
                     metadata (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Required)
                         }
                     ]
                     mountConfiguration (Optional): [
                          (Optional){
                             azureBlobFileSystemConfiguration (Optional): {
                                 accountName: String (Required)
                                 containerName: String (Required)
                                 accountKey: String (Optional)
                                 sasKey: String (Optional)
                                 blobfuseOptions: String (Optional)
                                 relativeMountPath: String (Required)
                                 identityReference (Optional): (recursive schema, see identityReference above)
                             }
                             nfsMountConfiguration (Optional): {
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                             cifsMountConfiguration (Optional): {
                                 username: String (Required)
                                 source: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                                 password: String (Required)
                             }
                             azureFileShareConfiguration (Optional): {
                                 accountName: String (Required)
                                 azureFileUrl: String (Required)
                                 accountKey: String (Required)
                                 relativeMountPath: String (Required)
                                 mountOptions: String (Optional)
                             }
                         }
                     ]
                     targetNodeCommunicationMode: String(default/classic/simplified) (Optional)
                     upgradePolicy (Optional): {
                         mode: String(automatic/manual/rolling) (Required)
                         automaticOSUpgradePolicy (Optional): {
                             disableAutomaticRollback: Boolean (Optional)
                             enableAutomaticOSUpgrade: Boolean (Optional)
                             useRollingUpgradePolicy: Boolean (Optional)
                             osRollingUpgradeDeferral: Boolean (Optional)
                         }
                         rollingUpgradePolicy (Optional): {
                             enableCrossZoneUpgrade: Boolean (Optional)
                             maxBatchInstancePercent: Integer (Optional)
                             maxUnhealthyInstancePercent: Integer (Optional)
                             maxUnhealthyUpgradedInstancePercent: Integer (Optional)
                             pauseTimeBetweenBatches: Duration (Optional)
                             prioritizeUnhealthyInstances: Boolean (Optional)
                             rollbackFailedInstancesOnPolicyBreach: Boolean (Optional)
                         }
                     }
                 }
             }
         }
         metadata (Optional): [
             (recursive schema, see above)
         ]
     }
     executionInfo (Optional): {
         nextRunTime: OffsetDateTime (Optional)
         recentJob (Optional): {
             id: String (Optional)
             url: String (Optional)
         }
         endTime: OffsetDateTime (Optional)
     }
     metadata (Optional): [
         (recursive schema, see above)
     ]
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         numSucceededTasks: long (Required)
         numFailedTasks: long (Required)
         numTaskRetries: long (Required)
         waitTime: Duration (Required)
     }
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Job Schedules in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createTaskWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> createTaskWithResponse(String jobId, com.azure.core.util.BinaryData task, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Required)
     displayName: String (Optional)
     exitConditions (Optional): {
         exitCodes (Optional): [
              (Optional){
                 code: int (Required)
                 exitOptions (Required): {
                     jobAction: String(none/disable/terminate) (Optional)
                     dependencyAction: String(satisfy/block) (Optional)
                 }
             }
         ]
         exitCodeRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
                 exitOptions (Required): (recursive schema, see exitOptions above)
             }
         ]
         preProcessingError (Optional): (recursive schema, see preProcessingError above)
         fileUploadError (Optional): (recursive schema, see fileUploadError above)
         default (Optional): (recursive schema, see default above)
     }
     commandLine: String (Required)
     containerSettings (Optional): {
         containerRunOptions: String (Optional)
         imageName: String (Required)
         registry (Optional): {
             username: String (Optional)
             password: String (Optional)
             registryServer: String (Optional)
             identityReference (Optional): {
                 resourceId: String (Optional)
             }
         }
         workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
         containerHostBatchBindMounts (Optional): [
              (Optional){
                 source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                 isReadOnly: Boolean (Optional)
             }
         ]
     }
     resourceFiles (Optional): [
          (Optional){
             autoStorageContainerName: String (Optional)
             storageContainerUrl: String (Optional)
             httpUrl: String (Optional)
             blobPrefix: String (Optional)
             filePath: String (Optional)
             fileMode: String (Optional)
             identityReference (Optional): (recursive schema, see identityReference above)
         }
     ]
     outputFiles (Optional): [
          (Optional){
             filePattern: String (Required)
             destination (Required): {
                 container (Optional): {
                     path: String (Optional)
                     containerUrl: String (Required)
                     identityReference (Optional): (recursive schema, see identityReference above)
                     uploadHeaders (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Optional)
                         }
                     ]
                 }
             }
             uploadOptions (Required): {
                 uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
             }
         }
     ]
     environmentSettings (Optional): [
          (Optional){
             name: String (Required)
             value: String (Optional)
         }
     ]
     affinityInfo (Optional): {
         affinityId: String (Required)
     }
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     requiredSlots: Integer (Optional)
     userIdentity (Optional): {
         username: String (Optional)
         autoUser (Optional): {
             scope: String(task/pool) (Optional)
             elevationLevel: String(nonadmin/admin) (Optional)
         }
     }
     multiInstanceSettings (Optional): {
         numberOfInstances: Integer (Optional)
         coordinationCommandLine: String (Required)
         commonResourceFiles (Optional): [
             (recursive schema, see above)
         ]
     }
     dependsOn (Optional): {
         taskIds (Optional): [
             String (Optional)
         ]
         taskIdRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
             }
         ]
     }
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     authenticationTokenSettings (Optional): {
         access (Optional): [
             String(job) (Optional)
         ]
     }
 }
      Parameters:
      jobId - The ID of the Job to which the Task is to be created.
      task - The Task to be created.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listTasks

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listTasks(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasks.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     exitConditions (Optional): {
         exitCodes (Optional): [
              (Optional){
                 code: int (Required)
                 exitOptions (Required): {
                     jobAction: String(none/disable/terminate) (Optional)
                     dependencyAction: String(satisfy/block) (Optional)
                 }
             }
         ]
         exitCodeRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
                 exitOptions (Required): (recursive schema, see exitOptions above)
             }
         ]
         preProcessingError (Optional): (recursive schema, see preProcessingError above)
         fileUploadError (Optional): (recursive schema, see fileUploadError above)
         default (Optional): (recursive schema, see default above)
     }
     state: String(active/preparing/running/completed) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/preparing/running/completed) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     commandLine: String (Optional)
     containerSettings (Optional): {
         containerRunOptions: String (Optional)
         imageName: String (Required)
         registry (Optional): {
             username: String (Optional)
             password: String (Optional)
             registryServer: String (Optional)
             identityReference (Optional): {
                 resourceId: String (Optional)
             }
         }
         workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
         containerHostBatchBindMounts (Optional): [
              (Optional){
                 source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                 isReadOnly: Boolean (Optional)
             }
         ]
     }
     resourceFiles (Optional): [
          (Optional){
             autoStorageContainerName: String (Optional)
             storageContainerUrl: String (Optional)
             httpUrl: String (Optional)
             blobPrefix: String (Optional)
             filePath: String (Optional)
             fileMode: String (Optional)
             identityReference (Optional): (recursive schema, see identityReference above)
         }
     ]
     outputFiles (Optional): [
          (Optional){
             filePattern: String (Required)
             destination (Required): {
                 container (Optional): {
                     path: String (Optional)
                     containerUrl: String (Required)
                     identityReference (Optional): (recursive schema, see identityReference above)
                     uploadHeaders (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Optional)
                         }
                     ]
                 }
             }
             uploadOptions (Required): {
                 uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
             }
         }
     ]
     environmentSettings (Optional): [
          (Optional){
             name: String (Required)
             value: String (Optional)
         }
     ]
     affinityInfo (Optional): {
         affinityId: String (Required)
     }
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     requiredSlots: Integer (Optional)
     userIdentity (Optional): {
         username: String (Optional)
         autoUser (Optional): {
             scope: String(task/pool) (Optional)
             elevationLevel: String(nonadmin/admin) (Optional)
         }
     }
     executionInfo (Optional): {
         startTime: OffsetDateTime (Optional)
         endTime: OffsetDateTime (Optional)
         exitCode: Integer (Optional)
         containerInfo (Optional): {
             containerId: String (Optional)
             state: String (Optional)
             error: String (Optional)
         }
         failureInfo (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         retryCount: int (Required)
         lastRetryTime: OffsetDateTime (Optional)
         requeueCount: int (Required)
         lastRequeueTime: OffsetDateTime (Optional)
         result: String(success/failure) (Optional)
     }
     nodeInfo (Optional): {
         affinityId: String (Optional)
         nodeUrl: String (Optional)
         poolId: String (Optional)
         nodeId: String (Optional)
         taskRootDirectory: String (Optional)
         taskRootDirectoryUrl: String (Optional)
     }
     multiInstanceSettings (Optional): {
         numberOfInstances: Integer (Optional)
         coordinationCommandLine: String (Required)
         commonResourceFiles (Optional): [
             (recursive schema, see above)
         ]
     }
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         waitTime: Duration (Required)
     }
     dependsOn (Optional): {
         taskIds (Optional): [
             String (Optional)
         ]
         taskIdRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
             }
         ]
     }
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     authenticationTokenSettings (Optional): {
         access (Optional): [
             String(job) (Optional)
         ]
     }
 }
      Parameters:
      jobId - The ID of the Job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Tasks in a Job as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createTaskCollectionWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> createTaskCollectionWithResponse(String jobId, com.azure.core.util.BinaryData taskCollection, com.azure.core.http.rest.RequestOptions requestOptions)
      Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     value (Required): [
          (Required){
             id: String (Required)
             displayName: String (Optional)
             exitConditions (Optional): {
                 exitCodes (Optional): [
                      (Optional){
                         code: int (Required)
                         exitOptions (Required): {
                             jobAction: String(none/disable/terminate) (Optional)
                             dependencyAction: String(satisfy/block) (Optional)
                         }
                     }
                 ]
                 exitCodeRanges (Optional): [
                      (Optional){
                         start: int (Required)
                         end: int (Required)
                         exitOptions (Required): (recursive schema, see exitOptions above)
                     }
                 ]
                 preProcessingError (Optional): (recursive schema, see preProcessingError above)
                 fileUploadError (Optional): (recursive schema, see fileUploadError above)
                 default (Optional): (recursive schema, see default above)
             }
             commandLine: String (Required)
             containerSettings (Optional): {
                 containerRunOptions: String (Optional)
                 imageName: String (Required)
                 registry (Optional): {
                     username: String (Optional)
                     password: String (Optional)
                     registryServer: String (Optional)
                     identityReference (Optional): {
                         resourceId: String (Optional)
                     }
                 }
                 workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
                 containerHostBatchBindMounts (Optional): [
                      (Optional){
                         source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                         isReadOnly: Boolean (Optional)
                     }
                 ]
             }
             resourceFiles (Optional): [
                  (Optional){
                     autoStorageContainerName: String (Optional)
                     storageContainerUrl: String (Optional)
                     httpUrl: String (Optional)
                     blobPrefix: String (Optional)
                     filePath: String (Optional)
                     fileMode: String (Optional)
                     identityReference (Optional): (recursive schema, see identityReference above)
                 }
             ]
             outputFiles (Optional): [
                  (Optional){
                     filePattern: String (Required)
                     destination (Required): {
                         container (Optional): {
                             path: String (Optional)
                             containerUrl: String (Required)
                             identityReference (Optional): (recursive schema, see identityReference above)
                             uploadHeaders (Optional): [
                                  (Optional){
                                     name: String (Required)
                                     value: String (Optional)
                                 }
                             ]
                         }
                     }
                     uploadOptions (Required): {
                         uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
                     }
                 }
             ]
             environmentSettings (Optional): [
                  (Optional){
                     name: String (Required)
                     value: String (Optional)
                 }
             ]
             affinityInfo (Optional): {
                 affinityId: String (Required)
             }
             constraints (Optional): {
                 maxWallClockTime: Duration (Optional)
                 retentionTime: Duration (Optional)
                 maxTaskRetryCount: Integer (Optional)
             }
             requiredSlots: Integer (Optional)
             userIdentity (Optional): {
                 username: String (Optional)
                 autoUser (Optional): {
                     scope: String(task/pool) (Optional)
                     elevationLevel: String(nonadmin/admin) (Optional)
                 }
             }
             multiInstanceSettings (Optional): {
                 numberOfInstances: Integer (Optional)
                 coordinationCommandLine: String (Required)
                 commonResourceFiles (Optional): [
                     (recursive schema, see above)
                 ]
             }
             dependsOn (Optional): {
                 taskIds (Optional): [
                     String (Optional)
                 ]
                 taskIdRanges (Optional): [
                      (Optional){
                         start: int (Required)
                         end: int (Required)
                     }
                 ]
             }
             applicationPackageReferences (Optional): [
                  (Optional){
                     applicationId: String (Required)
                     version: String (Optional)
                 }
             ]
             authenticationTokenSettings (Optional): {
                 access (Optional): [
                     String(job) (Optional)
                 ]
             }
         }
     ]
 }

      Response Body Schema

       
 {
     value (Optional): [
          (Optional){
             status: String(success/clienterror/servererror) (Required)
             taskId: String (Required)
             eTag: String (Optional)
             lastModified: OffsetDateTime (Optional)
             location: String (Optional)
             error (Optional): {
                 code: String (Required)
                 message (Optional): {
                     lang: String (Optional)
                     value: String (Optional)
                 }
                 values (Optional): [
                      (Optional){
                         key: String (Optional)
                         value: String (Optional)
                     }
                 ]
             }
         }
     ]
 }
      Parameters:
      jobId - The ID of the Job to which the Task collection is to be added.
      taskCollection - The Tasks to be added.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of adding a collection of Tasks to a Job along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteTaskWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteTaskWithResponse(String jobId, String taskId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobId - The ID of the Job from which to delete the Task.
      taskId - The ID of the Task to delete.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getTaskWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getTaskWithResponse(String jobId, String taskId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      $expandList<String>NoAn OData $expand clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     exitConditions (Optional): {
         exitCodes (Optional): [
              (Optional){
                 code: int (Required)
                 exitOptions (Required): {
                     jobAction: String(none/disable/terminate) (Optional)
                     dependencyAction: String(satisfy/block) (Optional)
                 }
             }
         ]
         exitCodeRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
                 exitOptions (Required): (recursive schema, see exitOptions above)
             }
         ]
         preProcessingError (Optional): (recursive schema, see preProcessingError above)
         fileUploadError (Optional): (recursive schema, see fileUploadError above)
         default (Optional): (recursive schema, see default above)
     }
     state: String(active/preparing/running/completed) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/preparing/running/completed) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     commandLine: String (Optional)
     containerSettings (Optional): {
         containerRunOptions: String (Optional)
         imageName: String (Required)
         registry (Optional): {
             username: String (Optional)
             password: String (Optional)
             registryServer: String (Optional)
             identityReference (Optional): {
                 resourceId: String (Optional)
             }
         }
         workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
         containerHostBatchBindMounts (Optional): [
              (Optional){
                 source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                 isReadOnly: Boolean (Optional)
             }
         ]
     }
     resourceFiles (Optional): [
          (Optional){
             autoStorageContainerName: String (Optional)
             storageContainerUrl: String (Optional)
             httpUrl: String (Optional)
             blobPrefix: String (Optional)
             filePath: String (Optional)
             fileMode: String (Optional)
             identityReference (Optional): (recursive schema, see identityReference above)
         }
     ]
     outputFiles (Optional): [
          (Optional){
             filePattern: String (Required)
             destination (Required): {
                 container (Optional): {
                     path: String (Optional)
                     containerUrl: String (Required)
                     identityReference (Optional): (recursive schema, see identityReference above)
                     uploadHeaders (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Optional)
                         }
                     ]
                 }
             }
             uploadOptions (Required): {
                 uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
             }
         }
     ]
     environmentSettings (Optional): [
          (Optional){
             name: String (Required)
             value: String (Optional)
         }
     ]
     affinityInfo (Optional): {
         affinityId: String (Required)
     }
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     requiredSlots: Integer (Optional)
     userIdentity (Optional): {
         username: String (Optional)
         autoUser (Optional): {
             scope: String(task/pool) (Optional)
             elevationLevel: String(nonadmin/admin) (Optional)
         }
     }
     executionInfo (Optional): {
         startTime: OffsetDateTime (Optional)
         endTime: OffsetDateTime (Optional)
         exitCode: Integer (Optional)
         containerInfo (Optional): {
             containerId: String (Optional)
             state: String (Optional)
             error: String (Optional)
         }
         failureInfo (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         retryCount: int (Required)
         lastRetryTime: OffsetDateTime (Optional)
         requeueCount: int (Required)
         lastRequeueTime: OffsetDateTime (Optional)
         result: String(success/failure) (Optional)
     }
     nodeInfo (Optional): {
         affinityId: String (Optional)
         nodeUrl: String (Optional)
         poolId: String (Optional)
         nodeId: String (Optional)
         taskRootDirectory: String (Optional)
         taskRootDirectoryUrl: String (Optional)
     }
     multiInstanceSettings (Optional): {
         numberOfInstances: Integer (Optional)
         coordinationCommandLine: String (Required)
         commonResourceFiles (Optional): [
             (recursive schema, see above)
         ]
     }
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         waitTime: Duration (Required)
     }
     dependsOn (Optional): {
         taskIds (Optional): [
             String (Optional)
         ]
         taskIdRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
             }
         ]
     }
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     authenticationTokenSettings (Optional): {
         access (Optional): [
             String(job) (Optional)
         ]
     }
 }
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task to get information about.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • replaceTaskWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> replaceTaskWithResponse(String jobId, String taskId, com.azure.core.util.BinaryData task, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the properties of the specified Task.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Optional)
     displayName: String (Optional)
     url: String (Optional)
     eTag: String (Optional)
     lastModified: OffsetDateTime (Optional)
     creationTime: OffsetDateTime (Optional)
     exitConditions (Optional): {
         exitCodes (Optional): [
              (Optional){
                 code: int (Required)
                 exitOptions (Required): {
                     jobAction: String(none/disable/terminate) (Optional)
                     dependencyAction: String(satisfy/block) (Optional)
                 }
             }
         ]
         exitCodeRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
                 exitOptions (Required): (recursive schema, see exitOptions above)
             }
         ]
         preProcessingError (Optional): (recursive schema, see preProcessingError above)
         fileUploadError (Optional): (recursive schema, see fileUploadError above)
         default (Optional): (recursive schema, see default above)
     }
     state: String(active/preparing/running/completed) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(active/preparing/running/completed) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     commandLine: String (Optional)
     containerSettings (Optional): {
         containerRunOptions: String (Optional)
         imageName: String (Required)
         registry (Optional): {
             username: String (Optional)
             password: String (Optional)
             registryServer: String (Optional)
             identityReference (Optional): {
                 resourceId: String (Optional)
             }
         }
         workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
         containerHostBatchBindMounts (Optional): [
              (Optional){
                 source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                 isReadOnly: Boolean (Optional)
             }
         ]
     }
     resourceFiles (Optional): [
          (Optional){
             autoStorageContainerName: String (Optional)
             storageContainerUrl: String (Optional)
             httpUrl: String (Optional)
             blobPrefix: String (Optional)
             filePath: String (Optional)
             fileMode: String (Optional)
             identityReference (Optional): (recursive schema, see identityReference above)
         }
     ]
     outputFiles (Optional): [
          (Optional){
             filePattern: String (Required)
             destination (Required): {
                 container (Optional): {
                     path: String (Optional)
                     containerUrl: String (Required)
                     identityReference (Optional): (recursive schema, see identityReference above)
                     uploadHeaders (Optional): [
                          (Optional){
                             name: String (Required)
                             value: String (Optional)
                         }
                     ]
                 }
             }
             uploadOptions (Required): {
                 uploadCondition: String(tasksuccess/taskfailure/taskcompletion) (Required)
             }
         }
     ]
     environmentSettings (Optional): [
          (Optional){
             name: String (Required)
             value: String (Optional)
         }
     ]
     affinityInfo (Optional): {
         affinityId: String (Required)
     }
     constraints (Optional): {
         maxWallClockTime: Duration (Optional)
         retentionTime: Duration (Optional)
         maxTaskRetryCount: Integer (Optional)
     }
     requiredSlots: Integer (Optional)
     userIdentity (Optional): {
         username: String (Optional)
         autoUser (Optional): {
             scope: String(task/pool) (Optional)
             elevationLevel: String(nonadmin/admin) (Optional)
         }
     }
     executionInfo (Optional): {
         startTime: OffsetDateTime (Optional)
         endTime: OffsetDateTime (Optional)
         exitCode: Integer (Optional)
         containerInfo (Optional): {
             containerId: String (Optional)
             state: String (Optional)
             error: String (Optional)
         }
         failureInfo (Optional): {
             category: String(usererror/servererror) (Required)
             code: String (Optional)
             message: String (Optional)
             details (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
         retryCount: int (Required)
         lastRetryTime: OffsetDateTime (Optional)
         requeueCount: int (Required)
         lastRequeueTime: OffsetDateTime (Optional)
         result: String(success/failure) (Optional)
     }
     nodeInfo (Optional): {
         affinityId: String (Optional)
         nodeUrl: String (Optional)
         poolId: String (Optional)
         nodeId: String (Optional)
         taskRootDirectory: String (Optional)
         taskRootDirectoryUrl: String (Optional)
     }
     multiInstanceSettings (Optional): {
         numberOfInstances: Integer (Optional)
         coordinationCommandLine: String (Required)
         commonResourceFiles (Optional): [
             (recursive schema, see above)
         ]
     }
     stats (Optional): {
         url: String (Required)
         startTime: OffsetDateTime (Required)
         lastUpdateTime: OffsetDateTime (Required)
         userCPUTime: Duration (Required)
         kernelCPUTime: Duration (Required)
         wallClockTime: Duration (Required)
         readIOps: long (Required)
         writeIOps: long (Required)
         readIOGiB: double (Required)
         writeIOGiB: double (Required)
         waitTime: Duration (Required)
     }
     dependsOn (Optional): {
         taskIds (Optional): [
             String (Optional)
         ]
         taskIdRanges (Optional): [
              (Optional){
                 start: int (Required)
                 end: int (Required)
             }
         ]
     }
     applicationPackageReferences (Optional): [
          (Optional){
             applicationId: String (Required)
             version: String (Optional)
         }
     ]
     authenticationTokenSettings (Optional): {
         access (Optional): [
             String(job) (Optional)
         ]
     }
 }
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to update.
      task - The Task to update.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listSubTasks

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listSubTasks(String jobId, String taskId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: Integer (Optional)
     nodeInfo (Optional): {
         affinityId: String (Optional)
         nodeUrl: String (Optional)
         poolId: String (Optional)
         nodeId: String (Optional)
         taskRootDirectory: String (Optional)
         taskRootDirectoryUrl: String (Optional)
     }
     startTime: OffsetDateTime (Optional)
     endTime: OffsetDateTime (Optional)
     exitCode: Integer (Optional)
     containerInfo (Optional): {
         containerId: String (Optional)
         state: String (Optional)
         error: String (Optional)
     }
     failureInfo (Optional): {
         category: String(usererror/servererror) (Required)
         code: String (Optional)
         message: String (Optional)
         details (Optional): [
              (Optional){
                 name: String (Optional)
                 value: String (Optional)
             }
         ]
     }
     state: String(preparing/running/completed) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     previousState: String(preparing/running/completed) (Optional)
     previousStateTransitionTime: OffsetDateTime (Optional)
     result: String(success/failure) (Optional)
 }
      Parameters:
      jobId - The ID of the Job.
      taskId - The ID of the Task.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the subtasks of a Task as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • terminateTaskWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> terminateTaskWithResponse(String jobId, String taskId, com.azure.core.http.rest.RequestOptions requestOptions)
      Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to terminate.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • reactivateTaskWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> reactivateTaskWithResponse(String jobId, String taskId, com.azure.core.http.rest.RequestOptions requestOptions)
      Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      If-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
      If-None-MatchStringNoAn ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to reactivate.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteTaskFileWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteTaskFileWithResponse(String jobId, String taskId, String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes the specified Task file from the Compute Node where the Task ran.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      recursiveBooleanNoWhether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getTaskFileWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getTaskFileWithResponse(String jobId, String taskId, String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
      Returns the content of the specified Task file.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      ocp-rangeStringNoThe byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 BinaryData
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the response body along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getTaskFilePropertiesWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> getTaskFilePropertiesWithResponse(String jobId, String taskId, String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the properties of the specified Task file.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the properties of the specified Task file along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listTaskFiles

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listTaskFiles(String jobId, String taskId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the files in a Task's directory on its Compute Node.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files.
      recursiveBooleanNoWhether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     name: String (Optional)
     url: String (Optional)
     isDirectory: Boolean (Optional)
     properties (Optional): {
         creationTime: OffsetDateTime (Optional)
         lastModified: OffsetDateTime (Required)
         contentLength: long (Required)
         contentType: String (Optional)
         fileMode: String (Optional)
     }
 }
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose files you want to list.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createNodeUserWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> createNodeUserWithResponse(String poolId, String nodeId, com.azure.core.util.BinaryData user, com.azure.core.http.rest.RequestOptions requestOptions)
      Adds a user Account to the specified Compute Node. You can add a user Account to a Compute Node only when it is in the idle or running state.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     name: String (Required)
     isAdmin: Boolean (Optional)
     expiryTime: OffsetDateTime (Optional)
     password: String (Optional)
     sshPublicKey: String (Optional)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to create a user Account.
      user - The options to use for creating the user.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteNodeUserWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteNodeUserWithResponse(String poolId, String nodeId, String userName, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes a user Account from the specified Compute Node. You can delete a user Account to a Compute Node only when it is in the idle or running state.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to delete a user Account.
      userName - The name of the user Account to delete.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • replaceNodeUserWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> replaceNodeUserWithResponse(String poolId, String nodeId, String userName, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates the password and expiration time of a user Account on the specified Compute Node. This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     password: String (Optional)
     expiryTime: OffsetDateTime (Optional)
     sshPublicKey: String (Optional)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to update a user Account.
      userName - The name of the user Account to update.
      content - The options to use for updating the user.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getNodeWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getNodeWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Compute Node.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     url: String (Optional)
     state: String(idle/rebooting/reimaging/running/unusable/creating/starting/waitingforstarttask/starttaskfailed/unknown/leavingpool/offline/preempted/upgradingos/deallocated/deallocating) (Optional)
     schedulingState: String(enabled/disabled) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     lastBootTime: OffsetDateTime (Optional)
     allocationTime: OffsetDateTime (Optional)
     ipAddress: String (Optional)
     affinityId: String (Optional)
     vmSize: String (Optional)
     totalTasksRun: Integer (Optional)
     runningTasksCount: Integer (Optional)
     runningTaskSlotsCount: Integer (Optional)
     totalTasksSucceeded: Integer (Optional)
     recentTasks (Optional): [
          (Optional){
             taskUrl: String (Optional)
             jobId: String (Optional)
             taskId: String (Optional)
             subtaskId: Integer (Optional)
             taskState: String(active/preparing/running/completed) (Required)
             executionInfo (Optional): {
                 startTime: OffsetDateTime (Optional)
                 endTime: OffsetDateTime (Optional)
                 exitCode: Integer (Optional)
                 containerInfo (Optional): {
                     containerId: String (Optional)
                     state: String (Optional)
                     error: String (Optional)
                 }
                 failureInfo (Optional): {
                     category: String(usererror/servererror) (Required)
                     code: String (Optional)
                     message: String (Optional)
                     details (Optional): [
                          (Optional){
                             name: String (Optional)
                             value: String (Optional)
                         }
                     ]
                 }
                 retryCount: int (Required)
                 lastRetryTime: OffsetDateTime (Optional)
                 requeueCount: int (Required)
                 lastRequeueTime: OffsetDateTime (Optional)
                 result: String(success/failure) (Optional)
             }
         }
     ]
     startTask (Optional): {
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         maxTaskRetryCount: Integer (Optional)
         waitForSuccess: Boolean (Optional)
     }
     startTaskInfo (Optional): {
         state: String(running/completed) (Required)
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         exitCode: Integer (Optional)
         containerInfo (Optional): (recursive schema, see containerInfo above)
         failureInfo (Optional): (recursive schema, see failureInfo above)
         retryCount: int (Required)
         lastRetryTime: OffsetDateTime (Optional)
         result: String(success/failure) (Optional)
     }
     certificateReferences (Optional): [
          (Optional){
             thumbprint: String (Required)
             thumbprintAlgorithm: String (Required)
             storeLocation: String(currentuser/localmachine) (Optional)
             storeName: String (Optional)
             visibility (Optional): [
                 String(starttask/task/remoteuser) (Optional)
             ]
         }
     ]
     errors (Optional): [
          (Optional){
             code: String (Optional)
             message: String (Optional)
             errorDetails (Optional): [
                 (recursive schema, see above)
             ]
         }
     ]
     isDedicated: Boolean (Optional)
     endpointConfiguration (Optional): {
         inboundEndpoints (Required): [
              (Required){
                 name: String (Required)
                 protocol: String(tcp/udp) (Required)
                 publicIPAddress: String (Required)
                 publicFQDN: String (Required)
                 frontendPort: int (Required)
                 backendPort: int (Required)
             }
         ]
     }
     nodeAgentInfo (Optional): {
         version: String (Required)
         lastUpdateTime: OffsetDateTime (Required)
     }
     virtualMachineInfo (Optional): {
         imageReference (Optional): {
             publisher: String (Optional)
             offer: String (Optional)
             sku: String (Optional)
             version: String (Optional)
             virtualMachineImageId: String (Optional)
             exactVersion: String (Optional)
             sharedGalleryImageId: String (Optional)
             communityGalleryImageId: String (Optional)
         }
         scaleSetVmResourceId: String (Optional)
     }
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to get information about.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Compute Node along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • rebootNodeWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> rebootNodeWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Restarts the specified Compute Node. You can restart a Compute Node only if it is in an idle or running state.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      Content-TypeStringNoThe content type. Allowed values: "application/json; odata=minimalmetadata".
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     nodeRebootOption: String(requeue/terminate/taskcompletion/retaineddata) (Optional)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • startNodeWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> startNodeWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Starts the specified Compute Node. You can start a Compute Node only if it has been deallocated.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • reimageNodeWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> reimageNodeWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Reinstalls the operating system on the specified Compute Node. You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      Content-TypeStringNoThe content type. Allowed values: "application/json; odata=minimalmetadata".
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     nodeReimageOption: String(requeue/terminate/taskcompletion/retaineddata) (Optional)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deallocateNodeWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deallocateNodeWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deallocates the specified Compute Node. You can deallocate a Compute Node only if it is in an idle or running state.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      Content-TypeStringNoThe content type. Allowed values: "application/json; odata=minimalmetadata".
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     nodeDeallocateOption: String(requeue/terminate/taskcompletion/retaineddata) (Optional)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • disableNodeSchedulingWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> disableNodeSchedulingWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Disables Task scheduling on the specified Compute Node. You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      Content-TypeStringNoThe content type. Allowed values: "application/json; odata=minimalmetadata".
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     nodeDisableSchedulingOption: String(requeue/terminate/taskcompletion) (Optional)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node on which you want to disable Task scheduling.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • enableNodeSchedulingWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> enableNodeSchedulingWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Enables Task scheduling on the specified Compute Node. You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node on which you want to enable Task scheduling.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getNodeRemoteLoginSettingsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getNodeRemoteLoginSettingsWithResponse(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the settings required for remote login to a Compute Node. Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     remoteLoginIPAddress: String (Required)
     remoteLoginPort: int (Required)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node for which to obtain the remote login settings.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the settings required for remote login to a Compute Node. Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • uploadNodeLogsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> uploadNodeLogsWithResponse(String poolId, String nodeId, com.azure.core.util.BinaryData content, com.azure.core.http.rest.RequestOptions requestOptions)
      Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage. This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     containerUrl: String (Required)
     startTime: OffsetDateTime (Required)
     endTime: OffsetDateTime (Optional)
     identityReference (Optional): {
         resourceId: String (Optional)
     }
 }

      Response Body Schema

       
 {
     virtualDirectoryName: String (Required)
     numberOfFilesUploaded: int (Required)
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.
      content - The Azure Batch service log files upload options.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of uploading Batch service log files from a specific Compute Node along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listNodes

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listNodes(String poolId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the Compute Nodes in the specified Pool.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Optional)
     url: String (Optional)
     state: String(idle/rebooting/reimaging/running/unusable/creating/starting/waitingforstarttask/starttaskfailed/unknown/leavingpool/offline/preempted/upgradingos/deallocated/deallocating) (Optional)
     schedulingState: String(enabled/disabled) (Optional)
     stateTransitionTime: OffsetDateTime (Optional)
     lastBootTime: OffsetDateTime (Optional)
     allocationTime: OffsetDateTime (Optional)
     ipAddress: String (Optional)
     affinityId: String (Optional)
     vmSize: String (Optional)
     totalTasksRun: Integer (Optional)
     runningTasksCount: Integer (Optional)
     runningTaskSlotsCount: Integer (Optional)
     totalTasksSucceeded: Integer (Optional)
     recentTasks (Optional): [
          (Optional){
             taskUrl: String (Optional)
             jobId: String (Optional)
             taskId: String (Optional)
             subtaskId: Integer (Optional)
             taskState: String(active/preparing/running/completed) (Required)
             executionInfo (Optional): {
                 startTime: OffsetDateTime (Optional)
                 endTime: OffsetDateTime (Optional)
                 exitCode: Integer (Optional)
                 containerInfo (Optional): {
                     containerId: String (Optional)
                     state: String (Optional)
                     error: String (Optional)
                 }
                 failureInfo (Optional): {
                     category: String(usererror/servererror) (Required)
                     code: String (Optional)
                     message: String (Optional)
                     details (Optional): [
                          (Optional){
                             name: String (Optional)
                             value: String (Optional)
                         }
                     ]
                 }
                 retryCount: int (Required)
                 lastRetryTime: OffsetDateTime (Optional)
                 requeueCount: int (Required)
                 lastRequeueTime: OffsetDateTime (Optional)
                 result: String(success/failure) (Optional)
             }
         }
     ]
     startTask (Optional): {
         commandLine: String (Required)
         containerSettings (Optional): {
             containerRunOptions: String (Optional)
             imageName: String (Required)
             registry (Optional): {
                 username: String (Optional)
                 password: String (Optional)
                 registryServer: String (Optional)
                 identityReference (Optional): {
                     resourceId: String (Optional)
                 }
             }
             workingDirectory: String(taskWorkingDirectory/containerImageDefault) (Optional)
             containerHostBatchBindMounts (Optional): [
                  (Optional){
                     source: String(Shared/Startup/VfsMounts/Task/JobPrep/Applications) (Optional)
                     isReadOnly: Boolean (Optional)
                 }
             ]
         }
         resourceFiles (Optional): [
              (Optional){
                 autoStorageContainerName: String (Optional)
                 storageContainerUrl: String (Optional)
                 httpUrl: String (Optional)
                 blobPrefix: String (Optional)
                 filePath: String (Optional)
                 fileMode: String (Optional)
                 identityReference (Optional): (recursive schema, see identityReference above)
             }
         ]
         environmentSettings (Optional): [
              (Optional){
                 name: String (Required)
                 value: String (Optional)
             }
         ]
         userIdentity (Optional): {
             username: String (Optional)
             autoUser (Optional): {
                 scope: String(task/pool) (Optional)
                 elevationLevel: String(nonadmin/admin) (Optional)
             }
         }
         maxTaskRetryCount: Integer (Optional)
         waitForSuccess: Boolean (Optional)
     }
     startTaskInfo (Optional): {
         state: String(running/completed) (Required)
         startTime: OffsetDateTime (Required)
         endTime: OffsetDateTime (Optional)
         exitCode: Integer (Optional)
         containerInfo (Optional): (recursive schema, see containerInfo above)
         failureInfo (Optional): (recursive schema, see failureInfo above)
         retryCount: int (Required)
         lastRetryTime: OffsetDateTime (Optional)
         result: String(success/failure) (Optional)
     }
     certificateReferences (Optional): [
          (Optional){
             thumbprint: String (Required)
             thumbprintAlgorithm: String (Required)
             storeLocation: String(currentuser/localmachine) (Optional)
             storeName: String (Optional)
             visibility (Optional): [
                 String(starttask/task/remoteuser) (Optional)
             ]
         }
     ]
     errors (Optional): [
          (Optional){
             code: String (Optional)
             message: String (Optional)
             errorDetails (Optional): [
                 (recursive schema, see above)
             ]
         }
     ]
     isDedicated: Boolean (Optional)
     endpointConfiguration (Optional): {
         inboundEndpoints (Required): [
              (Required){
                 name: String (Required)
                 protocol: String(tcp/udp) (Required)
                 publicIPAddress: String (Required)
                 publicFQDN: String (Required)
                 frontendPort: int (Required)
                 backendPort: int (Required)
             }
         ]
     }
     nodeAgentInfo (Optional): {
         version: String (Required)
         lastUpdateTime: OffsetDateTime (Required)
     }
     virtualMachineInfo (Optional): {
         imageReference (Optional): {
             publisher: String (Optional)
             offer: String (Optional)
             sku: String (Optional)
             version: String (Optional)
             virtualMachineImageId: String (Optional)
             exactVersion: String (Optional)
             sharedGalleryImageId: String (Optional)
             communityGalleryImageId: String (Optional)
         }
         scaleSetVmResourceId: String (Optional)
     }
 }
      Parameters:
      poolId - The ID of the Pool from which you want to list Compute Nodes.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Compute Nodes in a Pool as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getNodeExtensionWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getNodeExtensionWithResponse(String poolId, String nodeId, String extensionName, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets information about the specified Compute Node Extension.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     provisioningState: String (Optional)
     vmExtension (Optional): {
         name: String (Required)
         publisher: String (Required)
         type: String (Required)
         typeHandlerVersion: String (Optional)
         autoUpgradeMinorVersion: Boolean (Optional)
         enableAutomaticUpgrade: Boolean (Optional)
         settings (Optional): {
             String: String (Required)
         }
         protectedSettings (Optional): {
             String: String (Required)
         }
         provisionAfterExtensions (Optional): [
             String (Optional)
         ]
     }
     instanceView (Optional): {
         name: String (Optional)
         statuses (Optional): [
              (Optional){
                 code: String (Optional)
                 displayStatus: String (Optional)
                 level: String(Error/Info/Warning) (Optional)
                 message: String (Optional)
                 time: OffsetDateTime (Optional)
             }
         ]
         subStatuses (Optional): [
             (recursive schema, see above)
         ]
     }
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that contains the extensions.
      extensionName - The name of the Compute Node Extension that you want to get information about.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      information about the specified Compute Node Extension along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listNodeExtensions

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listNodeExtensions(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists the Compute Nodes Extensions in the specified Pool.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $selectList<String>NoAn OData $select clause. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     provisioningState: String (Optional)
     vmExtension (Optional): {
         name: String (Required)
         publisher: String (Required)
         type: String (Required)
         typeHandlerVersion: String (Optional)
         autoUpgradeMinorVersion: Boolean (Optional)
         enableAutomaticUpgrade: Boolean (Optional)
         settings (Optional): {
             String: String (Required)
         }
         protectedSettings (Optional): {
             String: String (Required)
         }
         provisionAfterExtensions (Optional): [
             String (Optional)
         ]
     }
     instanceView (Optional): {
         name: String (Optional)
         statuses (Optional): [
              (Optional){
                 code: String (Optional)
                 displayStatus: String (Optional)
                 level: String(Error/Info/Warning) (Optional)
                 message: String (Optional)
                 time: OffsetDateTime (Optional)
             }
         ]
         subStatuses (Optional): [
             (recursive schema, see above)
         ]
     }
 }
      Parameters:
      poolId - The ID of the Pool that contains Compute Node.
      nodeId - The ID of the Compute Node that you want to list extensions.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the Compute Node extensions in a Node as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteNodeFileWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteNodeFileWithResponse(String poolId, String nodeId, String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes the specified file from the Compute Node.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      recursiveBooleanNoWhether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getNodeFileWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getNodeFileWithResponse(String poolId, String nodeId, String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
      Returns the content of the specified Compute Node file.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      ocp-rangeStringNoThe byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 BinaryData
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the response body along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getNodeFilePropertiesWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> getNodeFilePropertiesWithResponse(String poolId, String nodeId, String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the properties of the specified Compute Node file.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-Modified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
      If-Unmodified-SinceOffsetDateTimeNoA timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the properties of the specified Compute Node file along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listNodeFiles

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> listNodeFiles(String poolId, String nodeId, com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all of the files in Task directories on the specified Compute Node.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      timeOutIntegerNoThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
      maxresultsIntegerNoThe maximum number of items to return in the response. A maximum of 1000 applications can be returned.
      $filterStringNoAn OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
      recursiveBooleanNoWhether to list children of a directory.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     name: String (Optional)
     url: String (Optional)
     isDirectory: Boolean (Optional)
     properties (Optional): {
         creationTime: OffsetDateTime (Optional)
         lastModified: OffsetDateTime (Required)
         contentLength: long (Required)
         contentType: String (Optional)
         fileMode: String (Optional)
     }
 }
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node whose files you want to list.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listApplications

      public com.azure.core.http.rest.PagedFlux<BatchApplication> listApplications(ListBatchApplicationsOptions options)
      Lists all of the applications available in the specified Account. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.
      Parameters:
      options - Optional parameters for List Applications operation.
      Returns:
      the result of listing the applications available in an Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listApplications

      public com.azure.core.http.rest.PagedFlux<BatchApplication> listApplications()
      Lists all of the applications available in the specified Account. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.
      Returns:
      the result of listing the applications available in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getApplication

      public Mono<BatchApplication> getApplication(String applicationId, GetBatchApplicationOptions options)
      Gets information about the specified Application. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about Applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.
      Parameters:
      applicationId - The ID of the Application.
      options - Optional parameters for Get Application operation.
      Returns:
      information about the specified Application. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getApplication

      public Mono<BatchApplication> getApplication(String applicationId)
      Gets information about the specified Application. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about Applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.
      Parameters:
      applicationId - The ID of the Application.
      Returns:
      information about the specified Application. This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPoolUsageMetrics

      public com.azure.core.http.rest.PagedFlux<BatchPoolUsageMetrics> listPoolUsageMetrics(ListBatchPoolUsageMetricsOptions options)
      Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account. If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
      Parameters:
      options - Optional parameters for List Pool Usage Metrics operation.
      Returns:
      the result of a listing the usage metrics for an Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPoolUsageMetrics

      public com.azure.core.http.rest.PagedFlux<BatchPoolUsageMetrics> listPoolUsageMetrics()
      Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account. If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
      Returns:
      the result of a listing the usage metrics for an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createPool

      public Mono<Void> createPool(BatchPoolCreateContent pool, CreateBatchPoolOptions options)
      Creates a Pool to the specified Account. When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
      Parameters:
      pool - The Pool to be created.
      options - Optional parameters for Create Pool operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createPool

      public Mono<Void> createPool(BatchPoolCreateContent pool)
      Creates a Pool to the specified Account. When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
      Parameters:
      pool - The Pool to be created.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPools

      public com.azure.core.http.rest.PagedFlux<BatchPool> listPools(ListBatchPoolsOptions options)
      Lists all of the Pools which be mounted.
      Parameters:
      options - Optional parameters for List Pools operation.
      Returns:
      the result of listing the Pools in an Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPools

      public com.azure.core.http.rest.PagedFlux<BatchPool> listPools()
      Lists all of the Pools which be mounted.
      Returns:
      the result of listing the Pools in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deletePool

      public Mono<Void> deletePool(String poolId, DeleteBatchPoolOptions options, com.azure.core.http.RequestConditions requestConditions)
      Deletes a Pool from the specified Account. When you request that a Pool be deleted, the following actions occur: the Pool state is set to deleting; any ongoing resize operation on the Pool are stopped; the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks running on existing Compute Nodes are terminated and requeued (as if a resize Pool operation had been requested with the default requeue option); finally, the Pool is removed from the system. Because running Tasks are requeued, the user can rerun these Tasks by updating their Job to target a different Pool. The Tasks can then run on the new Pool. If you want to override the requeue behavior, then you should call resize Pool explicitly to shrink the Pool to zero size before deleting the Pool. If you call an Update, Patch or Delete API on a Pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
      Parameters:
      poolId - The ID of the Pool to get.
      options - Optional parameters for Delete Pool operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deletePool

      public Mono<Void> deletePool(String poolId)
      Deletes a Pool from the specified Account. When you request that a Pool be deleted, the following actions occur: the Pool state is set to deleting; any ongoing resize operation on the Pool are stopped; the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks running on existing Compute Nodes are terminated and requeued (as if a resize Pool operation had been requested with the default requeue option); finally, the Pool is removed from the system. Because running Tasks are requeued, the user can rerun these Tasks by updating their Job to target a different Pool. The Tasks can then run on the new Pool. If you want to override the requeue behavior, then you should call resize Pool explicitly to shrink the Pool to zero size before deleting the Pool. If you call an Update, Patch or Delete API on a Pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
      Parameters:
      poolId - The ID of the Pool to get.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • poolExists

      public Mono<Boolean> poolExists(String poolId, BatchPoolExistsOptions options, com.azure.core.http.RequestConditions requestConditions)
      Gets basic properties of a Pool.
      Parameters:
      poolId - The ID of the Pool to get.
      options - Optional parameters for Pool Exists operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      basic properties of a Pool on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • poolExists

      public Mono<Boolean> poolExists(String poolId)
      Gets basic properties of a Pool.
      Parameters:
      poolId - The ID of the Pool to get.
      Returns:
      basic properties of a Pool on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getPool

      public Mono<BatchPool> getPool(String poolId, GetBatchPoolOptions options, com.azure.core.http.RequestConditions requestConditions)
      Gets information about the specified Pool.
      Parameters:
      poolId - The ID of the Pool to get.
      options - Optional parameters for Get Pool operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      information about the specified Pool on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getPool

      public Mono<BatchPool> getPool(String poolId)
      Gets information about the specified Pool.
      Parameters:
      poolId - The ID of the Pool to get.
      Returns:
      information about the specified Pool on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updatePool

      public Mono<Void> updatePool(String poolId, BatchPoolUpdateContent pool, UpdateBatchPoolOptions options, com.azure.core.http.RequestConditions requestConditions)
      Updates the properties of the specified Pool. This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask.
      Parameters:
      poolId - The ID of the Pool to get.
      pool - The pool properties to update.
      options - Optional parameters for Update Pool operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updatePool

      public Mono<Void> updatePool(String poolId, BatchPoolUpdateContent pool)
      Updates the properties of the specified Pool. This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask.
      Parameters:
      poolId - The ID of the Pool to get.
      pool - The pool properties to update.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disablePoolAutoScale

      public Mono<Void> disablePoolAutoScale(String poolId, DisableBatchPoolAutoScaleOptions options)
      Disables automatic scaling for a Pool.
      Parameters:
      poolId - The ID of the Pool on which to disable automatic scaling.
      options - Optional parameters for Disable Pool AutoScale operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disablePoolAutoScale

      public Mono<Void> disablePoolAutoScale(String poolId)
      Disables automatic scaling for a Pool.
      Parameters:
      poolId - The ID of the Pool on which to disable automatic scaling.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enablePoolAutoScale

      public Mono<Void> enablePoolAutoScale(String poolId, BatchPoolEnableAutoScaleContent content, EnableBatchPoolAutoScaleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Enables automatic scaling for a Pool. You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the Pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same Pool more than once every 30 seconds.
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for enabling automatic scaling.
      options - Optional parameters for Enable Pool AutoScale operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enablePoolAutoScale

      public Mono<Void> enablePoolAutoScale(String poolId, BatchPoolEnableAutoScaleContent content)
      Enables automatic scaling for a Pool. You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the Pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same Pool more than once every 30 seconds.
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for enabling automatic scaling.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • evaluatePoolAutoScale

      public Mono<AutoScaleRun> evaluatePoolAutoScale(String poolId, BatchPoolEvaluateAutoScaleContent content, EvaluateBatchPoolAutoScaleOptions options)
      Gets the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.
      Parameters:
      poolId - The ID of the Pool on which to evaluate the automatic scaling formula.
      content - The options to use for evaluating the automatic scaling formula.
      options - Optional parameters for Evaluate Pool AutoScale operation.
      Returns:
      the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • evaluatePoolAutoScale

      public Mono<AutoScaleRun> evaluatePoolAutoScale(String poolId, BatchPoolEvaluateAutoScaleContent content)
      Gets the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.
      Parameters:
      poolId - The ID of the Pool on which to evaluate the automatic scaling formula.
      content - The options to use for evaluating the automatic scaling formula.
      Returns:
      the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resizePool

      public Mono<Void> resizePool(String poolId, BatchPoolResizeContent content, ResizeBatchPoolOptions options, com.azure.core.http.RequestConditions requestConditions)
      Changes the number of Compute Nodes that are assigned to a Pool. You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a Pool, the Pool's allocation state changes from steady to resizing. You cannot resize Pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a Pool downwards, the Batch service chooses which Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead.
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for resizing the pool.
      options - Optional parameters for Resize Pool operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resizePool

      public Mono<Void> resizePool(String poolId, BatchPoolResizeContent content)
      Changes the number of Compute Nodes that are assigned to a Pool. You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a Pool, the Pool's allocation state changes from steady to resizing. You cannot resize Pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a Pool downwards, the Batch service chooses which Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead.
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for resizing the pool.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stopPoolResize

      public Mono<Void> stopPoolResize(String poolId, StopBatchPoolResizeOptions options, com.azure.core.http.RequestConditions requestConditions)
      Stops an ongoing resize operation on the Pool. This does not restore the Pool to its previous state before the resize operation: it only stops any further changes being made, and the Pool maintains its current state. After stopping, the Pool stabilizes at the number of Compute Nodes it was at when the stop operation was done. During the stop operation, the Pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize Pool request; this API can also be used to halt the initial sizing of the Pool when it is created.
      Parameters:
      poolId - The ID of the Pool to get.
      options - Optional parameters for Stop Pool Resize operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stopPoolResize

      public Mono<Void> stopPoolResize(String poolId)
      Stops an ongoing resize operation on the Pool. This does not restore the Pool to its previous state before the resize operation: it only stops any further changes being made, and the Pool maintains its current state. After stopping, the Pool stabilizes at the number of Compute Nodes it was at when the stop operation was done. During the stop operation, the Pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize Pool request; this API can also be used to halt the initial sizing of the Pool when it is created.
      Parameters:
      poolId - The ID of the Pool to get.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replacePoolProperties

      public Mono<Void> replacePoolProperties(String poolId, BatchPoolReplaceContent pool, ReplaceBatchPoolPropertiesOptions options)
      Updates the properties of the specified Pool. This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.
      Parameters:
      poolId - The ID of the Pool to update.
      pool - The options to use for replacing properties on the pool.
      options - Optional parameters for Replace Pool Properties operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replacePoolProperties

      public Mono<Void> replacePoolProperties(String poolId, BatchPoolReplaceContent pool)
      Updates the properties of the specified Pool. This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.
      Parameters:
      poolId - The ID of the Pool to update.
      pool - The options to use for replacing properties on the pool.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • removeNodes

      public Mono<Void> removeNodes(String poolId, BatchNodeRemoveContent content, RemoveBatchNodesOptions options, com.azure.core.http.RequestConditions requestConditions)
      Removes Compute Nodes from the specified Pool. This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for removing the node.
      options - Optional parameters for Remove Nodes operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • removeNodes

      public Mono<Void> removeNodes(String poolId, BatchNodeRemoveContent content)
      Removes Compute Nodes from the specified Pool. This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.
      Parameters:
      poolId - The ID of the Pool to get.
      content - The options to use for removing the node.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSupportedImages

      public com.azure.core.http.rest.PagedFlux<BatchSupportedImage> listSupportedImages(ListSupportedBatchImagesOptions options)
      Lists all Virtual Machine Images supported by the Azure Batch service.
      Parameters:
      options - Optional parameters for List Supported Images operation.
      Returns:
      the result of listing the supported Virtual Machine Images as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSupportedImages

      public com.azure.core.http.rest.PagedFlux<BatchSupportedImage> listSupportedImages()
      Lists all Virtual Machine Images supported by the Azure Batch service.
      Returns:
      the result of listing the supported Virtual Machine Images as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPoolNodeCounts

      public com.azure.core.http.rest.PagedFlux<BatchPoolNodeCounts> listPoolNodeCounts(ListBatchPoolNodeCountsOptions options)
      Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.
      Parameters:
      options - Optional parameters for List Pool Node Counts operation.
      Returns:
      the number of Compute Nodes in each state, grouped by Pool as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPoolNodeCounts

      public com.azure.core.http.rest.PagedFlux<BatchPoolNodeCounts> listPoolNodeCounts()
      Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.
      Returns:
      the number of Compute Nodes in each state, grouped by Pool as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteJob

      public Mono<Void> deleteJob(String jobId, DeleteBatchJobOptions options, com.azure.core.http.RequestConditions requestConditions)
      Deletes a Job. Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted.
      Parameters:
      jobId - The ID of the Job to delete.
      options - Optional parameters for Delete Job operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteJob

      public Mono<Void> deleteJob(String jobId)
      Deletes a Job. Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted.
      Parameters:
      jobId - The ID of the Job to delete.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJob

      public Mono<BatchJob> getJob(String jobId, GetBatchJobOptions options, com.azure.core.http.RequestConditions requestConditions)
      Gets information about the specified Job.
      Parameters:
      jobId - The ID of the Job.
      options - Optional parameters for Get Job operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      information about the specified Job on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJob

      public Mono<BatchJob> getJob(String jobId)
      Gets information about the specified Job.
      Parameters:
      jobId - The ID of the Job.
      Returns:
      information about the specified Job on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateJob

      public Mono<Void> updateJob(String jobId, BatchJobUpdateContent job, UpdateBatchJobOptions options, com.azure.core.http.RequestConditions requestConditions)
      Updates the properties of the specified Job. This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.
      Parameters:
      jobId - The ID of the Job whose properties you want to update.
      job - The options to use for updating the Job.
      options - Optional parameters for Update Job operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateJob

      public Mono<Void> updateJob(String jobId, BatchJobUpdateContent job)
      Updates the properties of the specified Job. This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.
      Parameters:
      jobId - The ID of the Job whose properties you want to update.
      job - The options to use for updating the Job.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceJob

      public Mono<Void> replaceJob(String jobId, BatchJob job, ReplaceBatchJobOptions options, com.azure.core.http.RequestConditions requestConditions)
      Updates the properties of the specified Job. This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
      Parameters:
      jobId - The ID of the Job whose properties you want to update.
      job - A job with updated properties.
      options - Optional parameters for Replace Job operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceJob

      public Mono<Void> replaceJob(String jobId, BatchJob job)
      Updates the properties of the specified Job. This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
      Parameters:
      jobId - The ID of the Job whose properties you want to update.
      job - A job with updated properties.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableJob

      public Mono<Void> disableJob(String jobId, BatchJobDisableContent content, DisableBatchJobOptions options, com.azure.core.http.RequestConditions requestConditions)
      Disables the specified Job, preventing new Tasks from running. The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
      Parameters:
      jobId - The ID of the Job to disable.
      content - The options to use for disabling the Job.
      options - Optional parameters for Disable Job operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableJob

      public Mono<Void> disableJob(String jobId, BatchJobDisableContent content)
      Disables the specified Job, preventing new Tasks from running. The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409.
      Parameters:
      jobId - The ID of the Job to disable.
      content - The options to use for disabling the Job.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enableJob

      public Mono<Void> enableJob(String jobId, EnableBatchJobOptions options, com.azure.core.http.RequestConditions requestConditions)
      Enables the specified Job, allowing new Tasks to run. When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run.
      Parameters:
      jobId - The ID of the Job to enable.
      options - Optional parameters for Enable Job operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enableJob

      public Mono<Void> enableJob(String jobId)
      Enables the specified Job, allowing new Tasks to run. When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run.
      Parameters:
      jobId - The ID of the Job to enable.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • terminateJob

      public Mono<Void> terminateJob(String jobId, TerminateBatchJobOptions options, com.azure.core.http.RequestConditions requestConditions)
      Terminates the specified Job, marking it as completed. When a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled.
      Parameters:
      jobId - The ID of the Job to terminate.
      options - Optional parameters for Terminate Job operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • terminateJob

      public Mono<Void> terminateJob(String jobId)
      Terminates the specified Job, marking it as completed. When a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled.
      Parameters:
      jobId - The ID of the Job to terminate.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createJob

      public Mono<Void> createJob(BatchJobCreateContent job, CreateBatchJobOptions options)
      Creates a Job to the specified Account. The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
      Parameters:
      job - The Job to be created.
      options - Optional parameters for Create Job operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createJob

      public Mono<Void> createJob(BatchJobCreateContent job)
      Creates a Job to the specified Account. The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
      Parameters:
      job - The Job to be created.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobs

      public com.azure.core.http.rest.PagedFlux<BatchJob> listJobs(ListBatchJobsOptions options)
      Lists all of the Jobs in the specified Account.
      Parameters:
      options - Optional parameters for List Jobs operation.
      Returns:
      the result of listing the Jobs in an Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobs

      public com.azure.core.http.rest.PagedFlux<BatchJob> listJobs()
      Lists all of the Jobs in the specified Account.
      Returns:
      the result of listing the Jobs in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobsFromSchedule

      public com.azure.core.http.rest.PagedFlux<BatchJob> listJobsFromSchedule(String jobScheduleId, ListBatchJobsFromScheduleOptions options)
      Lists the Jobs that have been created under the specified Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule from which you want to get a list of Jobs.
      options - Optional parameters for List Jobs From Schedule operation.
      Returns:
      the result of listing the Jobs in an Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobsFromSchedule

      public com.azure.core.http.rest.PagedFlux<BatchJob> listJobsFromSchedule(String jobScheduleId)
      Lists the Jobs that have been created under the specified Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule from which you want to get a list of Jobs.
      Returns:
      the result of listing the Jobs in an Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobPreparationAndReleaseTaskStatus

      public com.azure.core.http.rest.PagedFlux<BatchJobPreparationAndReleaseTaskStatus> listJobPreparationAndReleaseTaskStatus(String jobId, ListBatchJobPreparationAndReleaseTaskStatusOptions options)
      Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run. This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
      Parameters:
      jobId - The ID of the Job.
      options - Optional parameters for List Jobs Preparation and Release Task Status operation.
      Returns:
      the result of listing the status of the Job Preparation and Job Release Tasks for a Job as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobPreparationAndReleaseTaskStatus

      public com.azure.core.http.rest.PagedFlux<BatchJobPreparationAndReleaseTaskStatus> listJobPreparationAndReleaseTaskStatus(String jobId)
      Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run. This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
      Parameters:
      jobId - The ID of the Job.
      Returns:
      the result of listing the status of the Job Preparation and Job Release Tasks for a Job as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJobTaskCounts

      public Mono<BatchTaskCountsResult> getJobTaskCounts(String jobId, GetBatchJobTaskCountsOptions options)
      Gets the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.
      Parameters:
      jobId - The ID of the Job.
      options - Optional parameters for Get Job Task Counts operation.
      Returns:
      the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJobTaskCounts

      public Mono<BatchTaskCountsResult> getJobTaskCounts(String jobId)
      Gets the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.
      Parameters:
      jobId - The ID of the Job.
      Returns:
      the Task counts for the specified Job. Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createCertificate

      public Mono<Void> createCertificate(BatchCertificate certificate, CreateBatchCertificateOptions options)
      Creates a Certificate to the specified Account.
      Parameters:
      certificate - The Certificate to be created.
      options - Optional parameters for Create Certificate operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createCertificate

      public Mono<Void> createCertificate(BatchCertificate certificate)
      Creates a Certificate to the specified Account.
      Parameters:
      certificate - The Certificate to be created.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listCertificates

      public com.azure.core.http.rest.PagedFlux<BatchCertificate> listCertificates(ListBatchCertificatesOptions options)
      Lists all of the Certificates that have been added to the specified Account.
      Parameters:
      options - Optional parameters for List Certificates operation.
      Returns:
      the result of listing the Certificates in the Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listCertificates

      public com.azure.core.http.rest.PagedFlux<BatchCertificate> listCertificates()
      Lists all of the Certificates that have been added to the specified Account.
      Returns:
      the result of listing the Certificates in the Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancelCertificateDeletion

      public Mono<Void> cancelCertificateDeletion(String thumbprintAlgorithm, String thumbprint, CancelBatchCertificateDeletionOptions options)
      Cancels a failed deletion of a Certificate from the specified Account. If you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate.
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate being deleted.
      options - Optional parameters for Cancel Certificate Deletion operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • cancelCertificateDeletion

      public Mono<Void> cancelCertificateDeletion(String thumbprintAlgorithm, String thumbprint)
      Cancels a failed deletion of a Certificate from the specified Account. If you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate.
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate being deleted.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteCertificate

      public Mono<Void> deleteCertificate(String thumbprintAlgorithm, String thumbprint, DeleteBatchCertificateOptions options)
      Deletes a Certificate from the specified Account. You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate.
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate to be deleted.
      options - Optional parameters for Delete Certificate operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteCertificate

      public Mono<Void> deleteCertificate(String thumbprintAlgorithm, String thumbprint)
      Deletes a Certificate from the specified Account. You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate.
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate to be deleted.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getCertificate

      public Mono<GetCertificateResponse> getCertificate(String thumbprintAlgorithm, String thumbprint, GetBatchCertificateOptions options)
      Gets information about the specified Certificate.
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate to get.
      options - Optional parameters for Get Certificate operation.
      Returns:
      information about the specified Certificate on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getCertificate

      public Mono<GetCertificateResponse> getCertificate(String thumbprintAlgorithm, String thumbprint)
      Gets information about the specified Certificate.
      Parameters:
      thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
      thumbprint - The thumbprint of the Certificate to get.
      Returns:
      information about the specified Certificate on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • jobScheduleExists

      public Mono<Boolean> jobScheduleExists(String jobScheduleId, BatchJobScheduleExistsOptions options, com.azure.core.http.RequestConditions requestConditions)
      Checks the specified Job Schedule exists.
      Parameters:
      jobScheduleId - The ID of the Job Schedule which you want to check.
      options - Optional parameters for Job Schedule Exists operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      whether resource exists on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • jobScheduleExists

      public Mono<Boolean> jobScheduleExists(String jobScheduleId)
      Checks the specified Job Schedule exists.
      Parameters:
      jobScheduleId - The ID of the Job Schedule which you want to check.
      Returns:
      whether resource exists on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteJobSchedule

      public Mono<Void> deleteJobSchedule(String jobScheduleId, DeleteBatchJobScheduleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Deletes a Job Schedule from the specified Account. When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to delete.
      options - Optional parameters for Delete Job Schedule operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteJobSchedule

      public Mono<Void> deleteJobSchedule(String jobScheduleId)
      Deletes a Job Schedule from the specified Account. When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to delete.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJobSchedule

      public Mono<BatchJobSchedule> getJobSchedule(String jobScheduleId, GetBatchJobScheduleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Gets information about the specified Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to get.
      options - Optional parameters for Get Job Schedule operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      information about the specified Job Schedule on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getJobSchedule

      public Mono<BatchJobSchedule> getJobSchedule(String jobScheduleId)
      Gets information about the specified Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to get.
      Returns:
      information about the specified Job Schedule on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateJobSchedule

      public Mono<Void> updateJobSchedule(String jobScheduleId, BatchJobScheduleUpdateContent jobSchedule, UpdateBatchJobScheduleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Updates the properties of the specified Job Schedule. This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to update.
      jobSchedule - The options to use for updating the Job Schedule.
      options - Optional parameters for Update Job Schedule operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateJobSchedule

      public Mono<Void> updateJobSchedule(String jobScheduleId, BatchJobScheduleUpdateContent jobSchedule)
      Updates the properties of the specified Job Schedule. This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to update.
      jobSchedule - The options to use for updating the Job Schedule.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceJobSchedule

      public Mono<Void> replaceJobSchedule(String jobScheduleId, BatchJobSchedule jobSchedule, ReplaceBatchJobScheduleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Updates the properties of the specified Job Schedule. This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to update.
      jobSchedule - A Job Schedule with updated properties.
      options - Optional parameters for Replace Job Schedule operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceJobSchedule

      public Mono<Void> replaceJobSchedule(String jobScheduleId, BatchJobSchedule jobSchedule)
      Updates the properties of the specified Job Schedule. This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to update.
      jobSchedule - A Job Schedule with updated properties.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableJobSchedule

      public Mono<Void> disableJobSchedule(String jobScheduleId, DisableBatchJobScheduleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Disables a Job Schedule. No new Jobs will be created until the Job Schedule is enabled again.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to disable.
      options - Optional parameters for Disable Job Schedule operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableJobSchedule

      public Mono<Void> disableJobSchedule(String jobScheduleId)
      Disables a Job Schedule. No new Jobs will be created until the Job Schedule is enabled again.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to disable.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enableJobSchedule

      public Mono<Void> enableJobSchedule(String jobScheduleId, EnableBatchJobScheduleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Enables a Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to enable.
      options - Optional parameters for Enable Job Schedule operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enableJobSchedule

      public Mono<Void> enableJobSchedule(String jobScheduleId)
      Enables a Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to enable.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • terminateJobSchedule

      public Mono<Void> terminateJobSchedule(String jobScheduleId, TerminateBatchJobScheduleOptions options, com.azure.core.http.RequestConditions requestConditions)
      Terminates a Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to terminates.
      options - Optional parameters for Terminate Job Schedule operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • terminateJobSchedule

      public Mono<Void> terminateJobSchedule(String jobScheduleId)
      Terminates a Job Schedule.
      Parameters:
      jobScheduleId - The ID of the Job Schedule to terminates.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createJobSchedule

      public Mono<Void> createJobSchedule(BatchJobScheduleCreateContent jobSchedule, CreateBatchJobScheduleOptions options)
      Creates a Job Schedule to the specified Account.
      Parameters:
      jobSchedule - The Job Schedule to be created.
      options - Optional parameters for Create Job Schedule operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createJobSchedule

      public Mono<Void> createJobSchedule(BatchJobScheduleCreateContent jobSchedule)
      Creates a Job Schedule to the specified Account.
      Parameters:
      jobSchedule - The Job Schedule to be created.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobSchedules

      public com.azure.core.http.rest.PagedFlux<BatchJobSchedule> listJobSchedules(ListBatchJobSchedulesOptions options)
      Lists all of the Job Schedules in the specified Account.
      Parameters:
      options - Optional parameters for List Job Schedules operation.
      Returns:
      the result of listing the Job Schedules in an Account as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listJobSchedules

      public com.azure.core.http.rest.PagedFlux<BatchJobSchedule> listJobSchedules()
      Lists all of the Job Schedules in the specified Account.
      Returns:
      the result of listing the Job Schedules in an Account as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createTask

      public Mono<Void> createTask(String jobId, BatchTaskCreateContent task, CreateBatchTaskOptions options)
      Creates a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.
      Parameters:
      jobId - The ID of the Job to which the Task is to be created.
      task - The Task to be created.
      options - Optional parameters for Create Task operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createTask

      public Mono<Void> createTask(String jobId, BatchTaskCreateContent task)
      Creates a Task to the specified Job. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.
      Parameters:
      jobId - The ID of the Job to which the Task is to be created.
      task - The Task to be created.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listTasks

      public com.azure.core.http.rest.PagedFlux<BatchTask> listTasks(String jobId, ListBatchTasksOptions options)
      Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.
      Parameters:
      jobId - The ID of the Job.
      options - Optional parameters for List Tasks operation.
      Returns:
      the result of listing the Tasks in a Job as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listTasks

      public com.azure.core.http.rest.PagedFlux<BatchTask> listTasks(String jobId)
      Lists all of the Tasks that are associated with the specified Job. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.
      Parameters:
      jobId - The ID of the Job.
      Returns:
      the result of listing the Tasks in a Job as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createTaskCollection

      public Mono<BatchTaskAddCollectionResult> createTaskCollection(String jobId, BatchTaskGroup taskCollection, CreateBatchTaskCollectionOptions options)
      Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.
      Parameters:
      jobId - The ID of the Job to which the Task collection is to be added.
      taskCollection - The Tasks to be added.
      options - Optional parameters for Create Task Collection operation.
      Returns:
      the result of adding a collection of Tasks to a Job on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createTaskCollection

      public Mono<BatchTaskAddCollectionResult> createTaskCollection(String jobId, BatchTaskGroup taskCollection)
      Adds a collection of Tasks to the specified Job. Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.
      Parameters:
      jobId - The ID of the Job to which the Task collection is to be added.
      taskCollection - The Tasks to be added.
      Returns:
      the result of adding a collection of Tasks to a Job on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteTask

      public Mono<Void> deleteTask(String jobId, String taskId, DeleteBatchTaskOptions options, com.azure.core.http.RequestConditions requestConditions)
      Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.
      Parameters:
      jobId - The ID of the Job from which to delete the Task.
      taskId - The ID of the Task to delete.
      options - Optional parameters for Delete Task operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteTask

      public Mono<Void> deleteTask(String jobId, String taskId)
      Deletes a Task from the specified Job. When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.
      Parameters:
      jobId - The ID of the Job from which to delete the Task.
      taskId - The ID of the Task to delete.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getTask

      public Mono<BatchTask> getTask(String jobId, String taskId, GetBatchTaskOptions options, com.azure.core.http.RequestConditions requestConditions)
      Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task to get information about.
      options - Optional parameters for Get Task operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getTask

      public Mono<BatchTask> getTask(String jobId, String taskId)
      Gets information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task to get information about.
      Returns:
      information about the specified Task. For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceTask

      public Mono<Void> replaceTask(String jobId, String taskId, BatchTask task, ReplaceBatchTaskOptions options, com.azure.core.http.RequestConditions requestConditions)
      Updates the properties of the specified Task.
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to update.
      task - The Task to update.
      options - Optional parameters for Replace Task operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceTask

      public Mono<Void> replaceTask(String jobId, String taskId, BatchTask task)
      Updates the properties of the specified Task.
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to update.
      task - The Task to update.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSubTasks

      public com.azure.core.http.rest.PagedFlux<BatchSubtask> listSubTasks(String jobId, String taskId, ListBatchSubTasksOptions options)
      Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.
      Parameters:
      jobId - The ID of the Job.
      taskId - The ID of the Task.
      options - Optional parameters for List SubTasks operation.
      Returns:
      the result of listing the subtasks of a Task as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSubTasks

      public com.azure.core.http.rest.PagedFlux<BatchSubtask> listSubTasks(String jobId, String taskId)
      Lists all of the subtasks that are associated with the specified multi-instance Task. If the Task is not a multi-instance Task then this returns an empty collection.
      Parameters:
      jobId - The ID of the Job.
      taskId - The ID of the Task.
      Returns:
      the result of listing the subtasks of a Task as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • terminateTask

      public Mono<Void> terminateTask(String jobId, String taskId, TerminateBatchTaskOptions options, com.azure.core.http.RequestConditions requestConditions)
      Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to terminate.
      options - Optional parameters for Terminate Task operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • terminateTask

      public Mono<Void> terminateTask(String jobId, String taskId)
      Terminates the specified Task. When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to terminate.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reactivateTask

      public Mono<Void> reactivateTask(String jobId, String taskId, ReactivateBatchTaskOptions options, com.azure.core.http.RequestConditions requestConditions)
      Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to reactivate.
      options - Optional parameters for Reactivate Task operation.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reactivateTask

      public Mono<Void> reactivateTask(String jobId, String taskId)
      Reactivates a Task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).
      Parameters:
      jobId - The ID of the Job containing the Task.
      taskId - The ID of the Task to reactivate.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteTaskFile

      public Mono<Void> deleteTaskFile(String jobId, String taskId, String filePath, DeleteBatchTaskFileOptions options)
      Deletes the specified Task file from the Compute Node where the Task ran.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      options - Optional parameters for Delete Task File operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteTaskFile

      public Mono<Void> deleteTaskFile(String jobId, String taskId, String filePath)
      Deletes the specified Task file from the Compute Node where the Task ran.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getTaskFile

      public Mono<com.azure.core.util.BinaryData> getTaskFile(String jobId, String taskId, String filePath, GetBatchTaskFileOptions options)
      Returns the content of the specified Task file.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      options - Optional parameters for Get Task File operation.
      Returns:
      the response body on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getTaskFile

      public Mono<com.azure.core.util.BinaryData> getTaskFile(String jobId, String taskId, String filePath)
      Returns the content of the specified Task file.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      Returns:
      the response body on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getTaskFileProperties

      public Mono<FileResponseHeaderProperties> getTaskFileProperties(String jobId, String taskId, String filePath, GetBatchTaskFilePropertiesOptions options)
      Gets the properties of the specified Task file.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      options - Optional parameters for Get Task File Properties operation.
      Returns:
      the properties of the specified Task file on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getTaskFileProperties

      public Mono<FileResponseHeaderProperties> getTaskFileProperties(String jobId, String taskId, String filePath)
      Gets the properties of the specified Task file.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose file you want to retrieve.
      filePath - The path to the Task file that you want to get the content of.
      Returns:
      the properties of the specified Task file on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listTaskFiles

      public com.azure.core.http.rest.PagedFlux<BatchNodeFile> listTaskFiles(String jobId, String taskId, ListBatchTaskFilesOptions options)
      Lists the files in a Task's directory on its Compute Node.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose files you want to list.
      options - Optional parameters for List Task Files operation.
      Returns:
      the result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listTaskFiles

      public com.azure.core.http.rest.PagedFlux<BatchNodeFile> listTaskFiles(String jobId, String taskId)
      Lists the files in a Task's directory on its Compute Node.
      Parameters:
      jobId - The ID of the Job that contains the Task.
      taskId - The ID of the Task whose files you want to list.
      Returns:
      the result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createNodeUser

      public Mono<Void> createNodeUser(String poolId, String nodeId, BatchNodeUserCreateContent user, CreateBatchNodeUserOptions options)
      Adds a user Account to the specified Compute Node. You can add a user Account to a Compute Node only when it is in the idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to create a user Account.
      user - The options to use for creating the user.
      options - Optional parameters for Create Node User operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createNodeUser

      public Mono<Void> createNodeUser(String poolId, String nodeId, BatchNodeUserCreateContent user)
      Adds a user Account to the specified Compute Node. You can add a user Account to a Compute Node only when it is in the idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to create a user Account.
      user - The options to use for creating the user.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteNodeUser

      public Mono<Void> deleteNodeUser(String poolId, String nodeId, String userName, DeleteBatchNodeUserOptions options)
      Deletes a user Account from the specified Compute Node. You can delete a user Account to a Compute Node only when it is in the idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to delete a user Account.
      userName - The name of the user Account to delete.
      options - Optional parameters for Delete Node User operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteNodeUser

      public Mono<Void> deleteNodeUser(String poolId, String nodeId, String userName)
      Deletes a user Account from the specified Compute Node. You can delete a user Account to a Compute Node only when it is in the idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to delete a user Account.
      userName - The name of the user Account to delete.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceNodeUser

      public Mono<Void> replaceNodeUser(String poolId, String nodeId, String userName, BatchNodeUserUpdateContent content, ReplaceBatchNodeUserOptions options)
      Updates the password and expiration time of a user Account on the specified Compute Node. This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to update a user Account.
      userName - The name of the user Account to update.
      content - The options to use for updating the user.
      options - Optional parameters for Replace Node User operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • replaceNodeUser

      public Mono<Void> replaceNodeUser(String poolId, String nodeId, String userName, BatchNodeUserUpdateContent content)
      Updates the password and expiration time of a user Account on the specified Compute Node. This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the machine on which you want to update a user Account.
      userName - The name of the user Account to update.
      content - The options to use for updating the user.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNode

      public Mono<BatchNode> getNode(String poolId, String nodeId, GetBatchNodeOptions options)
      Gets information about the specified Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to get information about.
      options - Optional parameters for Get Node operation.
      Returns:
      information about the specified Compute Node on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNode

      public Mono<BatchNode> getNode(String poolId, String nodeId)
      Gets information about the specified Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to get information about.
      Returns:
      information about the specified Compute Node on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • rebootNode

      public Mono<Void> rebootNode(String poolId, String nodeId, RebootBatchNodeOptions options)
      Restarts the specified Compute Node. You can restart a Compute Node only if it is in an idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      options - Optional parameters for Reboot Node operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • rebootNode

      public Mono<Void> rebootNode(String poolId, String nodeId)
      Restarts the specified Compute Node. You can restart a Compute Node only if it is in an idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • startNode

      public Mono<Void> startNode(String poolId, String nodeId, StartBatchNodeOptions options)
      Starts the specified Compute Node. You can start a Compute Node only if it has been deallocated.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      options - Optional parameters for Start Node operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • startNode

      public Mono<Void> startNode(String poolId, String nodeId)
      Starts the specified Compute Node. You can start a Compute Node only if it has been deallocated.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reimageNode

      public Mono<Void> reimageNode(String poolId, String nodeId, ReimageBatchNodeOptions options)
      Reinstalls the operating system on the specified Compute Node. You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      options - Optional parameters for Reimage Node operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reimageNode

      public Mono<Void> reimageNode(String poolId, String nodeId)
      Reinstalls the operating system on the specified Compute Node. You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deallocateNode

      public Mono<Void> deallocateNode(String poolId, String nodeId, DeallocateBatchNodeOptions options)
      Deallocates the specified Compute Node. You can deallocate a Compute Node only if it is in an idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      options - Optional parameters for Deallocate Node operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deallocateNode

      public Mono<Void> deallocateNode(String poolId, String nodeId)
      Deallocates the specified Compute Node. You can deallocate a Compute Node only if it is in an idle or running state.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that you want to restart.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableNodeScheduling

      public Mono<Void> disableNodeScheduling(String poolId, String nodeId, DisableBatchNodeSchedulingOptions options)
      Disables Task scheduling on the specified Compute Node. You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node on which you want to disable Task scheduling.
      options - Optional parameters for Disable Node Scheduling operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • disableNodeScheduling

      public Mono<Void> disableNodeScheduling(String poolId, String nodeId)
      Disables Task scheduling on the specified Compute Node. You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node on which you want to disable Task scheduling.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enableNodeScheduling

      public Mono<Void> enableNodeScheduling(String poolId, String nodeId, EnableBatchNodeSchedulingOptions options)
      Enables Task scheduling on the specified Compute Node. You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node on which you want to enable Task scheduling.
      options - Optional parameters for Enable Node Scheduling operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • enableNodeScheduling

      public Mono<Void> enableNodeScheduling(String poolId, String nodeId)
      Enables Task scheduling on the specified Compute Node. You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node on which you want to enable Task scheduling.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeRemoteLoginSettings

      public Mono<BatchNodeRemoteLoginSettings> getNodeRemoteLoginSettings(String poolId, String nodeId, GetBatchNodeRemoteLoginSettingsOptions options)
      Gets the settings required for remote login to a Compute Node. Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node for which to obtain the remote login settings.
      options - Optional parameters for Get Node Remote Login Settings operation.
      Returns:
      the settings required for remote login to a Compute Node. Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeRemoteLoginSettings

      public Mono<BatchNodeRemoteLoginSettings> getNodeRemoteLoginSettings(String poolId, String nodeId)
      Gets the settings required for remote login to a Compute Node. Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node for which to obtain the remote login settings.
      Returns:
      the settings required for remote login to a Compute Node. Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • uploadNodeLogs

      public Mono<UploadBatchServiceLogsResult> uploadNodeLogs(String poolId, String nodeId, UploadBatchServiceLogsContent content, UploadBatchNodeLogsOptions options)
      Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage. This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.
      content - The Azure Batch service log files upload options.
      options - Optional parameters for Upload Node Logs operation.
      Returns:
      the result of uploading Batch service log files from a specific Compute Node on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • uploadNodeLogs

      public Mono<UploadBatchServiceLogsResult> uploadNodeLogs(String poolId, String nodeId, UploadBatchServiceLogsContent content)
      Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage. This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.
      content - The Azure Batch service log files upload options.
      Returns:
      the result of uploading Batch service log files from a specific Compute Node on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listNodes

      public com.azure.core.http.rest.PagedFlux<BatchNode> listNodes(String poolId, ListBatchNodesOptions options)
      Lists the Compute Nodes in the specified Pool.
      Parameters:
      poolId - The ID of the Pool from which you want to list Compute Nodes.
      options - Optional parameters for List Nodes operation.
      Returns:
      the result of listing the Compute Nodes in a Pool as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listNodes

      public com.azure.core.http.rest.PagedFlux<BatchNode> listNodes(String poolId)
      Lists the Compute Nodes in the specified Pool.
      Parameters:
      poolId - The ID of the Pool from which you want to list Compute Nodes.
      Returns:
      the result of listing the Compute Nodes in a Pool as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeExtension

      public Mono<BatchNodeVMExtension> getNodeExtension(String poolId, String nodeId, String extensionName, GetBatchNodeExtensionOptions options)
      Gets information about the specified Compute Node Extension.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that contains the extensions.
      extensionName - The name of the Compute Node Extension that you want to get information about.
      options - Optional parameters for Get Node Extension operation.
      Returns:
      information about the specified Compute Node Extension on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeExtension

      public Mono<BatchNodeVMExtension> getNodeExtension(String poolId, String nodeId, String extensionName)
      Gets information about the specified Compute Node Extension.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node that contains the extensions.
      extensionName - The name of the Compute Node Extension that you want to get information about.
      Returns:
      information about the specified Compute Node Extension on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listNodeExtensions

      public com.azure.core.http.rest.PagedFlux<BatchNodeVMExtension> listNodeExtensions(String poolId, String nodeId, ListBatchNodeExtensionsOptions options)
      Lists the Compute Nodes Extensions in the specified Pool.
      Parameters:
      poolId - The ID of the Pool that contains Compute Node.
      nodeId - The ID of the Compute Node that you want to list extensions.
      options - Optional parameters for List Node Extensions operation.
      Returns:
      the result of listing the Compute Node extensions in a Node as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listNodeExtensions

      public com.azure.core.http.rest.PagedFlux<BatchNodeVMExtension> listNodeExtensions(String poolId, String nodeId)
      Lists the Compute Nodes Extensions in the specified Pool.
      Parameters:
      poolId - The ID of the Pool that contains Compute Node.
      nodeId - The ID of the Compute Node that you want to list extensions.
      Returns:
      the result of listing the Compute Node extensions in a Node as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteNodeFile

      public Mono<Void> deleteNodeFile(String poolId, String nodeId, String filePath, DeleteBatchNodeFileOptions options)
      Deletes the specified file from the Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      options - Optional parameters for Delete Node File operation.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteNodeFile

      public Mono<Void> deleteNodeFile(String poolId, String nodeId, String filePath)
      Deletes the specified file from the Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      Returns:
      A Mono that completes when a successful response is received.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeFile

      public Mono<com.azure.core.util.BinaryData> getNodeFile(String poolId, String nodeId, String filePath, GetBatchNodeFileOptions options)
      Returns the content of the specified Compute Node file.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      options - Optional parameters for Get Node File operation.
      Returns:
      the response body on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeFile

      public Mono<com.azure.core.util.BinaryData> getNodeFile(String poolId, String nodeId, String filePath)
      Returns the content of the specified Compute Node file.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      Returns:
      the response body on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeFileProperties

      public Mono<FileResponseHeaderProperties> getNodeFileProperties(String poolId, String nodeId, String filePath, GetBatchNodeFilePropertiesOptions options)
      Gets the properties of the specified Compute Node file.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      options - Optional parameters for Get Node File Properties operation.
      Returns:
      the properties of the specified Compute Node file on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getNodeFileProperties

      public Mono<FileResponseHeaderProperties> getNodeFileProperties(String poolId, String nodeId, String filePath)
      Gets the properties of the specified Compute Node file.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node.
      filePath - The path to the file or directory.
      Returns:
      the properties of the specified Compute Node file on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listNodeFiles

      public com.azure.core.http.rest.PagedFlux<BatchNodeFile> listNodeFiles(String poolId, String nodeId, ListBatchNodeFilesOptions options)
      Lists all of the files in Task directories on the specified Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node whose files you want to list.
      options - Optional parameters for List Node Files operation.
      Returns:
      the result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listNodeFiles

      public com.azure.core.http.rest.PagedFlux<BatchNodeFile> listNodeFiles(String poolId, String nodeId)
      Lists all of the files in Task directories on the specified Compute Node.
      Parameters:
      poolId - The ID of the Pool that contains the Compute Node.
      nodeId - The ID of the Compute Node whose files you want to list.
      Returns:
      the result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.