Add azureml schedule trigger once arm API contract in 2024-01-01-prev…

…iew (Azure#27116) * Add azureml schedule trigger once arm API contract in 2024-01-01-preview * Fix error * Prettier * Fix wording and update sample value. * Update
kseager · Jan 9, 2024 · 4254c79 · 4254c79
1 parent 6137ac9
commit 4254c79
Show file tree

Hide file tree

Showing 2 changed files with 148 additions and 0 deletions.
diff --git a/...crosoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/trigger.json b/...crosoft.MachineLearningServices/preview/2024-01-01-preview/examples/Schedule/trigger.json
@@ -0,0 +1,21 @@
+{
+  "parameters": {
+    "subscriptionId": "00000000-1111-2222-3333-444444444444",
+    "resourceGroupName": "test-rg",
+    "workspaceName": "my-aml-workspace",
+    "name": "test-schedule",
+    "api-version": "2024-01-01-preview",
+    "body": {
+      "scheduleTime": "2024-01-01T12:34:56.999Z"
+    }
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "scheduleActionType": "CreateJob",
+        "submissionId": "createjob-test-job-id"
+      }
+    }
+  }
+}
diff --git a/...es/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/mfe.json b/...es/resource-manager/Microsoft.MachineLearningServices/preview/2024-01-01-preview/mfe.json
@@ -13660,6 +13660,70 @@
         }
       }
     },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}/trigger": {
+      "post": {
+        "tags": [
+          "Schedule"
+        ],
+        "summary": "Trigger run.",
+        "operationId": "Schedules_Trigger",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+          },
+          {
+            "in": "path",
+            "name": "name",
+            "description": "Schedule name.",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "in": "body",
+            "name": "body",
+            "description": "Request body for trigger once",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/TriggerOnceRequest"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": "Error",
+            "schema": {
+              "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+            }
+          },
+          "200": {
+            "description": "Success",
+            "schema": {
+              "$ref": "#/definitions/TriggerRunSubmissionDto"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Trigger Schedule.": {
+            "$ref": "./examples/Schedule/trigger.json"
+          }
+        }
+      }
+    },
     "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints": {
       "get": {
         "tags": [
@@ -27666,6 +27730,42 @@
       },
       "additionalProperties": false
     },
+    "ScheduleType": {
+      "enum": [
+        "ComputeStartStop",
+        "CreateJob",
+        "InvokeBatchEndpoint",
+        "ImportData",
+        "CreateMonitor",
+        "FeatureStoreMaterialization"
+      ],
+      "type": "string",
+      "x-ms-enum": {
+        "name": "ScheduleType",
+        "modelAsString": true,
+        "values": [
+          {
+            "value": "ComputeStartStop"
+          },
+          {
+            "value": "CreateJob"
+          },
+          {
+            "value": "InvokeBatchEndpoint"
+          },
+          {
+            "value": "ImportData"
+          },
+          {
+            "value": "CreateMonitor"
+          },
+          {
+            "value": "FeatureStoreMaterialization"
+          }
+        ]
+      },
+      "additionalProperties": false
+    },
     "Seasonality": {
       "description": "Forecasting seasonality.",
       "required": [
@@ -29828,6 +29928,33 @@
       },
       "discriminator": "triggerType"
     },
+    "TriggerOnceRequest": {
+      "required": [
+        "scheduleTime"
+      ],
+      "type": "object",
+      "properties": {
+        "scheduleTime": {
+          "description": "[Required] Specify the schedule time for trigger once",
+          "minLength": 1,
+          "pattern": "[a-zA-Z0-9_]",
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "TriggerRunSubmissionDto": {
+      "type": "object",
+      "properties": {
+        "scheduleActionType": {
+          "$ref": "#/definitions/ScheduleType"
+        },
+        "submissionId": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
     "TriggerType": {
       "enum": [
         "Recurrence",