From b38570283a29ad00915700c1728e237c018ac2cb Mon Sep 17 00:00:00 2001 From: Kayla Seager <1675997+kseager@users.noreply.github.com> Date: Sat, 1 Apr 2023 23:14:45 -0700 Subject: [PATCH] MFE April-preview 2023 staging (#23165) * update mfe.json to latest * update preview examples * make it pretty * createOrUpload example touch-ups * pretty check * POST pendingUpload lint violation, description, and array * spell check fixes * featurestore updates + notification patch updates to align with jobs * fix feature examples * rename PendingUpload -> startPendingUpload + better description * prettier feature get/list.json * update Job-Update example * update descriptions * x-ms-secret-true, remove wasbs and pattern for registries * update examples to remove wasbsUri * update registry refrence and add pattern to featuresetname * temporarily add in registry reference * one more pattern add-on for featuresetname * remove wasbs since that is no longer a part of PR * bump * add empty secrets to examples - can show object but hide secret itself * original-uri -> azure-async-operation * createOrGetPendingUpload -> createOrGetStartPendingUpload * add ms-secret to uri to keep it from breaking relative to GA --------- Co-authored-by: Kayla Ames --- custom-words.txt | 5 +- .../AzureBlobWAccountKey/createOrUpdate.json | 10 +- .../createOrUpdate.json | 10 +- .../createOrUpdate.json | 10 +- .../AzureFileWAccountKey/createOrUpdate.json | 10 +- .../examples/Datastore/get.json | 5 +- .../examples/Datastore/list.json | 5 +- .../examples/Feature/get.json | 40 + .../examples/Feature/list.json | 48 + .../examples/Job/update.json | 154 + .../createOrGetStartPendingUpload.json | 31 + .../createOrGetStartPendingUpload.json | 31 + .../createOrGetStartPendingUpload.json | 31 + .../createOrGetStartPendingUpload.json | 31 + .../FeaturesetVersion/getFeature.json | 26 - .../FeaturesetVersion/listFeatures.json | 30 - .../preview/2023-04-01-preview/mfe.json | 4896 +++++++++++++---- 17 files changed, 4236 insertions(+), 1137 deletions(-) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Feature/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Feature/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Job/update.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json delete mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/getFeature.json delete mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/listFeatures.json diff --git a/custom-words.txt b/custom-words.txt index 8eb786758764..bec9b6076785 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2752,4 +2752,7 @@ remediatable Overprovisioning Unprepares Unpreparing - +Pearsons +Smirnov +Kolmogorov +Wasserstein diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json index 2edd0cf81699..8646f68d4d27 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json @@ -43,7 +43,10 @@ "isDefault": false, "properties": null, "credentials": { - "credentialsType": "AccountKey" + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } }, "datastoreType": "AzureBlob", "accountName": "string", @@ -75,7 +78,10 @@ "isDefault": false, "properties": null, "credentials": { - "credentialsType": "AccountKey" + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } }, "datastoreType": "AzureBlob", "accountName": "string", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json index dbfebe7bf17f..5f11dd53337d 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json @@ -47,7 +47,10 @@ "authorityUrl": "string", "resourceUrl": "string", "tenantId": "00000000-1111-2222-3333-444444444444", - "clientId": "00000000-1111-2222-3333-444444444444" + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } }, "datastoreType": "AzureDataLakeGen1", "storeName": "string" @@ -79,7 +82,10 @@ "authorityUrl": "string", "resourceUrl": "string", "tenantId": "00000000-1111-2222-3333-444444444444", - "clientId": "00000000-1111-2222-3333-444444444444" + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } }, "datastoreType": "AzureDataLakeGen1", "storeName": "string" diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json index d9cb358c044d..065f123a2342 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json @@ -50,7 +50,10 @@ "authorityUrl": "string", "resourceUrl": "string", "tenantId": "00000000-1111-2222-3333-444444444444", - "clientId": "00000000-1111-2222-3333-444444444444" + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } }, "datastoreType": "AzureDataLakeGen2", "filesystem": "string", @@ -85,7 +88,10 @@ "authorityUrl": "string", "resourceUrl": "string", "tenantId": "00000000-1111-2222-3333-444444444444", - "clientId": "00000000-1111-2222-3333-444444444444" + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } }, "datastoreType": "AzureDataLakeGen2", "filesystem": "string", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json index b9f37931f79e..1d9f6037212f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json @@ -42,7 +42,10 @@ }, "properties": null, "credentials": { - "credentialsType": "AccountKey" + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } }, "datastoreType": "AzureFile", "accountName": "string", @@ -73,7 +76,10 @@ }, "properties": null, "credentials": { - "credentialsType": "AccountKey" + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } }, "datastoreType": "AzureFile", "accountName": "string", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/get.json index ca59e977ba75..7ed832397052 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/get.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/get.json @@ -21,7 +21,10 @@ "isDefault": false, "properties": null, "credentials": { - "credentialsType": "AccountKey" + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } }, "datastoreType": "AzureBlob", "accountName": "string", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/list.json index 1bc12234245d..8b9f3fbdfa0a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/list.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Datastore/list.json @@ -31,7 +31,10 @@ "isDefault": false, "properties": null, "credentials": { - "credentialsType": "AccountKey" + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } }, "datastoreType": "AzureBlob", "accountName": "string", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Feature/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Feature/get.json new file mode 100644 index 000000000000..9064ff3d672c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/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-04-01-preview" + }, + "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/preview/2023-04-01-preview/examples/Feature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Feature/list.json new file mode 100644 index 000000000000..cef79c098143 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/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-04-01-preview", + "$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/preview/2023-04-01-preview/examples/Job/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Job/update.json new file mode 100644 index 000000000000..2cedf94e4c54 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Job/update.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-04-01-preview", + "body": { + "properties": { + "notificationSetting": { + "webhooks": { + "string": { + "eventType": "string", + "webhookType": "AzureDevOps" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Canceled", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ], + "webhooks": { + "string": { + "eventType": "string", + "webhookType": "AzureDevOps" + } + } + }, + "secretsConfiguration": { + "string": { + "workspaceSecretName": "string", + "uri": null + } + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "maxInstanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "00cac5bf-6a80-4db4-9c7f-1feebe8c21c8": null + } + }, + "shmSize": "2g", + "dockerArgs": "string" + }, + "codeId": "string", + "command": "string", + "environmentId": "string", + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "uri": "string", + "assetName": "string", + "assetVersion": "string", + "mode": "Upload", + "autoDeleteSetting": { + "condition": "CreatedGreaterThan", + "value": "string" + }, + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "6f851dd9-5a2d-4bd7-8a67-3b0e6a075bdb": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:44", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:44", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..454b1af28613 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "codeName": "string", + "version": "string", + "api-version": "2023-04-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..bb6f8cfdc9b9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2023-04-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "None" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..188d3e2a191c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "modelName": "string", + "version": "string", + "api-version": "2023-04-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "None" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..4b8d7ba691c2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-04-01-preview", + "body": { + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobReferenceForConsumption": { + "blobUri": "https://www.contoso.com/example", + "storageAccountArmId": "string", + "credential": { + "credentialType": "SAS", + "sasUri": "https://www.contoso.com/example" + } + }, + "pendingUploadId": "string", + "pendingUploadType": "TemporaryBlobReference" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/getFeature.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/getFeature.json deleted file mode 100644 index ca95bdabbf5b..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/getFeature.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "test-rg", - "workspaceName": "my-aml-workspace", - "name": "string", - "version": "string", - "api-version": "2023-04-01-preview", - "body": { - "featureName": "string" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "featureName": "string", - "description": "string", - "dataType": "Float", - "tags": { - "string": "string" - } - } - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/listFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/listFeatures.json deleted file mode 100644 index 420d5ccdadb4..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/examples/Workspace/FeaturesetVersion/listFeatures.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "test-rg", - "workspaceName": "my-aml-workspace", - "name": "string", - "version": "string", - "api-version": "2023-04-01-preview", - "$skipToken": "string", - "tags": "string" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "featureName": "string", - "description": "string", - "dataType": "Datetime", - "tags": { - "string": "string" - } - } - ], - "nextLink": "string" - } - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/mfe.json index 187ecb8e12b1..f187354b53bc 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-04-01-preview/mfe.json @@ -27,11 +27,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -69,7 +65,7 @@ "tags": [ "CodeContainer" ], - "summary": "Delete container.", + "summary": "Delete Code container.", "operationId": "RegistryCodeContainers_Delete", "produces": [ "application/json" @@ -82,18 +78,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "codeName", "description": "Container name.", "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" @@ -148,7 +141,7 @@ "tags": [ "CodeContainer" ], - "summary": "Get container.", + "summary": "Get Code container.", "operationId": "RegistryCodeContainers_Get", "produces": [ "application/json" @@ -161,18 +154,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "codeName", "description": "Container name.", "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" @@ -202,7 +192,7 @@ "tags": [ "CodeContainer" ], - "summary": "Create or update container.", + "summary": "Create or update Code container.", "operationId": "RegistryCodeContainers_CreateOrUpdate", "consumes": [ "application/json" @@ -218,11 +208,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -283,7 +269,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -305,18 +291,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "codeName", "description": "Container name.", "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" @@ -380,18 +363,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "codeName", "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -466,18 +446,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "codeName", "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -530,11 +507,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -602,7 +575,79 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "RegistryCodeVersions_CreateOrGetStartPendingUpload", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Pending upload 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": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/createOrGetStartPendingUpload.json" + } } } }, @@ -624,11 +669,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -679,18 +720,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "componentName", "description": "Container name.", "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" @@ -758,18 +796,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "componentName", "description": "Container name.", "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" @@ -815,11 +850,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -880,7 +911,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -902,18 +933,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "componentName", "description": "Container name.", "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" @@ -933,6 +961,12 @@ }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "stage", + "description": "Component stage.", + "type": "string" } ], "responses": { @@ -977,18 +1011,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "componentName", "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -1063,18 +1094,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "componentName", "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -1127,11 +1155,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1199,7 +1223,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -1208,7 +1232,7 @@ "tags": [ "DataContainerRegistry" ], - "summary": "List containers.", + "summary": "List Data containers.", "operationId": "RegistryDataContainers_List", "produces": [ "application/json" @@ -1221,12 +1245,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1304,12 +1323,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1384,11 +1398,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1441,11 +1451,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1528,12 +1534,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1637,12 +1638,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1724,11 +1720,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1788,11 +1780,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -1864,6 +1852,77 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Generate a storage location and credential for the client to upload a data asset to.", + "operationId": "RegistryDataVersions_CreateOrGetStartPendingUpload", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data asset 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" + }, + { + "in": "body", + "name": "body", + "description": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments": { "get": { "tags": [ @@ -1882,11 +1941,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1964,18 +2019,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "environmentName", "description": "Container name.", "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" @@ -2043,18 +2095,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "environmentName", "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" @@ -2100,11 +2149,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -2165,7 +2210,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -2187,11 +2232,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -2289,18 +2330,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "environmentName", "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -2375,18 +2413,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "environmentName", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -2439,11 +2474,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -2511,7 +2542,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -2533,11 +2564,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -2615,18 +2642,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "modelName", "description": "Container name.", "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" @@ -2694,11 +2718,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -2751,11 +2771,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -2816,7 +2832,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -2838,18 +2854,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "modelName", "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" @@ -2964,18 +2977,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "modelName", "description": "Container name.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -3050,18 +3060,15 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", "name": "modelName", "description": "Container name. This is case-sensitive.", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" }, { "in": "path", @@ -3114,11 +3121,7 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "in": "path", - "name": "registryName", - "description": "Name of Azure Machine Learning registry.", - "required": true, - "type": "string" + "$ref": "registries.json#/parameters/RegistryNameParameter" }, { "in": "path", @@ -3186,7 +3189,79 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a model asset to.", + "operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload", + "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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Model 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": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json" + } } } }, @@ -3540,7 +3615,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -3937,7 +4012,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -4260,6 +4335,18 @@ }, { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "hash", + "description": "If specified, return CodeVersion assets with specified content hash value, regardless of name", + "type": "string" + }, + { + "in": "query", + "name": "hashVersion", + "description": "Hash algorithm version when listing by hash", + "type": "string" } ], "responses": { @@ -4478,6 +4565,77 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": { + "post": { + "tags": [ + "CodeVersion" + ], + "summary": "Generate a storage location and credential for the client to upload a code asset to.", + "operationId": "CodeVersions_CreateOrGetStartPendingUpload", + "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" + }, + { + "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": "Pending upload request object", + "required": true, + "schema": { + "$ref": "#/definitions/PendingUploadRequestDto" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PendingUploadResponseDto" + } + } + }, + "x-ms-examples": { + "CreateOrGetStartPendingUpload Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": { "get": { "tags": [ @@ -4773,6 +4931,12 @@ { "$ref": "machineLearningServices.json#/parameters/PaginationParameter" }, + { + "in": "query", + "name": "stage", + "description": "Component stage.", + "type": "string" + }, { "in": "query", "name": "listViewType", @@ -5318,6 +5482,12 @@ "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", "type": "string" }, + { + "in": "query", + "name": "stage", + "description": "data stage", + "type": "string" + }, { "in": "query", "name": "listViewType", @@ -6492,6 +6662,32 @@ } ] } + }, + { + "in": "query", + "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" } ], "responses": { @@ -6518,13 +6714,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { - "delete": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "get": { "tags": [ - "FeaturesetContainer" + "Feature" ], - "summary": "Delete container.", - "operationId": "FeaturesetContainers_Delete", + "summary": "List Features.", + "operationId": "Features_List", "produces": [ "application/json" ], @@ -6540,13 +6736,42 @@ }, { "in": "path", - "name": "name", - "description": "Container name. 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" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "featureName", + "description": "feature name.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Description of the featureset.", + "type": "string" } ], "responses": { @@ -6557,7 +6782,130 @@ } }, "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Feature.": { + "$ref": "./examples/Feature/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": { + "get": { + "tags": [ + "Feature" + ], + "summary": "Get feature.", + "operationId": "Features_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": "featuresetName", + "description": "Feature set 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": "Feature set version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "featureName", + "description": "Feature 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" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeatureResource" + } + } + }, + "x-ms-examples": { + "Get Feature.": { + "$ref": "./examples/Feature/get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": { + "delete": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Delete container.", + "operationId": "FeaturesetContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" }, "202": { "description": "Accepted", @@ -6794,6 +7142,44 @@ } ] } + }, + { + "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": { @@ -7112,7 +7498,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeaturesetVersionBackfillResponse" + "$ref": "#/definitions/FeaturesetJob" } }, "202": { @@ -7143,16 +7529,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/getFeature": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/listMaterializationJobs": { "post": { "tags": [ "FeaturesetVersion" ], - "summary": "Get feature.", - "operationId": "FeaturesetVersions_GetFeature", - "consumes": [ - "application/json" - ], + "summary": "List materialization Jobs.", + "operationId": "FeaturesetVersions_ListMaterializationJobs", "produces": [ "application/json" ], @@ -7169,14 +7552,14 @@ { "in": "path", "name": "name", - "description": "Feature set name. This is case-sensitive.", + "description": "Container name. This is case-sensitive.", "required": true, "type": "string" }, { "in": "path", "name": "version", - "description": "Feature set version identifier. This is case-sensitive.", + "description": "Version identifier. This is case-sensitive.", "required": true, "type": "string" }, @@ -7184,13 +7567,25 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "Feature Name request. This is case-sensitive.", - "required": true, - "schema": { - "$ref": "#/definitions/GetFeatureRequest" - } + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "filters", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "featureWindowStart", + "description": "Start time of the feature window to filter materialization jobs.", + "type": "string" + }, + { + "in": "query", + "name": "featureWindowEnd", + "description": "End time of the feature window to filter materialization jobs.", + "type": "string" } ], "responses": { @@ -7203,24 +7598,27 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/Feature" + "$ref": "#/definitions/FeaturesetJobArmPaginatedResult" } } }, "x-ms-examples": { - "GetFeature Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/getFeature.json" + "ListMaterializationJobs Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/listMaterializationJobs.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/listFeatures": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { + "get": { "tags": [ - "FeaturesetVersion" + "FeaturestoreEntityContainer" ], - "summary": "List Features.", - "operationId": "FeaturesetVersions_ListFeatures", + "summary": "List featurestore entity containers.", + "operationId": "FeaturestoreEntityContainers_List", "produces": [ "application/json" ], @@ -7235,29 +7633,68 @@ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" }, { - "in": "path", - "name": "name", - "description": "Featureset name. This is case-sensitive.", - "required": true, - "type": "string" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "in": "path", - "name": "version", - "description": "Featureset Version identifier. This is case-sensitive.", - "required": true, + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", "type": "string" }, { - "$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" + } + ] + } }, { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 }, { "in": "query", - "name": "$tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "name": "name", + "description": "name for the featurestore entity", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the featurestore entity", + "type": "string" + }, + { + "in": "query", + "name": "createdBy", + "description": "createdBy user name", "type": "string" } ], @@ -7271,13 +7708,13 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/FeatureArmPaginatedResult" + "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" } } }, "x-ms-examples": { - "ListFeatures Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/listFeatures.json" + "List Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" } }, "x-ms-pageable": { @@ -7285,177 +7722,10 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/listMaterializationJobs": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { + "delete": { "tags": [ - "FeaturesetVersion" - ], - "summary": "List materialization Jobs.", - "operationId": "FeaturesetVersions_ListMaterializationJobs", - "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" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "in": "query", - "name": "filters", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "featureWindowStart", - "description": "Start time of the feature window to filter materialization jobs.", - "type": "string" - }, - { - "in": "query", - "name": "featureWindowEnd", - "description": "End time of the feature window to filter materialization jobs.", - "type": "string" - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturesetJobArmPaginatedResult" - } - } - }, - "x-ms-examples": { - "ListMaterializationJobs Workspace Featureset Version.": { - "$ref": "./examples/Workspace/FeaturesetVersion/listMaterializationJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": { - "get": { - "tags": [ - "FeaturestoreEntityContainer" - ], - "summary": "List featurestore entity containers.", - "operationId": "FeaturestoreEntityContainers_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": "tags", - "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", - "type": "string" - }, - { - "in": "query", - "name": "listViewType", - "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", - "type": "string", - "default": "ActiveOnly", - "enum": [ - "ActiveOnly", - "ArchivedOnly", - "All" - ], - "x-ms-enum": { - "name": "ListViewType", - "modelAsString": true, - "values": [ - { - "value": "ActiveOnly" - }, - { - "value": "ArchivedOnly" - }, - { - "value": "All" - } - ] - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult" - } - } - }, - "x-ms-examples": { - "List Workspace Featurestore Entity Container.": { - "$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": { - "delete": { - "tags": [ - "FeaturestoreEntityContainer" + "FeaturestoreEntityContainer" ], "summary": "Delete container.", "operationId": "FeaturestoreEntityContainers_Delete", @@ -7728,6 +7998,44 @@ } ] } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "versionName", + "description": "name for the featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "version", + "description": "featurestore entity version", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "description for the feature entity 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": { @@ -8238,6 +8546,68 @@ } } }, + "patch": { + "tags": [ + "Job" + ], + "summary": "Updates a Job.", + "operationId": "Jobs_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": "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": "Job definition to apply during the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialJobBasePartialResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + }, + "x-ms-examples": { + "Update Job.": { + "$ref": "./examples/Job/update.json" + } + } + }, "put": { "tags": [ "Job" @@ -8640,7 +9010,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -9185,6 +9555,12 @@ "description": "Name of the feed.", "type": "string" }, + { + "in": "query", + "name": "stage", + "description": "Model stage", + "type": "string" + }, { "in": "query", "name": "listViewType", @@ -9919,7 +10295,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -10325,7 +10701,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } }, @@ -10613,7 +10989,7 @@ "tags": [ "OnlineEndpoint" ], - "summary": "Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.", + "summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.", "operationId": "OnlineEndpoints_GetToken", "produces": [ "application/json" @@ -10945,7 +11321,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "azure-async-operation" } } } @@ -10994,6 +11370,19 @@ "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", @@ -11024,8 +11413,18 @@ } ], "properties": { + "autoDeleteSetting": { + "description": "Specifies the lifecycle setting of managed data asset.", + "$ref": "#/definitions/AutoDeleteSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, "isAnonymous": { - "description": "If the name version are system generated (anonymous registration).", + "description": "If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous", "default": false, "type": "boolean", "x-ms-mutability": [ @@ -11034,7 +11433,7 @@ ] }, "isArchived": { - "description": "Is the asset archived?", + "description": "Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived", "default": false, "type": "boolean", "x-ms-mutability": [ @@ -11124,6 +11523,16 @@ "type": "string", "x-nullable": true }, + "autoDeleteSetting": { + "description": "Auto delete setting of output data asset.", + "$ref": "#/definitions/AutoDeleteSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, "mode": { "description": "Output Asset Delivery Mode.", "default": "ReadWriteMount", @@ -11192,35 +11601,63 @@ }, "discriminator": "referenceType" }, - "AutoForecastHorizon": { - "description": "Forecast horizon determined automatically by system.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ForecastHorizon" - } + "AutoDeleteCondition": { + "enum": [ + "CreatedGreaterThan", + "LastAccessedGreaterThan" ], - "x-ms-discriminator-value": "Auto", + "type": "string", + "x-ms-enum": { + "name": "AutoDeleteCondition", + "modelAsString": true, + "values": [ + { + "value": "CreatedGreaterThan" + }, + { + "value": "LastAccessedGreaterThan" + } + ] + }, "additionalProperties": false }, - "AutologgerSettings": { - "description": "Settings for Autologger.", - "required": [ - "mlflowAutologger" - ], + "AutoDeleteSetting": { "type": "object", "properties": { - "mlflowAutologger": { - "description": "[Required] Indicates whether mlflow autologger is enabled.", - "$ref": "#/definitions/MLFlowAutologgerState", + "condition": { + "description": "When to check if an asset is expired", + "default": "CreatedGreaterThan", + "$ref": "#/definitions/AutoDeleteCondition", "x-ms-mutability": [ "create", - "read" + "read", + "update" ] + }, + "value": { + "description": "Expiration condition value.", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true } }, "additionalProperties": false }, + "AutoForecastHorizon": { + "description": "Forecast horizon determined automatically by system.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, "AutoMLJob": { "description": "AutoMLJob class.\r\nUse this class for executing AutoML tasks like Classification/Regression etc.\r\nSee TaskType enum for all the tasks supported.", "required": [ @@ -11391,6 +11828,34 @@ "x-ms-discriminator-value": "Auto", "additionalProperties": false }, + "AutologgerSettings": { + "description": "Settings for Autologger.", + "required": [ + "mlflowAutologger" + ], + "type": "object", + "properties": { + "mlflowAutologger": { + "description": "[Required] Indicates whether mlflow autologger is enabled.", + "$ref": "#/definitions/MLFlowAutologgerState", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "AzMonMonitoringAlertNotificationSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringAlertNotificationSettingsBase" + } + ], + "x-ms-discriminator-value": "AzureMonitor", + "additionalProperties": false + }, "AzureBlobDatastore": { "description": "Azure Blob datastore configuration.", "type": "object", @@ -11578,6 +12043,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": [ @@ -12060,6 +12536,9 @@ }, "BatchPipelineComponentDeploymentConfiguration": { "description": "Properties for a Batch Pipeline Component Deployment.", + "required": [ + "deploymentConfigurationType" + ], "type": "object", "allOf": [ { @@ -12129,6 +12608,28 @@ "x-ms-discriminator-value": "Bayesian", "additionalProperties": false }, + "BlobReferenceForConsumptionDto": { + "type": "object", + "properties": { + "blobUri": { + "format": "uri", + "description": "Blob URI path for client to upload data.\r\nExample: https://blob.windows.core.net/Container/Path", + "type": "string", + "x-nullable": true + }, + "credential": { + "description": "Credential info to access storage account", + "$ref": "#/definitions/PendingUploadCredentialDto", + "x-nullable": true + }, + "storageAccountArmId": { + "description": "Arm ID of the storage account to use", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, "BlockedTransformers": { "description": "Enum for all classification models supported by AutoML.", "enum": [ @@ -12223,6 +12724,156 @@ }, "additionalProperties": false }, + "CategoricalDataDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "PearsonsChiSquaredTest" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalDataDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "PearsonsChiSquaredTest", + "description": "The Pearsons Chi Squared Test metric." + } + ] + }, + "additionalProperties": false + }, + "CategoricalDataDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical data drift metric to calculate.", + "$ref": "#/definitions/CategoricalDataDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CategoricalDataQualityMetric": { + "enum": [ + "NullValueRate", + "DataTypeErrorRate", + "OutOfBoundsRate" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalDataQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "NullValueRate", + "description": "Calculates the rate of null values." + }, + { + "value": "DataTypeErrorRate", + "description": "Calculates the rate of data type errors." + }, + { + "value": "OutOfBoundsRate", + "description": "Calculates the rate values are out of bounds." + } + ] + }, + "additionalProperties": false + }, + "CategoricalDataQualityMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical data quality metric to calculate.", + "$ref": "#/definitions/CategoricalDataQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, + "CategoricalPredictionDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "PearsonsChiSquaredTest" + ], + "type": "string", + "x-ms-enum": { + "name": "CategoricalPredictionDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "PearsonsChiSquaredTest", + "description": "The Pearsons Chi Squared Test metric." + } + ] + }, + "additionalProperties": false + }, + "CategoricalPredictionDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The categorical prediction drift metric to calculate.", + "$ref": "#/definitions/CategoricalPredictionDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Categorical", + "additionalProperties": false + }, "CertificateDatastoreCredentials": { "description": "Certificate datastore credentials configuration.", "required": [ @@ -12326,6 +12977,61 @@ "x-ms-discriminator-value": "Classification", "additionalProperties": false }, + "ClassificationModelPerformanceMetric": { + "enum": [ + "Accuracy", + "Precision", + "Recall", + "F1Score" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationModelPerformanceMetric", + "modelAsString": true, + "values": [ + { + "value": "Accuracy", + "description": "Calculates the accuracy of the model predictions." + }, + { + "value": "Precision", + "description": "Calculates the precision of the model predictions." + }, + { + "value": "Recall", + "description": "Calculates the recall of the model predictions." + }, + { + "value": "F1Score", + "description": "Calculates the F1 score of the model predictions." + } + ] + }, + "additionalProperties": false + }, + "ClassificationModelPerformanceMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ModelPerformanceMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The classification model performance to calculate.", + "$ref": "#/definitions/ClassificationModelPerformanceMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Classification", + "additionalProperties": false + }, "ClassificationModels": { "description": "Enum for all classification models supported by AutoML.", "enum": [ @@ -12382,7 +13088,7 @@ }, { "value": "RandomForest", - "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the 'bagging' method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the bagging method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." }, { "value": "ExtremeRandomTrees", @@ -12696,6 +13402,33 @@ }, "additionalProperties": false }, + "Collection": { + "type": "object", + "properties": { + "clientId": { + "description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.", + "type": "string", + "x-nullable": true + }, + "dataCollectionMode": { + "description": "Enable or disable data collection.", + "default": "Disabled", + "$ref": "#/definitions/DataCollectionMode" + }, + "dataId": { + "description": "The data asset arm resource id. Client side will ensure data asset is pointing to the blob storage, and backend will collect data to the blob storage.", + "type": "string", + "x-nullable": true + }, + "samplingRate": { + "format": "double", + "description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.", + "default": 1, + "type": "number" + } + }, + "additionalProperties": false + }, "ColumnTransformer": { "description": "Column transformer parameters.", "type": "object", @@ -12758,7 +13491,7 @@ ] }, "distribution": { - "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, Ray, or null.", "$ref": "#/definitions/DistributionConfiguration", "x-ms-mutability": [ "create", @@ -12961,6 +13694,11 @@ "x-ms-mutability": [ "read" ] + }, + "stage": { + "description": "Stage in the component lifecycle", + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "ComponentVersionProperties", @@ -13004,18 +13742,6 @@ }, "additionalProperties": false }, - "MaterializationComputeResource": { - "description": "Dto object representing compute resource", - "type": "object", - "properties": { - "instanceType": { - "description": "Specifies the instance type", - "type": "string", - "x-nullable": true - } - }, - "additionalProperties": false - }, "ContainerResourceRequirements": { "description": "Resource requirements for each container instance within an online deployment.", "type": "object", @@ -13085,6 +13811,29 @@ }, "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": [ @@ -13216,6 +13965,34 @@ "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", + "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 + } + }, + "additionalProperties": false + }, "CustomModelJobInput": { "type": "object", "allOf": [ @@ -13242,6 +14019,57 @@ "x-ms-discriminator-value": "custom_model", "additionalProperties": false }, + "CustomMonitoringSignal": { + "required": [ + "componentId", + "metricThresholds" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "componentId": { + "description": "[Required] ARM resource ID of the component resource 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": { + "$ref": "#/definitions/MonitoringInputData", + "x-nullable": 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/CustomMetricThreshold" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, "CustomNCrossValidations": { "description": "N-Cross validations are specified by user.", "required": [ @@ -13326,6 +14154,53 @@ "x-ms-discriminator-value": "Custom", "additionalProperties": false }, + "DataCollectionMode": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DataCollectionMode", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "DataCollector": { + "required": [ + "collections" + ], + "type": "object", + "properties": { + "collections": { + "description": "[Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string.\r\nModel data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Collection", + "x-nullable": true + } + }, + "requestLogging": { + "description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.", + "$ref": "#/definitions/RequestLogging", + "x-nullable": true + }, + "rollingRate": { + "description": "When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file.\r\nIf the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/.\r\nIf it's day, all data will be collected in blob path /yyyy/MM/dd/.\r\nThe other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.", + "default": "Hour", + "$ref": "#/definitions/RollingRateType" + } + }, + "additionalProperties": false + }, "DataContainer": { "description": "Container for data asset versions.", "required": [ @@ -13388,180 +14263,261 @@ }, "additionalProperties": false }, - "DataPathAssetReference": { - "description": "Reference to an asset via its path in a datastore.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetReferenceBase" - } + "DataDriftMetricThresholdBase": { + "required": [ + "dataType" ], + "type": "object", "properties": { - "datastoreId": { - "description": "ARM resource ID of the datastore where the asset is located.", - "type": "string", - "x-nullable": true + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] }, - "path": { - "description": "The path of the file/directory in the datastore.", - "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 } }, - "x-ms-discriminator-value": "DataPath", - "additionalProperties": false + "discriminator": "dataType" }, - "DatasetExportSummary": { + "DataDriftMonitoringSignal": { + "required": [ + "baselineData", + "metricThresholds", + "targetData" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportSummary" + "$ref": "#/definitions/MonitoringSignalBase" } ], "properties": { - "labeledAssetName": { - "description": "The unique name of the labeled data asset.", - "type": "string", - "readOnly": true, + "baselineData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataSegment": { + "description": "The data segment used for scoping on a subset of the data population.", + "$ref": "#/definitions/MonitoringDataSegment", + "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": [] + }, + "targetData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "x-ms-discriminator-value": "Dataset", + "x-ms-discriminator-value": "DataDrift", "additionalProperties": false }, - "Datastore": { - "description": "Base definition for datastore contents configuration.", - "required": [ - "credentials", - "datastoreType" - ], + "DataImport": { "type": "object", "allOf": [ { - "$ref": "#/definitions/ResourceBase" + "$ref": "#/definitions/DataVersionBase" } ], "properties": { - "credentials": { - "description": "[Required] Account credentials.", - "$ref": "#/definitions/DatastoreCredentials" - }, - "datastoreType": { - "description": "[Required] Storage type backing the datastore.", - "$ref": "#/definitions/DatastoreType" + "assetName": { + "description": "Name of the asset for data import job to create", + "type": "string", + "x-nullable": true }, - "isDefault": { - "description": "Readonly property to indicate if datastore is the workspace default datastore", - "type": "boolean", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "source": { + "description": "Source data of the asset to import from", + "$ref": "#/definitions/DataImportSource", + "x-nullable": true } }, - "discriminator": "datastoreType", - "x-ms-client-name": "DatastoreProperties" + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false }, - "DatastoreCredentials": { - "description": "Base definition for datastore credentials.", + "DataImportSource": { "required": [ - "credentialsType" + "sourceType" ], "type": "object", "properties": { - "credentialsType": { - "description": "[Required] Credential type used to authentication with storage.", - "$ref": "#/definitions/CredentialsType" + "connection": { + "description": "Workspace connection for data import source storage", + "type": "string", + "x-nullable": true + }, + "sourceType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataImportSourceType", + "x-ms-mutability": [ + "create", + "read" + ] } }, - "discriminator": "credentialsType" + "discriminator": "sourceType" }, - "DatastoreResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" + "DataImportSourceType": { + "description": "Enum to determine the type of data.", + "enum": [ + "database", + "file_system" ], + "type": "string", + "x-ms-enum": { + "name": "DataImportSourceType", + "modelAsString": true, + "values": [ + { + "value": "database" + }, + { + "value": "file_system" + } + ] + }, + "additionalProperties": false + }, + "DataPathAssetReference": { + "description": "Reference to an asset via its path in a datastore.", "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "#/definitions/AssetReferenceBase" } ], "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/Datastore" + "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": "Datastore", + "x-ms-discriminator-value": "DataPath", "additionalProperties": false }, - "DatastoreResourceArmPaginatedResult": { - "description": "A paginated list of Datastore entities.", + "DataQualityMetricThresholdBase": { + "required": [ + "dataType" + ], "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of Datastore 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 Datastore.", - "type": "array", - "items": { - "$ref": "#/definitions/DatastoreResource" - } + "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" }, - "DatastoreSecrets": { - "description": "Base definition for datastore secrets.", + "DataQualityMonitoringSignal": { "required": [ - "secretsType" + "baselineData", + "metricThresholds", + "targetData" ], "type": "object", - "properties": { - "secretsType": { - "description": "[Required] Credential type used to authentication with storage.", - "$ref": "#/definitions/SecretsType" + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" } - }, - "discriminator": "secretsType" - }, - "DatastoreType": { - "description": "Enum to determine the datastore contents type.", - "enum": [ - "AzureBlob", - "AzureDataLakeGen1", - "AzureDataLakeGen2", - "AzureFile", - "Hdfs" ], - "type": "string", - "x-ms-enum": { - "name": "DatastoreType", - "modelAsString": true, - "values": [ - { - "value": "AzureBlob" - }, - { - "value": "AzureDataLakeGen1" - }, - { - "value": "AzureDataLakeGen2" - }, - { - "value": "AzureFile" + "properties": { + "baselineData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "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" }, - { - "value": "Hdfs" - } - ] + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "targetData": { + "description": "[Required] The data produced by the production service which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] + } }, + "x-ms-discriminator-value": "DataQuality", "additionalProperties": false }, "DataType": { @@ -13619,6 +14575,20 @@ "create", "read" ] + }, + "intellectualProperty": { + "description": "Intellectual Property details. Used if data is an Intellectual Property.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "stage": { + "description": "Stage in the data lifecycle assigned to this data asset", + "type": "string", + "x-nullable": true } }, "discriminator": "dataType", @@ -13662,118 +14632,324 @@ }, "additionalProperties": false }, - "DefaultScaleSettings": { + "DatabaseSource": { "type": "object", "allOf": [ { - "$ref": "#/definitions/OnlineScaleSettings" + "$ref": "#/definitions/DataImportSource" } ], - "x-ms-discriminator-value": "Default", - "additionalProperties": false - }, - "DeploymentLogs": { - "type": "object", "properties": { - "content": { - "description": "The retrieved online deployment logs.", + "query": { + "description": "SQL Query statement for data import Database source", + "type": "string", + "x-nullable": true + }, + "storedProcedure": { + "description": "SQL StoredProcedure on data import Database source", + "type": "string", + "x-nullable": true + }, + "storedProcedureParams": { + "description": "SQL StoredProcedure parameters", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "tableName": { + "description": "Name of the table on data import Database source", "type": "string", "x-nullable": true } }, + "x-ms-discriminator-value": "database", "additionalProperties": false }, - "DeploymentLogsRequest": { + "DatasetExportSummary": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], "properties": { - "containerType": { - "description": "The type of container to retrieve logs from.", - "default": "InferenceServer", - "$ref": "#/definitions/ContainerType" - }, - "tail": { - "format": "int32", - "description": "The maximum number of lines to tail.", - "type": "integer", + "labeledAssetName": { + "description": "The unique name of the labeled data asset.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], "x-nullable": true } }, + "x-ms-discriminator-value": "Dataset", "additionalProperties": false }, - "DeploymentProvisioningState": { - "description": "Possible values for DeploymentProvisioningState.", - "enum": [ - "Creating", - "Deleting", - "Scaling", - "Updating", - "Succeeded", - "Failed", - "Canceled" + "Datastore": { + "description": "Base definition for datastore contents configuration.", + "required": [ + "credentials", + "datastoreType" ], - "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" + "$ref": "#/definitions/ResourceBase" } ], - "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", + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" + }, + "datastoreType": { + "description": "[Required] Storage type backing the datastore.", + "$ref": "#/definitions/DatastoreType" + }, + "intellectualProperty": { + "description": "Intellectual Property details.", + "$ref": "#/definitions/IntellectualProperty", "x-ms-mutability": [ "create", "read" - ] - } - }, - "discriminator": "distributionType" - }, - "DistributionType": { - "description": "Enum to determine the job distribution type.", + ], + "x-nullable": true + }, + "isDefault": { + "description": "Readonly property to indicate if datastore is the workspace default datastore", + "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "datastoreType", + "x-ms-client-name": "DatastoreProperties" + }, + "DatastoreCredentials": { + "description": "Base definition for datastore credentials.", + "required": [ + "credentialsType" + ], + "type": "object", + "properties": { + "credentialsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/CredentialsType" + } + }, + "discriminator": "credentialsType" + }, + "DatastoreResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Datastore" + } + }, + "x-ms-client-name": "Datastore", + "additionalProperties": false + }, + "DatastoreResourceArmPaginatedResult": { + "description": "A paginated list of Datastore entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Datastore objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Datastore.", + "type": "array", + "items": { + "$ref": "#/definitions/DatastoreResource" + } + } + }, + "additionalProperties": false + }, + "DatastoreSecrets": { + "description": "Base definition for datastore secrets.", + "required": [ + "secretsType" + ], + "type": "object", + "properties": { + "secretsType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/SecretsType" + } + }, + "discriminator": "secretsType" + }, + "DatastoreType": { + "description": "Enum to determine the datastore contents type.", + "enum": [ + "AzureBlob", + "AzureDataLakeGen1", + "AzureDataLakeGen2", + "AzureFile", + "Hdfs", + "OneLake" + ], + "type": "string", + "x-ms-enum": { + "name": "DatastoreType", + "modelAsString": true, + "values": [ + { + "value": "AzureBlob" + }, + { + "value": "AzureDataLakeGen1" + }, + { + "value": "AzureDataLakeGen2" + }, + { + "value": "AzureFile" + }, + { + "value": "Hdfs" + }, + { + "value": "OneLake" + } + ] + }, + "additionalProperties": false + }, + "DefaultScaleSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineScaleSettings" + } + ], + "x-ms-discriminator-value": "Default", + "additionalProperties": false + }, + "DeploymentLogs": { + "type": "object", + "properties": { + "content": { + "description": "The retrieved online deployment logs.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentLogsRequest": { + "type": "object", + "properties": { + "containerType": { + "description": "The type of container to retrieve logs from.", + "default": "InferenceServer", + "$ref": "#/definitions/ContainerType" + }, + "tail": { + "format": "int32", + "description": "The maximum number of lines to tail.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "DeploymentProvisioningState": { + "description": "Possible values for DeploymentProvisioningState.", + "enum": [ + "Creating", + "Deleting", + "Scaling", + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "DeploymentProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Scaling" + }, + { + "value": "Updating" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "DeploymentResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" + } + ], + "additionalProperties": false + }, + "DistributionConfiguration": { + "description": "Base definition for job distribution configuration.", + "required": [ + "distributionType" + ], + "type": "object", + "properties": { + "distributionType": { + "description": "[Required] Specifies the type of distribution framework.", + "$ref": "#/definitions/DistributionType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "distributionType" + }, + "DistributionType": { + "description": "Enum to determine the job distribution type.", "enum": [ "PyTorch", "TensorFlow", - "Mpi" + "Mpi", + "Ray" ], "type": "string", "x-ms-enum": { @@ -13788,6 +14964,9 @@ }, { "value": "Mpi" + }, + { + "value": "Ray" } ] }, @@ -13864,6 +15043,27 @@ }, "additionalProperties": false }, + "EmailMonitoringAlertNotificationSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringAlertNotificationSettingsBase" + } + ], + "properties": { + "emailNotificationSetting": { + "description": "Configuration for notification.", + "$ref": "#/definitions/NotificationSetting", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Email", + "additionalProperties": false + }, "EmailNotificationEnableType": { "description": "Enum to determine the email notification type.", "enum": [ @@ -14297,6 +15497,15 @@ "read" ] }, + "intellectualProperty": { + "description": "Intellectual Property details. Used if environment is an Intellectual Property.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "osType": { "description": "The OS type of the environment.", "default": "Linux", @@ -14313,6 +15522,11 @@ "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", @@ -14440,49 +15654,115 @@ "Feature": { "description": "Dto object representing feature", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], "properties": { "dataType": { "description": "Specifies type", "default": "String", "$ref": "#/definitions/FeatureDataType" }, - "description": { - "description": "Specifies description", - "type": "string", - "x-nullable": true - }, "featureName": { "description": "Specifies name", "type": "string", "x-nullable": true + } + }, + "x-ms-client-name": "FeatureProperties", + "additionalProperties": false + }, + "FeatureAttributionDriftMonitoringSignal": { + "required": [ + "baselineData", + "metricThreshold", + "modelType", + "targetData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "baselineData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] }, - "tags": { - "description": "Specifies tags", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "x-nullable": true + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/FeatureAttributionMetricThreshold", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "modelType": { + "description": "[Required] The type of task the model performs.", + "$ref": "#/definitions/MonitoringModelType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "targetData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] } }, + "x-ms-discriminator-value": "FeatureAttributionDrift", "additionalProperties": false }, - "FeatureArmPaginatedResult": { - "description": "A paginated list of Feature entities.", + "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": { - "nextLink": { - "description": "The link to the next page of Feature objects. If null, there are no additional pages.", - "type": "string" + "metric": { + "description": "[Required] The feature attribution metric to calculate.", + "$ref": "#/definitions/FeatureAttributionMetric", + "x-ms-mutability": [ + "create", + "read" + ] }, - "value": { - "description": "An array of objects of type Feature.", - "type": "array", - "items": { - "$ref": "#/definitions/Feature" - }, - "x-ms-identifiers": [] + "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 @@ -14554,6 +15834,90 @@ }, "additionalProperties": false }, + "FeatureResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Feature" + } + }, + "x-ms-client-name": "Feature", + "additionalProperties": false + }, + "FeatureResourceArmPaginatedResult": { + "description": "A paginated list of Feature entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Feature objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Feature.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureResource" + } + } + }, + "additionalProperties": false + }, + "FeatureSubset": { + "required": [ + "features", + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "properties": { + "features": { + "description": "[Required] The list of features to include.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "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 + }, "FeaturesetContainer": { "description": "Dto object representing feature set", "type": "object", @@ -14786,18 +16150,6 @@ }, "additionalProperties": false }, - "FeaturesetVersionBackfillResponse": { - "description": "Response payload for creating a backfill request for a given feature set version", - "type": "object", - "properties": { - "jobId": { - "description": "Job id created as part of request", - "type": "string", - "x-nullable": true - } - }, - "additionalProperties": false - }, "FeaturesetVersionResource": { "description": "Azure Resource Manager resource envelope.", "required": [ @@ -14920,6 +16272,11 @@ "x-ms-mutability": [ "read" ] + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "FeaturestoreEntityVersionProperties", @@ -14983,25 +16340,6 @@ }, "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 - }, "FeaturizationMode": { "description": "Featurization mode - determines data featurization mode.", "enum": [ @@ -15042,6 +16380,23 @@ }, "additionalProperties": false }, + "FileSystemSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataImportSource" + } + ], + "properties": { + "path": { + "description": "Path on data import FileSystem source", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "file_system", + "additionalProperties": false + }, "FlavorData": { "type": "object", "properties": { @@ -15219,7 +16574,7 @@ }, { "value": "RandomForest", - "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the 'bagging' method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the bagging method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." }, { "value": "ExtremeRandomTrees", @@ -15290,6 +16645,14 @@ "default": "None", "$ref": "#/definitions/FeatureLags" }, + "featuresUnknownAtForecastTime": { + "description": "The feature columns that are available for training but unknown at the time of forecast/inference.\r\nIf features_unknown_at_forecast_time is not set, it is assumed that all the feature columns in the dataset are known at inference time.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, "forecastHorizon": { "description": "The desired maximum forecast horizon in units of time-series frequency.", "default": "{\"Mode\": \"Custom\", \"Value\": 1}", @@ -15374,18 +16737,6 @@ }, "additionalProperties": false }, - "GetFeatureRequest": { - "description": "Request payload to retrieve feature information from a given feature set version", - "type": "object", - "properties": { - "featureName": { - "description": "Specifies name of the feature.", - "type": "string", - "x-nullable": true - } - }, - "additionalProperties": false - }, "Goal": { "description": "Defines supported metric goals for hyperparameter tuning", "enum": [ @@ -15666,7 +17017,7 @@ "additionalProperties": false }, "ImageModelDistributionSettings": { - "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n\r\nAll distributions can be specified as distribution_name(min, max) or choice(val1, val2, ..., valn)\r\nwhere distribution name can be: uniform, quniform, loguniform, etc\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nAll distributions can be specified as distribution_name(min, max) or choice(val1, val2, ..., valn)\r\nwhere distribution name can be: uniform, quniform, loguniform, etc\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", "properties": { "amsGradient": { @@ -15841,7 +17192,7 @@ "additionalProperties": false }, "ImageModelDistributionSettingsClassification": { - "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", "allOf": [ { @@ -15877,7 +17228,7 @@ "additionalProperties": false }, "ImageModelDistributionSettingsObjectDetection": { - "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "description": "Distribution expressions to sweep over values of model settings.\r\n\r\nSome examples are:\r\n```\r\nModelName = \"choice('seresnext', 'resnest50')\";\r\nLearningRate = \"uniform(0.001, 0.01)\";\r\nLayersToFreeze = \"choice(0, 2)\";\r\n```\r\nFor more details on how to compose distribution expressions please check the documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\r\nFor more information on the available settings please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", "type": "object", "allOf": [ { @@ -16218,6 +17569,16 @@ "type": "integer", "x-nullable": true }, + "logTrainingMetrics": { + "description": "Enable computing and logging training metrics.", + "default": "Enable", + "$ref": "#/definitions/LogTrainingMetrics" + }, + "logValidationLoss": { + "description": "Enable computing and logging validation loss.", + "default": "Disable", + "$ref": "#/definitions/LogValidationLoss" + }, "maxSize": { "format": "int32", "description": "Maximum size of the image to be rescaled before feeding it to the backbone.\r\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", @@ -16373,6 +17734,31 @@ }, "additionalProperties": false }, + "ImportDataAction": { + "required": [ + "actionType", + "dataImportDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "dataImportDefinition": { + "description": "[Required] Defines Schedule action definition details.", + "$ref": "#/definitions/DataImport", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "ImportData", + "additionalProperties": false + }, "IncrementalDataRefresh": { "description": "Whether IncrementalDataRefresh is enabled", "enum": [ @@ -16551,6 +17937,27 @@ }, "additionalProperties": false }, + "IntellectualProperty": { + "description": "Intellectual Property details for a resource.", + "required": [ + "publisher" + ], + "type": "object", + "properties": { + "protectionLevel": { + "description": "Protection level of the Intellectual Property.", + "default": "All", + "$ref": "#/definitions/ProtectionLevel" + }, + "publisher": { + "description": "[Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, "JobBase": { "description": "Base definition for a job.", "required": [ @@ -16629,6 +18036,20 @@ "notificationSetting": { "description": "Notification setting for the job", "$ref": "#/definitions/NotificationSetting", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "secretsConfiguration": { + "description": "Configuration for secrets to be made available during runtime.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SecretConfiguration", + "x-nullable": true + }, "x-ms-mutability": [ "create", "read" @@ -17664,8 +19085,18 @@ "x-ms-discriminator-value": "Text", "additionalProperties": false }, - "LearningRateScheduler": { - "description": "Learning rate scheduler enum.", + "LakeHouseArtifact": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OneLakeArtifact" + } + ], + "x-ms-discriminator-value": "LakeHouse", + "additionalProperties": false + }, + "LearningRateScheduler": { + "description": "Learning rate scheduler enum.", "enum": [ "None", "WarmupCosine", @@ -17738,6 +19169,50 @@ "x-ms-discriminator-value": "literal", "additionalProperties": false }, + "LogTrainingMetrics": { + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "LogTrainingMetrics", + "modelAsString": true, + "values": [ + { + "value": "Enable", + "description": "Enable compute and log training metrics." + }, + { + "value": "Disable", + "description": "Disable compute and log training metrics." + } + ] + }, + "additionalProperties": false + }, + "LogValidationLoss": { + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "LogValidationLoss", + "modelAsString": true, + "values": [ + { + "value": "Enable", + "description": "Enable compute and log validation metrics." + }, + { + "value": "Disable", + "description": "Disable compute and log validation metrics." + } + ] + }, + "additionalProperties": false + }, "LogVerbosity": { "description": "Enum for setting log verbosity.", "enum": [ @@ -17781,154 +19256,6 @@ }, "additionalProperties": false }, - "ManagedIdentity": { - "description": "Managed identity configuration.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IdentityConfiguration" - } - ], - "properties": { - "clientId": { - "format": "uuid", - "description": "Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "objectId": { - "format": "uuid", - "description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - }, - "resourceId": { - "description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.", - "type": "string", - "x-ms-mutability": [ - "create", - "read" - ], - "x-nullable": true - } - }, - "x-ms-discriminator-value": "Managed", - "additionalProperties": false - }, - "ManagedOnlineDeployment": { - "description": "Properties specific to a ManagedOnlineDeployment.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/OnlineDeployment" - } - ], - "x-ms-discriminator-value": "Managed", - "additionalProperties": false - }, - "MaterializationSettings": { - "type": "object", - "properties": { - "notification": { - "description": "Specifies the notification details", - "$ref": "#/definitions/NotificationSetting", - "x-nullable": true - }, - "resource": { - "description": "Specifies the compute resource settings", - "$ref": "#/definitions/MaterializationComputeResource", - "x-nullable": true - }, - "schedule": { - "description": "Specifies the schedule details", - "$ref": "#/definitions/RecurrenceTrigger", - "x-nullable": true - }, - "sparkConfiguration": { - "description": "Specifies the spark compute settings", - "type": "object", - "additionalProperties": { - "type": "string", - "x-nullable": true - }, - "x-nullable": true - }, - "storeType": { - "description": "Specifies the stores to which materialization should happen", - "default": "None", - "$ref": "#/definitions/MaterializationStoreType" - } - }, - "additionalProperties": false - }, - "MaterializationStoreType": { - "enum": [ - "None", - "Online", - "Offline", - "OnlineAndOffline" - ], - "type": "string", - "x-ms-enum": { - "name": "MaterializationStoreType", - "modelAsString": true, - "values": [ - { - "value": "None" - }, - { - "value": "Online" - }, - { - "value": "Offline" - }, - { - "value": "OnlineAndOffline" - } - ] - }, - "additionalProperties": false - }, - "MedianStoppingPolicy": { - "description": "Defines an early termination policy based on running averages of the primary metric of all runs", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EarlyTerminationPolicy" - } - ], - "x-ms-discriminator-value": "MedianStopping", - "additionalProperties": false - }, - "MediaType": { - "description": "Media type of data asset.", - "enum": [ - "Image", - "Text" - ], - "type": "string", - "x-ms-enum": { - "name": "MediaType", - "modelAsString": true, - "values": [ - { - "value": "Image" - }, - { - "value": "Text" - } - ] - }, - "additionalProperties": false - }, "MLAssistConfiguration": { "description": "Labeling MLAssist configuration definition", "required": [ @@ -18116,50 +19443,210 @@ "x-ms-discriminator-value": "mltable", "additionalProperties": false }, - "ModelConfiguration": { - "description": "Model configuration options.", + "ManagedIdentity": { + "description": "Managed identity configuration.", "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], "properties": { - "mode": { - "description": "Input delivery mode for the model.", - "default": "Download", - "$ref": "#/definitions/PackageInputDeliveryMode" + "clientId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true }, - "mountPath": { - "description": "Relative mounting path of the model in the target image.", + "objectId": { + "format": "uuid", + "description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resourceId": { + "description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.", "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true } }, + "x-ms-discriminator-value": "Managed", "additionalProperties": false }, - "ModelContainer": { + "ManagedOnlineDeployment": { + "description": "Properties specific to a ManagedOnlineDeployment.", "type": "object", "allOf": [ { - "$ref": "#/definitions/AssetContainer" + "$ref": "#/definitions/OnlineDeployment" } ], + "x-ms-discriminator-value": "Managed", + "additionalProperties": false + }, + "MaterializationComputeResource": { + "description": "Dto object representing compute resource", + "type": "object", "properties": { - "provisioningState": { - "description": "Provisioning state for the model container.", - "$ref": "#/definitions/AssetProvisioningState", - "readOnly": true, - "x-ms-mutability": [ - "read" - ] + "instanceType": { + "description": "Specifies the instance type", + "type": "string", + "x-nullable": true } }, - "x-ms-client-name": "ModelContainerProperties", "additionalProperties": false }, - "ModelContainerResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], + "MaterializationSettings": { "type": "object", - "allOf": [ + "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 + }, + "MediaType": { + "description": "Media type of data asset.", + "enum": [ + "Image", + "Text" + ], + "type": "string", + "x-ms-enum": { + "name": "MediaType", + "modelAsString": true, + "values": [ + { + "value": "Image" + }, + { + "value": "Text" + } + ] + }, + "additionalProperties": false + }, + "MedianStoppingPolicy": { + "description": "Defines an early termination policy based on running averages of the primary metric of all runs", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "x-ms-discriminator-value": "MedianStopping", + "additionalProperties": false + }, + "ModelConfiguration": { + "description": "Model configuration options.", + "type": "object", + "properties": { + "mode": { + "description": "Input delivery mode for the model.", + "default": "Download", + "$ref": "#/definitions/PackageInputDeliveryMode" + }, + "mountPath": { + "description": "Relative mounting path of the model in the target image.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ModelContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the model container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ModelContainerProperties", + "additionalProperties": false + }, + "ModelContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } @@ -18220,6 +19707,81 @@ }, "additionalProperties": false }, + "ModelPerformanceMetricThresholdBase": { + "required": [ + "modelType" + ], + "type": "object", + "properties": { + "modelType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringModelType", + "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": "modelType" + }, + "ModelPerformanceSignalBase": { + "required": [ + "baselineData", + "metricThreshold", + "targetData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "baselineData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataSegment": { + "description": "The data segment.", + "$ref": "#/definitions/MonitoringDataSegment", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/ModelPerformanceMetricThresholdBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "targetData": { + "description": "[Required] The data produced by the production service which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, "ModelSize": { "description": "Image model size.", "enum": [ @@ -18231,112 +19793,531 @@ ], "type": "string", "x-ms-enum": { - "name": "ModelSize", + "name": "ModelSize", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No value selected." + }, + { + "value": "Small", + "description": "Small size." + }, + { + "value": "Medium", + "description": "Medium size." + }, + { + "value": "Large", + "description": "Large size." + }, + { + "value": "ExtraLarge", + "description": "Extra large size." + } + ] + }, + "additionalProperties": false + }, + "ModelVersion": { + "description": "Model asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "flavors": { + "description": "Mapping of model flavors to their properties.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FlavorData", + "x-nullable": true + }, + "x-nullable": true + }, + "intellectualProperty": { + "description": "Intellectual Property details. Used if model is an Intellectual Property.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobName": { + "description": "Name of the training job which produced this model", + "type": "string", + "x-nullable": true + }, + "modelType": { + "description": "The storage format for this entity. Used for NCD.", + "type": "string", + "x-nullable": true + }, + "modelUri": { + "description": "The URI path to the model contents.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the model version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the model lifecycle assigned to this model", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ModelVersionProperties", + "additionalProperties": false + }, + "ModelVersionResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ModelVersion" + } + }, + "x-ms-client-name": "ModelVersion", + "additionalProperties": false + }, + "ModelVersionResourceArmPaginatedResult": { + "description": "A paginated list of ModelVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ModelVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "additionalProperties": false + }, + "MonitorDefinition": { + "required": [ + "computeId", + "signals" + ], + "type": "object", + "properties": { + "alertNotificationSetting": { + "description": "The monitor's notification settings.", + "$ref": "#/definitions/MonitoringAlertNotificationSettingsBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "computeId": { + "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "monitoringTarget": { + "description": "The ARM resource ID of either the model or deployment targeted by this monitor.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "signals": { + "description": "[Required] The signals to monitor.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringSignalBase", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "MonitoringAlertNotificationSettingsBase": { + "required": [ + "alertNotificationType" + ], + "type": "object", + "properties": { + "alertNotificationType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringAlertNotificationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "alertNotificationType" + }, + "MonitoringAlertNotificationType": { + "enum": [ + "AzureMonitor", + "Email" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringAlertNotificationType", + "modelAsString": true, + "values": [ + { + "value": "AzureMonitor", + "description": "Settings for Azure Monitor based alerting." + }, + { + "value": "Email", + "description": "Settings for AML email notifications." + } + ] + }, + "additionalProperties": false + }, + "MonitoringDataSegment": { + "type": "object", + "properties": { + "feature": { + "description": "The feature to segment the data on.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "values": { + "description": "Filters for only the specified values of the given segmented feature.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MonitoringFeatureDataType": { + "enum": [ + "Numerical", + "Categorical" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringFeatureDataType", + "modelAsString": true, + "values": [ + { + "value": "Numerical", + "description": "Used for features of numerical data type." + }, + { + "value": "Categorical", + "description": "Used for features of categorical data type." + } + ] + }, + "additionalProperties": false + }, + "MonitoringFeatureFilterBase": { + "required": [ + "filterType" + ], + "type": "object", + "properties": { + "filterType": { + "description": "[Required] Specifies the feature filter to leverage when selecting features to calculate metrics over.", + "$ref": "#/definitions/MonitoringFeatureFilterType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "filterType" + }, + "MonitoringFeatureFilterType": { + "enum": [ + "AllFeatures", + "TopNByAttribution", + "FeatureSubset" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringFeatureFilterType", + "modelAsString": true, + "values": [ + { + "value": "AllFeatures", + "description": "Includes all features." + }, + { + "value": "TopNByAttribution", + "description": "Only includes the top contributing features, measured by feature attribution." + }, + { + "value": "FeatureSubset", + "description": "Includes a user-defined subset of features." + } + ] + }, + "additionalProperties": false + }, + "MonitoringInputData": { + "required": [ + "dataContext" + ], + "type": "object", + "properties": { + "asset": { + "description": "The data asset input to be leveraged by the monitoring job..", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "dataContext": { + "description": "[Required] The context of the data source.", + "$ref": "#/definitions/MonitoringInputDataContext", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "preprocessingComponentId": { + "description": "The ARM resource ID of the component resource used to preprocess the data.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "targetColumnName": { + "description": "The target column in the given data asset to leverage.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MonitoringInputDataContext": { + "enum": [ + "ModelInputs", + "ModelOutputs", + "Training", + "Test", + "Validation", + "GroundTruth" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringInputDataContext", + "modelAsString": true, + "values": [ + { + "value": "ModelInputs", + "description": "A dataset containing the feature input to the model." + }, + { + "value": "ModelOutputs", + "description": "A dataset containing the inferred results of the model." + }, + { + "value": "Training", + "description": "A dataset containing the data used for training the model." + }, + { + "value": "Test", + "description": "A dataset leveraged to test the model." + }, + { + "value": "Validation", + "description": "A dataset leveraged for model validation." + }, + { + "value": "GroundTruth", + "description": "A dataset containing the ground truth data." + } + ] + }, + "additionalProperties": false + }, + "MonitoringModelType": { + "enum": [ + "Classification", + "Regression" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringModelType", + "modelAsString": true, + "values": [ + { + "value": "Classification", + "description": "A model trained for classification tasks." + }, + { + "value": "Regression", + "description": "A model trained for regressions tasks." + } + ] + }, + "additionalProperties": false + }, + "MonitoringNotificationMode": { + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringNotificationMode", "modelAsString": true, "values": [ { - "value": "None", - "description": "No value selected." - }, - { - "value": "Small", - "description": "Small size." - }, - { - "value": "Medium", - "description": "Medium size." - }, - { - "value": "Large", - "description": "Large size." + "value": "Disabled", + "description": "Disabled notifications will not produce emails/metrics leveraged for alerting." }, { - "value": "ExtraLarge", - "description": "Extra large size." + "value": "Enabled", + "description": "Enabled notification will produce emails/metrics leveraged for alerting." } ] }, "additionalProperties": false }, - "ModelVersion": { - "description": "Model asset version details.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AssetBase" - } + "MonitoringSignalBase": { + "required": [ + "signalType" ], + "type": "object", "properties": { - "flavors": { - "description": "Mapping of model flavors to their properties.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/FlavorData", - "x-nullable": true - }, - "x-nullable": true - }, - "jobName": { - "description": "Name of the training job which produced this model", - "type": "string", - "x-nullable": true - }, - "modelType": { - "description": "The storage format for this entity. Used for NCD.", + "lookbackPeriod": { + "format": "duration", + "description": "The amount of time a single monitor should look back over the target data on a given run.", "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], "x-nullable": true }, - "modelUri": { - "description": "The URI path to the model contents.", - "type": "string", - "x-nullable": true + "mode": { + "description": "The current notification mode for this signal.", + "default": "Disabled", + "$ref": "#/definitions/MonitoringNotificationMode", + "x-ms-mutability": [ + "create", + "read" + ] }, - "provisioningState": { - "description": "Provisioning state for the model version.", - "$ref": "#/definitions/AssetProvisioningState", - "readOnly": true, + "signalType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringSignalType", "x-ms-mutability": [ + "create", "read" ] } }, - "x-ms-client-name": "ModelVersionProperties", - "additionalProperties": false + "discriminator": "signalType" }, - "ModelVersionResource": { - "description": "Azure Resource Manager resource envelope.", - "required": [ - "properties" - ], - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" - } + "MonitoringSignalType": { + "enum": [ + "DataDrift", + "PredictionDrift", + "DataQuality", + "FeatureAttributionDrift", + "Custom", + "ModelPerformance" ], - "properties": { - "properties": { - "description": "[Required] Additional attributes of the entity.", - "$ref": "#/definitions/ModelVersion" - } + "type": "string", + "x-ms-enum": { + "name": "MonitoringSignalType", + "modelAsString": true, + "values": [ + { + "value": "DataDrift", + "description": "Tracks model input data distribution change, comparing against training data or past production data." + }, + { + "value": "PredictionDrift", + "description": "Tracks prediction result data distribution change, comparing against validation/test label data or past production data." + }, + { + "value": "DataQuality", + "description": "Tracks model input data integrity." + }, + { + "value": "FeatureAttributionDrift", + "description": "Tracks feature importance change in production, comparing against feature importance at training time." + }, + { + "value": "Custom", + "description": "Tracks a custom signal provided by users." + }, + { + "value": "ModelPerformance", + "description": "Tracks model performance based on ground truth data." + } + ] }, - "x-ms-client-name": "ModelVersion", "additionalProperties": false }, - "ModelVersionResourceArmPaginatedResult": { - "description": "A paginated list of ModelVersion entities.", + "MonitoringThreshold": { "type": "object", "properties": { - "nextLink": { - "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", - "type": "string" - }, "value": { - "description": "An array of objects of type ModelVersion.", - "type": "array", - "items": { - "$ref": "#/definitions/ModelVersionResource" - } + "format": "double", + "description": "The threshold value. If null, the set default is dependent on the metric type.", + "type": "number", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true } }, "additionalProperties": false @@ -18729,55 +20710,226 @@ "modelAsString": true, "values": [ { - "value": "All" + "value": "All" + }, + { + "value": "Custom" + } + ] + }, + "additionalProperties": false + }, + "NoneDatastoreCredentials": { + "description": "Empty/none datastore credentials.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "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", + "PopulationStabilityIndex", + "NormalizedWassersteinDistance", + "TwoSampleKolmogorovSmirnovTest" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalDataDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "NormalizedWassersteinDistance", + "description": "The Normalized Wasserstein Distance metric." + }, + { + "value": "TwoSampleKolmogorovSmirnovTest", + "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric." + } + ] + }, + "additionalProperties": false + }, + "NumericalDataDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical data drift metric to calculate.", + "$ref": "#/definitions/NumericalDataDriftMetric" + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "NumericalDataQualityMetric": { + "enum": [ + "NullValueRate", + "DataTypeErrorRate", + "OutOfBoundsRate" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalDataQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "NullValueRate", + "description": "Calculates the rate of null values." + }, + { + "value": "DataTypeErrorRate", + "description": "Calculates the rate of data type errors." + }, + { + "value": "OutOfBoundsRate", + "description": "Calculates the rate values are out of bounds." + } + ] + }, + "additionalProperties": false + }, + "NumericalDataQualityMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical data quality metric to calculate.", + "$ref": "#/definitions/NumericalDataQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "NumericalPredictionDriftMetric": { + "enum": [ + "JensenShannonDistance", + "PopulationStabilityIndex", + "NormalizedWassersteinDistance", + "TwoSampleKolmogorovSmirnovTest" + ], + "type": "string", + "x-ms-enum": { + "name": "NumericalPredictionDriftMetric", + "modelAsString": true, + "values": [ + { + "value": "JensenShannonDistance", + "description": "The Jensen Shannon Distance (JSD) metric." + }, + { + "value": "PopulationStabilityIndex", + "description": "The Population Stability Index (PSI) metric." + }, + { + "value": "NormalizedWassersteinDistance", + "description": "The Normalized Wasserstein Distance metric." }, { - "value": "Custom" + "value": "TwoSampleKolmogorovSmirnovTest", + "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric." } ] }, "additionalProperties": false }, - "NoneDatastoreCredentials": { - "description": "Empty/none datastore credentials.", + "NumericalPredictionDriftMetricThreshold": { + "required": [ + "metric" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DatastoreCredentials" + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" } ], - "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" - }, + "metric": { + "description": "[Required] The numerical prediction drift metric to calculate.", + "$ref": "#/definitions/NumericalPredictionDriftMetric", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] } }, + "x-ms-discriminator-value": "Numerical", "additionalProperties": false }, "ObjectDetectionPrimaryMetrics": { @@ -18819,6 +20971,102 @@ }, "additionalProperties": false }, + "OneLakeArtifact": { + "description": "OneLake artifact (data source) configuration.", + "required": [ + "artifactName", + "artifactType" + ], + "type": "object", + "properties": { + "artifactName": { + "description": "[Required] OneLake artifact name", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "artifactType": { + "description": "[Required] OneLake artifact type", + "$ref": "#/definitions/OneLakeArtifactType" + } + }, + "discriminator": "artifactType" + }, + "OneLakeArtifactType": { + "description": "Enum to determine OneLake artifact type.", + "enum": [ + "LakeHouse" + ], + "type": "string", + "x-ms-enum": { + "name": "OneLakeArtifactType", + "modelAsString": true, + "values": [ + { + "value": "LakeHouse" + } + ] + }, + "additionalProperties": false + }, + "OneLakeDatastore": { + "description": "OneLake (Trident) datastore configuration.", + "required": [ + "artifact", + "oneLakeWorkspaceName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "artifact": { + "description": "[Required] OneLake artifact backing the datastore.", + "$ref": "#/definitions/OneLakeArtifact", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "OneLake endpoint to use for the datastore.", + "type": "string", + "example": "data.microsoft.com", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "oneLakeWorkspaceName": { + "description": "[Required] OneLake workspace name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "default": "None", + "$ref": "#/definitions/ServiceDataAccessAuthIdentity", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "OneLake", + "additionalProperties": false + }, "OnlineDeployment": { "required": [ "endpointComputeType" @@ -18835,6 +21083,11 @@ "default": false, "type": "boolean" }, + "dataCollector": { + "description": "The mdc configuration, we disable mdc when it's null.", + "$ref": "#/definitions/DataCollector", + "x-nullable": true + }, "egressPublicNetworkAccess": { "description": "If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.", "default": "Enabled", @@ -19611,6 +21864,29 @@ }, "additionalProperties": false }, + "PartialJobBase": { + "description": "Mutable base definition for a job.", + "type": "object", + "properties": { + "notificationSetting": { + "description": "Mutable notification setting for the job", + "$ref": "#/definitions/PartialNotificationSetting", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialJobBasePartialResource": { + "description": "Azure Resource Manager resource envelope strictly used in update requests.", + "type": "object", + "properties": { + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/PartialJobBase" + } + }, + "additionalProperties": false + }, "PartialManagedServiceIdentity": { "description": "Managed service identity (system assigned and/or user assigned identities)", "type": "object", @@ -19676,6 +21952,23 @@ }, "additionalProperties": false }, + "PartialNotificationSetting": { + "description": "Mutable configuration for notification.", + "type": "object", + "properties": { + "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-nullable": true + } + }, + "additionalProperties": false + }, "PartialSku": { "description": "Common SKU definition.", "type": "object", @@ -19708,6 +22001,94 @@ "type": "object", "additionalProperties": false }, + "PendingUploadCredentialDto": { + "required": [ + "credentialType" + ], + "type": "object", + "properties": { + "credentialType": { + "description": "[Required] Credential type used to authentication with storage.", + "$ref": "#/definitions/PendingUploadCredentialType" + } + }, + "discriminator": "credentialType" + }, + "PendingUploadCredentialType": { + "description": "Enum to determine the PendingUpload credentials type.", + "enum": [ + "SAS" + ], + "type": "string", + "x-ms-enum": { + "name": "PendingUploadCredentialType", + "modelAsString": true, + "values": [ + { + "value": "SAS" + } + ] + }, + "additionalProperties": false + }, + "PendingUploadRequestDto": { + "type": "object", + "properties": { + "pendingUploadId": { + "description": "If PendingUploadId = null then random guid will be used.", + "type": "string", + "x-nullable": true + }, + "pendingUploadType": { + "description": "TemporaryBlobReference is the only supported type", + "default": "TemporaryBlobReference", + "$ref": "#/definitions/PendingUploadType" + } + }, + "additionalProperties": false + }, + "PendingUploadResponseDto": { + "type": "object", + "properties": { + "blobReferenceForConsumption": { + "description": "Container level read, write, list SAS", + "$ref": "#/definitions/BlobReferenceForConsumptionDto", + "x-nullable": true + }, + "pendingUploadId": { + "description": "ID for this upload request", + "type": "string", + "x-nullable": true + }, + "pendingUploadType": { + "description": "TemporaryBlobReference is the only supported type", + "default": "TemporaryBlobReference", + "$ref": "#/definitions/PendingUploadType" + } + }, + "additionalProperties": false + }, + "PendingUploadType": { + "description": "Type of storage to use for the pending upload location", + "enum": [ + "None", + "TemporaryBlobReference" + ], + "type": "string", + "x-ms-enum": { + "name": "PendingUploadType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "TemporaryBlobReference" + } + ] + }, + "additionalProperties": false + }, "PipelineJob": { "description": "Pipeline Job definition: defines generic to MFE attributes.", "type": "object", @@ -19744,40 +22125,120 @@ ], "x-nullable": true }, - "outputs": { - "description": "Outputs for the pipeline job", - "type": "object", - "additionalProperties": { - "description": "Job output definition container information on where to find job output/logs.", - "$ref": "#/definitions/JobOutput", - "x-nullable": true + "outputs": { + "description": "Outputs for the pipeline 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 + }, + "settings": { + "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", + "type": "object", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "sourceJobId": { + "description": "ARM resource ID of source job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Pipeline", + "additionalProperties": false + }, + "PredictionDriftMetricThresholdBase": { + "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" + }, + "PredictionDriftMonitoringSignal": { + "required": [ + "baselineData", + "metricThresholds", + "modelType", + "targetData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "baselineData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputData", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" }, "x-ms-mutability": [ "create", "read" ], - "x-nullable": true + "x-ms-identifiers": [] }, - "settings": { - "description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.", - "type": "object", + "modelType": { + "description": "[Required] The type of the model monitored.", + "$ref": "#/definitions/MonitoringModelType", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] }, - "sourceJobId": { - "description": "ARM resource ID of source job.", - "type": "string", + "targetData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputData", "x-ms-mutability": [ "create", "read" - ], - "x-nullable": true + ] } }, - "x-ms-discriminator-value": "Pipeline", + "x-ms-discriminator-value": "PredictionDrift", "additionalProperties": false }, "ProbeSettings": { @@ -19864,6 +22325,29 @@ }, "additionalProperties": false }, + "ProtectionLevel": { + "description": "Protection level associated with the Intellectual Property.", + "enum": [ + "All", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionLevel", + "modelAsString": true, + "values": [ + { + "value": "All", + "description": "All means Intellectual Property is fully protected." + }, + { + "value": "None", + "description": "None means it is not an Intellectual Property." + } + ] + }, + "additionalProperties": false + }, "PublicNetworkAccessType": { "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled.", "enum": [ @@ -19979,6 +22463,51 @@ }, "additionalProperties": false }, + "Ray": { + "description": "Ray distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "address": { + "description": "The address of Ray head node.", + "type": "string", + "x-nullable": true + }, + "dashboardPort": { + "format": "int32", + "description": "The port to bind the dashboard server to.", + "type": "integer", + "x-nullable": true + }, + "headNodeAdditionalArgs": { + "description": "Additional arguments passed to ray start in head node.", + "type": "string", + "x-nullable": true + }, + "includeDashboard": { + "description": "Provide this argument to start the Ray dashboard GUI.", + "type": "boolean", + "x-nullable": true + }, + "port": { + "format": "int32", + "description": "The port of the head ray process.", + "type": "integer", + "x-nullable": true + }, + "workerNodeAdditionalArgs": { + "description": "Additional arguments passed to ray start in worker node.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Ray", + "additionalProperties": false + }, "RecurrenceFrequency": { "description": "Enum to describe the frequency of a recurrence schedule", "enum": [ @@ -20160,6 +22689,56 @@ "x-ms-discriminator-value": "Regression", "additionalProperties": false }, + "RegressionModelPerformanceMetric": { + "enum": [ + "MeanAbsoluteError", + "RootMeanSquaredError", + "MeanSquaredError" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionModelPerformanceMetric", + "modelAsString": true, + "values": [ + { + "value": "MeanAbsoluteError", + "description": "The Mean Absolute Error (MAE) metric." + }, + { + "value": "RootMeanSquaredError", + "description": "The Root Mean Squared Error (RMSE) metric." + }, + { + "value": "MeanSquaredError", + "description": "The Mean Squared Error (MSE) metric." + } + ] + }, + "additionalProperties": false + }, + "RegressionModelPerformanceMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ModelPerformanceMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The regression model performance metric to calculate.", + "$ref": "#/definitions/RegressionModelPerformanceMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Regression", + "additionalProperties": false + }, "RegressionModels": { "description": "Enum for all Regression models supported by AutoML.", "enum": [ @@ -20205,7 +22784,7 @@ }, { "value": "RandomForest", - "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the 'bagging' method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." + "description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the bagging method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result." }, { "value": "ExtremeRandomTrees", @@ -20284,6 +22863,20 @@ }, "additionalProperties": false }, + "RequestLogging": { + "type": "object", + "properties": { + "captureHeaders": { + "description": "For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, "ResourceBase": { "type": "object", "properties": { @@ -20347,6 +22940,16 @@ ], "x-nullable": true }, + "maxInstanceCount": { + "format": "int32", + "description": "Optional max allowed number of instances or nodes to be used by the compute target.\r\nFor use with elastic training, currently supported by PyTorch distribution type only.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "properties": { "description": "Additional properties bag.", "type": "object", @@ -20363,6 +22966,38 @@ }, "additionalProperties": false }, + "RollingRateType": { + "enum": [ + "Year", + "Month", + "Day", + "Hour", + "Minute" + ], + "type": "string", + "x-ms-enum": { + "name": "RollingRateType", + "modelAsString": true, + "values": [ + { + "value": "Year" + }, + { + "value": "Month" + }, + { + "value": "Day" + }, + { + "value": "Hour" + }, + { + "value": "Minute" + } + ] + }, + "additionalProperties": false + }, "Route": { "required": [ "path", @@ -20384,6 +23019,25 @@ }, "additionalProperties": false }, + "SASCredentialDto": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PendingUploadCredentialDto" + } + ], + "properties": { + "sasUri": { + "format": "uri", + "description": "Full SAS Uri, including the storage, container/blob path and SAS token", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "SAS", + "additionalProperties": false + }, "SamplingAlgorithm": { "description": "The Sampling Algorithm used to generate hyperparameter values, along with properties to\r\nconfigure the algorithm", "required": [ @@ -20568,7 +23222,9 @@ "ScheduleActionType": { "enum": [ "CreateJob", - "InvokeBatchEndpoint" + "InvokeBatchEndpoint", + "ImportData", + "CreateMonitor" ], "type": "string", "x-ms-enum": { @@ -20580,6 +23236,12 @@ }, { "value": "InvokeBatchEndpoint" + }, + { + "value": "ImportData" + }, + { + "value": "CreateMonitor" } ] }, @@ -20724,6 +23386,31 @@ }, "additionalProperties": false }, + "SecretConfiguration": { + "description": "Secret Configuration definition.", + "type": "object", + "properties": { + "uri": { + "description": "Secret Uri.\r\nSample Uri : https://myvault.vault.azure.net/secrets/mysecretname/secretversion", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "workspaceSecretName": { + "description": "Name of secret in workspace key vault.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, "SecretsType": { "description": "Enum to determine the datastore secrets type.", "enum": [ @@ -22342,6 +25029,31 @@ "x-ms-discriminator-value": "TextNER", "additionalProperties": false }, + "TopNFeaturesByAttribution": { + "required": [ + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "properties": { + "top": { + "format": "int32", + "description": "The number of top features to include.", + "default": 10, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "TopNByAttribution", + "additionalProperties": false + }, "TrainingMode": { "description": "Training mode dictates whether to use distributed training or not", "enum": [ @@ -22675,17 +25387,6 @@ "x-ms-discriminator-value": "uri_folder", "additionalProperties": false }, - "UserIdentity": { - "description": "User identity configuration.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IdentityConfiguration" - } - ], - "x-ms-discriminator-value": "UserIdentity", - "additionalProperties": false - }, "UseStl": { "description": "Configure STL Decomposition of the time-series target column.", "enum": [ @@ -22712,6 +25413,17 @@ }, "additionalProperties": false }, + "UserIdentity": { + "description": "User identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "UserIdentity", + "additionalProperties": false + }, "ValidationMetricType": { "description": "Metric computation method to use for validation metrics in image tasks.", "enum": [ @@ -22745,6 +25457,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": [