[Batch] Updated job schedule description (#15681)

The behavior of job schedules with respect to UTC time was causing some confusion. Co-authored-by: David Watrous <set>
Azure · Aug 18, 2021 · 0a68678 · 0a68678
1 parent b60aed7
commit 0a68678
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/BatchService.json
@@ -11631,7 +11631,7 @@
           "description": "Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
         }
       },
-      "title": "The schedule according to which Jobs will be created"
+      "title": "The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time."
     },
     "JobConstraints": {
       "type": "object",
@@ -12928,7 +12928,8 @@
         },
         "schedule": {
           "$ref": "#/definitions/Schedule",
-          "title": "The schedule according to which Jobs will be created."
+          "title": "The schedule according to which Jobs will be created.",
+          "description": "All times are fixed respective to UTC and are not impacted by daylight saving time."
         },
         "jobSpecification": {
           "$ref": "#/definitions/JobSpecification",
@@ -12968,7 +12969,8 @@
         },
         "schedule": {
           "$ref": "#/definitions/Schedule",
-          "title": "The schedule according to which Jobs will be created."
+          "title": "The schedule according to which Jobs will be created.",
+          "description": "All times are fixed respective to UTC and are not impacted by daylight saving time."
         },
         "jobSpecification": {
           "$ref": "#/definitions/JobSpecification",
@@ -16107,7 +16109,7 @@
         "schedule": {
           "$ref": "#/definitions/Schedule",
           "title": "The schedule according to which Jobs will be created.",
-          "description": "If you do not specify this element, the existing schedule is left unchanged."
+          "description": "All times are fixed respective to UTC and are not impacted by daylight saving time. If you do not specify this element, the existing schedule is left unchanged."
         },
         "jobSpecification": {
           "$ref": "#/definitions/JobSpecification",
@@ -16131,7 +16133,7 @@
         "schedule": {
           "$ref": "#/definitions/Schedule",
           "title": "The schedule according to which Jobs will be created.",
-          "description": "If you do not specify this element, it is equivalent to passing the default schedule: that is, a single Job scheduled to run immediately."
+          "description": "All times are fixed respective to UTC and are not impacted by daylight saving time. If you do not specify this element, it is equivalent to passing the default schedule: that is, a single Job scheduled to run immediately."
         },
         "jobSpecification": {
           "$ref": "#/definitions/JobSpecification",