diff --git a/custom-words.txt b/custom-words.txt index 8c3a52677ce5..7251ae0afc6b 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -760,6 +760,10 @@ Fcontoso FDID fearthecowboy featurecapabilities +Featureset +featuresets +featurestore +Featurestore featurestate Featurization featurized diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/createOrUpdate.json index e5076882b9d8..439e50c5ecfa 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/createOrUpdate.json @@ -23,6 +23,9 @@ "endpoint": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, @@ -31,46 +34,68 @@ "identity": { "identityType": "AMLToken" }, - "jobType": "AutoML", + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + "f69c8d5a-9b39-4183-92d3-a2b18944cf95": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, + "codeId": "string", + "command": "string", "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "taskDetails": { - "taskType": "ImageClassification", - "limitSettings": { - "maxTrials": 2 - }, - "targetColumnName": "string", - "trainingData": { - "jobInputType": "mltable", - "uri": "string" - }, - "modelSettings": { - "validationCropSize": 2 - }, - "searchSpace": [ - { - "validationCropSize": "choice(2, 360)" - } - ] + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, "outputs": { "string": { "description": "string", "uri": "string", - "mode": "ReadWriteMount", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", "jobOutputType": "uri_file" } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 } } } @@ -91,7 +116,7 @@ "string": "string" }, "displayName": "string", - "status": "Scheduled", + "status": "CancelRequested", "experimentName": "string", "services": { "string": { @@ -102,6 +127,9 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, @@ -110,55 +138,80 @@ "identity": { "identityType": "AMLToken" }, - "jobType": "AutoML", + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + "94ce04ed-3b17-4e48-a2a6-a923068268fd": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, + "codeId": "string", + "command": "string", "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "taskDetails": { - "taskType": "ImageClassification", - "limitSettings": { - "maxTrials": 2 - }, - "targetColumnName": "string", - "trainingData": { - "jobInputType": "mltable", - "uri": "string" - }, - "modelSettings": { - "validationCropSize": 2 - }, - "searchSpace": [ - { - "validationCropSize": "choice(2, 360)" - } - ] + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, "outputs": { "string": { "description": "string", "uri": "string", + "assetName": "string", + "assetVersion": "string", "mode": "ReadWriteMount", "jobOutputType": "uri_file" } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "a6f57022-8e31-44db-98e6-fa9495abb01c": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:22", "createdBy": "string", "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", "lastModifiedBy": "string", - "lastModifiedByType": "ManagedIdentity" + "lastModifiedByType": "Application" } } }, @@ -177,7 +230,7 @@ "string": "string" }, "displayName": "string", - "status": "Scheduled", + "status": "Provisioning", "experimentName": "string", "services": { "string": { @@ -188,6 +241,9 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, @@ -196,53 +252,78 @@ "identity": { "identityType": "AMLToken" }, - "jobType": "AutoML", + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + "0aec33cb-4916-4b3b-b610-35f3f78cc6f0": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, + "codeId": "string", + "command": "string", "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "taskDetails": { - "taskType": "ImageClassification", - "limitSettings": { - "maxTrials": 2 - }, - "targetColumnName": "string", - "trainingData": { - "jobInputType": "mltable", - "uri": "string" - }, - "modelSettings": { - "validationCropSize": 2 - }, - "searchSpace": [ - { - "validationCropSize": "choice(2, 360)" - } - ] + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, "outputs": { "string": { "description": "string", "uri": "string", - "mode": "ReadWriteMount", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", "jobOutputType": "uri_file" } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "342c3b36-f4d6-4af6-8410-7198803cff8f": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:22", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", "lastModifiedBy": "string", "lastModifiedByType": "ManagedIdentity" } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/get.json index 635bebaea835..88db7e14147f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/get.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/get.json @@ -33,6 +33,9 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, @@ -41,55 +44,80 @@ "identity": { "identityType": "AMLToken" }, - "jobType": "AutoML", + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + "9c4f5d89-ed21-42e3-9263-246633ca4a50": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, + "codeId": "string", + "command": "string", "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "taskDetails": { - "taskType": "ImageClassification", - "limitSettings": { - "maxTrials": 2 - }, - "targetColumnName": "string", - "trainingData": { - "jobInputType": "mltable", - "uri": "string" - }, - "modelSettings": { - "validationCropSize": 2 - }, - "searchSpace": [ - { - "validationCropSize": "choice(2, 360)" - } - ] + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, "outputs": { "string": { "description": "string", "uri": "string", - "mode": "ReadWriteMount", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", "jobOutputType": "uri_file" } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "30a01c8b-9d69-4924-8a14-63a1fbd78f3a": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:19", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:19", "lastModifiedBy": "string", - "lastModifiedByType": "ManagedIdentity" + "lastModifiedByType": "Key" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/list.json index 15cef79b72aa..c094a4d0ca8e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/list.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/AutoMLJob/list.json @@ -3,7 +3,14 @@ "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "test-rg", "workspaceName": "my-aml-workspace", - "api-version": "2023-02-01-preview" + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "All", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" }, "responses": { "200": { @@ -23,7 +30,7 @@ "string": "string" }, "displayName": "string", - "status": "Scheduled", + "status": "Failed", "experimentName": "string", "services": { "string": { @@ -34,6 +41,9 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, @@ -42,58 +52,84 @@ "identity": { "identityType": "AMLToken" }, - "jobType": "AutoML", + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": null + "4e53b3df-bd02-42d1-a3cd-ee4678c0b79f": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, + "codeId": "string", + "command": "string", "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "taskDetails": { - "taskType": "ImageClassification", - "limitSettings": { - "maxTrials": 2 - }, - "targetColumnName": "string", - "trainingData": { - "jobInputType": "mltable", - "uri": "string" - }, - "modelSettings": { - "validationCropSize": 2 - }, - "searchSpace": [ - { - "validationCropSize": "choice(2, 360)" - } - ] + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, "outputs": { "string": { "description": "string", "uri": "string", + "assetName": "string", + "assetVersion": "string", "mode": "ReadWriteMount", "jobOutputType": "uri_file" } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "1a89709e-1af8-41de-99c1-0349bd20e005": null + }, + "queueSettings": { + "jobTier": "Spot", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:22", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", "lastModifiedBy": "string", - "lastModifiedByType": "ManagedIdentity" + "lastModifiedByType": "User" } } - ] + ], + "nextLink": "string" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/createOrUpdate.json index 69686063c3d0..fe5bfea6b3af 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/createOrUpdate.json @@ -23,19 +23,40 @@ "endpoint": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "e6b6493e-7d5e-4db3-be1e-306ec641327e": null + "c9ac10d0-915b-4de5-afe8-a4c78a37a558": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, "codeId": "string", "command": "string", @@ -50,9 +71,11 @@ "outputs": { "string": { "description": "string", - "jobOutputType": "uri_file", - "mode": "ReadWriteMount", - "uri": "string" + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" } }, "distribution": { @@ -61,7 +84,7 @@ "parameterServerCount": 1 }, "autologgerSettings": { - "mlflowAutologger": "Enabled" + "mlflowAutologger": "Disabled" }, "limits": { "timeout": "PT5M", @@ -70,8 +93,9 @@ "environmentVariables": { "string": "string" }, - "identity": { - "identityType": "AMLToken" + "queueSettings": { + "jobTier": "Basic", + "priority": 1 } } } @@ -92,7 +116,7 @@ "string": "string" }, "displayName": "string", - "status": "NotStarted", + "status": "Queued", "experimentName": "string", "services": { "string": { @@ -103,19 +127,40 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "a0847709-f5aa-4561-8ba5-d915d403fdcf": null + "500bc411-5f81-4b2c-aae9-f84c33146a4c": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, "codeId": "string", "command": "string", @@ -130,9 +175,11 @@ "outputs": { "string": { "description": "string", - "jobOutputType": "uri_file", - "mode": "ReadWriteMount", - "uri": "string" + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" } }, "distribution": { @@ -140,6 +187,9 @@ "workerCount": 1, "parameterServerCount": 1 }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, "limits": { "timeout": "PT5M", "jobLimitsType": "Command" @@ -147,20 +197,21 @@ "environmentVariables": { "string": "string" }, - "identity": { - "identityType": "AMLToken" - }, "parameters": { - "string": "string" + "56fc2716-8290-4394-867e-14e89387af68": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:23", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", "lastModifiedBy": "string", - "lastModifiedByType": "User" + "lastModifiedByType": "Application" } } }, @@ -179,7 +230,7 @@ "string": "string" }, "displayName": "string", - "status": "NotStarted", + "status": "Preparing", "experimentName": "string", "services": { "string": { @@ -190,19 +241,40 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "b8163d40-c351-43d6-8a34-d0cd895b8a5a": null + "56a57b62-09f2-48ee-a4ec-a19a230a6aa0": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, "codeId": "string", "command": "string", @@ -217,9 +289,11 @@ "outputs": { "string": { "description": "string", - "jobOutputType": "uri_file", - "mode": "ReadWriteMount", - "uri": "string" + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" } }, "distribution": { @@ -227,6 +301,9 @@ "workerCount": 1, "parameterServerCount": 1 }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, "limits": { "timeout": "PT5M", "jobLimitsType": "Command" @@ -234,20 +311,21 @@ "environmentVariables": { "string": "string" }, - "identity": { - "identityType": "AMLToken" - }, "parameters": { - "string": "string" + "e3455adb-ad77-4518-985a-c60703f3d3ea": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:23", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", "lastModifiedBy": "string", - "lastModifiedByType": "User" + "lastModifiedByType": "Key" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/get.json index 29e4ab52625e..157bb8383017 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/get.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/get.json @@ -33,19 +33,40 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "8385cf05-78c0-41ef-b31d-36796a678e19": null + "a2da3516-d5bf-4e6f-a220-463602afc87c": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, "codeId": "string", "command": "string", @@ -60,9 +81,11 @@ "outputs": { "string": { "description": "string", - "jobOutputType": "uri_file", + "uri": "string", + "assetName": "string", + "assetVersion": "string", "mode": "ReadWriteMount", - "uri": "string" + "jobOutputType": "uri_file" } }, "distribution": { @@ -70,6 +93,9 @@ "workerCount": 1, "parameterServerCount": 1 }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, "limits": { "timeout": "PT5M", "jobLimitsType": "Command" @@ -77,20 +103,21 @@ "environmentVariables": { "string": "string" }, - "identity": { - "identityType": "AMLToken" - }, "parameters": { - "string": "string" + "049b85fe-425d-4ec6-b194-85c0f2771fe5": null + }, + "queueSettings": { + "jobTier": "Spot", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:23", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", "lastModifiedBy": "string", - "lastModifiedByType": "User" + "lastModifiedByType": "Application" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/list.json index 5693fc779bf7..49acd147f04c 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/list.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/CommandJob/list.json @@ -6,7 +6,11 @@ "api-version": "2023-02-01-preview", "$skipToken": "string", "jobType": "string", - "tag": "string" + "tag": "string", + "listViewType": "ActiveOnly", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" }, "responses": { "200": { @@ -26,7 +30,7 @@ "string": "string" }, "displayName": "string", - "status": "NotStarted", + "status": "Failed", "experimentName": "string", "services": { "string": { @@ -37,19 +41,40 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, "jobType": "Command", "resources": { "instanceCount": 1, "instanceType": "string", + "locations": [ + "string" + ], "properties": { "string": { - "7aad5998-6c83-4ca9-b50a-b44dfc43f420": null + "47f85ca1-a889-4417-a451-2ebca543e605": null } - } + }, + "shmSize": "string", + "dockerArgs": "string" }, "codeId": "string", "command": "string", @@ -64,9 +89,11 @@ "outputs": { "string": { "description": "string", - "jobOutputType": "uri_file", + "uri": "string", + "assetName": "string", + "assetVersion": "string", "mode": "ReadWriteMount", - "uri": "string" + "jobOutputType": "uri_file" } }, "distribution": { @@ -74,6 +101,9 @@ "workerCount": 1, "parameterServerCount": 1 }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, "limits": { "timeout": "PT5M", "jobLimitsType": "Command" @@ -81,20 +111,21 @@ "environmentVariables": { "string": "string" }, - "identity": { - "identityType": "AMLToken" - }, "parameters": { - "string": "string" + "13a3c675-c28b-4143-807e-fde07ad06a01": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:23", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", "lastModifiedBy": "string", - "lastModifiedByType": "User" + "lastModifiedByType": "Application" } } ], diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/createOrUpdate.json index b5de140d995e..987c4897b74b 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/createOrUpdate.json @@ -23,52 +23,79 @@ "endpoint": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", - "jobType": "Sweep", - "samplingAlgorithm": { - "samplingAlgorithmType": "Grid" + "isArchived": false, + "identity": { + "identityType": "AMLToken" }, - "limits": { - "jobLimitsType": "Sweep", - "maxTotalTrials": 1, - "maxConcurrentTrials": 1, - "trialTimeout": "PT1S" + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] }, - "earlyTermination": { - "evaluationInterval": 1, - "delayEvaluation": 1, - "policyType": "MedianStopping" + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "5fc1f627-491e-45a0-a6a2-f5b4be884911": null + } + }, + "shmSize": "string", + "dockerArgs": "string" }, - "objective": { - "primaryMetric": "string", - "goal": "Minimize" + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, - "trial": { - "codeId": "string", - "command": "string", - "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "distribution": { - "distributionType": "Mpi", - "processCountPerInstance": 1 - }, - "resources": { - "instanceCount": 1, - "instanceType": "string", - "properties": { - "string": { - "e6b6493e-7d5e-4db3-be1e-306ec641327e": null - } - } + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "ReadWriteMount", + "jobOutputType": "uri_file" } }, - "searchSpace": { - "string": {} + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 } } } @@ -89,7 +116,7 @@ "string": "string" }, "displayName": "string", - "status": "NotStarted", + "status": "Starting", "experimentName": "string", "services": { "string": { @@ -100,61 +127,91 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", - "jobType": "Sweep", - "samplingAlgorithm": { - "samplingAlgorithmType": "Grid" + "isArchived": false, + "identity": { + "identityType": "AMLToken" }, - "limits": { - "jobLimitsType": "Sweep", - "maxTotalTrials": 1, - "maxConcurrentTrials": 1, - "trialTimeout": "PT1S" - }, - "earlyTermination": { - "evaluationInterval": 1, - "delayEvaluation": 1, - "policyType": "MedianStopping" - }, - "objective": { - "primaryMetric": "string", - "goal": "Minimize" - }, - "trial": { - "codeId": "string", - "command": "string", - "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "distribution": { - "distributionType": "Mpi", - "processCountPerInstance": 1 - }, - "resources": { - "instanceCount": 1, - "instanceType": "string", - "properties": { - "string": { - "e6b6493e-7d5e-4db3-be1e-306ec641327e": null - } + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "b2de23ac-268c-459c-bbf3-0d8ece77d247": null } + }, + "shmSize": "string", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" } }, - "searchSpace": { - "string": {} + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "5489ee88-92db-4266-b321-ed47823d52b8": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:25", "createdBy": "string", "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", "lastModifiedBy": "string", - "lastModifiedByType": "User" + "lastModifiedByType": "Key" } } }, @@ -173,7 +230,7 @@ "string": "string" }, "displayName": "string", - "status": "NotStarted", + "status": "Starting", "experimentName": "string", "services": { "string": { @@ -184,59 +241,89 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", - "jobType": "Sweep", - "samplingAlgorithm": { - "samplingAlgorithmType": "Grid" + "isArchived": false, + "identity": { + "identityType": "AMLToken" }, - "limits": { - "jobLimitsType": "Sweep", - "maxTotalTrials": 1, - "maxConcurrentTrials": 1, - "trialTimeout": "PT1S" - }, - "earlyTermination": { - "evaluationInterval": 1, - "delayEvaluation": 1, - "policyType": "MedianStopping" - }, - "objective": { - "primaryMetric": "string", - "goal": "Minimize" - }, - "trial": { - "codeId": "string", - "command": "string", - "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "distribution": { - "distributionType": "Mpi", - "processCountPerInstance": 1 - }, - "resources": { - "instanceCount": 1, - "instanceType": "string", - "properties": { - "string": { - "e6b6493e-7d5e-4db3-be1e-306ec641327e": null - } + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "64db9b4b-db26-4473-9eb8-49e5e5cbeb3f": null } + }, + "shmSize": "string", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "jobOutputType": "uri_file" } }, - "searchSpace": { - "string": {} + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "307f11f6-ff8d-450d-b8a3-4c9d0f7d883f": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:25", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", "lastModifiedBy": "string", "lastModifiedByType": "User" } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/get.json index 704b8f2d2075..314c98d62ef9 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/get.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/get.json @@ -22,7 +22,7 @@ "string": "string" }, "displayName": "string", - "status": "NotStarted", + "status": "Preparing", "experimentName": "string", "services": { "string": { @@ -33,61 +33,91 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", - "jobType": "Sweep", - "samplingAlgorithm": { - "samplingAlgorithmType": "Grid" + "isArchived": false, + "identity": { + "identityType": "AMLToken" }, - "limits": { - "jobLimitsType": "Sweep", - "maxTotalTrials": 1, - "maxConcurrentTrials": 1, - "trialTimeout": "PT1S" + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] }, - "earlyTermination": { - "evaluationInterval": 1, - "delayEvaluation": 1, - "policyType": "MedianStopping" + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "81750226-212a-41d5-b3c3-d6ba8a48ed6e": null + } + }, + "shmSize": "string", + "dockerArgs": "string" }, - "objective": { - "primaryMetric": "string", - "goal": "Minimize" + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, - "trial": { - "codeId": "string", - "command": "string", - "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "distribution": { - "distributionType": "Mpi", - "processCountPerInstance": 1 - }, - "resources": { - "instanceCount": 1, - "instanceType": "string", - "properties": { - "string": { - "e6b6493e-7d5e-4db3-be1e-306ec641327e": null - } - } + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", + "jobOutputType": "uri_file" } }, - "searchSpace": { - "string": {} + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "92ae6a47-dc8b-407a-88d1-2e8a1932e15a": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:24", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:24", "lastModifiedBy": "string", - "lastModifiedByType": "User" + "lastModifiedByType": "Key" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/list.json index 30b58e1fa201..a3d504be8356 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/list.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Job/SweepJob/list.json @@ -6,7 +6,11 @@ "api-version": "2023-02-01-preview", "$skipToken": "string", "jobType": "string", - "tag": "string" + "tag": "string", + "listViewType": "ActiveOnly", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" }, "responses": { "200": { @@ -26,7 +30,7 @@ "string": "string" }, "displayName": "string", - "status": "NotStarted", + "status": "Running", "experimentName": "string", "services": { "string": { @@ -37,59 +41,89 @@ "errorMessage": "string", "properties": { "string": "string" + }, + "nodes": { + "nodesValueType": "All" } } }, "computeId": "string", - "jobType": "Sweep", - "samplingAlgorithm": { - "samplingAlgorithmType": "Grid" + "isArchived": false, + "identity": { + "identityType": "AMLToken" }, - "limits": { - "jobLimitsType": "Sweep", - "maxTotalTrials": 1, - "maxConcurrentTrials": 1, - "trialTimeout": "PT1S" + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] }, - "earlyTermination": { - "evaluationInterval": 1, - "delayEvaluation": 1, - "policyType": "MedianStopping" + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "0a76565a-7e17-45ce-bdea-0548a617ce27": null + } + }, + "shmSize": "string", + "dockerArgs": "string" }, - "objective": { - "primaryMetric": "string", - "goal": "Minimize" + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } }, - "trial": { - "codeId": "string", - "command": "string", - "environmentId": "string", - "environmentVariables": { - "string": "string" - }, - "distribution": { - "distributionType": "Mpi", - "processCountPerInstance": 1 - }, - "resources": { - "instanceCount": 1, - "instanceType": "string", - "properties": { - "string": { - "e6b6493e-7d5e-4db3-be1e-306ec641327e": null - } - } + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Direct", + "jobOutputType": "uri_file" } }, - "searchSpace": { - "string": {} + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "ed0b17ef-7461-4e01-92bb-376554a4ee87": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 } }, "systemData": { - "createdAt": "2020-01-01T12:34:56.999Z", + "createdAt": "2020-01-01T12:34:56.999+00:25", "createdBy": "string", - "createdByType": "User", - "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", "lastModifiedBy": "string", "lastModifiedByType": "User" } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/createOrUpdate.json new file mode 100644 index 000000000000..06a22eb0ce9f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-02-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "dataType": "uri_folder" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "mltable" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/delete.json new file mode 100644 index 000000000000..1825e3965b13 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/get.json new file mode 100644 index 000000000000..47c31a85cd92 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_file" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/registryList.json new file mode 100644 index 000000000000..20a8e5e191d5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataContainer/registryList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json new file mode 100644 index 000000000000..914daf56fe4e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/delete.json new file mode 100644 index 000000000000..1ca212e51c42 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/get.json new file mode 100644 index 000000000000..803f114b34e9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/registryList.json new file mode 100644 index 000000000000..bb31098aadc0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Registry/DataVersionBase/registryList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-02-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string", + "$tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json new file mode 100644 index 000000000000..01d8623fa96c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/delete.json new file mode 100644 index 000000000000..093feebc84ab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json new file mode 100644 index 000000000000..313b06af21c2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/list.json new file mode 100644 index 000000000000..d5c5de0d5a4a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/backfill.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/backfill.json new file mode 100644 index 000000000000..8d8e459621b1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/backfill.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "body": { + "displayName": "string", + "description": "string", + "featureWindow": { + "featureWindowStart": "2020-01-01T12:34:56.999+00:51", + "featureWindowEnd": "2020-01-01T12:34:56.999+00:51" + }, + "tags": { + "string": "string" + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "string" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json new file mode 100644 index 000000000000..46a5a5b68976 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Online", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Monday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "OnlineAndOffline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Hour", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/delete.json new file mode 100644 index 000000000000..d9d9879735a9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/get.json new file mode 100644 index 000000000000..458797563998 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "None", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Minute", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/getFeature.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/getFeature.json new file mode 100644 index 000000000000..c204d941df24 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/getFeature.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "body": { + "featureName": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "featureName": "string", + "description": "string", + "dataType": "Float", + "tags": { + "string": "string" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/list.json new file mode 100644 index 000000000000..d574a588fd4a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/list.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Month", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Saturday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/listFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/listFeatures.json new file mode 100644 index 000000000000..4e27b3ac15c7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/listFeatures.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "tags": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "featureName": "string", + "description": "string", + "dataType": "Datetime", + "tags": { + "string": "string" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/listMaterializationJobs.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/listMaterializationJobs.json new file mode 100644 index 000000000000..e1496c7d119f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturesetVersion/listMaterializationJobs.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "filters": "string", + "featureWindowStart": "string", + "featureWindowEnd": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "RecurrentMaterialization", + "jobId": "string", + "experimentId": "string", + "displayName": "string", + "createdDate": "2020-01-01T12:34:56.999+00:53", + "duration": "PT5M", + "status": "CancelRequested", + "featureWindow": { + "featureWindowStart": "2020-01-01T12:34:56.999+00:53", + "featureWindowEnd": "2020-01-01T12:34:56.999+00:53" + }, + "tags": { + "string": "string" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json new file mode 100644 index 000000000000..9b96c3e92896 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json new file mode 100644 index 000000000000..093feebc84ab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json new file mode 100644 index 000000000000..edbff0ce54a9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json new file mode 100644 index 000000000000..fd0dc9ec8d99 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json new file mode 100644 index 000000000000..9830ed4baba3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json new file mode 100644 index 000000000000..d9d9879735a9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json new file mode 100644 index 000000000000..6561d1c9794d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:57", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:57", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json new file mode 100644 index 000000000000..a3b4ae5d677f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-02-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:55", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:55", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/ModelVersion/package.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/ModelVersion/package.json new file mode 100644 index 000000000000..e4631eebab7f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/examples/Workspace/ModelVersion/package.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-02-01-preview", + "body": { + "targetEnvironmentName": "string", + "targetEnvironmentVersion": "string", + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "targetEnvironmentName": "string", + "targetEnvironmentVersion": "string", + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string", + "logUrl": "string", + "buildId": "string", + "buildState": "NotStarted" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json index edb1678603a5..3d3cf9d8be5b 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json @@ -1203,13 +1203,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data": { "get": { "tags": [ - "EnvironmentContainer" + "DataContainerRegistry" ], - "summary": "List environment containers.", - "operationId": "RegistryEnvironmentContainers_List", + "summary": "List containers.", + "operationId": "RegistryDataContainers_List", "produces": [ "application/json" ], @@ -1225,7 +1225,8 @@ "name": "registryName", "description": "Name of Azure Machine Learning registry.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1271,13 +1272,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Environment Container.": { - "$ref": "./examples/Registry/EnvironmentContainer/list.json" + "RegistryList Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/registryList.json" } }, "x-ms-pageable": { @@ -1285,13 +1286,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}": { "delete": { "tags": [ - "EnvironmentContainer" + "DataContainerRegistry" ], "summary": "Delete container.", - "operationId": "RegistryEnvironmentContainers_Delete", + "operationId": "RegistryDataContainers_Delete", "produces": [ "application/json" ], @@ -1307,11 +1308,12 @@ "name": "registryName", "description": "Name of Azure Machine Learning registry.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, { "in": "path", - "name": "environmentName", + "name": "name", "description": "Container name.", "required": true, "type": "string" @@ -1356,8 +1358,8 @@ } }, "x-ms-examples": { - "Delete Registry Environment Container.": { - "$ref": "./examples/Registry/EnvironmentContainer/delete.json" + "Delete Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -1367,10 +1369,10 @@ }, "get": { "tags": [ - "EnvironmentContainer" + "DataContainerRegistry" ], "summary": "Get container.", - "operationId": "RegistryEnvironmentContainers_Get", + "operationId": "RegistryDataContainers_Get", "produces": [ "application/json" ], @@ -1390,8 +1392,8 @@ }, { "in": "path", - "name": "environmentName", - "description": "Container name. This is case-sensitive.", + "name": "name", + "description": "Container name.", "required": true, "type": "string" }, @@ -1409,22 +1411,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "Get Registry Environment Container.": { - "$ref": "./examples/Registry/EnvironmentContainer/get.json" + "Get Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/get.json" } } }, "put": { "tags": [ - "EnvironmentContainer" + "DataContainerRegistry" ], "summary": "Create or update container.", - "operationId": "RegistryEnvironmentContainers_CreateOrUpdate", + "operationId": "RegistryDataContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -1447,7 +1449,7 @@ }, { "in": "path", - "name": "environmentName", + "name": "name", "description": "Container name.", "required": true, "type": "string", @@ -1462,7 +1464,7 @@ "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataContainerResource" } } ], @@ -1476,13 +1478,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -1498,23 +1500,23 @@ } }, "x-ms-examples": { - "CreateOrUpdate Registry Environment Container.": { - "$ref": "./examples/Registry/EnvironmentContainer/createOrUpdate.json" + "CreateOrUpdate Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions": { "get": { "tags": [ - "EnvironmentVersion" + "DataVersionRegistry" ], - "summary": "List versions.", - "operationId": "RegistryEnvironmentVersions_List", + "summary": "List data versions in the data container", + "operationId": "RegistryDataVersions_List", "produces": [ "application/json" ], @@ -1530,12 +1532,13 @@ "name": "registryName", "description": "Name of Azure Machine Learning registry.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, { "in": "path", - "name": "environmentName", - "description": "Container name. This is case-sensitive.", + "name": "name", + "description": "Data container's name", "required": true, "type": "string" }, @@ -1545,23 +1548,29 @@ { "in": "query", "name": "$orderBy", - "description": "Ordering of list.", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", "type": "string" }, { "in": "query", "name": "$top", - "description": "Maximum number of records to return.", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", "type": "integer", "format": "int32" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, { "in": "query", "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -1596,13 +1605,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Environment Version.": { - "$ref": "./examples/Registry/EnvironmentVersion/list.json" + "RegistryList Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/registryList.json" } }, "x-ms-pageable": { @@ -1610,13 +1619,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}": { "delete": { "tags": [ - "EnvironmentVersion" + "DataVersionRegistry" ], "summary": "Delete version.", - "operationId": "RegistryEnvironmentVersions_Delete", + "operationId": "RegistryDataVersions_Delete", "produces": [ "application/json" ], @@ -1632,11 +1641,12 @@ "name": "registryName", "description": "Name of Azure Machine Learning registry.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" }, { "in": "path", - "name": "environmentName", + "name": "name", "description": "Container name.", "required": true, "type": "string" @@ -1688,8 +1698,8 @@ } }, "x-ms-examples": { - "Delete Registry Environment Version.": { - "$ref": "./examples/Registry/EnvironmentVersion/delete.json" + "Delete Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/delete.json" } }, "x-ms-long-running-operation": true, @@ -1699,10 +1709,10 @@ }, "get": { "tags": [ - "EnvironmentVersion" + "DataVersionRegistry" ], "summary": "Get version.", - "operationId": "RegistryEnvironmentVersions_Get", + "operationId": "RegistryDataVersions_Get", "produces": [ "application/json" ], @@ -1722,15 +1732,15 @@ }, { "in": "path", - "name": "environmentName", - "description": "Container name. This is case-sensitive.", + "name": "name", + "description": "Container name.", "required": true, "type": "string" }, { "in": "path", "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -1748,22 +1758,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "Get Registry Environment Version.": { - "$ref": "./examples/Registry/EnvironmentVersion/get.json" + "Get Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/get.json" } } }, "put": { "tags": [ - "EnvironmentVersion" + "DataVersionRegistry" ], "summary": "Create or update version.", - "operationId": "RegistryEnvironmentVersions_CreateOrUpdate", + "operationId": "RegistryDataVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -1786,7 +1796,7 @@ }, { "in": "path", - "name": "environmentName", + "name": "name", "description": "Container name.", "required": true, "type": "string", @@ -1808,7 +1818,7 @@ "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DataVersionBaseResource" } } ], @@ -1822,13 +1832,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DataVersionBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DataVersionBaseResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -1844,23 +1854,23 @@ } }, "x-ms-examples": { - "CreateOrUpdate Registry Environment Version.": { - "$ref": "./examples/Registry/EnvironmentVersion/createOrUpdate.json" + "CreateOrUpdate Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments": { "get": { "tags": [ - "ModelContainer" + "EnvironmentContainer" ], - "summary": "List model containers.", - "operationId": "RegistryModelContainers_List", + "summary": "List environment containers.", + "operationId": "RegistryEnvironmentContainers_List", "produces": [ "application/json" ], @@ -1922,13 +1932,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/list.json" + "List Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/list.json" } }, "x-ms-pageable": { @@ -1936,13 +1946,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}": { "delete": { "tags": [ - "ModelContainer" + "EnvironmentContainer" ], "summary": "Delete container.", - "operationId": "RegistryModelContainers_Delete", + "operationId": "RegistryEnvironmentContainers_Delete", "produces": [ "application/json" ], @@ -1962,7 +1972,7 @@ }, { "in": "path", - "name": "modelName", + "name": "environmentName", "description": "Container name.", "required": true, "type": "string" @@ -2007,8 +2017,8 @@ } }, "x-ms-examples": { - "Delete Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/delete.json" + "Delete Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/delete.json" } }, "x-ms-long-running-operation": true, @@ -2018,10 +2028,10 @@ }, "get": { "tags": [ - "ModelContainer" + "EnvironmentContainer" ], "summary": "Get container.", - "operationId": "RegistryModelContainers_Get", + "operationId": "RegistryEnvironmentContainers_Get", "produces": [ "application/json" ], @@ -2041,7 +2051,7 @@ }, { "in": "path", - "name": "modelName", + "name": "environmentName", "description": "Container name. This is case-sensitive.", "required": true, "type": "string" @@ -2060,22 +2070,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "Get Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/get.json" + "Get Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/get.json" } } }, "put": { "tags": [ - "ModelContainer" + "EnvironmentContainer" ], - "summary": "Create or update model container.", - "operationId": "RegistryModelContainers_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "RegistryEnvironmentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -2098,7 +2108,7 @@ }, { "in": "path", - "name": "modelName", + "name": "environmentName", "description": "Container name.", "required": true, "type": "string", @@ -2113,7 +2123,7 @@ "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } ], @@ -2127,13 +2137,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/EnvironmentContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/EnvironmentContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -2149,8 +2159,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Container.": { - "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" + "CreateOrUpdate Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -2159,13 +2169,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions": { "get": { "tags": [ - "ModelVersion" + "EnvironmentVersion" ], "summary": "List versions.", - "operationId": "RegistryModelVersions_List", + "operationId": "RegistryEnvironmentVersions_List", "produces": [ "application/json" ], @@ -2185,7 +2195,7 @@ }, { "in": "path", - "name": "modelName", + "name": "environmentName", "description": "Container name. This is case-sensitive.", "required": true, "type": "string" @@ -2193,9 +2203,6 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, { "in": "query", "name": "$orderBy", @@ -2210,28 +2217,7 @@ "format": "int32" }, { - "in": "query", - "name": "version", - "description": "Version identifier.", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "Model description.", - "type": "string" - }, - { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "properties", - "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", @@ -2271,13 +2257,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/list.json" + "List Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/list.json" } }, "x-ms-pageable": { @@ -2285,13 +2271,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}": { "delete": { "tags": [ - "ModelVersion" + "EnvironmentVersion" ], "summary": "Delete version.", - "operationId": "RegistryModelVersions_Delete", + "operationId": "RegistryEnvironmentVersions_Delete", "produces": [ "application/json" ], @@ -2311,7 +2297,7 @@ }, { "in": "path", - "name": "modelName", + "name": "environmentName", "description": "Container name.", "required": true, "type": "string" @@ -2363,8 +2349,8 @@ } }, "x-ms-examples": { - "Delete Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/delete.json" + "Delete Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/delete.json" } }, "x-ms-long-running-operation": true, @@ -2374,10 +2360,10 @@ }, "get": { "tags": [ - "ModelVersion" + "EnvironmentVersion" ], "summary": "Get version.", - "operationId": "RegistryModelVersions_Get", + "operationId": "RegistryEnvironmentVersions_Get", "produces": [ "application/json" ], @@ -2397,7 +2383,7 @@ }, { "in": "path", - "name": "modelName", + "name": "environmentName", "description": "Container name. This is case-sensitive.", "required": true, "type": "string" @@ -2423,22 +2409,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "Get Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/get.json" + "Get Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/get.json" } } }, "put": { "tags": [ - "ModelVersion" + "EnvironmentVersion" ], "summary": "Create or update version.", - "operationId": "RegistryModelVersions_CreateOrUpdate", + "operationId": "RegistryEnvironmentVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -2461,7 +2447,7 @@ }, { "in": "path", - "name": "modelName", + "name": "environmentName", "description": "Container name.", "required": true, "type": "string", @@ -2483,7 +2469,7 @@ "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } ], @@ -2497,13 +2483,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/EnvironmentVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/EnvironmentVersionResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -2519,8 +2505,8 @@ } }, "x-ms-examples": { - "CreateOrUpdate Registry Model Version.": { - "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" + "CreateOrUpdate Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/createOrUpdate.json" } }, "x-ms-long-running-operation": true, @@ -2529,13 +2515,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": { "get": { "tags": [ - "BatchEndpoint" + "ModelContainer" ], - "summary": "Lists Batch inference endpoint in the workspace.", - "operationId": "BatchEndpoints_List", + "summary": "List model containers.", + "operationId": "RegistryModelContainers_List", "produces": [ "application/json" ], @@ -2547,20 +2533,44 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", + "required": true, + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "count", - "description": "Number of endpoints to be retrieved in a page of results.", - "type": "integer", - "format": "int32" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -2573,13 +2583,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/list.json" + "List Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/list.json" } }, "x-ms-pageable": { @@ -2587,13 +2597,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { "delete": { "tags": [ - "BatchEndpoint" + "ModelContainer" ], - "summary": "Delete Batch Inference Endpoint (asynchronous).", - "operationId": "BatchEndpoints_Delete", + "summary": "Delete container.", + "operationId": "RegistryModelContainers_Delete", "produces": [ "application/json" ], @@ -2605,12 +2615,16 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", + "required": true, + "type": "string" }, { "in": "path", - "name": "endpointName", - "description": "Inference Endpoint name.", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string" }, @@ -2625,9 +2639,6 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success" - }, "202": { "description": "Accepted", "headers": { @@ -2649,23 +2660,29 @@ } } }, + "200": { + "description": "Success" + }, "204": { "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/delete.json" + "Delete Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/delete.json" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } }, "get": { "tags": [ - "BatchEndpoint" + "ModelContainer" ], - "summary": "Gets a batch inference endpoint by name.", - "operationId": "BatchEndpoints_Get", + "summary": "Get container.", + "operationId": "RegistryModelContainers_Get", "produces": [ "application/json" ], @@ -2676,81 +2693,22 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, { "in": "path", - "name": "endpointName", - "description": "Name for the Batch Endpoint.", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", "required": true, "type": "string" }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" - } - } - }, - "x-ms-examples": { - "Get Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/get.json" - } - } - }, - "patch": { - "tags": [ - "BatchEndpoint" - ], - "summary": "Update a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_Update", - "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": "endpointName", - "description": "Name for the Batch inference endpoint.", + "name": "modelName", + "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Mutable batch inference endpoint definition object.", - "required": true, - "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" - } } ], "responses": { @@ -2763,44 +2721,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" - } - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "$ref": "#/definitions/ModelContainerResource" } } }, "x-ms-examples": { - "Update Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/update.json" + "Get Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/get.json" } - }, - "x-ms-long-running-operation": true + } }, "put": { "tags": [ - "BatchEndpoint" + "ModelContainer" ], - "summary": "Creates a batch inference endpoint (asynchronous).", - "operationId": "BatchEndpoints_CreateOrUpdate", + "summary": "Create or update model container.", + "operationId": "RegistryModelContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -2815,12 +2751,16 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", + "required": true, + "type": "string" }, { "in": "path", - "name": "endpointName", - "description": "Name for the Batch inference endpoint.", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -2831,10 +2771,10 @@ { "in": "body", "name": "body", - "description": "Batch inference endpoint definition object.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/ModelContainerResource" } } ], @@ -2848,13 +2788,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/ModelContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/BatchEndpointTrackedResource" + "$ref": "#/definitions/ModelContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -2870,20 +2810,23 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" + "CreateOrUpdate Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/createOrUpdate.json" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": { "get": { "tags": [ - "BatchDeployment" + "ModelVersion" ], - "summary": "Lists Batch inference deployments in the workspace.", - "operationId": "BatchDeployments_List", + "summary": "List versions.", + "operationId": "RegistryModelVersions_List", "produces": [ "application/json" ], @@ -2895,18 +2838,25 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", + "required": true, + "type": "string" }, { "in": "path", - "name": "endpointName", - "description": "Endpoint name", + "name": "modelName", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, { "in": "query", "name": "$orderBy", @@ -2916,45 +2866,93 @@ { "in": "query", "name": "$top", - "description": "Top of list.", + "description": "Maximum number of records to return.", "type": "integer", "format": "int32" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } + "in": "query", + "name": "version", + "description": "Version identifier.", + "type": "string" }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" - } - } - }, - "x-ms-examples": { - "List Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/list.json" - } - }, - "x-ms-pageable": { + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/list.json" + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { "delete": { "tags": [ - "BatchDeployment" + "ModelVersion" ], - "summary": "Delete Batch Inference deployment (asynchronous).", - "operationId": "BatchDeployments_Delete", + "summary": "Delete version.", + "operationId": "RegistryModelVersions_Delete", "produces": [ "application/json" ], @@ -2966,19 +2964,23 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", + "required": true, + "type": "string" }, { "in": "path", - "name": "endpointName", - "description": "Endpoint name", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string" }, { "in": "path", - "name": "deploymentName", - "description": "Inference deployment identifier.", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -3022,18 +3024,21 @@ } }, "x-ms-examples": { - "Delete Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/delete.json" + "Delete Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/delete.json" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } }, "get": { "tags": [ - "BatchDeployment" + "ModelVersion" ], - "summary": "Gets a batch inference deployment by id.", - "operationId": "BatchDeployments_Get", + "summary": "Get version.", + "operationId": "RegistryModelVersions_Get", "produces": [ "application/json" ], @@ -3045,19 +3050,23 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", + "required": true, + "type": "string" }, { "in": "path", - "name": "endpointName", - "description": "Endpoint name", + "name": "modelName", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch deployments.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -3075,22 +3084,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/ModelVersionResource" } } }, "x-ms-examples": { - "Get Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/get.json" + "Get Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/get.json" } } }, - "patch": { + "put": { "tags": [ - "BatchDeployment" + "ModelVersion" ], - "summary": "Update a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_Update", + "summary": "Create or update version.", + "operationId": "RegistryModelVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3105,23 +3114,26 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "path", + "name": "registryName", + "description": "Name of Azure Machine Learning registry.", + "required": true, + "type": "string" }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name", + "name": "modelName", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", + "name": "version", + "description": "Version identifier.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -3129,10 +3141,10 @@ { "in": "body", "name": "body", - "description": "Batch inference deployment definition object.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" + "$ref": "#/definitions/ModelVersionResource" } } ], @@ -3146,47 +3158,45 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" + "$ref": "#/definitions/ModelVersionResource" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + }, "headers": { "x-ms-async-operation-timeout": { "description": "Timeout for the client to use when polling the asynchronous operation.", "type": "string", "format": "duration" }, - "Location": { - "description": "URI to poll for asynchronous operation result.", + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } } }, "x-ms-examples": { - "Update Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/update.json" + "CreateOrUpdate Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrUpdate.json" } }, - "x-ms-long-running-operation": true - }, - "put": { + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "get": { "tags": [ - "BatchDeployment" - ], - "summary": "Creates/updates a batch inference deployment (asynchronous).", - "operationId": "BatchDeployments_CreateOrUpdate", - "consumes": [ - "application/json" + "BatchEndpoint" ], + "summary": "Lists Batch inference endpoint in the workspace.", + "operationId": "BatchEndpoints_List", "produces": [ "application/json" ], @@ -3201,32 +3211,17 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "endpointName", - "description": "Inference endpoint name", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The identifier for the Batch inference deployment.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" }, { - "in": "body", - "name": "body", - "description": "Batch inference deployment definition object.", - "required": true, - "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -3239,42 +3234,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/BatchDeploymentTrackedResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Batch Deployment.": { - "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" + "List Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/list.json" } }, - "x-ms-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "delete": { "tags": [ "BatchEndpoint" ], - "summary": "Lists batch Inference Endpoint keys.", - "operationId": "BatchEndpoints_ListKeys", + "summary": "Delete Batch Inference Endpoint (asynchronous).", + "operationId": "BatchEndpoints_Delete", "produces": [ "application/json" ], @@ -3307,77 +3287,49 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EndpointAuthKeys" - } - } - }, - "x-ms-examples": { - "ListKeys Workspace Batch Endpoint.": { - "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { - "get": { - "tags": [ - "CodeContainer" - ], - "summary": "List containers.", - "operationId": "CodeContainers_List", - "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" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "description": "Success" }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" - } + "204": { + "description": "No Content" } }, "x-ms-examples": { - "List Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/list.json" + "Delete Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/delete.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { - "delete": { + }, + "get": { "tags": [ - "CodeContainer" + "BatchEndpoint" ], - "summary": "Delete container.", - "operationId": "CodeContainers_Delete", + "summary": "Gets a batch inference endpoint by name.", + "operationId": "BatchEndpoints_Get", "produces": [ "application/json" ], @@ -3393,8 +3345,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Name for the Batch Endpoint.", "required": true, "type": "string" }, @@ -3410,24 +3362,27 @@ } }, "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } } }, "x-ms-examples": { - "Delete Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/delete.json" + "Get Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/get.json" } } }, - "get": { + "patch": { "tags": [ - "CodeContainer" + "BatchEndpoint" + ], + "summary": "Update a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_Update", + "consumes": [ + "application/json" ], - "summary": "Get container.", - "operationId": "CodeContainers_Get", "produces": [ "application/json" ], @@ -3443,13 +3398,23 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Mutable batch inference endpoint definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } } ], "responses": { @@ -3462,22 +3427,44 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "Get Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/get.json" + "Update Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/update.json" } - } + }, + "x-ms-long-running-operation": true }, "put": { "tags": [ - "CodeContainer" + "BatchEndpoint" ], - "summary": "Create or update container.", - "operationId": "CodeContainers_CreateOrUpdate", + "summary": "Creates a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_CreateOrUpdate", "consumes": [ "application/json" ], @@ -3496,8 +3483,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -3508,10 +3495,10 @@ { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Batch inference endpoint definition object.", "required": true, "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } } ], @@ -3525,30 +3512,45 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/BatchEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Container.": { - "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { "get": { "tags": [ - "CodeVersion" + "BatchDeployment" ], - "summary": "List versions.", - "operationId": "CodeVersions_List", + "summary": "Lists Batch inference deployments in the workspace.", + "operationId": "BatchDeployments_List", "produces": [ "application/json" ], @@ -3564,8 +3566,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Endpoint name", "required": true, "type": "string" }, @@ -3581,7 +3583,7 @@ { "in": "query", "name": "$top", - "description": "Maximum number of records to return.", + "description": "Top of list.", "type": "integer", "format": "int32" }, @@ -3599,13 +3601,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/list.json" + "List Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/list.json" } }, "x-ms-pageable": { @@ -3613,13 +3615,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { "delete": { "tags": [ - "CodeVersion" + "BatchDeployment" ], - "summary": "Delete version.", - "operationId": "CodeVersions_Delete", + "summary": "Delete Batch Inference deployment (asynchronous).", + "operationId": "BatchDeployments_Delete", "produces": [ "application/json" ], @@ -3635,15 +3637,15 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Endpoint name", "required": true, "type": "string" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "deploymentName", + "description": "Inference deployment identifier.", "required": true, "type": "string" }, @@ -3658,25 +3660,50 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-examples": { - "Delete Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/delete.json" - } - } - }, - "get": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { "tags": [ - "CodeVersion" + "BatchDeployment" ], - "summary": "Get version.", - "operationId": "CodeVersions_Get", + "summary": "Gets a batch inference deployment by id.", + "operationId": "BatchDeployments_Get", "produces": [ "application/json" ], @@ -3692,15 +3719,15 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Endpoint name", "required": true, "type": "string" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "deploymentName", + "description": "The identifier for the Batch deployments.", "required": true, "type": "string" }, @@ -3718,22 +3745,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } } }, "x-ms-examples": { - "Get Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/get.json" + "Get Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/get.json" } } }, - "put": { + "patch": { "tags": [ - "CodeVersion" + "BatchDeployment" ], - "summary": "Create or update version.", - "operationId": "CodeVersions_CreateOrUpdate", + "summary": "Update a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_Update", "consumes": [ "application/json" ], @@ -3752,18 +3779,19 @@ }, { "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", + "name": "endpointName", + "description": "Inference endpoint name", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -3771,10 +3799,10 @@ { "in": "body", "name": "body", - "description": "Version entity to create or update.", + "description": "Batch inference deployment definition object.", "required": true, "schema": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" } } ], @@ -3788,30 +3816,47 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/BatchDeploymentTrackedResource" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/CodeVersionResource" + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Code Version.": { - "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" + "Update Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/update.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { - "get": { + }, + "x-ms-long-running-operation": true + }, + "put": { "tags": [ - "ComponentContainer" + "BatchDeployment" + ], + "summary": "Creates/updates a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "List component containers.", - "operationId": "ComponentContainers_List", "produces": [ "application/json" ], @@ -3826,36 +3871,31 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" } } ], @@ -3869,27 +3909,45 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "List Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/list.json" + "CreateOrUpdate Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": { + "post": { "tags": [ - "ComponentContainer" + "BatchEndpoint" ], - "summary": "Delete container.", - "operationId": "ComponentContainers_Delete", + "summary": "Lists batch Inference Endpoint keys.", + "operationId": "BatchEndpoints_ListKeys", "produces": [ "application/json" ], @@ -3905,8 +3963,8 @@ }, { "in": "path", - "name": "name", - "description": "Container name.", + "name": "endpointName", + "description": "Inference Endpoint name.", "required": true, "type": "string" }, @@ -3922,24 +3980,26 @@ } }, "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } } }, "x-ms-examples": { - "Delete Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/delete.json" + "ListKeys Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" } } - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { "get": { "tags": [ - "ComponentContainer" + "CodeContainer" ], - "summary": "Get container.", - "operationId": "ComponentContainers_Get", + "summary": "List containers.", + "operationId": "CodeContainers_List", "produces": [ "application/json" ], @@ -3954,14 +4014,10 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "name", - "description": "Container name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -3974,22 +4030,127 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "Get Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/get.json" + "List Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/list.json" } - } - }, + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { + "delete": { + "tags": [ + "CodeContainer" + ], + "summary": "Delete container.", + "operationId": "CodeContainers_Delete", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "Get container.", + "operationId": "CodeContainers_Get", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/get.json" + } + } + }, "put": { "tags": [ - "ComponentContainer" + "CodeContainer" ], "summary": "Create or update container.", - "operationId": "ComponentContainers_CreateOrUpdate", + "operationId": "CodeContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4009,7 +4170,7 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -4023,7 +4184,7 @@ "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/CodeContainerResource" } } ], @@ -4037,30 +4198,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/CodeContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/CodeContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Container.": { - "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { "get": { "tags": [ - "ComponentVersion" + "CodeVersion" ], - "summary": "List component versions.", - "operationId": "ComponentVersions_List", + "summary": "List versions.", + "operationId": "CodeVersions_List", "produces": [ "application/json" ], @@ -4077,7 +4238,7 @@ { "in": "path", "name": "name", - "description": "Component name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -4099,33 +4260,6 @@ }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } } ], "responses": { @@ -4138,13 +4272,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/list.json" + "List Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/list.json" } }, "x-ms-pageable": { @@ -4152,13 +4286,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { "delete": { "tags": [ - "ComponentVersion" + "CodeVersion" ], "summary": "Delete version.", - "operationId": "ComponentVersions_Delete", + "operationId": "CodeVersions_Delete", "produces": [ "application/json" ], @@ -4175,14 +4309,14 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", "name": "version", - "description": "Version identifier.", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -4205,17 +4339,17 @@ } }, "x-ms-examples": { - "Delete Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/delete.json" + "Delete Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/delete.json" } } }, "get": { "tags": [ - "ComponentVersion" + "CodeVersion" ], "summary": "Get version.", - "operationId": "ComponentVersions_Get", + "operationId": "CodeVersions_Get", "produces": [ "application/json" ], @@ -4232,14 +4366,14 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", "name": "version", - "description": "Version identifier.", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -4257,22 +4391,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/CodeVersionResource" } } }, "x-ms-examples": { - "Get Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/get.json" + "Get Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/get.json" } } }, "put": { "tags": [ - "ComponentVersion" + "CodeVersion" ], "summary": "Create or update version.", - "operationId": "ComponentVersions_CreateOrUpdate", + "operationId": "CodeVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4292,7 +4426,7 @@ { "in": "path", "name": "name", - "description": "Container name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -4300,7 +4434,7 @@ { "in": "path", "name": "version", - "description": "Version identifier.", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -4313,7 +4447,7 @@ "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/CodeVersionResource" } } ], @@ -4327,30 +4461,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/CodeVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ComponentVersionResource" + "$ref": "#/definitions/CodeVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Component Version.": { - "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" + "CreateOrUpdate Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { "get": { "tags": [ - "DataContainer" + "ComponentContainer" ], - "summary": "List data containers.", - "operationId": "DataContainers_List", + "summary": "List component containers.", + "operationId": "ComponentContainers_List", "produces": [ "application/json" ], @@ -4408,13 +4542,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + "$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/list.json" + "List Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/list.json" } }, "x-ms-pageable": { @@ -4422,13 +4556,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { "delete": { "tags": [ - "DataContainer" + "ComponentContainer" ], "summary": "Delete container.", - "operationId": "DataContainers_Delete", + "operationId": "ComponentContainers_Delete", "produces": [ "application/json" ], @@ -4468,17 +4602,17 @@ } }, "x-ms-examples": { - "Delete Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/delete.json" + "Delete Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/delete.json" } } }, "get": { "tags": [ - "DataContainer" + "ComponentContainer" ], "summary": "Get container.", - "operationId": "DataContainers_Get", + "operationId": "ComponentContainers_Get", "produces": [ "application/json" ], @@ -4513,22 +4647,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/ComponentContainerResource" } } }, "x-ms-examples": { - "Get Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/get.json" + "Get Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/get.json" } } }, "put": { "tags": [ - "DataContainer" + "ComponentContainer" ], "summary": "Create or update container.", - "operationId": "DataContainers_CreateOrUpdate", + "operationId": "ComponentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4562,7 +4696,7 @@ "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/ComponentContainerResource" } } ], @@ -4576,30 +4710,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/ComponentContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/ComponentContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Container.": { - "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { "get": { "tags": [ - "DataVersion" + "ComponentVersion" ], - "summary": "List data versions in the data container", - "operationId": "DataVersions_List", + "summary": "List component versions.", + "operationId": "ComponentVersions_List", "produces": [ "application/json" ], @@ -4616,7 +4750,7 @@ { "in": "path", "name": "name", - "description": "Data container's name", + "description": "Component name.", "required": true, "type": "string" }, @@ -4626,29 +4760,23 @@ { "in": "query", "name": "$orderBy", - "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "description": "Ordering of list.", "type": "string" }, { "in": "query", "name": "$top", - "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "description": "Maximum number of records to return.", "type": "integer", "format": "int32" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, - { - "in": "query", - "name": "$tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, { "in": "query", "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "description": "View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -4683,13 +4811,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/list.json" + "List Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/list.json" } }, "x-ms-pageable": { @@ -4697,13 +4825,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { "delete": { "tags": [ - "DataVersion" + "ComponentVersion" ], "summary": "Delete version.", - "operationId": "DataVersions_Delete", + "operationId": "ComponentVersions_Delete", "produces": [ "application/json" ], @@ -4750,17 +4878,17 @@ } }, "x-ms-examples": { - "Delete Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/delete.json" + "Delete Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/delete.json" } } }, "get": { "tags": [ - "DataVersion" + "ComponentVersion" ], "summary": "Get version.", - "operationId": "DataVersions_Get", + "operationId": "ComponentVersions_Get", "produces": [ "application/json" ], @@ -4802,22 +4930,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/ComponentVersionResource" } } }, "x-ms-examples": { - "Get Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/get.json" + "Get Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/get.json" } } }, "put": { "tags": [ - "DataVersion" + "ComponentVersion" ], "summary": "Create or update version.", - "operationId": "DataVersions_CreateOrUpdate", + "operationId": "ComponentVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -4858,7 +4986,7 @@ "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/ComponentVersionResource" } } ], @@ -4872,30 +5000,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/ComponentVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/ComponentVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Data Version Base.": { - "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" + "CreateOrUpdate Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { "get": { "tags": [ - "Datastore" + "DataContainer" ], - "summary": "List datastores.", - "operationId": "Datastores_List", + "summary": "List data containers.", + "operationId": "DataContainers_List", "produces": [ "application/json" ], @@ -4917,45 +5045,30 @@ }, { "in": "query", - "name": "count", - "description": "Maximum number of results to return.", - "type": "integer", - "format": "int32", - "default": 30 - }, - { - "in": "query", - "name": "isDefault", - "description": "Filter down to the workspace default datastore.", - "type": "boolean" - }, - { - "in": "query", - "name": "names", - "description": "Names of datastores to return.", - "type": "array", - "items": { - "type": "string" + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } - }, - { - "in": "query", - "name": "searchText", - "description": "Text to search for in the datastore names.", - "type": "string" - }, - { - "in": "query", - "name": "orderBy", - "description": "Order by property (createdtime | modifiedtime | name).", - "type": "string" - }, - { - "in": "query", - "name": "orderByAsc", - "description": "Order by property in ascending order.", - "type": "boolean", - "default": false } ], "responses": { @@ -4968,13 +5081,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List datastores.": { - "$ref": "./examples/Datastore/list.json" + "List Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/list.json" } }, "x-ms-pageable": { @@ -4982,13 +5095,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { "delete": { "tags": [ - "Datastore" + "DataContainer" ], - "summary": "Delete datastore.", - "operationId": "Datastores_Delete", + "summary": "Delete container.", + "operationId": "DataContainers_Delete", "produces": [ "application/json" ], @@ -5005,7 +5118,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name.", "required": true, "type": "string" }, @@ -5028,17 +5141,17 @@ } }, "x-ms-examples": { - "Delete datastore.": { - "$ref": "./examples/Datastore/delete.json" + "Delete Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/delete.json" } } }, "get": { "tags": [ - "Datastore" + "DataContainer" ], - "summary": "Get datastore.", - "operationId": "Datastores_Get", + "summary": "Get container.", + "operationId": "DataContainers_Get", "produces": [ "application/json" ], @@ -5055,7 +5168,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name.", "required": true, "type": "string" }, @@ -5073,22 +5186,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "Get datastore.": { - "$ref": "./examples/Datastore/get.json" + "Get Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/get.json" } } }, "put": { "tags": [ - "Datastore" + "DataContainer" ], - "summary": "Create or update datastore.", - "operationId": "Datastores_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "DataContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5108,7 +5221,7 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -5116,20 +5229,13 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, - { - "in": "query", - "name": "skipValidation", - "description": "Flag to skip validation.", - "type": "boolean", - "default": false - }, { "in": "body", "name": "body", - "description": "Datastore entity to create or update.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/DataContainerResource" } } ], @@ -5143,39 +5249,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/DataContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/DataContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { - "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" - }, - "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { - "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + "CreateOrUpdate Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "get": { "tags": [ - "Datastore" + "DataVersion" ], - "summary": "Get datastore secrets.", - "operationId": "Datastores_ListSecrets", + "summary": "List data versions in the data container", + "operationId": "DataVersions_List", "produces": [ "application/json" ], @@ -5192,66 +5289,39 @@ { "in": "path", "name": "name", - "description": "Datastore name.", + "description": "Data container's name", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } }, - "200": { - "description": "Success", - "schema": { - "description": "Base definition for datastore secrets.", - "$ref": "#/definitions/DatastoreSecrets" - } - } - }, - "x-ms-examples": { - "Get datastore secrets.": { - "$ref": "./examples/Datastore/listSecrets.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { - "get": { - "tags": [ - "EnvironmentContainer" - ], - "summary": "List environment containers.", - "operationId": "EnvironmentContainers_List", - "produces": [ - "application/json" - ], - "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { "in": "query", "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -5286,13 +5356,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/list.json" + "List Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/list.json" } }, "x-ms-pageable": { @@ -5300,13 +5370,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { "delete": { "tags": [ - "EnvironmentContainer" + "DataVersion" ], - "summary": "Delete container.", - "operationId": "EnvironmentContainers_Delete", + "summary": "Delete version.", + "operationId": "DataVersions_Delete", "produces": [ "application/json" ], @@ -5323,7 +5393,14 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -5346,17 +5423,17 @@ } }, "x-ms-examples": { - "Delete Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" + "Delete Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/delete.json" } } }, "get": { "tags": [ - "EnvironmentContainer" + "DataVersion" ], - "summary": "Get container.", - "operationId": "EnvironmentContainers_Get", + "summary": "Get version.", + "operationId": "DataVersions_Get", "produces": [ "application/json" ], @@ -5373,7 +5450,14 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", "required": true, "type": "string" }, @@ -5391,22 +5475,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "Get Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/get.json" + "Get Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/get.json" } } }, "put": { "tags": [ - "EnvironmentContainer" + "DataVersion" ], - "summary": "Create or update container.", - "operationId": "EnvironmentContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "DataVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5426,21 +5510,28 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Container name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } ], @@ -5454,30 +5545,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Container.": { - "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { "get": { "tags": [ - "EnvironmentVersion" + "Datastore" ], - "summary": "List versions.", - "operationId": "EnvironmentVersions_List", + "summary": "List datastores.", + "operationId": "Datastores_List", "produces": [ "application/json" ], @@ -5491,58 +5582,53 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, - { - "in": "path", - "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", + "name": "count", + "description": "Maximum number of results to return.", "type": "integer", - "format": "int32" + "format": "int32", + "default": 30 }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "isDefault", + "description": "Filter down to the workspace default datastore.", + "type": "boolean" }, { "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] + "name": "names", + "description": "Names of datastores to return.", + "type": "array", + "items": { + "type": "string" } + }, + { + "in": "query", + "name": "searchText", + "description": "Text to search for in the datastore names.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Order by property (createdtime | modifiedtime | name).", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Order by property in ascending order.", + "type": "boolean", + "default": false } ], "responses": { @@ -5555,13 +5641,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/list.json" + "List datastores.": { + "$ref": "./examples/Datastore/list.json" } }, "x-ms-pageable": { @@ -5569,13 +5655,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { "delete": { "tags": [ - "EnvironmentVersion" + "Datastore" ], - "summary": "Delete version.", - "operationId": "EnvironmentVersions_Delete", + "summary": "Delete datastore.", + "operationId": "Datastores_Delete", "produces": [ "application/json" ], @@ -5592,14 +5678,7 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Datastore name.", "required": true, "type": "string" }, @@ -5622,17 +5701,17 @@ } }, "x-ms-examples": { - "Delete Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" + "Delete datastore.": { + "$ref": "./examples/Datastore/delete.json" } } }, "get": { "tags": [ - "EnvironmentVersion" + "Datastore" ], - "summary": "Get version.", - "operationId": "EnvironmentVersions_Get", + "summary": "Get datastore.", + "operationId": "Datastores_Get", "produces": [ "application/json" ], @@ -5649,14 +5728,7 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Datastore name.", "required": true, "type": "string" }, @@ -5674,22 +5746,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DatastoreResource" } } }, "x-ms-examples": { - "Get Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/get.json" + "Get datastore.": { + "$ref": "./examples/Datastore/get.json" } } }, "put": { "tags": [ - "EnvironmentVersion" + "Datastore" ], - "summary": "Creates or updates an EnvironmentVersion.", - "operationId": "EnvironmentVersions_CreateOrUpdate", + "summary": "Create or update datastore.", + "operationId": "Datastores_CreateOrUpdate", "consumes": [ "application/json" ], @@ -5709,28 +5781,28 @@ { "in": "path", "name": "name", - "description": "Name of EnvironmentVersion. This is case-sensitive.", + "description": "Datastore name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { - "in": "path", - "name": "version", - "description": "Version of EnvironmentVersion.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "skipValidation", + "description": "Flag to skip validation.", + "type": "boolean", + "default": false }, { "in": "body", "name": "body", - "description": "Definition of EnvironmentVersion.", + "description": "Datastore entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DatastoreResource" } } ], @@ -5744,30 +5816,39 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DatastoreResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/DatastoreResource" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Environment Version.": { - "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { - "get": { + "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { + "post": { "tags": [ - "Job" + "Datastore" ], - "summary": "Lists Jobs in the workspace.", - "operationId": "Jobs_List", + "summary": "Get datastore secrets.", + "operationId": "Datastores_ListSecrets", "produces": [ "application/json" ], @@ -5781,23 +5862,64 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "name", + "description": "Datastore name.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "description": "Base definition for datastore secrets.", + "$ref": "#/definitions/DatastoreSecrets" + } + } + }, + "x-ms-examples": { + "Get datastore secrets.": { + "$ref": "./examples/Datastore/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "EnvironmentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "query", - "name": "jobType", - "description": "Type of job to be returned.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "query", - "name": "tag", - "description": "Jobs returned will have this tag key.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", @@ -5825,18 +5947,6 @@ } ] } - }, - { - "in": "query", - "name": "scheduled", - "description": "Indicator whether the job is scheduled job.", - "type": "boolean" - }, - { - "in": "query", - "name": "scheduleId", - "description": "The scheduled id for listing the job triggered from", - "type": "string" } ], "responses": { @@ -5849,22 +5959,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Command Job.": { - "$ref": "./examples/Job/CommandJob/list.json" - }, - "List AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/list.json" - }, - "List Sweep Job.": { - "$ref": "./examples/Job/SweepJob/list.json" - }, - "List Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/list.json" + "List Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/list.json" } }, "x-ms-pageable": { @@ -5872,13 +5973,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { "delete": { "tags": [ - "Job" + "EnvironmentContainer" ], - "summary": "Deletes a Job (asynchronous).", - "operationId": "Jobs_Delete", + "summary": "Delete container.", + "operationId": "EnvironmentContainers_Delete", "produces": [ "application/json" ], @@ -5894,8 +5995,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -5913,44 +6014,22 @@ "200": { "description": "Success" }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, "204": { "description": "No Content" } }, "x-ms-examples": { - "Delete Job.": { - "$ref": "./examples/Job/delete.json" + "Delete Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" } - }, - "x-ms-long-running-operation": true + } }, "get": { "tags": [ - "Job" + "EnvironmentContainer" ], - "summary": "Gets a Job by name/id.", - "operationId": "Jobs_Get", + "summary": "Get container.", + "operationId": "EnvironmentContainers_Get", "produces": [ "application/json" ], @@ -5966,8 +6045,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -5985,31 +6064,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "Get Command Job.": { - "$ref": "./examples/Job/CommandJob/get.json" - }, - "Get AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/get.json" - }, - "Get Sweep Job.": { - "$ref": "./examples/Job/SweepJob/get.json" - }, - "Get Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/get.json" + "Get Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/get.json" } } }, "put": { "tags": [ - "Job" + "EnvironmentContainer" ], - "summary": "Creates and executes a Job.", - "operationId": "Jobs_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "EnvironmentContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6028,8 +6098,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -6040,10 +6110,10 @@ { "in": "body", "name": "body", - "description": "Job definition object.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } ], @@ -6057,39 +6127,30 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/EnvironmentContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "x-ms-examples": { - "CreateOrUpdate Command Job.": { - "$ref": "./examples/Job/CommandJob/createOrUpdate.json" - }, - "CreateOrUpdate AutoML Job.": { - "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" - }, - "CreateOrUpdate Sweep Job.": { - "$ref": "./examples/Job/SweepJob/createOrUpdate.json" - }, - "CreateOrUpdate Pipeline Job.": { - "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" + "CreateOrUpdate Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "get": { "tags": [ - "Job" + "EnvironmentVersion" ], - "summary": "Cancels a Job (asynchronous).", - "operationId": "Jobs_Cancel", + "summary": "List versions.", + "operationId": "EnvironmentVersions_List", "produces": [ "application/json" ], @@ -6105,85 +6166,56 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - }, - "200": { - "description": "Success" - } - }, - "x-ms-examples": { - "Cancel Job.": { - "$ref": "./examples/Job/cancel.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": { - "get": { - "tags": [ - "LabelingJob" - ], - "summary": "Lists labeling jobs in the workspace.", - "operationId": "LabelingJobs_List", - "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": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", - "name": "$top", - "description": "Number of labeling jobs to return.", - "type": "integer", - "format": "int32" + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -6196,13 +6228,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult" + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Labeling Job.": { - "$ref": "./examples/LabelingJob/list.json" + "List Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/list.json" } }, "x-ms-pageable": { @@ -6210,13 +6242,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { "delete": { "tags": [ - "LabelingJob" + "EnvironmentVersion" ], - "summary": "Delete a labeling job.", - "operationId": "LabelingJobs_Delete", + "summary": "Delete version.", + "operationId": "EnvironmentVersions_Delete", "produces": [ "application/json" ], @@ -6232,8 +6264,15 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the LabelingJob.", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -6256,17 +6295,17 @@ } }, "x-ms-examples": { - "Delete Labeling Job.": { - "$ref": "./examples/LabelingJob/delete.json" + "Delete Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" } } }, "get": { "tags": [ - "LabelingJob" + "EnvironmentVersion" ], - "summary": "Gets a labeling job by name/id.", - "operationId": "LabelingJobs_Get", + "summary": "Get version.", + "operationId": "EnvironmentVersions_Get", "produces": [ "application/json" ], @@ -6282,27 +6321,20 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the LabelingJob.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "includeJobInstructions", - "description": "Boolean value to indicate whether to include JobInstructions in response.", - "type": "boolean", - "default": false + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { - "in": "query", - "name": "includeLabelCategories", - "description": "Boolean value to indicate Whether to include LabelCategories in response.", - "type": "boolean", - "default": false + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -6315,22 +6347,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/LabelingJobResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "Get Labeling Job.": { - "$ref": "./examples/LabelingJob/get.json" + "Get Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/get.json" } } }, "put": { "tags": [ - "LabelingJob" + "EnvironmentVersion" ], - "summary": "Creates or updates a labeling job (asynchronous).", - "operationId": "LabelingJobs_CreateOrUpdate", + "summary": "Creates or updates an EnvironmentVersion.", + "operationId": "EnvironmentVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6349,22 +6381,29 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the LabelingJob.", + "name": "name", + "description": "Name of EnvironmentVersion. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version of EnvironmentVersion.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "LabelingJob definition object.", + "description": "Definition of EnvironmentVersion.", "required": true, "schema": { - "$ref": "#/definitions/LabelingJobResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } ], @@ -6375,48 +6414,33 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "201": { - "description": "Created", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/LabelingJobResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/EnvironmentVersionResource" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", "schema": { - "$ref": "#/definitions/LabelingJobResource" + "$ref": "#/definitions/EnvironmentVersionResource" } } }, "x-ms-examples": { - "CreateOrUpdate Labeling Job.": { - "$ref": "./examples/LabelingJob/createOrUpdate.json" + "CreateOrUpdate Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" } - }, - "x-ms-long-running-operation": true + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + "get": { "tags": [ - "LabelingJob" - ], - "summary": "Export labels from a labeling job (asynchronous).", - "operationId": "LabelingJobs_ExportLabels", - "consumes": [ - "application/json" + "FeaturesetContainer" ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_List", "produces": [ "application/json" ], @@ -6431,22 +6455,42 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "id", - "description": "The name and identifier for the LabelingJob.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "in": "body", - "name": "body", - "description": "The export summary.", - "required": true, - "schema": { - "$ref": "#/definitions/ExportSummary" + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } } ], @@ -6460,44 +6504,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ExportSummary" - } - }, - "202": { - "description": "Accepted", - "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "ExportLabels Labeling Job.": { - "$ref": "./examples/LabelingJob/exportLabels.json" + "List Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/pause": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { "tags": [ - "LabelingJob" + "FeaturesetContainer" ], - "summary": "Pause a labeling job.", - "operationId": "LabelingJobs_Pause", + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", "produces": [ "application/json" ], @@ -6513,8 +6540,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the LabelingJob.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -6531,22 +6558,48 @@ }, "200": { "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Pause Labeling Job.": { - "$ref": "./examples/LabelingJob/pause.json" + "Delete Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/resume": { - "post": { + }, + "get": { "tags": [ - "LabelingJob" + "FeaturesetContainer" ], - "summary": "Resume a labeling job (asynchronous).", - "operationId": "LabelingJobs_Resume", + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", "produces": [ "application/json" ], @@ -6562,8 +6615,8 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the LabelingJob.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -6579,43 +6632,110 @@ } }, "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturesetContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, - "202": { - "description": "Accepted", + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + }, "headers": { - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" } } } }, "x-ms-examples": { - "Resume Labeling Job.": { - "$ref": "./examples/LabelingJob/resume.json" + "CreateOrUpdate Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { "get": { "tags": [ - "ModelContainer" + "FeaturesetVersion" ], - "summary": "List model containers.", - "operationId": "ModelContainers_List", + "summary": "List versions.", + "operationId": "FeaturesetVersions_List", "produces": [ "application/json" ], @@ -6629,6 +6749,13 @@ { "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, + { + "in": "path", + "name": "name", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, @@ -6637,15 +6764,14 @@ }, { "in": "query", - "name": "count", - "description": "Maximum number of results to return.", - "type": "integer", - "format": "int32" + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { "in": "query", "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -6680,13 +6806,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/list.json" + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" } }, "x-ms-pageable": { @@ -6694,13 +6820,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { "delete": { "tags": [ - "ModelContainer" + "FeaturesetVersion" ], - "summary": "Delete container.", - "operationId": "ModelContainers_Delete", + "summary": "Delete version.", + "operationId": "FeaturesetVersions_Delete", "produces": [ "application/json" ], @@ -6721,6 +6847,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -6735,22 +6868,47 @@ "200": { "description": "Success" }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, "204": { "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/delete.json" + "Delete Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } }, "get": { "tags": [ - "ModelContainer" + "FeaturesetVersion" ], - "summary": "Get container.", - "operationId": "ModelContainers_Get", + "summary": "Get version.", + "operationId": "FeaturesetVersions_Get", "produces": [ "application/json" ], @@ -6771,6 +6929,13 @@ "required": true, "type": "string" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } @@ -6785,22 +6950,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" } } }, "x-ms-examples": { - "Get Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/get.json" + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" } } }, "put": { "tags": [ - "ModelContainer" + "FeaturesetVersion" ], - "summary": "Create or update container.", - "operationId": "ModelContainers_CreateOrUpdate", + "summary": "Create or update version.", + "operationId": "FeaturesetVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -6825,16 +6990,23 @@ "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "body", - "description": "Container entity to create or update.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" } } ], @@ -6848,30 +7020,48 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json" + "CreateOrUpdate Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { + "post": { "tags": [ - "ModelVersion" + "FeaturesetVersion" + ], + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", + "consumes": [ + "application/json" ], - "summary": "List model versions.", - "operationId": "ModelVersions_List", "produces": [ "application/json" ], @@ -6888,91 +7078,27 @@ { "in": "path", "name": "name", - "description": "Model name. This is case-sensitive.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" - }, - { - "in": "query", - "name": "$top", - "description": "Maximum number of records to return.", - "type": "integer", - "format": "int32" - }, - { - "in": "query", + "in": "path", "name": "version", - "description": "Model version.", - "type": "string" - }, - { - "in": "query", - "name": "description", - "description": "Model description.", - "type": "string" - }, - { - "in": "query", - "name": "offset", - "description": "Number of initial results to skip.", - "type": "integer", - "format": "int32" - }, - { - "in": "query", - "name": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "properties", - "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "description": "Version identifier. This is case-sensitive.", + "required": true, "type": "string" }, { - "in": "query", - "name": "feed", - "description": "Name of the feed.", - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "listViewType", - "description": "View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] + "in": "body", + "name": "body", + "description": "Feature set version backfill request entity.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" } } ], @@ -6986,27 +7112,47 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } } }, "x-ms-examples": { - "List Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/list.json" + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/getFeature": { + "post": { "tags": [ - "ModelVersion" + "FeaturesetVersion" + ], + "summary": "Get feature.", + "operationId": "FeaturesetVersions_GetFeature", + "consumes": [ + "application/json" ], - "summary": "Delete version.", - "operationId": "ModelVersions_Delete", "produces": [ "application/json" ], @@ -7023,19 +7169,28 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Feature set name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Feature set version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Feature Name request. This is case-sensitive.", + "required": true, + "schema": { + "$ref": "#/definitions/GetFeatureRequest" + } } ], "responses": { @@ -7046,24 +7201,26 @@ } }, "200": { - "description": "Success" - }, - "204": { - "description": "No Content" + "description": "Success", + "schema": { + "$ref": "#/definitions/Feature" + } } }, "x-ms-examples": { - "Delete Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/delete.json" + "GetFeature Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/getFeature.json" } } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/listFeatures": { + "post": { "tags": [ - "ModelVersion" + "FeaturesetVersion" ], - "summary": "Get version.", - "operationId": "ModelVersions_Get", + "summary": "List Features.", + "operationId": "FeaturesetVersions_ListFeatures", "produces": [ "application/json" ], @@ -7080,19 +7237,28 @@ { "in": "path", "name": "name", - "description": "Container name. This is case-sensitive.", + "description": "Featureset name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", "name": "version", - "description": "Version identifier. This is case-sensitive.", + "description": "Featureset Version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" } ], "responses": { @@ -7105,25 +7271,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/FeatureArmPaginatedResult" } } }, "x-ms-examples": { - "Get Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/get.json" + "ListFeatures Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/listFeatures.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/listMaterializationJobs": { + "post": { "tags": [ - "ModelVersion" - ], - "summary": "Create or update version.", - "operationId": "ModelVersions_CreateOrUpdate", - "consumes": [ - "application/json" + "FeaturesetVersion" ], + "summary": "List materialization Jobs.", + "operationId": "FeaturesetVersions_ListMaterializationJobs", "produces": [ "application/json" ], @@ -7142,8 +7310,7 @@ "name": "name", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "in": "path", @@ -7156,13 +7323,25 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "Version entity to create or update.", - "required": true, - "schema": { - "$ref": "#/definitions/ModelVersionResource" - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "filters", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "featureWindowStart", + "description": "Start time of the feature window to filter materialization jobs.", + "type": "string" + }, + { + "in": "query", + "name": "featureWindowEnd", + "description": "End time of the feature window to filter materialization jobs.", + "type": "string" } ], "responses": { @@ -7175,30 +7354,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/FeaturesetJobArmPaginatedResult" } } }, "x-ms-examples": { - "CreateOrUpdate Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json" + "ListMaterializationJobs Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/listMaterializationJobs.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { "get": { "tags": [ - "OnlineEndpoint" + "FeaturestoreEntityContainer" ], - "summary": "List Online Endpoints.", - "operationId": "OnlineEndpoints_List", + "summary": "List featurestore entity containers.", + "operationId": "FeaturestoreEntityContainers_List", "produces": [ "application/json" ], @@ -7216,82 +7392,59 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "name", - "description": "Name of the endpoint.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", - "name": "count", - "description": "Number of endpoints to be retrieved in a page of results.", - "type": "integer", - "format": "int32" + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { "in": "query", - "name": "computeType", - "description": "EndpointComputeType to be filtered by.", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", + "default": "ActiveOnly", "enum": [ - "Managed", - "Kubernetes", - "AzureMLCompute" + "ActiveOnly", + "ArchivedOnly", + "All" ], "x-ms-enum": { - "name": "EndpointComputeType", - "modelAsString": true - } - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "tags", - "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", - "type": "string" - }, - { - "in": "query", - "name": "properties", - "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", - "type": "string" - }, - { - "in": "query", - "name": "orderBy", - "description": "The option to order the response.", - "type": "string", - "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" - ], - "x-ms-enum": { - "name": "OrderString", - "modelAsString": true - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/list.json" + "List Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" } }, "x-ms-pageable": { @@ -7299,13 +7452,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { "delete": { "tags": [ - "OnlineEndpoint" + "FeaturestoreEntityContainer" ], - "summary": "Delete Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_Delete", + "summary": "Delete container.", + "operationId": "FeaturestoreEntityContainers_Delete", "produces": [ "application/json" ], @@ -7321,8 +7474,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -7337,8 +7490,8 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "204": { - "description": "No Content" + "200": { + "description": "Success" }, "202": { "description": "Accepted", @@ -7361,23 +7514,26 @@ } } }, - "200": { - "description": "Success" + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/delete.json" + "Delete Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } }, "get": { "tags": [ - "OnlineEndpoint" + "FeaturestoreEntityContainer" ], - "summary": "Get Online Endpoint.", - "operationId": "OnlineEndpoints_Get", + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", "produces": [ "application/json" ], @@ -7393,8 +7549,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -7412,106 +7568,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } }, "x-ms-examples": { - "Get Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/get.json" + "GetEntity Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" } } }, - "patch": { - "tags": [ - "OnlineEndpoint" - ], - "summary": "Update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_Update", - "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": "endpointName", - "description": "Online Endpoint name.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Online Endpoint entity to apply during operation.", - "required": true, - "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" - } - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } - } - } - }, - "x-ms-examples": { - "Update Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/update.json" - } - }, - "x-ms-long-running-operation": true - }, "put": { "tags": [ - "OnlineEndpoint" + "FeaturestoreEntityContainer" ], - "summary": "Create or update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -7530,8 +7602,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -7542,10 +7614,10 @@ { "in": "body", "name": "body", - "description": "Online Endpoint entity to apply during operation.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } ], @@ -7559,13 +7631,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" }, "headers": { "x-ms-async-operation-timeout": { @@ -7581,20 +7653,23 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json" + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": { "get": { "tags": [ - "OnlineDeployment" + "FeaturestoreEntityVersion" ], - "summary": "List Inference Endpoint Deployments.", - "operationId": "OnlineDeployments_List", + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_List", "produces": [ "application/json" ], @@ -7610,8 +7685,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", + "name": "name", + "description": "Feature entity name. This is case-sensitive.", "required": true, "type": "string" }, @@ -7619,20 +7694,40 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", - "type": "string" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { "in": "query", - "name": "$top", - "description": "Top of list.", - "type": "integer", - "format": "int32" + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } } ], "responses": { @@ -7645,13 +7740,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" } } }, "x-ms-examples": { - "List Online Deployments.": { - "$ref": "./examples/OnlineDeployment/list.json" + "List Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" } }, "x-ms-pageable": { @@ -7659,13 +7754,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { "delete": { "tags": [ - "OnlineDeployment" + "FeaturestoreEntityVersion" ], - "summary": "Delete Inference Endpoint Deployment (asynchronous).", - "operationId": "OnlineDeployments_Delete", + "summary": "Delete version.", + "operationId": "FeaturestoreEntityVersions_Delete", "produces": [ "application/json" ], @@ -7681,15 +7776,15 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -7707,9 +7802,6 @@ "200": { "description": "Success" }, - "204": { - "description": "No Content" - }, "202": { "description": "Accepted", "headers": { @@ -7730,21 +7822,27 @@ "minimum": 10 } } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Delete Workspace Online Deployment.": { - "$ref": "./examples/Workspace/OnlineDeployment/delete.json" + "Delete Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } }, "get": { "tags": [ - "OnlineDeployment" + "FeaturestoreEntityVersion" ], - "summary": "Get Inference Deployment Deployment.", - "operationId": "OnlineDeployments_Get", + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_Get", "produces": [ "application/json" ], @@ -7760,15 +7858,15 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -7786,25 +7884,22 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } }, "x-ms-examples": { - "Get Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" - }, - "Get Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + "Get Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" } } }, - "patch": { + "put": { "tags": [ - "OnlineDeployment" + "FeaturestoreEntityVersion" ], - "summary": "Update Online Deployment (asynchronous).", - "operationId": "OnlineDeployments_Update", + "summary": "Create or update version.", + "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -7823,19 +7918,18 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "name": "version", + "description": "Version identifier. This is case-sensitive.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7843,10 +7937,10 @@ { "in": "body", "name": "body", - "description": "Online Endpoint entity to apply during operation.", + "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } ], @@ -7860,50 +7954,45 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + }, "headers": { "x-ms-async-operation-timeout": { "description": "Timeout for the client to use when polling the asynchronous operation.", "type": "string", "format": "duration" }, - "Location": { - "description": "URI to poll for asynchronous operation result.", + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } } }, "x-ms-examples": { - "Update Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" - }, - "Update Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + "CreateOrUpdate Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json" } }, - "x-ms-long-running-operation": true - }, - "put": { + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { + "get": { "tags": [ - "OnlineDeployment" - ], - "summary": "Create or update Inference Endpoint Deployment (asynchronous).", - "operationId": "OnlineDeployments_CreateOrUpdate", - "consumes": [ - "application/json" + "Job" ], + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_List", "produces": [ "application/json" ], @@ -7918,32 +8007,67 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "jobType", + "description": "Type of job to be returned.", + "type": "string" }, { - "in": "body", - "name": "body", - "description": "Inference Endpoint entity to apply during operation.", - "required": true, - "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "in": "query", + "name": "tag", + "description": "Jobs returned will have this tag key.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } + }, + { + "in": "query", + "name": "assetName", + "description": "Asset name the job's named output is registered with", + "type": "string" + }, + { + "in": "query", + "name": "scheduled", + "description": "Indicator whether the job is scheduled job.", + "type": "boolean" + }, + { + "in": "query", + "name": "scheduleId", + "description": "The scheduled id for listing the job triggered from", + "type": "string" } ], "responses": { @@ -7956,48 +8080,36 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" - }, - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" } } }, "x-ms-examples": { - "CreateOrUpdate Managed Online Deployment.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" + "List Command Job.": { + "$ref": "./examples/Job/CommandJob/list.json" }, - "CreateOrUpdate Kubernetes Online Deployment.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, + "List Sweep Job.": { + "$ref": "./examples/Job/SweepJob/list.json" + }, + "List Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/list.json" } }, - "x-ms-long-running-operation": true + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "delete": { "tags": [ - "OnlineDeployment" - ], - "summary": "Polls an Endpoint operation.", - "operationId": "OnlineDeployments_GetLogs", - "consumes": [ - "application/json" + "Job" ], + "summary": "Deletes a Job (asynchronous).", + "operationId": "Jobs_Delete", "produces": [ "application/json" ], @@ -8013,29 +8125,13 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "The name and identifier for the endpoint.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The request containing parameters for retrieving logs.", - "required": true, - "schema": { - "$ref": "#/definitions/DeploymentLogsRequest" - } } ], "responses": { @@ -8046,26 +8142,49 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeploymentLogs" + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } } + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "Get Online Deployment Logs.": { - "$ref": "./examples/OnlineDeployment/getLogs.json" + "Delete Job.": { + "$ref": "./examples/Job/delete.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + }, "get": { "tags": [ - "OnlineDeployment" + "Job" ], - "summary": "List Inference Endpoint Deployment Skus.", - "operationId": "OnlineDeployments_ListSkus", + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -8081,30 +8200,13 @@ }, { "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "deploymentName", - "description": "Inference Endpoint Deployment name.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "count", - "description": "Number of Skus to be retrieved in a page of results.", - "type": "integer", - "format": "int32" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" } ], "responses": { @@ -8117,30 +8219,34 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/SkuResourceArmPaginatedResult" + "$ref": "#/definitions/JobBaseResource" } } }, "x-ms-examples": { - "List Managed Online Deployment Skus.": { - "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" + "Get Command Job.": { + "$ref": "./examples/Job/CommandJob/get.json" }, - "List Kubernetes Online Deployment Skus.": { - "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, + "Get Sweep Job.": { + "$ref": "./examples/Job/SweepJob/get.json" + }, + "Get Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/get.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { - "post": { + }, + "put": { "tags": [ - "OnlineEndpoint" + "Job" + ], + "summary": "Creates and executes a Job.", + "operationId": "Jobs_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", - "operationId": "OnlineEndpoints_ListKeys", "produces": [ "application/json" ], @@ -8156,13 +8262,23 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Job definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/JobBaseResource" + } } ], "responses": { @@ -8175,27 +8291,39 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthKeys" + "$ref": "#/definitions/JobBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobBaseResource" } } }, "x-ms-examples": { - "ListKeys Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json" + "CreateOrUpdate Command Job.": { + "$ref": "./examples/Job/CommandJob/createOrUpdate.json" + }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, + "CreateOrUpdate Sweep Job.": { + "$ref": "./examples/Job/SweepJob/createOrUpdate.json" + }, + "CreateOrUpdate Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { "post": { "tags": [ - "OnlineEndpoint" - ], - "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", - "operationId": "OnlineEndpoints_RegenerateKeys", - "consumes": [ - "application/json" + "Job" ], + "summary": "Cancels a Job (asynchronous).", + "operationId": "Jobs_Cancel", "produces": [ "application/json" ], @@ -8211,22 +8339,13 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "RegenerateKeys request .", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateEndpointKeysRequest" - } } ], "responses": { @@ -8236,9 +8355,6 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "200": { - "description": "Success" - }, "202": { "description": "Accepted", "headers": { @@ -8254,11 +8370,14 @@ "minimum": 10 } } + }, + "200": { + "description": "Success" } }, "x-ms-examples": { - "RegenerateKeys Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json" + "Cancel Job.": { + "$ref": "./examples/Job/cancel.json" } }, "x-ms-long-running-operation": true, @@ -8267,13 +8386,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": { + "get": { "tags": [ - "OnlineEndpoint" + "LabelingJob" ], - "summary": "Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.", - "operationId": "OnlineEndpoints_GetToken", + "summary": "Lists labeling jobs in the workspace.", + "operationId": "LabelingJobs_List", "produces": [ "application/json" ], @@ -8288,14 +8407,17 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$top", + "description": "Number of labeling jobs to return.", + "type": "integer", + "format": "int32" } ], "responses": { @@ -8308,24 +8430,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/EndpointAuthToken" + "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult" } } }, "x-ms-examples": { - "GetToken Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/getToken.json" + "List Labeling Job.": { + "$ref": "./examples/LabelingJob/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": { + "delete": { "tags": [ - "Schedule" + "LabelingJob" ], - "summary": "List schedules in specified workspace.", - "operationId": "Schedules_List", + "summary": "Delete a labeling job.", + "operationId": "LabelingJobs_Delete", "produces": [ "application/json" ], @@ -8340,37 +8465,14 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" }, { - "in": "query", - "name": "listViewType", - "description": "Status filter for schedule.", - "type": "string", - "default": "EnabledOnly", - "enum": [ - "EnabledOnly", - "DisabledOnly", - "All" - ], - "x-ms-enum": { - "name": "ScheduleListViewType", - "modelAsString": true, - "values": [ - { - "value": "EnabledOnly" - }, - { - "value": "DisabledOnly" - }, - { - "value": "All" - } - ] - } + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -8381,29 +8483,24 @@ } }, "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" - } + "description": "Success" + }, + "204": { + "description": "No Content" } }, "x-ms-examples": { - "List Schedules.": { - "$ref": "./examples/Schedule/list.json" + "Delete Labeling Job.": { + "$ref": "./examples/LabelingJob/delete.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { - "delete": { + }, + "get": { "tags": [ - "Schedule" + "LabelingJob" ], - "summary": "Delete schedule.", - "operationId": "Schedules_Delete", + "summary": "Gets a labeling job by name/id.", + "operationId": "LabelingJobs_Get", "produces": [ "application/json" ], @@ -8419,63 +8516,58 @@ }, { "in": "path", - "name": "name", - "description": "Schedule name.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } }, - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted", - "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Location": { - "description": "URI to poll for asynchronous operation result.", - "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 - } + { + "in": "query", + "name": "includeJobInstructions", + "description": "Boolean value to indicate whether to include JobInstructions in response.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeLabelCategories", + "description": "Boolean value to indicate Whether to include LabelCategories in response.", + "type": "boolean", + "default": false + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, - "204": { - "description": "No Content" + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } } }, "x-ms-examples": { - "Delete Schedule.": { - "$ref": "./examples/Schedule/delete.json" + "Get Labeling Job.": { + "$ref": "./examples/LabelingJob/get.json" } - }, - "x-ms-long-running-operation": true + } }, - "get": { + "put": { "tags": [ - "Schedule" + "LabelingJob" + ], + "summary": "Creates or updates a labeling job (asynchronous).", + "operationId": "LabelingJobs_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Get schedule.", - "operationId": "Schedules_Get", "produces": [ "application/json" ], @@ -8491,13 +8583,23 @@ }, { "in": "path", - "name": "name", - "description": "Schedule name.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "LabelingJob definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } } ], "responses": { @@ -8507,25 +8609,48 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/LabelingJobResource" } } }, "x-ms-examples": { - "Get Schedule.": { - "$ref": "./examples/Schedule/get.json" + "CreateOrUpdate Labeling Job.": { + "$ref": "./examples/LabelingJob/createOrUpdate.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": { + "post": { "tags": [ - "Schedule" + "LabelingJob" ], - "summary": "Create or update schedule.", - "operationId": "Schedules_CreateOrUpdate", + "summary": "Export labels from a labeling job (asynchronous).", + "operationId": "LabelingJobs_ExportLabels", "consumes": [ "application/json" ], @@ -8544,11 +8669,10 @@ }, { "in": "path", - "name": "name", - "description": "Schedule name.", + "name": "id", + "description": "The name and identifier for the LabelingJob.", "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -8556,10 +8680,10 @@ { "in": "body", "name": "body", - "description": "Schedule definition.", + "description": "The export summary.", "required": true, "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/ExportSummary" } } ], @@ -8573,83 +8697,2306 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/ExportSummary" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ScheduleResource" - }, + "202": { + "description": "Accepted", "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } } }, "x-ms-examples": { - "CreateOrUpdate Schedule.": { - "$ref": "./examples/Schedule/createOrUpdate.json" + "ExportLabels Labeling Job.": { + "$ref": "./examples/LabelingJob/exportLabels.json" } }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "AccountKeyDatastoreCredentials": { - "description": "Account key datastore credentials configuration.", - "required": [ - "secrets" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreCredentials" - } - ], - "properties": { - "secrets": { - "description": "[Required] Storage account secrets.", - "$ref": "#/definitions/AccountKeyDatastoreSecrets", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } - }, - "x-ms-discriminator-value": "AccountKey", - "additionalProperties": false + } }, - "AccountKeyDatastoreSecrets": { - "description": "Datastore account key secrets.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatastoreSecrets" - } - ], - "properties": { - "key": { - "description": "Storage account key.", - "type": "string", - "x-nullable": true + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/pause": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Pause a labeling job.", + "operationId": "LabelingJobs_Pause", + "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": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Pause Labeling Job.": { + "$ref": "./examples/LabelingJob/pause.json" + } } - }, - "x-ms-discriminator-value": "AccountKey", - "additionalProperties": false + } }, - "AllNodes": { - "description": "All nodes means the service will be running on all of the nodes of the job", - "type": "object", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/resume": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Resume a labeling job (asynchronous).", + "operationId": "LabelingJobs_Resume", + "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": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Resume Labeling Job.": { + "$ref": "./examples/LabelingJob/resume.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "ModelContainers_List", + "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" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { + "delete": { + "tags": [ + "ModelContainer" + ], + "summary": "Delete container.", + "operationId": "ModelContainers_Delete", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "Get container.", + "operationId": "ModelContainers_Get", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ModelContainer" + ], + "summary": "Create or update container.", + "operationId": "ModelContainers_CreateOrUpdate", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "List model versions.", + "operationId": "ModelVersions_List", + "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": "Model name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Model version.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "offset", + "description": "Number of initial results to skip.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "feed", + "description": "Name of the feed.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { + "delete": { + "tags": [ + "ModelVersion" + ], + "summary": "Delete version.", + "operationId": "ModelVersions_Delete", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "Get version.", + "operationId": "ModelVersions_Get", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ModelVersion" + ], + "summary": "Create or update version.", + "operationId": "ModelVersions_CreateOrUpdate", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/package": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Model Version Package operation.", + "operationId": "ModelVersions_Package", + "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": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Package operation request body.", + "required": true, + "schema": { + "description": "Model package operation request properties." + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PackageResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Package Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/package.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List Online Endpoints.", + "operationId": "OnlineEndpoints_List", + "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" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the endpoint.", + "type": "string" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "computeType", + "description": "EndpointComputeType to be filtered by.", + "type": "string", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true + } + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "delete": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Delete Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Delete", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Delete Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Get Online Endpoint.", + "operationId": "OnlineEndpoints_Get", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Update", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Create or update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_CreateOrUpdate", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployments.", + "operationId": "OnlineDeployments_List", + "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": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Online Deployments.": { + "$ref": "./examples/OnlineDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Delete Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_Delete", + "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": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Delete Workspace Online Deployment.": { + "$ref": "./examples/Workspace/OnlineDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Get Inference Deployment Deployment.", + "operationId": "OnlineDeployments_Get", + "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": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" + }, + "Get Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Update Online Deployment (asynchronous).", + "operationId": "OnlineDeployments_Update", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" + }, + "Update Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Create or update Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_CreateOrUpdate", + "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": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Inference Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" + }, + "CreateOrUpdate Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { + "post": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Polls an Endpoint operation.", + "operationId": "OnlineDeployments_GetLogs", + "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": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The name and identifier for the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The request containing parameters for retrieving logs.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentLogsRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentLogs" + } + } + }, + "x-ms-examples": { + "Get Online Deployment Logs.": { + "$ref": "./examples/OnlineDeployment/getLogs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployment Skus.", + "operationId": "OnlineDeployments_ListSkus", + "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": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Managed Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" + }, + "List Kubernetes Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "OnlineEndpoints_ListKeys", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "OnlineEndpoints_RegenerateKeys", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "RegenerateKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.", + "operationId": "OnlineEndpoints_GetToken", + "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": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthToken" + } + } + }, + "x-ms-examples": { + "GetToken Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/getToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { + "get": { + "tags": [ + "Schedule" + ], + "summary": "List schedules in specified workspace.", + "operationId": "Schedules_List", + "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" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "Status filter for schedule.", + "type": "string", + "default": "EnabledOnly", + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Schedules.": { + "$ref": "./examples/Schedule/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "delete": { + "tags": [ + "Schedule" + ], + "summary": "Delete schedule.", + "operationId": "Schedules_Delete", + "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" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Schedule.": { + "$ref": "./examples/Schedule/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Schedule" + ], + "summary": "Get schedule.", + "operationId": "Schedules_Get", + "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" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + }, + "x-ms-examples": { + "Get Schedule.": { + "$ref": "./examples/Schedule/get.json" + } + } + }, + "put": { + "tags": [ + "Schedule" + ], + "summary": "Create or update schedule.", + "operationId": "Schedules_CreateOrUpdate", + "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", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Schedule definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ScheduleResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Schedule.": { + "$ref": "./examples/Schedule/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + } + }, + "definitions": { + "AccountKeyDatastoreCredentials": { + "description": "Account key datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage account secrets.", + "$ref": "#/definitions/AccountKeyDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AccountKeyDatastoreSecrets": { + "description": "Datastore account key secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "key": { + "description": "Storage account key.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AllNodes": { + "description": "All nodes means the service will be running on all of the nodes of the job", + "type": "object", "allOf": [ { "$ref": "#/definitions/Nodes" @@ -8921,6 +11268,15 @@ ], "x-nullable": true }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "resources": { "description": "Compute Resource configuration for the job.", "default": "{}", @@ -9285,6 +11641,42 @@ "x-ms-discriminator-value": "AzureFile", "additionalProperties": false }, + "AzureMLBatchInferencingServer": { + "description": "Azure ML batch inferencing server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "codeConfiguration": { + "description": "Code configuration for AML batch inferencing server.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AzureMLBatch", + "additionalProperties": false + }, + "AzureMLOnlineInferencingServer": { + "description": "Azure ML online inferencing configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "codeConfiguration": { + "description": "Code configuration for AML inferencing server.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AzureMLOnline", + "additionalProperties": false + }, "BanditPolicy": { "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", "type": "object", @@ -9310,6 +11702,57 @@ "x-ms-discriminator-value": "Bandit", "additionalProperties": false }, + "BaseEnvironmentId": { + "description": "Base environment type.", + "required": [ + "resourceId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseEnvironmentSource" + } + ], + "properties": { + "resourceId": { + "description": "[Required] Resource id accepting ArmId or AzureMlId.", + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "EnvironmentAsset", + "additionalProperties": false + }, + "BaseEnvironmentSource": { + "required": [ + "baseEnvironmentSourceType" + ], + "type": "object", + "properties": { + "baseEnvironmentSourceType": { + "description": "[Required] Base environment type.", + "$ref": "#/definitions/BaseEnvironmentSourceType" + } + }, + "discriminator": "baseEnvironmentSourceType" + }, + "BaseEnvironmentSourceType": { + "description": "Base environment type.", + "enum": [ + "EnvironmentAsset" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseEnvironmentSourceType", + "modelAsString": true, + "values": [ + { + "value": "EnvironmentAsset" + } + ] + }, + "additionalProperties": false + }, "BatchDeployment": { "description": "Batch inference settings per deployment.", "type": "object", @@ -9324,6 +11767,11 @@ "type": "string", "x-nullable": true }, + "deploymentProperties": { + "description": "Properties relevant to different deployment types.", + "$ref": "#/definitions/BatchDeploymentConfiguration", + "x-nullable": true + }, "errorThreshold": { "format": "int32", "description": "Error threshold, if the error count for the entire input goes above this value,\r\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\r\nFor FileDataset, this value is the count of file failures.\r\nFor TabularDataset, this value is the count of record failures.\r\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.", @@ -9384,6 +11832,41 @@ "x-ms-client-name": "BatchDeploymentProperties", "additionalProperties": false }, + "BatchDeploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "required": [ + "deploymentPropertyType" + ], + "type": "object", + "properties": { + "deploymentPropertyType": { + "description": "[Required] The type of the deployment", + "$ref": "#/definitions/BatchDeploymentConfigurationType" + } + }, + "discriminator": "deploymentPropertyType" + }, + "BatchDeploymentConfigurationType": { + "description": "The enumerated property types for batch deployments.", + "enum": [ + "Model", + "PipelineComponent" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchDeploymentConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Model" + }, + { + "value": "PipelineComponent" + } + ] + }, + "additionalProperties": false + }, "BatchDeploymentTrackedResource": { "required": [ "location", @@ -9444,7 +11927,7 @@ ], "properties": { "defaults": { - "description": "Default values for Batch Endpoint", + "description": "Default values for Batch Endpoint.", "$ref": "#/definitions/BatchEndpointDefaults", "x-nullable": true }, @@ -9568,6 +12051,47 @@ }, "additionalProperties": false }, + "BatchPipelineComponentDeploymentConfiguration": { + "description": "Properties for a Batch Pipeline Component Deployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BatchDeploymentConfiguration" + } + ], + "properties": { + "componentId": { + "description": "The ARM id of the component to be run.", + "$ref": "#/definitions/IdAssetReference", + "x-nullable": true + }, + "description": { + "description": "The description which will be applied to the job.", + "type": "string", + "x-nullable": true + }, + "settings": { + "description": "Run-time settings for the pipeline job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "The tags which will be applied to the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PipelineComponent", + "additionalProperties": false + }, "BatchRetrySettings": { "description": "Retry settings for a batch inference operation.", "type": "object", @@ -9849,7 +12373,7 @@ }, { "value": "RandomForest", - "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the 'bagging' method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." }, { "value": "ExtremeRandomTrees", @@ -10301,6 +12825,15 @@ ], "x-nullable": true }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "resources": { "description": "Compute Resource configuration for the job.", "default": "{}", @@ -10461,6 +12994,18 @@ }, "additionalProperties": false }, + "MaterializationComputeResource": { + "description": "Dto object representing compute resource", + "type": "object", + "properties": { + "instanceType": { + "description": "Specifies the instance type", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, "ContainerResourceRequirements": { "description": "Resource requirements for each container instance within an online deployment.", "type": "object", @@ -10621,22 +13166,40 @@ "x-ms-discriminator-value": "CSV", "additionalProperties": false }, - "CustomForecastHorizon": { - "description": "The desired maximum forecast horizon in units of time-series frequency.", - "required": [ - "value" - ], + "CustomForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Forecast horizon value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomInferencingServer": { + "description": "Custom inference server configurations.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ForecastHorizon" + "$ref": "#/definitions/InferencingServer" } ], "properties": { - "value": { - "format": "int32", - "description": "[Required] Forecast horizon value.", - "type": "integer" + "inferenceConfiguration": { + "description": "Inference configuration for custom inferencing.", + "$ref": "#/definitions/OnlineInferenceConfiguration", + "x-nullable": true } }, "x-ms-discriminator-value": "Custom", @@ -10749,18 +13312,282 @@ "type": "integer" } }, - "x-ms-discriminator-value": "Custom", + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "DataContainer": { + "description": "Container for data asset versions.", + "required": [ + "dataType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-name": "DataContainerProperties", + "additionalProperties": false + }, + "DataContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataContainer" + } + }, + "x-ms-client-name": "DataContainer", + "additionalProperties": false + }, + "DataContainerResourceArmPaginatedResult": { + "description": "A paginated list of DataContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/DataContainerResource" + } + } + }, + "additionalProperties": false + }, + "DataPathAssetReference": { + "description": "Reference to an asset via its path in a datastore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "datastoreId": { + "description": "ARM resource ID of the datastore where the asset is located.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the datastore.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "DataPath", + "additionalProperties": false + }, + "DatasetExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "labeledAssetName": { + "description": "The unique name of the labeled data asset.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Dataset", + "additionalProperties": false + }, + "Datastore": { + "description": "Base definition for datastore contents configuration.", + "required": [ + "credentials", + "datastoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" + }, + "datastoreType": { + "description": "[Required] Storage type backing the datastore.", + "$ref": "#/definitions/DatastoreType" + }, + "isDefault": { + "description": "Readonly property to indicate if datastore is the workspace default datastore", + "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "datastoreType", + "x-ms-client-name": "DatastoreProperties" + }, + "DatastoreCredentials": { + "description": "Base definition for datastore credentials.", + "required": [ + "credentialsType" + ], + "type": "object", + "properties": { + "credentialsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/CredentialsType" + } + }, + "discriminator": "credentialsType" + }, + "DatastoreResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Datastore" + } + }, + "x-ms-client-name": "Datastore", + "additionalProperties": false + }, + "DatastoreResourceArmPaginatedResult": { + "description": "A paginated list of Datastore entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Datastore.", + "type": "array", + "items": { + "$ref": "#/definitions/DatastoreResource" + } + } + }, + "additionalProperties": false + }, + "DatastoreSecrets": { + "description": "Base definition for datastore secrets.", + "required": [ + "secretsType" + ], + "type": "object", + "properties": { + "secretsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/SecretsType" + } + }, + "discriminator": "secretsType" + }, + "DatastoreType": { + "description": "Enum to determine the datastore contents type.", + "enum": [ + "AzureBlob", + "AzureDataLakeGen1", + "AzureDataLakeGen2", + "AzureFile", + "Hdfs" + ], + "type": "string", + "x-ms-enum": { + "name": "DatastoreType", + "modelAsString": true, + "values": [ + { + "value": "AzureBlob" + }, + { + "value": "AzureDataLakeGen1" + }, + { + "value": "AzureDataLakeGen2" + }, + { + "value": "AzureFile" + }, + { + "value": "Hdfs" + } + ] + }, + "additionalProperties": false + }, + "DataType": { + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder", + "mltable" + ], + "type": "string", + "x-ms-enum": { + "name": "DataType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + } + ] + }, "additionalProperties": false }, - "DataContainer": { - "description": "Container for data asset versions.", + "DataVersionBase": { + "description": "Data version base definition", "required": [ - "dataType" + "dataType", + "dataUri" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetContainer" + "$ref": "#/definitions/AssetBase" } ], "properties": { @@ -10771,12 +13598,21 @@ "create", "read" ] + }, + "dataUri": { + "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "x-ms-client-name": "DataContainerProperties", - "additionalProperties": false + "discriminator": "dataType", + "x-ms-client-name": "DataVersionBaseProperties" }, - "DataContainerResource": { + "DataVersionBaseResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -10790,266 +13626,548 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/DataContainer" + "$ref": "#/definitions/DataVersionBase" } }, - "x-ms-client-name": "DataContainer", + "x-ms-client-name": "DataVersionBase", "additionalProperties": false }, - "DataContainerResourceArmPaginatedResult": { - "description": "A paginated list of DataContainer entities.", + "DataVersionBaseResourceArmPaginatedResult": { + "description": "A paginated list of DataVersionBase entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type DataContainer.", + "description": "An array of objects of type DataVersionBase.", "type": "array", "items": { - "$ref": "#/definitions/DataContainerResource" + "$ref": "#/definitions/DataVersionBaseResource" } } }, "additionalProperties": false }, - "DataPathAssetReference": { - "description": "Reference to an asset via its path in a datastore.", + "DefaultScaleSettings": { "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetReferenceBase" + "$ref": "#/definitions/OnlineScaleSettings" } ], + "x-ms-discriminator-value": "Default", + "additionalProperties": false + }, + "DeploymentLogs": { + "type": "object", "properties": { - "datastoreId": { - "description": "ARM resource ID of the datastore where the asset is located.", + "content": { + "description": "The retrieved online deployment logs.", "type": "string", "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentLogsRequest": { + "type": "object", + "properties": { + "containerType": { + "description": "The type of container to retrieve logs from.", + "default": "InferenceServer", + "$ref": "#/definitions/ContainerType" }, - "path": { - "description": "The path of the file/directory in the datastore.", - "type": "string", + "tail": { + "format": "int32", + "description": "The maximum number of lines to tail.", + "type": "integer", "x-nullable": true } }, - "x-ms-discriminator-value": "DataPath", "additionalProperties": false }, - "DatasetExportSummary": { + "DeploymentProvisioningState": { + "description": "Possible values for DeploymentProvisioningState.", + "enum": [ + "Creating", + "Deleting", + "Scaling", + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Scaling" + }, + { + "value": "Updating" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "DeploymentResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" + } + ], + "additionalProperties": false + }, + "DistributionConfiguration": { + "description": "Base definition for job distribution configuration.", + "required": [ + "distributionType" + ], + "type": "object", + "properties": { + "distributionType": { + "description": "[Required] Specifies the type of distribution framework.", + "$ref": "#/definitions/DistributionType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "distributionType" + }, + "DistributionType": { + "description": "Enum to determine the job distribution type.", + "enum": [ + "PyTorch", + "TensorFlow", + "Mpi" + ], + "type": "string", + "x-ms-enum": { + "name": "DistributionType", + "modelAsString": true, + "values": [ + { + "value": "PyTorch" + }, + { + "value": "TensorFlow" + }, + { + "value": "Mpi" + } + ] + }, + "additionalProperties": false + }, + "EarlyTerminationPolicy": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "required": [ + "policyType" + ], + "type": "object", + "properties": { + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" + }, + "evaluationInterval": { + "format": "int32", + "description": "Interval (number of runs) between policy evaluations.", + "default": 0, + "type": "integer" + }, + "policyType": { + "description": "[Required] Name of policy configuration", + "$ref": "#/definitions/EarlyTerminationPolicyType" + } + }, + "discriminator": "policyType" + }, + "EarlyTerminationPolicyType": { + "enum": [ + "Bandit", + "MedianStopping", + "TruncationSelection" + ], + "type": "string", + "x-ms-enum": { + "name": "EarlyTerminationPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Bandit" + }, + { + "value": "MedianStopping" + }, + { + "value": "TruncationSelection" + } + ] + }, + "additionalProperties": false + }, + "EgressPublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EgressPublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "EmailNotificationEnableType": { + "description": "Enum to determine the email notification type.", + "enum": [ + "JobCompleted", + "JobFailed", + "JobCancelled" + ], + "type": "string", + "x-ms-enum": { + "name": "EmailNotificationEnableType", + "modelAsString": true, + "values": [ + { + "value": "JobCompleted" + }, + { + "value": "JobFailed" + }, + { + "value": "JobCancelled" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthKeys": { + "description": "Keys for endpoint authentication.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExportSummary" - } - ], "properties": { - "labeledAssetName": { - "description": "The unique name of the labeled data asset.", + "primaryKey": { + "description": "The primary key.", "type": "string", - "readOnly": true, "x-ms-mutability": [ + "create", "read" ], "x-nullable": true - } - }, - "x-ms-discriminator-value": "Dataset", - "additionalProperties": false - }, - "Datastore": { - "description": "Base definition for datastore contents configuration.", - "required": [ - "credentials", - "datastoreType" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ResourceBase" - } - ], - "properties": { - "credentials": { - "description": "[Required] Account credentials.", - "$ref": "#/definitions/DatastoreCredentials" - }, - "datastoreType": { - "description": "[Required] Storage type backing the datastore.", - "$ref": "#/definitions/DatastoreType" }, - "isDefault": { - "description": "Readonly property to indicate if datastore is the workspace default datastore", - "type": "boolean", - "readOnly": true, + "secondaryKey": { + "description": "The secondary key.", + "type": "string", "x-ms-mutability": [ + "create", "read" - ] + ], + "x-nullable": true } }, - "discriminator": "datastoreType", - "x-ms-client-name": "DatastoreProperties" + "additionalProperties": false }, - "DatastoreCredentials": { - "description": "Base definition for datastore credentials.", - "required": [ - "credentialsType" + "EndpointAuthMode": { + "description": "Enum to determine endpoint authentication mode.", + "enum": [ + "AMLToken", + "Key", + "AADToken" ], + "type": "string", + "x-ms-enum": { + "name": "EndpointAuthMode", + "modelAsString": true, + "values": [ + { + "value": "AMLToken" + }, + { + "value": "Key" + }, + { + "value": "AADToken" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthToken": { + "description": "Service Token", "type": "object", "properties": { - "credentialsType": { - "description": "[Required] Credential type used to authentication with storage.", - "$ref": "#/definitions/CredentialsType" + "accessToken": { + "description": "Access token for endpoint authentication.", + "type": "string", + "x-nullable": true + }, + "expiryTimeUtc": { + "format": "int64", + "description": "Access token expiry time (UTC).", + "default": 0, + "type": "integer" + }, + "refreshAfterTimeUtc": { + "format": "int64", + "description": "Refresh access token after time (UTC).", + "default": 0, + "type": "integer" + }, + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true } }, - "discriminator": "credentialsType" + "additionalProperties": false }, - "DatastoreResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } + "EndpointComputeType": { + "description": "Enum to determine endpoint compute type.", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" ], - "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/Datastore" - } + "type": "string", + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "Kubernetes" + }, + { + "value": "AzureMLCompute" + } + ] }, - "x-ms-client-name": "Datastore", "additionalProperties": false }, - "DatastoreResourceArmPaginatedResult": { - "description": "A paginated list of Datastore entities.", + "EndpointDeploymentPropertiesBase": { + "description": "Base definition for endpoint deployment.", "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", - "type": "string" + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true }, - "value": { - "description": "An array of objects of type Datastore.", - "type": "array", - "items": { - "$ref": "#/definitions/DatastoreResource" - } + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentId": { + "description": "ARM resource ID of the environment specification for the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the deployment.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true } }, "additionalProperties": false }, - "DatastoreSecrets": { - "description": "Base definition for datastore secrets.", + "EndpointPropertiesBase": { + "description": "Inference Endpoint base definition", "required": [ - "secretsType" + "authMode" ], "type": "object", "properties": { - "secretsType": { - "description": "[Required] Credential type used to authentication with storage.", - "$ref": "#/definitions/SecretsType" + "authMode": { + "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", + "$ref": "#/definitions/EndpointAuthMode" + }, + "description": { + "description": "Description of the inference endpoint.", + "type": "string", + "x-nullable": true + }, + "keys": { + "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", + "$ref": "#/definitions/EndpointAuthKeys", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "scoringUri": { + "format": "uri", + "description": "Endpoint URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "swaggerUri": { + "format": "uri", + "description": "Endpoint Swagger URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true } }, - "discriminator": "secretsType" + "additionalProperties": false }, - "DatastoreType": { - "description": "Enum to determine the datastore contents type.", + "EndpointProvisioningState": { + "description": "State of endpoint provisioning.", "enum": [ - "AzureBlob", - "AzureDataLakeGen1", - "AzureDataLakeGen2", - "AzureFile", - "Hdfs" + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" ], "type": "string", "x-ms-enum": { - "name": "DatastoreType", + "name": "EndpointProvisioningState", "modelAsString": true, "values": [ { - "value": "AzureBlob" - }, - { - "value": "AzureDataLakeGen1" + "value": "Creating" }, { - "value": "AzureDataLakeGen2" + "value": "Deleting" }, { - "value": "AzureFile" + "value": "Succeeded" }, { - "value": "Hdfs" - } - ] - }, - "additionalProperties": false - }, - "DataType": { - "description": "Enum to determine the type of data.", - "enum": [ - "uri_file", - "uri_folder", - "mltable" - ], - "type": "string", - "x-ms-enum": { - "name": "DataType", - "modelAsString": true, - "values": [ - { - "value": "uri_file" + "value": "Failed" }, { - "value": "uri_folder" + "value": "Updating" }, { - "value": "mltable" + "value": "Canceled" } ] }, "additionalProperties": false }, - "DataVersionBase": { - "description": "Data version base definition", + "EndpointScheduleAction": { "required": [ - "dataType", - "dataUri" + "actionType", + "endpointInvocationDefinition" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetBase" + "$ref": "#/definitions/ScheduleActionBase" } ], "properties": { - "dataType": { - "description": "[Required] Specifies the type of data.", - "$ref": "#/definitions/DataType", + "endpointInvocationDefinition": { + "description": "[Required] Defines Schedule action definition details.\r\n", + "type": "object", + "example": { + "endpoint": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/hello-pipeline", + "inputs": { + "create_time": "${{creation_context.trigger_time}}" + } + }, "x-ms-mutability": [ "create", - "read" + "read", + "update" ] - }, - "dataUri": { - "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", - "pattern": "[a-zA-Z0-9_]", - "type": "string", + } + }, + "x-ms-discriminator-value": "InvokeBatchEndpoint", + "additionalProperties": false + }, + "EnvironmentContainer": { + "description": "Container for environment specification versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the environment container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ] } }, - "discriminator": "dataType", - "x-ms-client-name": "DataVersionBaseProperties" + "x-ms-client-name": "EnvironmentContainerProperties", + "additionalProperties": false }, - "DataVersionBaseResource": { + "EnvironmentContainerResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -11063,503 +14181,648 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/DataVersionBase" + "$ref": "#/definitions/EnvironmentContainer" } }, - "x-ms-client-name": "DataVersionBase", + "x-ms-client-name": "EnvironmentContainer", "additionalProperties": false }, - "DataVersionBaseResourceArmPaginatedResult": { - "description": "A paginated list of DataVersionBase entities.", + "EnvironmentContainerResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentContainer entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type DataVersionBase.", + "description": "An array of objects of type EnvironmentContainer.", "type": "array", "items": { - "$ref": "#/definitions/DataVersionBaseResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "additionalProperties": false }, - "DefaultScaleSettings": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OnlineScaleSettings" - } - ], - "x-ms-discriminator-value": "Default", - "additionalProperties": false - }, - "DeploymentLogs": { - "type": "object", - "properties": { - "content": { - "description": "The retrieved online deployment logs.", - "type": "string", - "x-nullable": true - } - }, - "additionalProperties": false - }, - "DeploymentLogsRequest": { - "type": "object", - "properties": { - "containerType": { - "description": "The type of container to retrieve logs from.", - "default": "InferenceServer", - "$ref": "#/definitions/ContainerType" - }, - "tail": { - "format": "int32", - "description": "The maximum number of lines to tail.", - "type": "integer", - "x-nullable": true - } - }, - "additionalProperties": false - }, - "DeploymentProvisioningState": { - "description": "Possible values for DeploymentProvisioningState.", + "EnvironmentType": { + "description": "Environment type is either user created or curated by Azure ML service", "enum": [ - "Creating", - "Deleting", - "Scaling", - "Updating", - "Succeeded", - "Failed", - "Canceled" + "Curated", + "UserCreated" ], "type": "string", "x-ms-enum": { - "name": "DeploymentProvisioningState", + "name": "EnvironmentType", "modelAsString": true, "values": [ { - "value": "Creating" - }, - { - "value": "Deleting" - }, - { - "value": "Scaling" - }, - { - "value": "Updating" - }, - { - "value": "Succeeded" - }, - { - "value": "Failed" + "value": "Curated" }, { - "value": "Canceled" + "value": "UserCreated" } ] }, "additionalProperties": false }, - "DeploymentResourceConfiguration": { + "EnvironmentVersion": { + "description": "Environment version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "autoRebuild": { + "description": "Defines if image needs to be rebuilt based on base image changes.", + "default": "Disabled", + "$ref": "#/definitions/AutoRebuildSetting", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "build": { + "description": "Configuration settings for Docker build context.", + "$ref": "#/definitions/BuildContext", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "condaFile": { + "description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\r\n", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentType": { + "description": "Environment type is either user managed or curated by the Azure ML service\r\n", + "$ref": "#/definitions/EnvironmentType", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "image": { + "description": "Name of the image that will be used for the environment.\r\n", + "type": "string", + "example": "docker.io/tensorflow/serving:latest", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inferenceConfig": { + "description": "Defines configuration specific to inference.", + "$ref": "#/definitions/InferenceContainerProperties", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "osType": { + "description": "The OS type of the environment.", + "default": "Linux", + "$ref": "#/definitions/OperatingSystemType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "provisioningState": { + "description": "Provisioning state for the environment version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "EnvironmentVersionProperties", + "additionalProperties": false + }, + "EnvironmentVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ResourceConfiguration" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ], - "additionalProperties": false - }, - "DistributionConfiguration": { - "description": "Base definition for job distribution configuration.", - "required": [ - "distributionType" - ], - "type": "object", "properties": { - "distributionType": { - "description": "[Required] Specifies the type of distribution framework.", - "$ref": "#/definitions/DistributionType", - "x-ms-mutability": [ - "create", - "read" - ] + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/EnvironmentVersion" } }, - "discriminator": "distributionType" - }, - "DistributionType": { - "description": "Enum to determine the job distribution type.", - "enum": [ - "PyTorch", - "TensorFlow", - "Mpi" - ], - "type": "string", - "x-ms-enum": { - "name": "DistributionType", - "modelAsString": true, - "values": [ - { - "value": "PyTorch" - }, - { - "value": "TensorFlow" - }, - { - "value": "Mpi" - } - ] - }, + "x-ms-client-name": "EnvironmentVersion", "additionalProperties": false }, - "EarlyTerminationPolicy": { - "description": "Early termination policies enable canceling poor-performing runs before they complete", - "required": [ - "policyType" - ], + "EnvironmentVersionResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentVersion entities.", "type": "object", "properties": { - "delayEvaluation": { - "format": "int32", - "description": "Number of intervals by which to delay the first evaluation.", - "default": 0, - "type": "integer" - }, - "evaluationInterval": { - "format": "int32", - "description": "Interval (number of runs) between policy evaluations.", - "default": 0, - "type": "integer" + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" }, - "policyType": { - "description": "[Required] Name of policy configuration", - "$ref": "#/definitions/EarlyTerminationPolicyType" + "value": { + "description": "An array of objects of type EnvironmentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVersionResource" + } } }, - "discriminator": "policyType" + "additionalProperties": false }, - "EarlyTerminationPolicyType": { + "ExportFormatType": { + "description": "The format of exported labels.", "enum": [ - "Bandit", - "MedianStopping", - "TruncationSelection" + "Dataset", + "Coco", + "CSV" ], "type": "string", "x-ms-enum": { - "name": "EarlyTerminationPolicyType", + "name": "ExportFormatType", "modelAsString": true, "values": [ { - "value": "Bandit" + "value": "Dataset" }, { - "value": "MedianStopping" + "value": "Coco" }, { - "value": "TruncationSelection" + "value": "CSV" } ] }, "additionalProperties": false }, - "EgressPublicNetworkAccessType": { - "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.", - "enum": [ - "Enabled", - "Disabled" + "ExportSummary": { + "required": [ + "format" ], - "type": "string", - "x-ms-enum": { - "name": "EgressPublicNetworkAccessType", - "modelAsString": true, - "values": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - }, - "additionalProperties": false - }, - "EndpointAuthKeys": { - "description": "Keys for endpoint authentication.", "type": "object", "properties": { - "primaryKey": { - "description": "The primary key.", + "endDateTime": { + "format": "date-time", + "description": "The time when the export was completed.", "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "exportedRowCount": { + "format": "int64", + "description": "The total number of labeled datapoints exported.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "format": { + "description": "[Required] The format of exported labels, also as the discriminator.", + "$ref": "#/definitions/ExportFormatType", "x-ms-mutability": [ "create", "read" + ] + }, + "labelingJobId": { + "description": "Name and identifier of the job containing exported labels.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" ], "x-nullable": true }, - "secondaryKey": { - "description": "The secondary key.", + "startDateTime": { + "format": "date-time", + "description": "The time when the export was requested.", "type": "string", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true } }, - "additionalProperties": false - }, - "EndpointAuthMode": { - "description": "Enum to determine endpoint authentication mode.", - "enum": [ - "AMLToken", - "Key", - "AADToken" - ], - "type": "string", - "x-ms-enum": { - "name": "EndpointAuthMode", - "modelAsString": true, - "values": [ - { - "value": "AMLToken" - }, - { - "value": "Key" - }, - { - "value": "AADToken" - } - ] - }, - "additionalProperties": false + "discriminator": "format" }, - "EndpointAuthToken": { - "description": "Service Token", + "Feature": { + "description": "Dto object representing feature", "type": "object", "properties": { - "accessToken": { - "description": "Access token for endpoint authentication.", + "dataType": { + "description": "Specifies type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + }, + "description": { + "description": "Specifies description", "type": "string", "x-nullable": true }, - "expiryTimeUtc": { - "format": "int64", - "description": "Access token expiry time (UTC).", - "default": 0, - "type": "integer" - }, - "refreshAfterTimeUtc": { - "format": "int64", - "description": "Refresh access token after time (UTC).", - "default": 0, - "type": "integer" - }, - "tokenType": { - "description": "Access token type.", + "featureName": { + "description": "Specifies name", "type": "string", "x-nullable": true + }, + "tags": { + "description": "Specifies tags", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeatureArmPaginatedResult": { + "description": "A paginated list of Feature entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Feature objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Feature.", + "type": "array", + "items": { + "$ref": "#/definitions/Feature" + }, + "x-ms-identifiers": [] } }, "additionalProperties": false }, - "EndpointComputeType": { - "description": "Enum to determine endpoint compute type.", + "FeatureDataType": { "enum": [ - "Managed", - "Kubernetes", - "AzureMLCompute" + "String", + "Integer", + "Long", + "Float", + "Double", + "Binary", + "Datetime", + "Boolean" ], "type": "string", "x-ms-enum": { - "name": "EndpointComputeType", + "name": "FeatureDataType", "modelAsString": true, "values": [ { - "value": "Managed" + "value": "String" }, { - "value": "Kubernetes" + "value": "Integer" }, { - "value": "AzureMLCompute" + "value": "Long" + }, + { + "value": "Float" + }, + { + "value": "Double" + }, + { + "value": "Binary" + }, + { + "value": "Datetime" } ] }, "additionalProperties": false }, - "EndpointDeploymentPropertiesBase": { - "description": "Base definition for endpoint deployment.", + "FeatureLags": { + "description": "Flag for generating lags for the numeric features.", + "enum": [ + "None", + "Auto" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureLags", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No feature lags generated." + }, + { + "value": "Auto", + "description": "System auto-generates feature lags." + } + ] + }, + "additionalProperties": false + }, + "FeaturesetContainer": { + "description": "Dto object representing feature set", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], "properties": { - "codeConfiguration": { - "description": "Code configuration for the endpoint deployment.", - "$ref": "#/definitions/CodeConfiguration", + "provisioningState": { + "description": "Provisioning state for the featureset container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "FeaturesetContainerProperties", + "additionalProperties": false + }, + "FeaturesetContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturesetContainer" + } + }, + "x-ms-client-name": "FeaturesetContainer", + "additionalProperties": false + }, + "FeaturesetContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "additionalProperties": false + }, + "FeaturesetJob": { + "description": "Dto object representing the feature set job", + "type": "object", + "properties": { + "createdDate": { + "format": "date-time", + "description": "Specifies the created date", + "type": "string", "x-nullable": true }, - "description": { - "description": "Description of the endpoint deployment.", + "displayName": { + "description": "Specifies the display name", "type": "string", "x-nullable": true }, - "environmentId": { - "description": "ARM resource ID of the environment specification for the endpoint deployment.", + "duration": { + "format": "duration", + "description": "Specifies the duration", "type": "string", "x-nullable": true }, - "environmentVariables": { - "description": "Environment variables configuration for the deployment.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, + "experimentId": { + "description": "Specifies the experiment id", + "type": "string", "x-nullable": true }, - "properties": { - "description": "Property dictionary. Properties can be added, but not removed or altered.", + "featureWindow": { + "description": "Specifies the backfill feature window to be materialized", + "$ref": "#/definitions/FeatureWindow", + "x-nullable": true + }, + "jobId": { + "description": "Specifies the job id", + "type": "string", + "x-nullable": true + }, + "status": { + "description": "Specifies the job status", + "default": "Unknown", + "$ref": "#/definitions/JobStatus" + }, + "tags": { + "description": "Specifies the tags if any", "type": "object", "additionalProperties": { "type": "string", "x-nullable": true }, "x-nullable": true + }, + "type": { + "description": "Specifies the feature store job type", + "default": "RecurrentMaterialization", + "$ref": "#/definitions/FeaturestoreJobType" } }, "additionalProperties": false }, - "EndpointPropertiesBase": { - "description": "Inference Endpoint base definition", - "required": [ - "authMode" - ], + "FeaturesetJobArmPaginatedResult": { + "description": "A paginated list of FeaturesetJob entities.", "type": "object", "properties": { - "authMode": { - "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", - "$ref": "#/definitions/EndpointAuthMode" + "nextLink": { + "description": "The link to the next page of FeaturesetJob objects. If null, there are no additional pages.", + "type": "string" }, - "description": { - "description": "Description of the inference endpoint.", + "value": { + "description": "An array of objects of type FeaturesetJob.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetJob" + }, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "FeaturesetSpecification": { + "description": "Dto object representing specification", + "type": "object", + "properties": { + "path": { + "description": "Specifies the spec path", "type": "string", "x-nullable": true - }, - "keys": { - "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", - "$ref": "#/definitions/EndpointAuthKeys", - "x-ms-mutability": [ - "create" - ], - "x-ms-secret": true, + } + }, + "additionalProperties": false + }, + "FeaturesetVersion": { + "description": "Dto object representing feature set version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "entities": { + "description": "Specifies list of entities", + "type": "array", + "items": { + "type": "string" + }, "x-nullable": true }, - "properties": { - "description": "Property dictionary. Properties can be added, but not removed or altered.", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, + "materializationSettings": { + "description": "Specifies the materialization settings", + "$ref": "#/definitions/MaterializationSettings", "x-nullable": true }, - "scoringUri": { - "format": "uri", - "description": "Endpoint URI.", - "type": "string", + "provisioningState": { + "description": "Provisioning state for the featureset version container.", + "$ref": "#/definitions/AssetProvisioningState", "readOnly": true, "x-ms-mutability": [ "read" - ], + ] + }, + "specification": { + "description": "Specifies the feature spec details", + "$ref": "#/definitions/FeaturesetSpecification", "x-nullable": true }, - "swaggerUri": { - "format": "uri", - "description": "Endpoint Swagger URI.", + "stage": { + "description": "Specifies the asset stage", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], "x-nullable": true } }, + "x-ms-client-name": "FeaturesetVersionProperties", "additionalProperties": false }, - "EndpointProvisioningState": { - "description": "State of endpoint provisioning.", - "enum": [ - "Creating", - "Deleting", - "Succeeded", - "Failed", - "Updating", - "Canceled" - ], - "type": "string", - "x-ms-enum": { - "name": "EndpointProvisioningState", - "modelAsString": true, - "values": [ - { - "value": "Creating" - }, - { - "value": "Deleting" - }, - { - "value": "Succeeded" - }, - { - "value": "Failed" - }, - { - "value": "Updating" - }, - { - "value": "Canceled" + "FeaturesetVersionBackfillRequest": { + "description": "Request payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "description": { + "description": "Specifies description", + "type": "string" + }, + "displayName": { + "description": "Specifies description", + "type": "string" + }, + "featureWindow": { + "description": "Specifies the backfill feature window to be materialized", + "$ref": "#/definitions/FeatureWindow", + "x-nullable": true + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource" + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true } - ] + }, + "tags": { + "description": "Specifies the tags", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "FeaturesetVersionBackfillResponse": { + "description": "Response payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "jobId": { + "description": "Job id created as part of request", + "type": "string", + "x-nullable": true + } }, "additionalProperties": false }, - "EndpointScheduleAction": { + "FeaturesetVersionResource": { + "description": "Azure Resource Manager resource envelope.", "required": [ - "actionType", - "endpointInvocationDefinition" + "properties" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ScheduleActionBase" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ], "properties": { - "endpointInvocationDefinition": { - "description": "[Required] Defines Schedule action definition details.\r\n", - "type": "object", - "example": { - "endpoint": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/hello-pipeline", - "inputs": { - "create_time": "${{creation_context.trigger_time}}" - } - }, - "x-ms-mutability": [ - "create", - "read", - "update" - ] + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturesetVersion" } }, - "x-ms-discriminator-value": "InvokeBatchEndpoint", + "x-ms-client-name": "FeaturesetVersion", "additionalProperties": false }, - "EnvironmentContainer": { - "description": "Container for environment specification versions.", + "FeaturesetVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreEntityContainer": { + "description": "Dto object representing feature entity", "type": "object", "allOf": [ { @@ -11568,7 +14831,7 @@ ], "properties": { "provisioningState": { - "description": "Provisioning state for the environment container.", + "description": "Provisioning state for the featurestore entity container.", "$ref": "#/definitions/AssetProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -11576,10 +14839,10 @@ ] } }, - "x-ms-client-name": "EnvironmentContainerProperties", + "x-ms-client-name": "FeaturestoreEntityContainerProperties", "additionalProperties": false }, - "EnvironmentContainerResource": { + "FeaturestoreEntityContainerResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -11593,53 +14856,32 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/EnvironmentContainer" + "$ref": "#/definitions/FeaturestoreEntityContainer" } }, - "x-ms-client-name": "EnvironmentContainer", + "x-ms-client-name": "FeaturestoreEntityContainer", "additionalProperties": false }, - "EnvironmentContainerResourceArmPaginatedResult": { - "description": "A paginated list of EnvironmentContainer entities.", + "FeaturestoreEntityContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityContainer entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type EnvironmentContainer.", + "description": "An array of objects of type FeaturestoreEntityContainer.", "type": "array", "items": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } }, "additionalProperties": false }, - "EnvironmentType": { - "description": "Environment type is either user created or curated by Azure ML service", - "enum": [ - "Curated", - "UserCreated" - ], - "type": "string", - "x-ms-enum": { - "name": "EnvironmentType", - "modelAsString": true, - "values": [ - { - "value": "Curated" - }, - { - "value": "UserCreated" - } - ] - }, - "additionalProperties": false - }, - "EnvironmentVersion": { - "description": "Environment version details.", + "FeaturestoreEntityVersion": { + "description": "Dto object representing feature entity version", "type": "object", "allOf": [ { @@ -11647,67 +14889,17 @@ } ], "properties": { - "autoRebuild": { - "description": "Defines if image needs to be rebuilt based on base image changes.", - "default": "Disabled", - "$ref": "#/definitions/AutoRebuildSetting", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "build": { - "description": "Configuration settings for Docker build context.", - "$ref": "#/definitions/BuildContext", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "condaFile": { - "description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\r\n", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "environmentType": { - "description": "Environment type is either user managed or curated by the Azure ML service\r\n", - "$ref": "#/definitions/EnvironmentType", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] - }, - "image": { - "description": "Name of the image that will be used for the environment.\r\n", - "type": "string", - "example": "docker.io/tensorflow/serving:latest", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "inferenceConfig": { - "description": "Defines configuration specific to inference.", - "$ref": "#/definitions/InferenceContainerProperties", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "osType": { - "description": "The OS type of the environment.", - "default": "Linux", - "$ref": "#/definitions/OperatingSystemType", - "x-ms-mutability": [ - "create", - "read" - ] + "indexColumns": { + "description": "Specifies index columns", + "type": "array", + "items": { + "$ref": "#/definitions/IndexColumn" + }, + "x-nullable": true, + "x-ms-identifiers": [] }, "provisioningState": { - "description": "Provisioning state for the environment version.", + "description": "Provisioning state for the featurestore entity version.", "$ref": "#/definitions/AssetProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -11715,10 +14907,10 @@ ] } }, - "x-ms-client-name": "EnvironmentVersionProperties", + "x-ms-client-name": "FeaturestoreEntityVersionProperties", "additionalProperties": false }, - "EnvironmentVersionResource": { + "FeaturestoreEntityVersionResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -11732,132 +14924,67 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/EnvironmentVersion" + "$ref": "#/definitions/FeaturestoreEntityVersion" } }, - "x-ms-client-name": "EnvironmentVersion", + "x-ms-client-name": "FeaturestoreEntityVersion", "additionalProperties": false }, - "EnvironmentVersionResourceArmPaginatedResult": { - "description": "A paginated list of EnvironmentVersion entities.", + "FeaturestoreEntityVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityVersion entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type EnvironmentVersion.", + "description": "An array of objects of type FeaturestoreEntityVersion.", "type": "array", "items": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } } }, "additionalProperties": false }, - "ExportFormatType": { - "description": "The format of exported labels.", + "FeaturestoreJobType": { "enum": [ - "Dataset", - "Coco", - "CSV" + "RecurrentMaterialization", + "BackfillMaterialization" ], "type": "string", "x-ms-enum": { - "name": "ExportFormatType", + "name": "FeaturestoreJobType", "modelAsString": true, "values": [ { - "value": "Dataset" - }, - { - "value": "Coco" + "value": "RecurrentMaterialization" }, { - "value": "CSV" + "value": "BackfillMaterialization" } ] }, "additionalProperties": false }, - "ExportSummary": { - "required": [ - "format" - ], + "FeatureWindow": { + "description": "Specifies the feature window", "type": "object", "properties": { - "endDateTime": { + "featureWindowEnd": { "format": "date-time", - "description": "The time when the export was completed.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-nullable": true - }, - "exportedRowCount": { - "format": "int64", - "description": "The total number of labeled datapoints exported.", - "type": "integer", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-nullable": true - }, - "format": { - "description": "[Required] The format of exported labels, also as the discriminator.", - "$ref": "#/definitions/ExportFormatType", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "labelingJobId": { - "description": "Name and identifier of the job containing exported labels.", + "description": "Specifies the feature window end time", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], "x-nullable": true }, - "startDateTime": { + "featureWindowStart": { "format": "date-time", - "description": "The time when the export was requested.", + "description": "Specifies the feature window start time", "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], "x-nullable": true } }, - "discriminator": "format" - }, - "FeatureLags": { - "description": "Flag for generating lags for the numeric features.", - "enum": [ - "None", - "Auto" - ], - "type": "string", - "x-ms-enum": { - "name": "FeatureLags", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "No feature lags generated." - }, - { - "value": "Auto", - "description": "System auto-generates feature lags." - } - ] - }, "additionalProperties": false }, "FeaturizationMode": { @@ -12077,7 +15204,7 @@ }, { "value": "RandomForest", - "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the 'bagging' method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." }, { "value": "ExtremeRandomTrees", @@ -12232,6 +15359,18 @@ }, "additionalProperties": false }, + "GetFeatureRequest": { + "description": "Request payload to retrieve feature information from a given feature set version", + "type": "object", + "properties": { + "featureName": { + "description": "Specifies name of the feature.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, "Goal": { "description": "Defines supported metric goals for hyperparameter tuning", "enum": [ @@ -13238,6 +16377,23 @@ }, "additionalProperties": false }, + "IndexColumn": { + "description": "Dto object representing index column", + "type": "object", + "properties": { + "columnName": { + "description": "Specifies the column name", + "type": "string", + "x-nullable": true + }, + "dataType": { + "description": "Specifies the data type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + } + }, + "additionalProperties": false + }, "InferenceContainerProperties": { "type": "object", "properties": { @@ -13256,6 +16412,48 @@ }, "additionalProperties": false }, + "InferencingServer": { + "required": [ + "serverType" + ], + "type": "object", + "properties": { + "serverType": { + "description": "[Required] Inferencing server type for various targets.", + "$ref": "#/definitions/InferencingServerType" + } + }, + "discriminator": "serverType" + }, + "InferencingServerType": { + "description": "Inferencing server type for various targets.", + "enum": [ + "AzureMLOnline", + "AzureMLBatch", + "Triton", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "InferencingServerType", + "modelAsString": true, + "values": [ + { + "value": "AzureMLOnline" + }, + { + "value": "AzureMLBatch" + }, + { + "value": "Triton" + }, + { + "value": "Custom" + } + ] + }, + "additionalProperties": false + }, "InputDeliveryMode": { "description": "Enum to determine the input data delivery mode.", "enum": [ @@ -13293,6 +16491,31 @@ }, "additionalProperties": false }, + "InputPathType": { + "description": "Input path type for package inputs.", + "enum": [ + "Url", + "PathId", + "PathVersion" + ], + "type": "string", + "x-ms-enum": { + "name": "InputPathType", + "modelAsString": true, + "values": [ + { + "value": "Url" + }, + { + "value": "PathId" + }, + { + "value": "PathVersion" + } + ] + }, + "additionalProperties": false + }, "InstanceSegmentationPrimaryMetrics": { "description": "Primary metrics for InstanceSegmentation tasks.", "enum": [ @@ -13386,6 +16609,15 @@ "read" ] }, + "notificationSetting": { + "description": "Notification setting for the job", + "$ref": "#/definitions/NotificationSetting", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "services": { "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", "type": "object", @@ -13855,6 +17087,35 @@ }, "additionalProperties": false }, + "JobTier": { + "description": "Enum to determine the job tier.", + "enum": [ + "Spot", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "JobTier", + "modelAsString": true, + "values": [ + { + "value": "Spot" + }, + { + "value": "Basic" + }, + { + "value": "Standard" + }, + { + "value": "Premium" + } + ] + }, + "additionalProperties": false + }, "JobType": { "description": "Enum to determine the type of job.", "enum": [ @@ -14552,6 +17813,69 @@ "x-ms-discriminator-value": "Managed", "additionalProperties": false }, + "MaterializationSettings": { + "type": "object", + "properties": { + "notification": { + "description": "Specifies the notification details", + "$ref": "#/definitions/NotificationSetting", + "x-nullable": true + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource", + "x-nullable": true + }, + "schedule": { + "description": "Specifies the schedule details", + "$ref": "#/definitions/RecurrenceTrigger", + "x-nullable": true + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "storeType": { + "description": "Specifies the stores to which materialization should happen", + "default": "None", + "$ref": "#/definitions/MaterializationStoreType" + } + }, + "additionalProperties": false + }, + "MaterializationStoreType": { + "enum": [ + "None", + "Online", + "Offline", + "OnlineAndOffline" + ], + "type": "string", + "x-ms-enum": { + "name": "MaterializationStoreType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "Online" + }, + { + "value": "Offline" + }, + { + "value": "OnlineAndOffline" + } + ] + }, + "additionalProperties": false + }, "MedianStoppingPolicy": { "description": "Defines an early termination policy based on running averages of the primary metric of all runs", "type": "object", @@ -14769,6 +18093,23 @@ "x-ms-discriminator-value": "mltable", "additionalProperties": false }, + "ModelConfiguration": { + "description": "Model configuration options.", + "type": "object", + "properties": { + "mode": { + "description": "Input delivery mode for the model.", + "default": "Download", + "$ref": "#/definitions/PackageInputDeliveryMode" + }, + "mountPath": { + "description": "Relative mounting path of the model in the target image.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, "ModelContainer": { "type": "object", "allOf": [ @@ -14827,6 +18168,35 @@ }, "additionalProperties": false }, + "ModelPackageInput": { + "description": "Model package input options.", + "required": [ + "inputType", + "path" + ], + "type": "object", + "properties": { + "inputType": { + "description": "[Required] Type of the input included in the target image.", + "$ref": "#/definitions/PackageInputType" + }, + "mode": { + "description": "Input delivery mode of the input.", + "default": "ReadOnlyMount", + "$ref": "#/definitions/PackageInputDeliveryMode" + }, + "mountPath": { + "description": "Relative mount path of the input in the target image.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "[Required] Location of the input.", + "$ref": "#/definitions/PackageInputPathBase" + } + }, + "additionalProperties": false + }, "ModelSize": { "description": "Image model size.", "enum": [ @@ -15356,6 +18726,37 @@ "x-ms-discriminator-value": "None", "additionalProperties": false }, + "NotificationSetting": { + "description": "Configuration for notification.", + "type": "object", + "properties": { + "emailOn": { + "description": "Send email notification to user on specified notification type", + "type": "array", + "items": { + "$ref": "#/definitions/EmailNotificationEnableType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "emails": { + "description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, "ObjectDetectionPrimaryMetrics": { "description": "Primary metrics for Image ObjectDetection task.", "enum": [ @@ -15619,6 +19020,42 @@ }, "additionalProperties": false }, + "OnlineInferenceConfiguration": { + "description": "Online inference configuration options.", + "type": "object", + "properties": { + "configurations": { + "description": "Additional configurations", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "entryScript": { + "description": "Entry script or command to invoke.", + "type": "string", + "x-nullable": true + }, + "livenessRoute": { + "description": "The route to check the liveness of the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + }, + "readinessRoute": { + "description": "The route to check the readiness of the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + }, + "scoringRoute": { + "description": "The port to send the scoring requests to, within the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + } + }, + "additionalProperties": false + }, "OnlineRequestSettings": { "description": "Online deployment scoring requests configuration.", "type": "object", @@ -15656,103 +19093,387 @@ "$ref": "#/definitions/ScaleType" } }, - "discriminator": "scaleType" + "discriminator": "scaleType" + }, + "OperatingSystemType": { + "description": "The type of operating system.", + "enum": [ + "Linux", + "Windows" + ], + "type": "string", + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true, + "values": [ + { + "value": "Linux" + }, + { + "value": "Windows" + } + ] + }, + "additionalProperties": false + }, + "OrderString": { + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true, + "values": [ + { + "value": "CreatedAtDesc" + }, + { + "value": "CreatedAtAsc" + }, + { + "value": "UpdatedAtDesc" + }, + { + "value": "UpdatedAtAsc" + } + ] + }, + "additionalProperties": false + }, + "OutputDeliveryMode": { + "description": "Output data delivery mode enums.", + "enum": [ + "ReadWriteMount", + "Upload", + "Direct" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadWriteMount" + }, + { + "value": "Upload" + }, + { + "value": "Direct" + } + ] + }, + "additionalProperties": false + }, + "OutputPathAssetReference": { + "description": "Reference to an asset via its path in a job output.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "jobId": { + "description": "ARM resource ID of the job.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the job output.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "OutputPath", + "additionalProperties": false }, - "OperatingSystemType": { - "description": "The type of operating system.", + "PackageBuildState": { + "description": "Package build state returned in package response.", "enum": [ - "Linux", - "Windows" + "NotStarted", + "Running", + "Succeeded", + "Failed" ], "type": "string", "x-ms-enum": { - "name": "OperatingSystemType", + "name": "PackageBuildState", "modelAsString": true, "values": [ { - "value": "Linux" + "value": "NotStarted" }, { - "value": "Windows" + "value": "Running" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" } ] }, "additionalProperties": false }, - "OrderString": { + "PackageInputDeliveryMode": { + "description": "Mounting type of the model or the inputs", "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" + "ReadOnlyMount", + "Download" ], "type": "string", "x-ms-enum": { - "name": "OrderString", + "name": "PackageInputDeliveryMode", "modelAsString": true, "values": [ { - "value": "CreatedAtDesc" - }, - { - "value": "CreatedAtAsc" - }, - { - "value": "UpdatedAtDesc" + "value": "ReadOnlyMount" }, { - "value": "UpdatedAtAsc" + "value": "Download" } ] }, "additionalProperties": false }, - "OutputDeliveryMode": { - "description": "Output data delivery mode enums.", + "PackageInputPathBase": { + "required": [ + "inputPathType" + ], + "type": "object", + "properties": { + "inputPathType": { + "description": "[Required] Input path type for package inputs.", + "$ref": "#/definitions/InputPathType" + } + }, + "discriminator": "inputPathType" + }, + "PackageInputPathId": { + "description": "Package input path specified with a resource id.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "resourceId": { + "description": "Input resource id.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PathId", + "additionalProperties": false + }, + "PackageInputPathUrl": { + "description": "Package input path specified as an url.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "url": { + "description": "Input path url.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Url", + "additionalProperties": false + }, + "PackageInputPathVersion": { + "description": "Package input path specified with name and version.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "resourceName": { + "description": "Input resource name.", + "type": "string", + "x-nullable": true + }, + "resourceVersion": { + "description": "Input resource version.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PathVersion", + "additionalProperties": false + }, + "PackageInputType": { + "description": "Type of the inputs.", "enum": [ - "ReadWriteMount", - "Upload", - "Direct" + "UriFile", + "UriFolder" ], "type": "string", "x-ms-enum": { - "name": "OutputDeliveryMode", + "name": "PackageInputType", "modelAsString": true, "values": [ { - "value": "ReadWriteMount" - }, - { - "value": "Upload" + "value": "UriFile" }, { - "value": "Direct" + "value": "UriFolder" } ] }, "additionalProperties": false }, - "OutputPathAssetReference": { - "description": "Reference to an asset via its path in a job output.", + "PackageRequest": { + "description": "Model package operation request properties.", + "required": [ + "inferencingServer", + "targetEnvironmentName" + ], + "type": "object", + "properties": { + "baseEnvironmentSource": { + "description": "Base environment to start with.", + "$ref": "#/definitions/BaseEnvironmentSource", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Collection of environment variables.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inferencingServer": { + "description": "[Required] Inferencing server configurations.", + "$ref": "#/definitions/InferencingServer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inputs": { + "description": "Collection of inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelPackageInput" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "modelConfiguration": { + "description": "Model configuration including the mount mode.", + "$ref": "#/definitions/ModelConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "targetEnvironmentName": { + "description": "[Required] Target environment name to be generated by package.", + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "targetEnvironmentVersion": { + "description": "Target environment version to be generated by package.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PackageResponse": { + "description": "Package response returned after async package operation completes successfully.", "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetReferenceBase" + "$ref": "#/definitions/PackageRequest" } ], "properties": { - "jobId": { - "description": "ARM resource ID of the job.", + "buildId": { + "description": "Build id of the image build operation.", "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true }, - "path": { - "description": "The path of the file/directory in the job output.", + "buildState": { + "description": "Build state of the image build operation.", + "$ref": "#/definitions/PackageBuildState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "logUrl": { + "description": "Log url of the image build operation.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "targetEnvironmentId": { + "description": "Asset ID of the target environment created by package operation.", "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true } }, - "x-ms-discriminator-value": "OutputPath", "additionalProperties": false }, "PartialBatchDeployment": { @@ -16079,6 +19800,31 @@ "x-ms-discriminator-value": "PyTorch", "additionalProperties": false }, + "QueueSettings": { + "type": "object", + "properties": { + "jobTier": { + "description": "Enum to determine the job tier.", + "default": "Standard", + "$ref": "#/definitions/JobTier", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "priority": { + "format": "int32", + "description": "Controls the priority of the job on a compute.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, "RandomSamplingAlgorithm": { "description": "Defines a Sampling Algorithm that generates values randomly", "type": "object", @@ -16355,7 +20101,7 @@ }, { "value": "RandomForest", - "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the 'bagging' method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." }, { "value": "ExtremeRandomTrees", @@ -16485,6 +20231,18 @@ ], "x-nullable": true }, + "locations": { + "description": "Locations where the job can run.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "properties": { "description": "Additional properties bag.", "type": "object", @@ -17283,6 +21041,15 @@ ], "x-nullable": true }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "resources": { "description": "Compute Resource configuration for the job.", "$ref": "#/definitions/SparkResourceConfiguration", @@ -17643,6 +21410,15 @@ ], "x-nullable": true }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "samplingAlgorithm": { "description": "[Required] The hyperparameter sampling algorithm", "$ref": "#/definitions/SamplingAlgorithm" @@ -18654,6 +22430,24 @@ }, "additionalProperties": false }, + "TritonInferencingServer": { + "description": "Triton inferencing server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "inferenceConfiguration": { + "description": "Inference configuration for Triton.", + "$ref": "#/definitions/OnlineInferenceConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Triton", + "additionalProperties": false + }, "TritonModelJobInput": { "type": "object", "allOf": [