Updated preview API to add Kernel Config (#25361)

* Updated preview API to add Kernel Config and LRO Headers * Fixing formatting issue * Updated as per comments * Updated as per comments * Reverting changes * Reverted header changes * Reverting change * Reverting example * Added version parameter and removed addition properties as per guidelines --------- Co-authored-by: Srivatsa Sinha <srsinha@microsoft.com>
Azure · Sep 27, 2023 · 5f4676c · 5f4676c
1 parent 8f31487
commit 5f4676c
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 3 deletions.
diff --git a/...gServices/preview/2023-08-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json b/...gServices/preview/2023-08-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json
@@ -57,7 +57,16 @@
                   "target": "/home/testuser/",
                   "readOnly": true
                 }
-              ]
+              ],
+              "kernel": {
+                "displayName": "TestKernel",
+                "language": "python",
+                "argv": [
+                  "option1",
+                  "option2",
+                  "option3"
+                ]
+              }
             }
           ],
           "computeInstanceAuthorizationType": "personal",

diff --git a/...Microsoft.MachineLearningServices/preview/2023-08-01-preview/machineLearningServices.json b/...Microsoft.MachineLearningServices/preview/2023-08-01-preview/machineLearningServices.json
@@ -2992,6 +2992,10 @@
             "source",
             "target"
           ]
+        },
+        "kernel": {
+          "description": "Describes the jupyter kernel settings for the image if its a custom environment",
+          "$ref": "#/definitions/JupyterKernelConfig"
         }
       },
       "additionalProperties": true
@@ -3007,15 +3011,19 @@
           ],
           "type": "string",
           "title": "Type of the image",
-          "description": "Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images",
+          "description": "Type of the image. Possible values are: docker - For docker images. azureml - For AzureML Environment images (custom and curated)",
           "x-ms-enum": {
             "name": "ImageType",
             "modelAsString": true
           }
         },
         "reference": {
           "type": "string",
-          "description": "Image reference URL"
+          "description": "Image reference URL if type is docker. Environment name if type is azureml"
+        },
+        "version": {
+          "type": "string",
+          "description": "Version of image being used. If latest then skip this field"
         }
       },
       "additionalProperties": true
@@ -3188,6 +3196,28 @@
         }
       }
     },
+    "JupyterKernelConfig": {
+      "type": "object",
+      "description": "Jupyter kernel configuration.",
+      "properties": {
+        "argv": {
+          "type": "array",
+          "description": "Argument to the the runtime",
+          "items": {
+            "type": "string",
+            "description": "argument values"
+          }
+        },
+        "displayName": {
+          "type": "string",
+          "description": "Display name of the kernel"
+        },
+        "language": {
+          "type": "string",
+          "description": "Language of the kernel [Example value: python]"
+        }
+      }
+    },
     "ComputeInstanceAutologgerSettings": {
       "type": "object",
       "description": "Specifies settings for autologger.",