From 0479ab13cfd1435e01ef45e535b10b1a7ba5a45b Mon Sep 17 00:00:00 2001 From: shail2208 <59747407+shail2208@users.noreply.github.com> Date: Fri, 22 Sep 2023 07:57:25 -0700 Subject: [PATCH] Add feature store api's to GA version (#25594) * Add examples * Adding feature store GA api's * Sync examples * Add examples * Converting to ProxyResource --------- Co-authored-by: Shail Paragbhai Shah --- .../2023-10-01/examples/Feature/get.json | 40 + .../2023-10-01/examples/Feature/list.json | 48 + .../FeaturesetContainer/createOrUpdate.json | 81 + .../Workspace/FeaturesetContainer/delete.json | 18 + .../FeaturesetContainer/getEntity.json | 40 + .../Workspace/FeaturesetContainer/list.json | 47 + .../Workspace/FeaturesetVersion/backfill.json | 47 + .../FeaturesetVersion/createOrUpdate.json | 219 + .../Workspace/FeaturesetVersion/delete.json | 19 + .../Workspace/FeaturesetVersion/get.json | 86 + .../Workspace/FeaturesetVersion/list.json | 93 + .../createOrUpdate.json | 81 + .../FeaturestoreEntityContainer/delete.json | 18 + .../getEntity.json | 40 + .../FeaturestoreEntityContainer/list.json | 47 + .../createOrUpdate.json | 99 + .../FeaturestoreEntityVersion/delete.json | 19 + .../FeaturestoreEntityVersion/get.json | 46 + .../FeaturestoreEntityVersion/list.json | 53 + .../stable/2023-10-01/mfe.json | 7381 +++++++++++------ 20 files changed, 6017 insertions(+), 2505 deletions(-) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/getEntity.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/backfill.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/getEntity.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/list.json diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/get.json new file mode 100644 index 000000000000..2ccf27f3041f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "featuresetName": "string", + "featuresetVersion": "string", + "featureName": "string", + "api-version": "2023-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "featureName": "string", + "dataType": "Float" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:51", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:51", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/list.json new file mode 100644 index 000000000000..86d1e2132382 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Feature/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "featuresetName": "string", + "featuresetVersion": "string", + "api-version": "2023-10-01", + "$skipToken": "string", + "tags": "string", + "featureName": "string", + "description": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "featureName": "string", + "dataType": "Boolean" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:50", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:50", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/createOrUpdate.json new file mode 100644 index 000000000000..25a86a01f9b2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "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/stable/2023-10-01/examples/Workspace/FeaturesetContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/delete.json new file mode 100644 index 000000000000..6f6a0467a4e1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/getEntity.json new file mode 100644 index 000000000000..fc14373aa22b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "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/stable/2023-10-01/examples/Workspace/FeaturesetContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetContainer/list.json new file mode 100644 index 000000000000..8ae3538114e8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "$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/stable/2023-10-01/examples/Workspace/FeaturesetVersion/backfill.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/backfill.json new file mode 100644 index 000000000000..def523fb76f7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/backfill.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-10-01", + "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" + }, + "jobId": "string", + "dataAvailabilityStatus": [ + "None" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobIds": [ + "string", + "string" + ] + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/createOrUpdate.json new file mode 100644 index 000000000000..624996843f8a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "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/stable/2023-10-01/examples/Workspace/FeaturesetVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/delete.json new file mode 100644 index 000000000000..f9ac7108f9f2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/get.json new file mode 100644 index 000000000000..844e941b6a35 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "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/stable/2023-10-01/examples/Workspace/FeaturesetVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturesetVersion/list.json new file mode 100644 index 000000000000..2d81b9d84ab3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "$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/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json new file mode 100644 index 000000000000..2a7d5a005db2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "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/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/delete.json new file mode 100644 index 000000000000..6f6a0467a4e1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/getEntity.json new file mode 100644 index 000000000000..675eac59c318 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "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/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityContainer/list.json new file mode 100644 index 000000000000..f2d42482f296 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "$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/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json new file mode 100644 index 000000000000..76fa85189ae9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "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/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/delete.json new file mode 100644 index 000000000000..f9ac7108f9f2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/get.json new file mode 100644 index 000000000000..0144ab2544aa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01" + }, + "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/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/examples/Workspace/FeaturestoreEntityVersion/list.json new file mode 100644 index 000000000000..a2de4166b8ec --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/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-10-01", + "$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/stable/2023-10-01/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json index cb010c75dbd2..618d167b57b0 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2023-10-01/mfe.json @@ -7012,13 +7012,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { "get": { "tags": [ - "Job" + "FeaturesetContainer" ], - "summary": "Lists Jobs in the workspace.", - "operationId": "Jobs_List", + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_List", "produces": [ "application/json" ], @@ -7040,20 +7040,14 @@ }, { "in": "query", - "name": "jobType", - "description": "Type of job to be returned.", - "type": "string" - }, - { - "in": "query", - "name": "tag", - "description": "Jobs returned will have this tag key.", + "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": [ @@ -7079,8 +7073,28 @@ }, { "in": "query", - "name": "properties", - "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "name", + "description": "name for the featureset", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", "type": "string" } ], @@ -7088,7 +7102,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" } }, "default": { @@ -7099,17 +7113,8 @@ } }, "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 Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" } }, "x-ms-pageable": { @@ -7117,13 +7122,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "get": { "tags": [ - "Job" + "Feature" ], - "summary": "Deletes a Job (asynchronous).", - "operationId": "Jobs_Delete", + "summary": "List Features.", + "operationId": "Features_List", "produces": [ "application/json" ], @@ -7139,95 +7144,84 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "featuresetName", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "featuresetVersion", + "description": "Featureset Version identifier. This is case-sensitive.", "required": true, "type": "string" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "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" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Job.": { - "$ref": "./examples/Job/delete.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - }, - "get": { - "tags": [ - "Job" - ], - "summary": "Gets a Job by name/id.", - "operationId": "Jobs_Get", - "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": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "featureName", + "description": "feature name.", + "type": "string" }, { - "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", - "required": true, + "in": "query", + "name": "description", + "description": "Description of the featureset.", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "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" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "Page size.", + "type": "integer", + "format": "int32", + "default": 1000 } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/FeatureResourceArmPaginatedResult" } }, "default": { @@ -7238,29 +7232,22 @@ } }, "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" + "List Feature.": { + "$ref": "./examples/Feature/list.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { + "get": { "tags": [ - "Job" - ], - "summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", - "operationId": "Jobs_CreateOrUpdate", - "consumes": [ - "application/json" + "Feature" ], + "summary": "Get feature.", + "operationId": "Features_Get", "produces": [ "application/json" ], @@ -7276,36 +7263,36 @@ }, { "in": "path", - "name": "id", - "description": "The name and identifier for the Job. This is case-sensitive.", + "name": "featuresetName", + "description": "Feature set 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": "path", + "name": "featuresetVersion", + "description": "Feature set version identifier. This is case-sensitive.", + "required": true, + "type": "string" }, { - "in": "body", - "name": "body", - "description": "Job definition object.", + "in": "path", + "name": "featureName", + "description": "Feature Name. This is case-sensitive.", "required": true, - "schema": { - "$ref": "#/definitions/JobBaseResource" - } + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/JobBaseResource" - } - }, - "201": { - "description": "Created", + "description": "Success", "schema": { - "$ref": "#/definitions/JobBaseResource" + "$ref": "#/definitions/FeatureResource" } }, "default": { @@ -7316,28 +7303,19 @@ } }, "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" + "Get Feature.": { + "$ref": "./examples/Feature/get.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { "tags": [ - "Job" + "FeaturesetContainer" ], - "summary": "Cancels a Job (asynchronous).", - "operationId": "Jobs_Cancel", + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", "produces": [ "application/json" ], @@ -7353,8 +7331,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" }, @@ -7369,6 +7347,11 @@ "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" @@ -7382,6 +7365,9 @@ } } }, + "204": { + "description": "No Content" + }, "default": { "description": "Error", "schema": { @@ -7390,158 +7376,21 @@ } }, "x-ms-examples": { - "Cancel Job.": { - "$ref": "./examples/Job/cancel.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}/models": { + }, "get": { "tags": [ - "ModelContainer" + "FeaturesetContainer" ], - "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": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "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": { - "200": { - "description": "Success" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/delete.json" - } - } - }, - "get": { - "tags": [ - "ModelContainer" - ], - "summary": "Get container.", - "operationId": "ModelContainers_Get", + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", "produces": [ "application/json" ], @@ -7570,7 +7419,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetContainerResource" } }, "default": { @@ -7581,17 +7430,17 @@ } }, "x-ms-examples": { - "Get Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/get.json" + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" } } }, "put": { "tags": [ - "ModelContainer" + "FeaturesetContainer" ], "summary": "Create or update container.", - "operationId": "ModelContainers_CreateOrUpdate", + "operationId": "FeaturesetContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -7625,7 +7474,7 @@ "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetContainerResource" } } ], @@ -7633,13 +7482,24 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetContainerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelContainerResource" + "$ref": "#/definitions/FeaturesetContainerResource" + }, + "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" + } } }, "default": { @@ -7650,19 +7510,23 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Model Container.": { - "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.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": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { "get": { "tags": [ - "ModelVersion" + "FeaturesetVersion" ], - "summary": "List model versions.", - "operationId": "ModelVersions_List", + "summary": "List versions.", + "operationId": "FeaturesetVersions_List", "produces": [ "application/json" ], @@ -7679,7 +7543,7 @@ { "in": "path", "name": "name", - "description": "Model name. This is case-sensitive.", + "description": "Featureset name. This is case-sensitive.", "required": true, "type": "string" }, @@ -7689,60 +7553,16 @@ { "$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.", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", "type": "string", "default": "ActiveOnly", "enum": [ @@ -7765,13 +7585,51 @@ } ] } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featureset version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featureset version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature set version", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", + "type": "string" + }, + { + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" } }, "default": { @@ -7782,8 +7640,8 @@ } }, "x-ms-examples": { - "List Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/list.json" + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" } }, "x-ms-pageable": { @@ -7791,13 +7649,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { "delete": { "tags": [ - "ModelVersion" + "FeaturesetVersion" ], "summary": "Delete version.", - "operationId": "ModelVersions_Delete", + "operationId": "FeaturesetVersions_Delete", "produces": [ "application/json" ], @@ -7833,28 +7691,53 @@ "200": { "description": "Success" }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/delete.json" + "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" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "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": [ - "ModelVersion" + "FeaturesetVersion" ], "summary": "Get version.", - "operationId": "ModelVersions_Get", + "operationId": "FeaturesetVersions_Get", "produces": [ "application/json" ], @@ -7890,7 +7773,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/FeaturesetVersionResource" } }, "default": { @@ -7901,17 +7784,17 @@ } }, "x-ms-examples": { - "Get Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/get.json" + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" } } }, "put": { "tags": [ - "ModelVersion" + "FeaturesetVersion" ], "summary": "Create or update version.", - "operationId": "ModelVersions_CreateOrUpdate", + "operationId": "FeaturesetVersions_CreateOrUpdate", "consumes": [ "application/json" ], @@ -7952,7 +7835,7 @@ "description": "Version entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/FeaturesetVersionResource" } } ], @@ -7960,13 +7843,24 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$ref": "#/definitions/FeaturesetVersionResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ModelVersionResource" + "$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" + } } }, "default": { @@ -7977,19 +7871,23 @@ } }, "x-ms-examples": { - "CreateOrUpdate Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/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": "original-uri" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/publish": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { "post": { "tags": [ - "ModelVersion" + "FeaturesetVersion" ], - "summary": "Publish version asset into registry.", - "operationId": "ModelVersions_Publish", + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", "consumes": [ "application/json" ], @@ -8009,14 +7907,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" }, @@ -8026,16 +7924,19 @@ { "in": "body", "name": "body", - "description": "Destination registry info", + "description": "Feature set version backfill request entity.", "required": true, "schema": { - "$ref": "#/definitions/DestinationAsset" + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" } } ], "responses": { "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + } }, "202": { "description": "Accepted", @@ -8061,8 +7962,8 @@ } }, "x-ms-examples": { - "Publish Workspace Model Version.": { - "$ref": "./examples/Workspace/ModelVersion/publish.json" + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" } }, "x-ms-long-running-operation": true, @@ -8071,13 +7972,13 @@ } } }, - "/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" ], @@ -8095,70 +7996,73 @@ "$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 + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] } }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 }, { "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 .", + "name": "name", + "description": "name for the featurestore entity", "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 .", + "name": "description", + "description": "description for the featurestore entity", "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 - } + "name": "createdBy", + "description": "createdBy user name", + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" } }, "default": { @@ -8169,8 +8073,8 @@ } }, "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": { @@ -8178,13 +8082,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" ], @@ -8200,8 +8104,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -8245,8 +8149,8 @@ } }, "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, @@ -8256,10 +8160,10 @@ }, "get": { "tags": [ - "OnlineEndpoint" + "FeaturestoreEntityContainer" ], - "summary": "Get Online Endpoint.", - "operationId": "OnlineEndpoints_Get", + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", "produces": [ "application/json" ], @@ -8275,8 +8179,8 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -8288,7 +8192,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } }, "default": { @@ -8299,17 +8203,17 @@ } }, "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": { + "put": { "tags": [ - "OnlineEndpoint" + "FeaturestoreEntityContainer" ], - "summary": "Update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_Update", + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -8328,10 +8232,11 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Container name. 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" @@ -8339,38 +8244,34 @@ { "in": "body", "name": "body", - "description": "Online Endpoint entity to apply during operation.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } } ], "responses": { "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityContainerResource" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + }, "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 } } }, @@ -8382,21 +8283,23 @@ } }, "x-ms-examples": { - "Update Workspace Online Endpoint.": { - "$ref": "./examples/Workspace/OnlineEndpoint/update.json" + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/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}/featurestoreEntities/{name}/versions": { + "get": { "tags": [ - "OnlineEndpoint" - ], - "summary": "Create or update Online Endpoint (asynchronous).", - "operationId": "OnlineEndpoints_CreateOrUpdate", - "consumes": [ - "application/json" + "FeaturestoreEntityVersion" ], + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_List", "produces": [ "application/json" ], @@ -8412,119 +8315,94 @@ }, { "in": "path", - "name": "endpointName", - "description": "Online Endpoint name.", + "name": "name", + "description": "Feature entity 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": "Online Endpoint entity to apply during operation.", - "required": true, - "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" - } - } - ], - "responses": { - "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/OnlineEndpointTrackedResource" - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, - "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" - } - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "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" + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "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" + } + ] + } }, { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 }, { - "in": "path", - "name": "endpointName", - "description": "Inference endpoint name.", - "required": true, + "in": "query", + "name": "versionName", + "description": "name for the featurestore entity version", "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "in": "query", + "name": "version", + "description": "featurestore entity version", + "type": "string" }, { "in": "query", - "name": "$orderBy", - "description": "Ordering of list.", + "name": "description", + "description": "description for the feature entity version", "type": "string" }, { "in": "query", - "name": "$top", - "description": "Top of list.", - "type": "integer", - "format": "int32" + "name": "createdBy", + "description": "createdBy user name", + "type": "string" }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "stage", + "description": "Specifies the featurestore stage", + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" } }, "default": { @@ -8535,8 +8413,8 @@ } }, "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": { @@ -8544,13 +8422,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" ], @@ -8566,15 +8444,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" }, @@ -8618,8 +8496,8 @@ } }, "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, @@ -8629,10 +8507,10 @@ }, "get": { "tags": [ - "OnlineDeployment" + "FeaturestoreEntityVersion" ], - "summary": "Get Inference Deployment Deployment.", - "operationId": "OnlineDeployments_Get", + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_Get", "produces": [ "application/json" ], @@ -8648,15 +8526,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" }, @@ -8668,7 +8546,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" + "$ref": "#/definitions/FeaturestoreEntityVersionResource" } }, "default": { @@ -8679,20 +8557,17 @@ } }, "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" ], @@ -8711,19 +8586,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" @@ -8731,38 +8605,34 @@ { "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" } } ], "responses": { "200": { - "description": "Success", + "description": "Create or update request is successful.", "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 } } }, @@ -8774,24 +8644,23 @@ } }, "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": "original-uri" + } + } + }, + "/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" ], @@ -8806,56 +8675,62 @@ "$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": "properties", + "description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" } ], "responses": { "200": { - "description": "Create or update request is successful.", - "schema": { - "$ref": "#/definitions/OnlineDeploymentTrackedResource" - } - }, - "201": { - "description": "Created", + "description": "Success", "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" } }, "default": { @@ -8866,29 +8741,31 @@ } }, "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-long-running-operation-options": { - "final-state-via": "original-uri" + "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" ], @@ -8904,38 +8781,43 @@ }, { "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": { "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" + }, "default": { "description": "Error", "schema": { @@ -8944,19 +8826,21 @@ } }, "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" ], @@ -8972,37 +8856,20 @@ }, { "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": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/SkuResourceArmPaginatedResult" + "$ref": "#/definitions/JobBaseResource" } }, "default": { @@ -9013,25 +8880,29 @@ } }, "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.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.", + "operationId": "Jobs_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", - "operationId": "OnlineEndpoints_ListKeys", "produces": [ "application/json" ], @@ -9047,20 +8918,36 @@ }, { "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": { "200": { - "description": "Success", + "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/EndpointAuthKeys" + "$ref": "#/definitions/JobBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobBaseResource" } }, "default": { @@ -9071,22 +8958,28 @@ } }, "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" ], @@ -9102,22 +8995,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": { @@ -9148,8 +9032,8 @@ } }, "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, @@ -9158,13 +9042,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "get": { "tags": [ - "OnlineEndpoint" + "ModelContainer" ], - "summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.", - "operationId": "OnlineEndpoints_GetToken", + "summary": "List model containers.", + "operationId": "ModelContainers_List", "produces": [ "application/json" ], @@ -9179,83 +9063,38 @@ "$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" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/EndpointAuthToken" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "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" }, { - "$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": "Status filter for schedule.", + "description": "View type for including/excluding (for example) archived entities.", "type": "string", - "default": "EnabledOnly", + "default": "ActiveOnly", "enum": [ - "EnabledOnly", - "DisabledOnly", + "ActiveOnly", + "ArchivedOnly", "All" ], "x-ms-enum": { - "name": "ScheduleListViewType", + "name": "ListViewType", "modelAsString": true, "values": [ { - "value": "EnabledOnly" + "value": "ActiveOnly" }, { - "value": "DisabledOnly" + "value": "ArchivedOnly" }, { "value": "All" @@ -9268,7 +9107,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" } }, "default": { @@ -9279,8 +9118,8 @@ } }, "x-ms-examples": { - "List Schedules.": { - "$ref": "./examples/Schedule/list.json" + "List Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/list.json" } }, "x-ms-pageable": { @@ -9288,13 +9127,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { "delete": { "tags": [ - "Schedule" + "ModelContainer" ], - "summary": "Delete schedule.", - "operationId": "Schedules_Delete", + "summary": "Delete container.", + "operationId": "ModelContainers_Delete", "produces": [ "application/json" ], @@ -9311,7 +9150,7 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -9323,27 +9162,6 @@ "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" }, @@ -9355,21 +9173,17 @@ } }, "x-ms-examples": { - "Delete Schedule.": { - "$ref": "./examples/Schedule/delete.json" + "Delete Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/delete.json" } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" } }, "get": { "tags": [ - "Schedule" + "ModelContainer" ], - "summary": "Get schedule.", - "operationId": "Schedules_Get", + "summary": "Get container.", + "operationId": "ModelContainers_Get", "produces": [ "application/json" ], @@ -9386,7 +9200,7 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, @@ -9398,7 +9212,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/ModelContainerResource" } }, "default": { @@ -9409,17 +9223,17 @@ } }, "x-ms-examples": { - "Get Schedule.": { - "$ref": "./examples/Schedule/get.json" + "Get Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/get.json" } } }, "put": { "tags": [ - "Schedule" + "ModelContainer" ], - "summary": "Create or update schedule.", - "operationId": "Schedules_CreateOrUpdate", + "summary": "Create or update container.", + "operationId": "ModelContainers_CreateOrUpdate", "consumes": [ "application/json" ], @@ -9439,7 +9253,7 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -9450,10 +9264,10 @@ { "in": "body", "name": "body", - "description": "Schedule definition.", + "description": "Container entity to create or update.", "required": true, "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/ModelContainerResource" } } ], @@ -9461,24 +9275,13 @@ "200": { "description": "Create or update request is successful.", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/ModelContainerResource" } }, "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" - } + "$ref": "#/definitions/ModelContainerResource" } }, "default": { @@ -9489,112 +9292,1951 @@ } }, "x-ms-examples": { - "CreateOrUpdate Schedule.": { - "$ref": "./examples/Schedule/createOrUpdate.json" + "CreateOrUpdate Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/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 - }, - "AllFeatures": { - "required": [ - "filterType" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MonitoringFeatureFilterBase" - } - ], - "x-ms-discriminator-value": "AllFeatures", - "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" - } - ], - "x-ms-discriminator-value": "All", - "additionalProperties": false - }, - "AmlToken": { - "description": "AML Token identity configuration.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IdentityConfiguration" - } - ], - "x-ms-discriminator-value": "AMLToken", - "additionalProperties": false }, - "AmlTokenComputeIdentity": { - "description": "AML token compute identity definition.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MonitorComputeIdentityBase" - } - ], - "x-ms-discriminator-value": "AmlToken", - "additionalProperties": false - }, - "AnonymousAccessCredential": { - "description": "Access credential with no credentials", - "type": "object", - "allOf": [ - { + "/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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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}/publish": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Publish version asset into registry.", + "operationId": "ModelVersions_Publish", + "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.", + "required": true, + "type": "string" + }, + { + "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": "Destination registry info", + "required": true, + "schema": { + "$ref": "#/definitions/DestinationAsset" + } + } + ], + "responses": { + "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 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Publish Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/publish.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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "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" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "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 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Create or update request is successful.", + "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" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "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" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "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 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Create or update request is successful.", + "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" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "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 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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 AML 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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthToken" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "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" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": { + "200": { + "description": "Create or update request is successful.", + "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" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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 + }, + "AllFeatures": { + "required": [ + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "x-ms-discriminator-value": "AllFeatures", + "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" + } + ], + "x-ms-discriminator-value": "All", + "additionalProperties": false + }, + "AmlToken": { + "description": "AML Token identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "AMLToken", + "additionalProperties": false + }, + "AmlTokenComputeIdentity": { + "description": "AML token compute identity definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeIdentityBase" + } + ], + "x-ms-discriminator-value": "AmlToken", + "additionalProperties": false + }, + "AnonymousAccessCredential": { + "description": "Access credential with no credentials", + "type": "object", + "allOf": [ + { "$ref": "#/definitions/DataReferenceCredential" } ], @@ -10135,6 +11777,17 @@ }, "additionalProperties": false }, + "AzureDevOpsWebhook": { + "description": "Webhook details specific for Azure DevOps", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Webhook" + } + ], + "x-ms-discriminator-value": "AzureDevOps", + "additionalProperties": false + }, "AzureFileDatastore": { "description": "Azure File datastore configuration.", "required": [ @@ -10960,150 +12613,437 @@ "value": "XGBoostClassifier", "description": "XGBoost: Extreme Gradient Boosting Algorithm. This algorithm is used for structured data where target column values can be divided into distinct class values." } - ] + ] + }, + "additionalProperties": false + }, + "ClassificationMultilabelPrimaryMetrics": { + "description": "Primary metrics for classification multilabel tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted", + "IOU" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationMultilabelPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + }, + { + "value": "IOU", + "description": "Intersection Over Union. Intersection of predictions divided by union of predictions." + } + ] + }, + "additionalProperties": false + }, + "ClassificationPrimaryMetrics": { + "description": "Primary metrics for classification tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + } + ] + }, + "additionalProperties": false + }, + "ClassificationTrainingSettings": { + "description": "Classification Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CodeConfiguration": { + "description": "Configuration for a scoring code asset.", + "required": [ + "scoringScript" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "scoringScript": { + "description": "[Required] The script to execute on startup. eg. \"score.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CodeContainer": { + "description": "Container for code asset versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the code container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "CodeContainerProperties", + "additionalProperties": false + }, + "CodeContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeContainer" + } + }, + "x-ms-client-name": "CodeContainer", + "additionalProperties": false + }, + "CodeContainerResourceArmPaginatedResult": { + "description": "A paginated list of CodeContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeContainerResource" + } + } }, "additionalProperties": false }, - "ClassificationMultilabelPrimaryMetrics": { - "description": "Primary metrics for classification multilabel tasks.", - "enum": [ - "AUCWeighted", - "Accuracy", - "NormMacroRecall", - "AveragePrecisionScoreWeighted", - "PrecisionScoreWeighted", - "IOU" + "CodeVersion": { + "description": "Code asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } ], - "type": "string", - "x-ms-enum": { - "name": "ClassificationMultilabelPrimaryMetrics", - "modelAsString": true, - "values": [ - { - "value": "AUCWeighted", - "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." - }, - { - "value": "Accuracy", - "description": "Accuracy is the ratio of predictions that exactly match the true class labels." - }, - { - "value": "NormMacroRecall", - "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." - }, - { - "value": "AveragePrecisionScoreWeighted", - "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." - }, - { - "value": "PrecisionScoreWeighted", - "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." - }, - { - "value": "IOU", - "description": "Intersection Over Union. Intersection of predictions divided by union of predictions." - } - ] + "properties": { + "codeUri": { + "description": "Uri where code is located", + "type": "string", + "example": "https://blobStorage/folderName", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the code version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } }, + "x-ms-client-name": "CodeVersionProperties", "additionalProperties": false }, - "ClassificationPrimaryMetrics": { - "description": "Primary metrics for classification tasks.", - "enum": [ - "AUCWeighted", - "Accuracy", - "NormMacroRecall", - "AveragePrecisionScoreWeighted", - "PrecisionScoreWeighted" + "CodeVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" ], - "type": "string", - "x-ms-enum": { - "name": "ClassificationPrimaryMetrics", - "modelAsString": true, - "values": [ - { - "value": "AUCWeighted", - "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." - }, - { - "value": "Accuracy", - "description": "Accuracy is the ratio of predictions that exactly match the true class labels." - }, - { - "value": "NormMacroRecall", - "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." - }, - { - "value": "AveragePrecisionScoreWeighted", - "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." - }, - { - "value": "PrecisionScoreWeighted", - "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeVersion" + } + }, + "x-ms-client-name": "CodeVersion", + "additionalProperties": false + }, + "CodeVersionResourceArmPaginatedResult": { + "description": "A paginated list of CodeVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeVersionResource" } - ] + } }, "additionalProperties": false }, - "ClassificationTrainingSettings": { - "description": "Classification Training related configuration.", + "ColumnTransformer": { + "description": "Column transformer parameters.", + "type": "object", + "properties": { + "fields": { + "description": "Fields to apply transformer logic on.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "parameters": { + "description": "Different properties to be passed to transformer.\r\nInput expected is dictionary of key,value pairs in JSON format.", + "type": "object", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CommandJob": { + "description": "Command job definition.", + "required": [ + "command", + "environmentId" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/TrainingSettings" + "$ref": "#/definitions/JobBase" } ], "properties": { - "allowedTrainingAlgorithms": { - "description": "Allowed models for classification task.", - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationModels" + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true }, + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "blockedTrainingAlgorithms": { - "description": "Blocked models for classification task.", - "type": "array", - "items": { - "$ref": "#/definitions/ClassificationModels" + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Command Job limit.", + "$ref": "#/definitions/CommandJobLimits", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "parameters": { + "description": "Input parameters.", + "type": "object", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true - } - }, - "additionalProperties": false - }, - "CodeConfiguration": { - "description": "Configuration for a scoring code asset.", - "required": [ - "scoringScript" - ], - "type": "object", - "properties": { - "codeId": { - "description": "ARM resource ID of the code asset.", - "type": "string", + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", "x-ms-mutability": [ "create", "read" ], "x-nullable": true }, - "scoringScript": { - "description": "[Required] The script to execute on startup. eg. \"score.py\"", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", "x-ms-mutability": [ "create", "read" ] } }, + "x-ms-discriminator-value": "Command", "additionalProperties": false }, - "CodeContainer": { - "description": "Container for code asset versions.", + "CommandJobLimits": { + "description": "Command Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "ComponentContainer": { + "description": "Component container definition.\r\n", "type": "object", "allOf": [ { @@ -11112,7 +13052,7 @@ ], "properties": { "provisioningState": { - "description": "Provisioning state for the code container.", + "description": "Provisioning state for the component container.", "$ref": "#/definitions/AssetProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -11120,10 +13060,10 @@ ] } }, - "x-ms-client-name": "CodeContainerProperties", + "x-ms-client-name": "ComponentContainerProperties", "additionalProperties": false }, - "CodeContainerResource": { + "ComponentContainerResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -11137,32 +13077,32 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/CodeContainer" + "$ref": "#/definitions/ComponentContainer" } }, - "x-ms-client-name": "CodeContainer", + "x-ms-client-name": "ComponentContainer", "additionalProperties": false }, - "CodeContainerResourceArmPaginatedResult": { - "description": "A paginated list of CodeContainer entities.", + "ComponentContainerResourceArmPaginatedResult": { + "description": "A paginated list of ComponentContainer entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type CodeContainer.", + "description": "An array of objects of type ComponentContainer.", "type": "array", "items": { - "$ref": "#/definitions/CodeContainerResource" + "$ref": "#/definitions/ComponentContainerResource" } } }, "additionalProperties": false }, - "CodeVersion": { - "description": "Code asset version details.", + "ComponentVersion": { + "description": "Definition of a component version: defines resources that span component types.", "type": "object", "allOf": [ { @@ -11170,14 +13110,26 @@ } ], "properties": { - "codeUri": { - "description": "Uri where code is located", - "type": "string", - "example": "https://blobStorage/folderName", + "componentSpec": { + "description": "Defines Component definition details.\r\n", + "type": "object", + "example": { + "name": "Hello_Python_World", + "display_name": "Hello_Python_World", + "version": 1, + "type": "command", + "code": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/mycode/versions/1", + "environment": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/AzureML-Tutorial/versions/1", + "command": "python hello.py" + }, + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, "provisioningState": { - "description": "Provisioning state for the code version.", + "description": "Provisioning state for the component version.", "$ref": "#/definitions/AssetProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -11185,10 +13137,10 @@ ] } }, - "x-ms-client-name": "CodeVersionProperties", + "x-ms-client-name": "ComponentVersionProperties", "additionalProperties": false }, - "CodeVersionResource": { + "ComponentVersionResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -11202,74 +13154,197 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/CodeVersion" + "$ref": "#/definitions/ComponentVersion" } }, - "x-ms-client-name": "CodeVersion", + "x-ms-client-name": "ComponentVersion", "additionalProperties": false }, - "CodeVersionResourceArmPaginatedResult": { - "description": "A paginated list of CodeVersion entities.", + "ComponentVersionResourceArmPaginatedResult": { + "description": "A paginated list of ComponentVersion entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { - "description": "An array of objects of type CodeVersion.", + "description": "An array of objects of type ComponentVersion.", "type": "array", "items": { - "$ref": "#/definitions/CodeVersionResource" + "$ref": "#/definitions/ComponentVersionResource" } } }, "additionalProperties": false }, - "ColumnTransformer": { - "description": "Column transformer parameters.", + "ContainerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", "type": "object", "properties": { - "fields": { - "description": "Fields to apply transformer logic on.", - "type": "array", - "items": { - "type": "string" - }, + "containerResourceLimits": { + "description": "Container resource limit info:", + "$ref": "#/definitions/ContainerResourceSettings", "x-nullable": true }, - "parameters": { - "description": "Different properties to be passed to transformer.\r\nInput expected is dictionary of key,value pairs in JSON format.", - "type": "object", + "containerResourceRequests": { + "description": "Container resource request info:", + "$ref": "#/definitions/ContainerResourceSettings", "x-nullable": true } }, "additionalProperties": false }, - "CommandJob": { - "description": "Command job definition.", + "ContainerResourceSettings": { + "type": "object", + "properties": { + "cpu": { + "description": "Number of vCPUs request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "gpu": { + "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "memory": { + "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "2Gi", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerType": { + "enum": [ + "StorageInitializer", + "InferenceServer" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "value": "StorageInitializer" + }, + { + "value": "InferenceServer" + } + ] + }, + "additionalProperties": false + }, + "CreateMonitorAction": { + "required": [ + "monitorDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "monitorDefinition": { + "description": "[Required] Defines the monitor.", + "$ref": "#/definitions/MonitorDefinition", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "CreateMonitor", + "additionalProperties": false + }, + "CredentialsType": { + "description": "Enum to determine the datastore credentials type.", + "enum": [ + "AccountKey", + "Certificate", + "None", + "Sas", + "ServicePrincipal" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "None" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + } + ] + }, + "additionalProperties": false + }, + "CronTrigger": { + "required": [ + "expression" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Cron", + "additionalProperties": false + }, + "CustomForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", "required": [ - "command", - "environmentId" + "value" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/JobBase" + "$ref": "#/definitions/ForecastHorizon" } ], "properties": { - "codeId": { - "description": "ARM resource ID of the code asset.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "command": { - "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "value": { + "format": "int32", + "description": "[Required] Forecast horizon value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] The user-defined metric to calculate.", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string", @@ -11278,17 +13353,58 @@ "read" ] }, - "distribution": { - "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", - "$ref": "#/definitions/DistributionConfiguration", + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", "x-ms-mutability": [ "create", "read" ], "x-nullable": true + } + }, + "additionalProperties": false + }, + "CustomModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" }, - "environmentId": { - "description": "[Required] The ARM resource ID of the Environment specification for the job.", + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomMonitoringSignal": { + "required": [ + "componentId", + "metricThresholds" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "componentId": { + "description": "[Required] Reference to the component asset used to calculate the custom metrics.", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string", @@ -11297,11 +13413,12 @@ "read" ] }, - "environmentVariables": { - "description": "Environment variables included in the job.", + "inputAssets": { + "description": "Monitoring assets to take as input. Key is the component input port name, value is the data asset.", "type": "object", "additionalProperties": { - "type": "string", + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase", "x-nullable": true }, "x-ms-mutability": [ @@ -11311,7 +13428,7 @@ "x-nullable": true }, "inputs": { - "description": "Mapping of input data bindings used in the job.", + "description": "Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.", "type": "object", "additionalProperties": { "description": "Command job definition.", @@ -11324,93 +13441,159 @@ ], "x-nullable": true }, - "limits": { - "description": "Command Job limit.", - "$ref": "#/definitions/CommandJobLimits", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "outputs": { - "description": "Mapping of output data bindings used in the job.", - "type": "object", - "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", - "x-nullable": true + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomMetricThreshold" }, "x-ms-mutability": [ "create", "read" ], - "x-nullable": true - }, - "parameters": { - "description": "Input parameters.", - "type": "object", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "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": "{}", - "$ref": "#/definitions/JobResourceConfiguration", - "x-ms-mutability": [ - "create", - "read" - ] + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Command", + "x-ms-discriminator-value": "Custom", "additionalProperties": false }, - "CommandJobLimits": { - "description": "Command Job limit class.", + "CustomNCrossValidations": { + "description": "N-Cross validations are specified by user.", + "required": [ + "value" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/JobLimits" + "$ref": "#/definitions/NCrossValidations" } ], - "x-ms-discriminator-value": "Command", + "properties": { + "value": { + "format": "int32", + "description": "[Required] N-Cross validations value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", "additionalProperties": false }, - "ComponentContainer": { - "description": "Component container definition.\r\n", + "CustomSeasonality": { + "required": [ + "value" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetContainer" + "$ref": "#/definitions/Seasonality" } ], "properties": { - "provisioningState": { - "description": "Provisioning state for the component container.", - "$ref": "#/definitions/AssetProvisioningState", - "readOnly": true, + "value": { + "format": "int32", + "description": "[Required] Seasonality value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetLags": { + "required": [ + "values" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "properties": { + "values": { + "description": "[Required] Set target lags values.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetRollingWindowSize": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] TargetRollingWindowSize value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "DataAvailabilityStatus": { + "enum": [ + "None", + "Pending", + "Incomplete", + "Complete" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAvailabilityStatus", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "Pending" + }, + { + "value": "Incomplete" + }, + { + "value": "Complete" + } + ] + }, + "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": "ComponentContainerProperties", + "x-ms-client-name": "DataContainerProperties", "additionalProperties": false }, - "ComponentContainerResource": { + "DataContainerResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -11424,50 +13607,74 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/ComponentContainer" + "$ref": "#/definitions/DataContainer" } }, - "x-ms-client-name": "ComponentContainer", + "x-ms-client-name": "DataContainer", "additionalProperties": false }, - "ComponentContainerResourceArmPaginatedResult": { - "description": "A paginated list of ComponentContainer entities.", + "DataContainerResourceArmPaginatedResult": { + "description": "A paginated list of DataContainer entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "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 ComponentContainer.", + "description": "An array of objects of type DataContainer.", "type": "array", "items": { - "$ref": "#/definitions/ComponentContainerResource" + "$ref": "#/definitions/DataContainerResource" } } }, "additionalProperties": false }, - "ComponentVersion": { - "description": "Definition of a component version: defines resources that span component types.", + "DataDriftMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "DataDriftMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetBase" + "$ref": "#/definitions/MonitoringSignalBase" } ], "properties": { - "componentSpec": { - "description": "Defines Component definition details.\r\n", + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", "type": "object", - "example": { - "name": "Hello_Python_World", - "display_name": "Hello_Python_World", - "version": 1, - "type": "command", - "code": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/mycode/versions/1", - "environment": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/AzureML-Tutorial/versions/1", - "command": "python hello.py" + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" }, "x-ms-mutability": [ "create", @@ -11475,498 +13682,737 @@ ], "x-nullable": true }, - "provisioningState": { - "description": "Provisioning state for the component version.", - "$ref": "#/definitions/AssetProvisioningState", - "readOnly": true, + "featureImportanceSettings": { + "description": "The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The feature filter which identifies which feature to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", "read" ] } }, - "x-ms-client-name": "ComponentVersionProperties", + "x-ms-discriminator-value": "DataDrift", "additionalProperties": false }, - "ComponentVersionResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], + "DataPathAssetReference": { + "description": "Reference to an asset via its path in a datastore.", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + "$ref": "#/definitions/AssetReferenceBase" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/ComponentVersion" + "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-client-name": "ComponentVersion", + "x-ms-discriminator-value": "DataPath", "additionalProperties": false }, - "ComponentVersionResourceArmPaginatedResult": { - "description": "A paginated list of ComponentVersion entities.", + "DataQualityMetricThresholdBase": { + "required": [ + "dataType" + ], "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", - "type": "string" + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] }, - "value": { - "description": "An array of objects of type ComponentVersion.", - "type": "array", - "items": { - "$ref": "#/definitions/ComponentVersionResource" - } + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, - "additionalProperties": false + "discriminator": "dataType" }, - "ContainerResourceRequirements": { - "description": "Resource requirements for each container instance within an online deployment.", + "DataQualityMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], "properties": { - "containerResourceLimits": { - "description": "Container resource limit info:", - "$ref": "#/definitions/ContainerResourceSettings", + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "containerResourceRequests": { - "description": "Container resource request info:", - "$ref": "#/definitions/ContainerResourceSettings", + "featureImportanceSettings": { + "description": "The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The features to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data produced by the production service which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] } }, + "x-ms-discriminator-value": "DataQuality", "additionalProperties": false }, - "ContainerResourceSettings": { + "DataReferenceCredential": { + "description": "DataReferenceCredential base class", + "required": [ + "credentialType" + ], "type": "object", "properties": { - "cpu": { - "description": "Number of vCPUs request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", - "type": "string", - "example": "1", - "x-nullable": true - }, - "gpu": { - "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", - "type": "string", - "example": "1", - "x-nullable": true - }, - "memory": { - "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", - "type": "string", - "example": "2Gi", - "x-nullable": true + "credentialType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/DataReferenceCredentialType" } }, - "additionalProperties": false + "discriminator": "credentialType" }, - "ContainerType": { + "DataReferenceCredentialType": { + "description": "Enum to determine the DataReference credentials type.", "enum": [ - "StorageInitializer", - "InferenceServer" + "SAS", + "DockerCredentials", + "ManagedIdentity", + "NoCredentials" ], "type": "string", "x-ms-enum": { - "name": "ContainerType", + "name": "DataReferenceCredentialType", "modelAsString": true, "values": [ { - "value": "StorageInitializer" + "value": "SAS" }, { - "value": "InferenceServer" + "value": "DockerCredentials" + }, + { + "value": "ManagedIdentity" + }, + { + "value": "NoCredentials" } ] }, "additionalProperties": false }, - "CreateMonitorAction": { - "required": [ - "monitorDefinition" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ScheduleActionBase" - } - ], - "properties": { - "monitorDefinition": { - "description": "[Required] Defines the monitor.", - "$ref": "#/definitions/MonitorDefinition", - "x-ms-mutability": [ - "create", - "read" - ] - } - }, - "x-ms-discriminator-value": "CreateMonitor", - "additionalProperties": false - }, - "CredentialsType": { - "description": "Enum to determine the datastore credentials type.", + "DataType": { + "description": "Enum to determine the type of data.", "enum": [ - "AccountKey", - "Certificate", - "None", - "Sas", - "ServicePrincipal" + "uri_file", + "uri_folder", + "mltable" ], "type": "string", "x-ms-enum": { - "name": "CredentialsType", + "name": "DataType", "modelAsString": true, "values": [ { - "value": "AccountKey" - }, - { - "value": "Certificate" - }, - { - "value": "None" + "value": "uri_file" }, { - "value": "Sas" + "value": "uri_folder" }, { - "value": "ServicePrincipal" + "value": "mltable" } ] }, "additionalProperties": false }, - "CronTrigger": { + "DataVersionBase": { + "description": "Data version base definition", "required": [ - "expression" + "dataType", + "dataUri" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/TriggerBase" + "$ref": "#/definitions/AssetBase" } ], "properties": { - "expression": { - "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataUri": { + "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", "minLength": 1, "pattern": "[a-zA-Z0-9_]", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "x-ms-discriminator-value": "Cron", - "additionalProperties": false + "discriminator": "dataType", + "x-ms-client-name": "DataVersionBaseProperties" }, - "CustomForecastHorizon": { - "description": "The desired maximum forecast horizon in units of time-series frequency.", + "DataVersionBaseResource": { + "description": "Azure Resource Manager resource envelope.", "required": [ - "value" + "properties" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ForecastHorizon" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], "properties": { - "value": { - "format": "int32", - "description": "[Required] Forecast horizon value.", - "type": "integer" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataVersionBase" } }, - "x-ms-discriminator-value": "Custom", + "x-ms-client-name": "DataVersionBase", "additionalProperties": false }, - "CustomMetricThreshold": { - "required": [ - "metric" - ], + "DataVersionBaseResourceArmPaginatedResult": { + "description": "A paginated list of DataVersionBase entities.", "type": "object", "properties": { - "metric": { - "description": "[Required] The user-defined metric to calculate.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] + "nextLink": { + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "type": "string" }, - "threshold": { - "description": "The threshold value. If null, a default value will be set depending on the selected metric.", - "$ref": "#/definitions/MonitoringThreshold", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true + "value": { + "description": "An array of objects of type DataVersionBase.", + "type": "array", + "items": { + "$ref": "#/definitions/DataVersionBaseResource" + } } }, "additionalProperties": false }, - "CustomModelJobInput": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetJobInput" - }, - { - "$ref": "#/definitions/JobInput" - } - ], - "x-ms-discriminator-value": "custom_model", - "additionalProperties": false - }, - "CustomModelJobOutput": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetJobOutput" - }, - { - "$ref": "#/definitions/JobOutput" - } - ], - "x-ms-discriminator-value": "custom_model", - "additionalProperties": false - }, - "CustomMonitoringSignal": { + "Datastore": { + "description": "Base definition for datastore contents configuration.", "required": [ - "componentId", - "metricThresholds" + "credentials", + "datastoreType" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/MonitoringSignalBase" + "$ref": "#/definitions/ResourceBase" } ], "properties": { - "componentId": { - "description": "[Required] Reference to the component asset used to calculate the custom metrics.", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "inputAssets": { - "description": "Monitoring assets to take as input. Key is the component input port name, value is the data asset.", - "type": "object", - "additionalProperties": { - "description": "Monitoring input data base definition.", - "$ref": "#/definitions/MonitoringInputDataBase", - "x-nullable": true - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "inputs": { - "description": "Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.", - "type": "object", - "additionalProperties": { - "description": "Command job definition.", - "$ref": "#/definitions/JobInput", - "x-nullable": true - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" }, - "metricThresholds": { - "description": "[Required] A list of metrics to calculate and their associated thresholds.", - "type": "array", - "items": { - "$ref": "#/definitions/CustomMetricThreshold" - }, + "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": [ - "create", "read" - ], - "x-ms-identifiers": [] + ] } }, - "x-ms-discriminator-value": "Custom", - "additionalProperties": false + "discriminator": "datastoreType", + "x-ms-client-name": "DatastoreProperties" }, - "CustomNCrossValidations": { - "description": "N-Cross validations are specified by user.", + "DatastoreCredentials": { + "description": "Base definition for datastore credentials.", "required": [ - "value" + "credentialsType" ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/NCrossValidations" - } - ], "properties": { - "value": { - "format": "int32", - "description": "[Required] N-Cross validations value.", - "type": "integer" + "credentialsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/CredentialsType" } }, - "x-ms-discriminator-value": "Custom", - "additionalProperties": false + "discriminator": "credentialsType" }, - "CustomSeasonality": { + "DatastoreResource": { + "description": "Azure Resource Manager resource envelope.", "required": [ - "value" + "properties" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/Seasonality" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], "properties": { - "value": { - "format": "int32", - "description": "[Required] Seasonality value.", - "type": "integer" + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Datastore" } }, - "x-ms-discriminator-value": "Custom", + "x-ms-client-name": "Datastore", "additionalProperties": false }, - "CustomTargetLags": { - "required": [ - "values" - ], + "DatastoreResourceArmPaginatedResult": { + "description": "A paginated list of Datastore entities.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TargetLags" - } - ], "properties": { - "values": { - "description": "[Required] Set target lags values.", + "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": { - "format": "int32", - "type": "integer" + "$ref": "#/definitions/DatastoreResource" } } }, - "x-ms-discriminator-value": "Custom", "additionalProperties": false }, - "CustomTargetRollingWindowSize": { + "DatastoreSecrets": { + "description": "Base definition for datastore secrets.", "required": [ - "value" + "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" ], + "type": "string", + "x-ms-enum": { + "name": "DatastoreType", + "modelAsString": true, + "values": [ + { + "value": "AzureBlob" + }, + { + "value": "AzureDataLakeGen1" + }, + { + "value": "AzureDataLakeGen2" + }, + { + "value": "AzureFile" + } + ] + }, + "additionalProperties": false + }, + "DefaultScaleSettings": { "type": "object", "allOf": [ { - "$ref": "#/definitions/TargetRollingWindowSize" + "$ref": "#/definitions/OnlineScaleSettings" } ], + "x-ms-discriminator-value": "Default", + "additionalProperties": false + }, + "DeploymentLogs": { + "type": "object", "properties": { - "value": { + "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": "[Required] TargetRollingWindowSize value.", - "type": "integer" + "description": "The maximum number of lines to tail.", + "type": "integer", + "x-nullable": true } }, - "x-ms-discriminator-value": "Custom", "additionalProperties": false }, - "DataContainer": { - "description": "Container for data asset versions.", - "required": [ - "dataType" + "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/AssetContainer" + "$ref": "#/definitions/ResourceConfiguration" } ], + "additionalProperties": false + }, + "DestinationAsset": { + "description": "Publishing destination registry asset information", + "type": "object", "properties": { - "dataType": { - "description": "[Required] Specifies the type of data.", - "$ref": "#/definitions/DataType", + "destinationName": { + "description": "Destination asset name", + "type": "string", + "x-nullable": true + }, + "destinationVersion": { + "description": "Destination asset version", + "type": "string", + "x-nullable": true + }, + "registryName": { + "description": "Destination registry name", + "type": "string", + "x-nullable": true + } + }, + "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" ] } }, - "x-ms-client-name": "DataContainerProperties", + "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 }, - "DataContainerResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], + "DockerCredential": { + "description": "Credential for docker with username and password", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + "$ref": "#/definitions/DataReferenceCredential" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/DataContainer" + "password": { + "description": "DockerCredential user password", + "type": "string", + "x-nullable": true + }, + "userName": { + "description": "DockerCredential user name", + "type": "string", + "x-nullable": true } }, - "x-ms-client-name": "DataContainer", + "x-ms-discriminator-value": "DockerCredentials", "additionalProperties": false }, - "DataContainerResourceArmPaginatedResult": { - "description": "A paginated list of DataContainer entities.", + "EarlyTerminationPolicy": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "required": [ + "policyType" + ], "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", - "type": "string" + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" }, - "value": { - "description": "An array of objects of type DataContainer.", - "type": "array", - "items": { - "$ref": "#/definitions/DataContainerResource" - } + "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 }, - "DataDriftMetricThresholdBase": { - "required": [ - "dataType" + "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", "properties": { - "dataType": { - "description": "[Required] Specifies the data type of the metric threshold.", - "$ref": "#/definitions/MonitoringFeatureDataType", + "primaryKey": { + "description": "The primary key.", + "type": "string", "x-ms-mutability": [ "create", "read" - ] + ], + "x-nullable": true }, - "threshold": { - "description": "The threshold value. If null, a default value will be set depending on the selected metric.", - "$ref": "#/definitions/MonitoringThreshold", + "secondaryKey": { + "description": "The secondary key.", + "type": "string", "x-ms-mutability": [ "create", "read" @@ -11974,396 +14420,274 @@ "x-nullable": true } }, - "discriminator": "dataType" + "additionalProperties": false }, - "DataDriftMonitoringSignal": { - "required": [ - "metricThresholds", - "productionData", - "referenceData" + "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", - "allOf": [ - { - "$ref": "#/definitions/MonitoringSignalBase" - } - ], "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "featureImportanceSettings": { - "description": "The settings for computing feature importance.", - "$ref": "#/definitions/FeatureImportanceSettings", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "features": { - "description": "The feature filter which identifies which feature to calculate drift over.", - "$ref": "#/definitions/MonitoringFeatureFilterBase", - "x-ms-mutability": [ - "create", - "read" - ], + "accessToken": { + "description": "Access token for endpoint authentication.", + "type": "string", "x-nullable": true }, - "metricThresholds": { - "description": "[Required] A list of metrics to calculate and their associated thresholds.", - "type": "array", - "items": { - "$ref": "#/definitions/DataDriftMetricThresholdBase" - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-ms-identifiers": [] + "expiryTimeUtc": { + "format": "int64", + "description": "Access token expiry time (UTC).", + "default": 0, + "type": "integer" }, - "productionData": { - "description": "[Required] The data which drift will be calculated for.", - "$ref": "#/definitions/MonitoringInputDataBase", - "x-ms-mutability": [ - "create", - "read" - ] + "refreshAfterTimeUtc": { + "format": "int64", + "description": "Refresh access token after time (UTC).", + "default": 0, + "type": "integer" }, - "referenceData": { - "description": "[Required] The data to calculate drift against.", - "$ref": "#/definitions/MonitoringInputDataBase", - "x-ms-mutability": [ - "create", - "read" - ] + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true } }, - "x-ms-discriminator-value": "DataDrift", "additionalProperties": false }, - "DataPathAssetReference": { - "description": "Reference to an asset via its path in a datastore.", + "EndpointComputeType": { + "description": "Enum to determine endpoint compute type.", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "Kubernetes" + }, + { + "value": "AzureMLCompute" + } + ] + }, + "additionalProperties": false + }, + "EndpointDeploymentPropertiesBase": { + "description": "Base definition for endpoint deployment.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetReferenceBase" - } - ], "properties": { - "datastoreId": { - "description": "ARM resource ID of the datastore where the asset is located.", + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "description": { + "description": "Description of the endpoint deployment.", "type": "string", "x-nullable": true }, - "path": { - "description": "The path of the file/directory in the datastore.", + "environmentId": { + "description": "ARM resource ID or AssetId 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 } }, - "x-ms-discriminator-value": "DataPath", "additionalProperties": false }, - "DataQualityMetricThresholdBase": { + "EndpointPropertiesBase": { + "description": "Inference Endpoint base definition", "required": [ - "dataType" + "authMode" ], "type": "object", "properties": { - "dataType": { - "description": "[Required] Specifies the data type of the metric threshold.", - "$ref": "#/definitions/MonitoringFeatureDataType", - "x-ms-mutability": [ - "create", - "read" - ] + "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" }, - "threshold": { - "description": "The threshold value. If null, a default value will be set depending on the selected metric.", - "$ref": "#/definitions/MonitoringThreshold", + "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", - "read" + "create" ], + "x-ms-secret": true, "x-nullable": true - } - }, - "discriminator": "dataType" - }, - "DataQualityMonitoringSignal": { - "required": [ - "metricThresholds", - "productionData", - "referenceData" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MonitoringSignalBase" - } - ], - "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", "type": "object", "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" + "type": "string", + "x-nullable": true }, - "x-ms-mutability": [ - "create", - "read" - ], "x-nullable": true }, - "featureImportanceSettings": { - "description": "The settings for computing feature importance.", - "$ref": "#/definitions/FeatureImportanceSettings", + "scoringUri": { + "format": "uri", + "description": "Endpoint URI.", + "type": "string", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true }, - "features": { - "description": "The features to calculate drift over.", - "$ref": "#/definitions/MonitoringFeatureFilterBase", + "swaggerUri": { + "format": "uri", + "description": "Endpoint Swagger URI.", + "type": "string", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ], "x-nullable": true - }, - "metricThresholds": { - "description": "[Required] A list of metrics to calculate and their associated thresholds.", - "type": "array", - "items": { - "$ref": "#/definitions/DataQualityMetricThresholdBase" - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-ms-identifiers": [] - }, - "productionData": { - "description": "[Required] The data produced by the production service which drift will be calculated for.", - "$ref": "#/definitions/MonitoringInputDataBase", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "referenceData": { - "description": "[Required] The data to calculate drift against.", - "$ref": "#/definitions/MonitoringInputDataBase", - "x-ms-mutability": [ - "create", - "read" - ] } }, - "x-ms-discriminator-value": "DataQuality", "additionalProperties": false }, - "DataReferenceCredential": { - "description": "DataReferenceCredential base class", - "required": [ - "credentialType" - ], - "type": "object", - "properties": { - "credentialType": { - "description": "[Required] Credential type used to authentication with storage.", - "$ref": "#/definitions/DataReferenceCredentialType" - } - }, - "discriminator": "credentialType" - }, - "DataReferenceCredentialType": { - "description": "Enum to determine the DataReference credentials type.", + "EndpointProvisioningState": { + "description": "State of endpoint provisioning.", "enum": [ - "SAS", - "DockerCredentials", - "ManagedIdentity", - "NoCredentials" + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" ], "type": "string", "x-ms-enum": { - "name": "DataReferenceCredentialType", + "name": "EndpointProvisioningState", "modelAsString": true, "values": [ { - "value": "SAS" + "value": "Creating" }, { - "value": "DockerCredentials" + "value": "Deleting" }, { - "value": "ManagedIdentity" + "value": "Succeeded" }, { - "value": "NoCredentials" - } - ] - }, - "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", - "required": [ - "dataType", - "dataUri" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetBase" - } - ], - "properties": { - "dataType": { - "description": "[Required] Specifies the type of data.", - "$ref": "#/definitions/DataType", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "dataUri": { - "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", - "minLength": 1, - "pattern": "[a-zA-Z0-9_]", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ] - } - }, - "discriminator": "dataType", - "x-ms-client-name": "DataVersionBaseProperties" - }, - "DataVersionBaseResource": { - "description": "Azure Resource Manager resource envelope.", + "EndpointScheduleAction": { "required": [ - "properties" + "actionType", + "endpointInvocationDefinition" ], "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + "$ref": "#/definitions/ScheduleActionBase" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/DataVersionBase" - } - }, - "x-ms-client-name": "DataVersionBase", - "additionalProperties": false - }, - "DataVersionBaseResourceArmPaginatedResult": { - "description": "A paginated list of DataVersionBase entities.", - "type": "object", - "properties": { - "nextLink": { - "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 DataVersionBase.", - "type": "array", - "items": { - "$ref": "#/definitions/DataVersionBaseResource" - } + "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" + ] } }, + "x-ms-discriminator-value": "InvokeBatchEndpoint", "additionalProperties": false }, - "Datastore": { - "description": "Base definition for datastore contents configuration.", - "required": [ - "credentials", - "datastoreType" - ], + "EnvironmentContainer": { + "description": "Container for environment specification versions.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ResourceBase" + "$ref": "#/definitions/AssetContainer" } ], "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", + "provisioningState": { + "description": "Provisioning state for the environment container.", + "$ref": "#/definitions/AssetProvisioningState", "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" + "x-ms-client-name": "EnvironmentContainerProperties", + "additionalProperties": false }, - "DatastoreResource": { + "EnvironmentContainerResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -12377,336 +14701,298 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/Datastore" + "$ref": "#/definitions/EnvironmentContainer" } }, - "x-ms-client-name": "Datastore", + "x-ms-client-name": "EnvironmentContainer", "additionalProperties": false }, - "DatastoreResourceArmPaginatedResult": { - "description": "A paginated list of Datastore entities.", + "EnvironmentContainerResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentContainer entities.", "type": "object", "properties": { "nextLink": { - "description": "The link to the next page of Datastore 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 Datastore.", + "description": "An array of objects of type EnvironmentContainer.", "type": "array", "items": { - "$ref": "#/definitions/DatastoreResource" + "$ref": "#/definitions/EnvironmentContainerResource" } } }, "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.", + "EnvironmentType": { + "description": "Environment type is either user created or curated by Azure ML service", "enum": [ - "AzureBlob", - "AzureDataLakeGen1", - "AzureDataLakeGen2", - "AzureFile" + "Curated", + "UserCreated" ], "type": "string", "x-ms-enum": { - "name": "DatastoreType", + "name": "EnvironmentType", "modelAsString": true, "values": [ { - "value": "AzureBlob" - }, - { - "value": "AzureDataLakeGen1" - }, - { - "value": "AzureDataLakeGen2" + "value": "Curated" }, { - "value": "AzureFile" + "value": "UserCreated" } ] }, "additionalProperties": false }, - "DefaultScaleSettings": { + "EnvironmentVersion": { + "description": "Environment version details.", "type": "object", "allOf": [ { - "$ref": "#/definitions/OnlineScaleSettings" + "$ref": "#/definitions/AssetBase" } ], - "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" + "autoRebuild": { + "description": "Defines if image needs to be rebuilt based on base image changes.", + "default": "Disabled", + "$ref": "#/definitions/AutoRebuildSetting", + "x-ms-mutability": [ + "create", + "read" + ] }, - "tail": { - "format": "int32", - "description": "The maximum number of lines to tail.", - "type": "integer", - "x-nullable": true - } - }, - "additionalProperties": false - }, - "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 - }, - "DestinationAsset": { - "description": "Publishing destination registry asset information", - "type": "object", - "properties": { - "destinationName": { - "description": "Destination asset name", + "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-nullable": true + "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" + ] }, - "destinationVersion": { - "description": "Destination asset version", + "image": { + "description": "Name of the image that will be used for the environment.\r\n", "type": "string", - "x-nullable": true + "example": "docker.io/tensorflow/serving:latest", + "x-ms-mutability": [ + "create", + "read" + ] }, - "registryName": { - "description": "Destination registry name", + "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" + ] + }, + "stage": { + "description": "Stage in the environment lifecycle assigned to this environment", "type": "string", "x-nullable": true } }, + "x-ms-client-name": "EnvironmentVersionProperties", "additionalProperties": false }, - "DistributionConfiguration": { - "description": "Base definition for job distribution configuration.", + "EnvironmentVersionResource": { + "description": "Azure Resource Manager resource envelope.", "required": [ - "distributionType" + "properties" ], "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], "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" + "x-ms-client-name": "EnvironmentVersion", + "additionalProperties": false }, - "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" + "EnvironmentVersionResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVersionResource" } - ] + } }, "additionalProperties": false }, - "DockerCredential": { - "description": "Credential for docker with username and password", + "Feature": { + "description": "DTO object representing feature", "type": "object", "allOf": [ { - "$ref": "#/definitions/DataReferenceCredential" + "$ref": "#/definitions/ResourceBase" } ], "properties": { - "password": { - "description": "DockerCredential user password", - "type": "string", - "x-nullable": true + "dataType": { + "description": "Specifies type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" }, - "userName": { - "description": "DockerCredential user name", + "featureName": { + "description": "Specifies name", "type": "string", "x-nullable": true } }, - "x-ms-discriminator-value": "DockerCredentials", + "x-ms-client-name": "FeatureProperties", "additionalProperties": false }, - "EarlyTerminationPolicy": { - "description": "Early termination policies enable canceling poor-performing runs before they complete", + "FeatureAttributionDriftMonitoringSignal": { "required": [ - "policyType" + "featureImportanceSettings", + "metricThreshold", + "productionData", + "referenceData" ], "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" + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" } - }, - "discriminator": "policyType" - }, - "EarlyTerminationPolicyType": { - "enum": [ - "Bandit", - "MedianStopping", - "TruncationSelection" ], - "type": "string", - "x-ms-enum": { - "name": "EarlyTerminationPolicyType", - "modelAsString": true, - "values": [ - { - "value": "Bandit" + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" }, - { - "value": "MedianStopping" + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "featureImportanceSettings": { + "description": "[Required] The settings for computing feature importance.", + "$ref": "#/definitions/FeatureImportanceSettings", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/FeatureAttributionMetricThreshold", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" }, - { - "value": "TruncationSelection" - } - ] + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } }, + "x-ms-discriminator-value": "FeatureAttributionDrift", "additionalProperties": false }, - "EgressPublicNetworkAccessType": { - "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.", + "FeatureAttributionMetric": { "enum": [ - "Enabled", - "Disabled" + "NormalizedDiscountedCumulativeGain" ], "type": "string", "x-ms-enum": { - "name": "EgressPublicNetworkAccessType", + "name": "FeatureAttributionMetric", "modelAsString": true, "values": [ { - "value": "Enabled" - }, - { - "value": "Disabled" + "value": "NormalizedDiscountedCumulativeGain", + "description": "The Normalized Discounted Cumulative Gain metric." } ] }, "additionalProperties": false }, - "EndpointAuthKeys": { - "description": "Keys for endpoint authentication.", + "FeatureAttributionMetricThreshold": { + "required": [ + "metric" + ], "type": "object", "properties": { - "primaryKey": { - "description": "The primary key.", - "type": "string", + "metric": { + "description": "[Required] The feature attribution metric to calculate.", + "$ref": "#/definitions/FeatureAttributionMetric", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, - "secondaryKey": { - "description": "The secondary key.", - "type": "string", + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", "x-ms-mutability": [ "create", "read" @@ -12716,252 +15002,198 @@ }, "additionalProperties": false }, - "EndpointAuthMode": { - "description": "Enum to determine endpoint authentication mode.", + "FeatureDataType": { + "enum": [ + "String", + "Integer", + "Long", + "Float", + "Double", + "Binary", + "Datetime", + "Boolean" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureDataType", + "modelAsString": true, + "values": [ + { + "value": "String" + }, + { + "value": "Integer" + }, + { + "value": "Long" + }, + { + "value": "Float" + }, + { + "value": "Double" + }, + { + "value": "Binary" + }, + { + "value": "Datetime" + }, + { + "value": "Boolean" + } + ] + }, + "additionalProperties": false + }, + "FeatureImportanceMode": { + "description": "The mode of operation for computing feature importance.", "enum": [ - "AMLToken", - "Key", - "AADToken" + "Disabled", + "Enabled" ], "type": "string", "x-ms-enum": { - "name": "EndpointAuthMode", + "name": "FeatureImportanceMode", "modelAsString": true, "values": [ { - "value": "AMLToken" - }, - { - "value": "Key" + "value": "Disabled", + "description": "Disables computing feature importance within a signal." }, { - "value": "AADToken" + "value": "Enabled", + "description": "Enables computing feature importance within a signal." } ] }, "additionalProperties": false }, - "EndpointAuthToken": { - "description": "Service Token", + "FeatureImportanceSettings": { "type": "object", "properties": { - "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" + "mode": { + "description": "The mode of operation for computing feature importance.", + "default": "Disabled", + "$ref": "#/definitions/FeatureImportanceMode" }, - "tokenType": { - "description": "Access token type.", + "targetColumn": { + "description": "The name of the target column within the input data asset.", "type": "string", "x-nullable": true } }, "additionalProperties": false }, - "EndpointComputeType": { - "description": "Enum to determine endpoint compute type.", + "FeatureLags": { + "description": "Flag for generating lags for the numeric features.", "enum": [ - "Managed", - "Kubernetes", - "AzureMLCompute" + "None", + "Auto" ], "type": "string", "x-ms-enum": { - "name": "EndpointComputeType", + "name": "FeatureLags", "modelAsString": true, "values": [ { - "value": "Managed" - }, - { - "value": "Kubernetes" + "value": "None", + "description": "No feature lags generated." }, { - "value": "AzureMLCompute" + "value": "Auto", + "description": "System auto-generates feature lags." } ] }, "additionalProperties": false }, - "EndpointDeploymentPropertiesBase": { - "description": "Base definition for endpoint deployment.", + "FeatureResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], "properties": { - "codeConfiguration": { - "description": "Code configuration for the endpoint deployment.", - "$ref": "#/definitions/CodeConfiguration", - "x-nullable": true - }, - "description": { - "description": "Description of the endpoint deployment.", - "type": "string", - "x-nullable": true - }, - "environmentId": { - "description": "ARM resource ID or AssetId 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 + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Feature" } }, + "x-ms-client-name": "Feature", "additionalProperties": false }, - "EndpointPropertiesBase": { - "description": "Inference Endpoint base definition", - "required": [ - "authMode" - ], + "FeatureResourceArmPaginatedResult": { + "description": "A paginated list of Feature 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" - }, - "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 + "nextLink": { + "description": "The link to the next page of Feature objects. If null, there are no additional pages.", + "type": "string" }, - "swaggerUri": { - "format": "uri", - "description": "Endpoint Swagger URI.", - "type": "string", - "readOnly": true, - "x-ms-mutability": [ - "read" - ], - "x-nullable": true - } - }, - "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" + "value": { + "description": "An array of objects of type Feature.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureResource" } - ] + } }, "additionalProperties": false }, - "EndpointScheduleAction": { + "FeatureSubset": { "required": [ - "actionType", - "endpointInvocationDefinition" + "features", + "filterType" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ScheduleActionBase" + "$ref": "#/definitions/MonitoringFeatureFilterBase" } ], "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}}" - } + "features": { + "description": "[Required] The list of features to include.", + "type": "array", + "items": { + "type": "string" }, "x-ms-mutability": [ "create", - "read", - "update" + "read" ] } }, - "x-ms-discriminator-value": "InvokeBatchEndpoint", + "x-ms-discriminator-value": "FeatureSubset", + "additionalProperties": false + }, + "FeatureWindow": { + "description": "Specifies the feature window", + "type": "object", + "properties": { + "featureWindowEnd": { + "format": "date-time", + "description": "Specifies the feature window end time", + "type": "string", + "x-nullable": true + }, + "featureWindowStart": { + "format": "date-time", + "description": "Specifies the feature window start time", + "type": "string", + "x-nullable": true + } + }, "additionalProperties": false }, - "EnvironmentContainer": { - "description": "Container for environment specification versions.", + "FeaturesetContainer": { + "description": "DTO object representing feature set", "type": "object", "allOf": [ { @@ -12970,7 +15202,7 @@ ], "properties": { "provisioningState": { - "description": "Provisioning state for the environment container.", + "description": "Provisioning state for the featureset container.", "$ref": "#/definitions/AssetProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -12978,10 +15210,10 @@ ] } }, - "x-ms-client-name": "EnvironmentContainerProperties", + "x-ms-client-name": "FeaturesetContainerProperties", "additionalProperties": false }, - "EnvironmentContainerResource": { + "FeaturesetContainerResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -12995,53 +15227,44 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/EnvironmentContainer" + "$ref": "#/definitions/FeaturesetContainer" } }, - "x-ms-client-name": "EnvironmentContainer", + "x-ms-client-name": "FeaturesetContainer", "additionalProperties": false }, - "EnvironmentContainerResourceArmPaginatedResult": { - "description": "A paginated list of EnvironmentContainer entities.", + "FeaturesetContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetContainer 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 FeaturesetContainer 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 FeaturesetContainer.", "type": "array", "items": { - "$ref": "#/definitions/EnvironmentContainerResource" + "$ref": "#/definitions/FeaturesetContainerResource" } } }, "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" - } - ] + "FeaturesetSpecification": { + "description": "DTO object representing specification", + "type": "object", + "properties": { + "path": { + "description": "Specifies the spec path", + "type": "string", + "x-nullable": true + } }, "additionalProperties": false }, - "EnvironmentVersion": { - "description": "Environment version details.", + "FeaturesetVersion": { + "description": "DTO object representing feature set version", "type": "object", "allOf": [ { @@ -13049,83 +15272,116 @@ } ], "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" - ] + "entities": { + "description": "Specifies list of entities", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true }, - "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" - ] + "materializationSettings": { + "description": "Specifies the materialization settings", + "$ref": "#/definitions/MaterializationSettings", + "x-nullable": true }, - "environmentType": { - "description": "Environment type is either user managed or curated by the Azure ML service\r\n", - "$ref": "#/definitions/EnvironmentType", + "provisioningState": { + "description": "Provisioning state for the featureset version container.", + "$ref": "#/definitions/AssetProvisioningState", "readOnly": true, "x-ms-mutability": [ "read" ] }, - "image": { - "description": "Name of the image that will be used for the environment.\r\n", + "specification": { + "description": "Specifies the feature spec details", + "$ref": "#/definitions/FeaturesetSpecification", + "x-nullable": true + }, + "stage": { + "description": "Specifies the asset stage", "type": "string", - "example": "docker.io/tensorflow/serving:latest", - "x-ms-mutability": [ - "create", - "read" - ] + "x-nullable": true + } + }, + "x-ms-client-name": "FeaturesetVersionProperties", + "additionalProperties": false + }, + "FeaturesetVersionBackfillRequest": { + "description": "Request payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "dataAvailabilityStatus": { + "description": "Specified the data availability status that you want to backfill", + "type": "array", + "items": { + "$ref": "#/definitions/DataAvailabilityStatus" + } }, - "inferenceConfig": { - "description": "Defines configuration specific to inference.", - "$ref": "#/definitions/InferenceContainerProperties", - "x-ms-mutability": [ - "create", - "read" - ] + "description": { + "description": "Specifies description", + "type": "string" }, - "osType": { - "description": "The OS type of the environment.", - "default": "Linux", - "$ref": "#/definitions/OperatingSystemType", - "x-ms-mutability": [ - "create", - "read" - ] + "displayName": { + "description": "Specifies description", + "type": "string" }, - "provisioningState": { - "description": "Provisioning state for the environment version.", - "$ref": "#/definitions/AssetProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "featureWindow": { + "description": "Specifies the backfill feature window to be materialized", + "$ref": "#/definitions/FeatureWindow", + "x-nullable": true }, - "stage": { - "description": "Stage in the environment lifecycle assigned to this environment", - "type": "string", + "jobId": { + "description": "Specify the jobId to retry the failed materialization", + "type": "string" + }, + "properties": { + "description": "Specifies the properties", + "type": "object", + "additionalProperties": { + "type": "string", + "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": { + "jobIds": { + "description": "List of jobs submitted as part of the backfill request.", + "type": "array", + "items": { + "type": "string" + }, "x-nullable": true } }, - "x-ms-client-name": "EnvironmentVersionProperties", "additionalProperties": false }, - "EnvironmentVersionResource": { + "FeaturesetVersionResource": { "description": "Azure Resource Manager resource envelope.", "required": [ "properties" @@ -13139,227 +15395,160 @@ "properties": { "properties": { "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/EnvironmentVersion" + "$ref": "#/definitions/FeaturesetVersion" } }, - "x-ms-client-name": "EnvironmentVersion", + "x-ms-client-name": "FeaturesetVersion", "additionalProperties": false }, - "EnvironmentVersionResourceArmPaginatedResult": { - "description": "A paginated list of EnvironmentVersion entities.", + "FeaturesetVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetVersion 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 FeaturesetVersion 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 FeaturesetVersion.", "type": "array", "items": { - "$ref": "#/definitions/EnvironmentVersionResource" + "$ref": "#/definitions/FeaturesetVersionResource" } } }, "additionalProperties": false }, - "FeatureAttributionDriftMonitoringSignal": { - "required": [ - "featureImportanceSettings", - "metricThreshold", - "productionData", - "referenceData" - ], + "FeaturestoreEntityContainer": { + "description": "DTO object representing feature entity", "type": "object", "allOf": [ { - "$ref": "#/definitions/MonitoringSignalBase" - } - ], - "properties": { - "featureDataTypeOverride": { - "description": "A dictionary that maps feature names to their respective data types.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/MonitoringFeatureDataType" - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "featureImportanceSettings": { - "description": "[Required] The settings for computing feature importance.", - "$ref": "#/definitions/FeatureImportanceSettings", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "metricThreshold": { - "description": "[Required] A list of metrics to calculate and their associated thresholds.", - "$ref": "#/definitions/FeatureAttributionMetricThreshold", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "productionData": { - "description": "[Required] The data which drift will be calculated for.", - "type": "array", - "items": { - "description": "Monitoring input data base definition.", - "$ref": "#/definitions/MonitoringInputDataBase" - }, - "x-ms-mutability": [ - "create", - "read" - ], - "x-ms-identifiers": [] - }, - "referenceData": { - "description": "[Required] The data to calculate drift against.", - "$ref": "#/definitions/MonitoringInputDataBase", - "x-ms-mutability": [ - "create", - "read" - ] + "$ref": "#/definitions/AssetContainer" } - }, - "x-ms-discriminator-value": "FeatureAttributionDrift", - "additionalProperties": false - }, - "FeatureAttributionMetric": { - "enum": [ - "NormalizedDiscountedCumulativeGain" - ], - "type": "string", - "x-ms-enum": { - "name": "FeatureAttributionMetric", - "modelAsString": true, - "values": [ - { - "value": "NormalizedDiscountedCumulativeGain", - "description": "The Normalized Discounted Cumulative Gain metric." - } - ] - }, - "additionalProperties": false - }, - "FeatureAttributionMetricThreshold": { - "required": [ - "metric" ], - "type": "object", - "properties": { - "metric": { - "description": "[Required] The feature attribution metric to calculate.", - "$ref": "#/definitions/FeatureAttributionMetric", + "properties": { + "provisioningState": { + "description": "Provisioning state for the featurestore entity container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, "x-ms-mutability": [ - "create", "read" ] - }, - "threshold": { - "description": "The threshold value. If null, a default value will be set depending on the selected metric.", - "$ref": "#/definitions/MonitoringThreshold", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true } }, + "x-ms-client-name": "FeaturestoreEntityContainerProperties", "additionalProperties": false }, - "FeatureImportanceMode": { - "description": "The mode of operation for computing feature importance.", - "enum": [ - "Disabled", - "Enabled" + "FeaturestoreEntityContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" ], - "type": "string", - "x-ms-enum": { - "name": "FeatureImportanceMode", - "modelAsString": true, - "values": [ - { - "value": "Disabled", - "description": "Disables computing feature importance within a signal." - }, - { - "value": "Enabled", - "description": "Enables computing feature importance within a signal." - } - ] + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturestoreEntityContainer" + } }, + "x-ms-client-name": "FeaturestoreEntityContainer", "additionalProperties": false }, - "FeatureImportanceSettings": { + "FeaturestoreEntityContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityContainer entities.", "type": "object", "properties": { - "mode": { - "description": "The mode of operation for computing feature importance.", - "default": "Disabled", - "$ref": "#/definitions/FeatureImportanceMode" + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", + "type": "string" }, - "targetColumn": { - "description": "The name of the target column within the input data asset.", - "type": "string", - "x-nullable": true + "value": { + "description": "An array of objects of type FeaturestoreEntityContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } } }, "additionalProperties": false }, - "FeatureLags": { - "description": "Flag for generating lags for the numeric features.", - "enum": [ - "None", - "Auto" + "FeaturestoreEntityVersion": { + "description": "DTO object representing feature entity version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } ], - "type": "string", - "x-ms-enum": { - "name": "FeatureLags", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "No feature lags generated." + "properties": { + "indexColumns": { + "description": "Specifies index columns", + "type": "array", + "items": { + "$ref": "#/definitions/IndexColumn" }, - { - "value": "Auto", - "description": "System auto-generates feature lags." - } - ] + "x-nullable": true, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "Provisioning state for the featurestore entity version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + } }, + "x-ms-client-name": "FeaturestoreEntityVersionProperties", "additionalProperties": false }, - "FeatureSubset": { + "FeaturestoreEntityVersionResource": { + "description": "Azure Resource Manager resource envelope.", "required": [ - "features", - "filterType" + "properties" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/MonitoringFeatureFilterBase" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], "properties": { - "features": { - "description": "[Required] The list of features to include.", + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturestoreEntityVersion" + } + }, + "x-ms-client-name": "FeaturestoreEntityVersion", + "additionalProperties": false + }, + "FeaturestoreEntityVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "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 FeaturestoreEntityVersion.", "type": "array", "items": { - "type": "string" - }, - "x-ms-mutability": [ - "create", - "read" - ] + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } } }, - "x-ms-discriminator-value": "FeatureSubset", "additionalProperties": false }, "FeaturizationMode": { @@ -14715,6 +16904,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": { @@ -15701,6 +17907,81 @@ "x-ms-discriminator-value": "Managed", "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 + }, + "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", @@ -16587,6 +18868,52 @@ "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 + }, + "webhooks": { + "description": "Send webhook callback to a service. Key is a user-provided name for the webhook.", + "type": "object", + "additionalProperties": { + "description": "Webhook base", + "$ref": "#/definitions/Webhook", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, "NumericalDataDriftMetric": { "enum": [ "JensenShannonDistance", @@ -19855,6 +22182,50 @@ }, "additionalProperties": false }, + "Webhook": { + "description": "Webhook base", + "required": [ + "webhookType" + ], + "type": "object", + "properties": { + "eventType": { + "description": "Send callback on a specified notification event", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "webhookType": { + "description": "[Required] Specifies the type of service to send a callback", + "$ref": "#/definitions/WebhookType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "webhookType" + }, + "WebhookType": { + "description": "Enum to determine the webhook callback service type.", + "enum": [ + "AzureDevOps" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookType", + "modelAsString": true, + "values": [ + { + "value": "AzureDevOps" + } + ] + }, + "additionalProperties": false + }, "WeekDay": { "description": "Enum of weekday", "enum": [