From 0b18643d5c21cb1ddb57cbb1503f1d9269c337a7 Mon Sep 17 00:00:00 2001 From: Kayla Seager <1675997+kseager@users.noreply.github.com> Date: Tue, 1 Aug 2023 10:38:26 -0700 Subject: [PATCH] MFE 2023-08-01-preview mfe.json (#24764) * add mfe.json * labeling jobs update descriptions * add examples for ServerlessEndpoint * update labelingjob examples * label job examples remove additional properties * adding sku to patch * add identity to patch * add in operationresult to examples --------- Co-authored-by: Kayla Ames --- .../examples/LabelingJob/pause.json | 111 ++- .../examples/LabelingJob/resume.json | 113 ++- .../ServerlessEndpoint/createOrUpdate.json | 122 +++ .../Workspace/ServerlessEndpoint/delete.json | 18 + .../Workspace/ServerlessEndpoint/get.json | 55 ++ .../Workspace/ServerlessEndpoint/list.json | 60 ++ .../ServerlessEndpoint/listKeys.json | 18 + .../ServerlessEndpoint/regenerateKeys.json | 27 + .../Workspace/ServerlessEndpoint/update.json | 63 ++ .../preview/2023-08-01-preview/mfe.json | 824 ++++++++++++++++-- 10 files changed, 1316 insertions(+), 95 deletions(-) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/delete.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/get.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/list.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/update.json diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/pause.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/pause.json index bda2dae467ba..38aa625edc3f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/pause.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/pause.json @@ -1,12 +1,113 @@ { "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "workspace-1234", - "workspaceName": "testworkspace", - "api-version": "2023-08-01-preview", - "id": "testLabelingJob" + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-08-01-preview" }, "responses": { - "200": {} + "200": { + "headers": {}, + "body": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Queued", + "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": [ + "JobFailed" + ], + "webhooks": { + "string": { + "eventType": "string", + "webhookType": "AzureDevOps" + } + } + }, + "secretsConfiguration": { + "string": { + "workspaceSecretName": "string", + "uri": null + } + }, + "jobType": "Labeling", + "provisioningState": "InProgress", + "labelCategories": { + "string": { + "displayName": "string", + "multiSelect": "Disabled", + "classes": { + "string": { + "displayName": "string", + "subclasses": null + } + } + } + }, + "jobInstructions": { + "uri": "string" + }, + "dataConfiguration": { + "dataId": "string", + "incrementalDataRefresh": "Disabled" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "string", + "trainingComputeBinding": "string" + }, + "labelingJobMediaProperties": { + "mediaType": "Image", + "annotationType": "Classification" + }, + "projectId": "00000000-1111-2222-3333-444444444444", + "progressMetrics": { + "totalDatapointCount": 1, + "completedDatapointCount": 1, + "skippedDatapointCount": 1, + "incrementalDataLastRefreshDateTime": "2020-01-01T12:34:56.999+00:21" + }, + "statusMessages": [ + { + "level": "Information", + "code": "string", + "message": "string", + "createdDateTime": "2020-01-01T12:34:56.999+00:21" + } + ], + "createdDateTime": "2020-01-01T12:34:56.999+00:21" + } + } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/resume.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/resume.json index 862556788a60..c9e3925c9b3a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/resume.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/LabelingJob/resume.json @@ -1,16 +1,117 @@ { "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "workspace-1234", - "workspaceName": "testworkspace", - "api-version": "2023-08-01-preview", - "id": "testLabelingJob" + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-08-01-preview" }, "responses": { - "200": {}, + "200": { + "headers": {}, + "body": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Failed", + "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": "Labeling", + "provisioningState": "Succeeded", + "labelCategories": { + "string": { + "displayName": "string", + "multiSelect": "Enabled", + "classes": { + "string": { + "displayName": "string", + "subclasses": null + } + } + } + }, + "jobInstructions": { + "uri": "string" + }, + "dataConfiguration": { + "dataId": "string", + "incrementalDataRefresh": "Disabled" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "string", + "trainingComputeBinding": "string" + }, + "labelingJobMediaProperties": { + "mediaType": "Image", + "annotationType": "BoundingBox" + }, + "projectId": "00000000-1111-2222-3333-444444444444", + "progressMetrics": { + "totalDatapointCount": 1, + "completedDatapointCount": 1, + "skippedDatapointCount": 1, + "incrementalDataLastRefreshDateTime": "2020-01-01T12:34:56.999+00:22" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-01-01T12:34:56.999+00:22" + } + ], + "createdDateTime": "2020-01-01T12:34:56.999+00:22" + } + }, "202": { "headers": { - "Location": "example_location" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..5928ac000fb4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/createOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-08-01-preview", + "body": { + "properties": { + "modelProfile": { + "modelUri": "string" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelProfile": { + "modelUri": "string" + }, + "inferenceUri": "https://www.contoso.com/example", + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:11", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:11", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelProfile": { + "modelUri": "string" + }, + "inferenceUri": "https://www.contoso.com/example", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:11", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:11", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Standard", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/delete.json new file mode 100644 index 000000000000..87854c632aee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-08-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/get.json new file mode 100644 index 000000000000..c05c110dc9da --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-08-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelProfile": { + "modelUri": "string" + }, + "inferenceUri": "https://www.contoso.com/example", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:12", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:12", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/list.json new file mode 100644 index 000000000000..5cfe0cceb83d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/list.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-08-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelProfile": { + "modelUri": "string" + }, + "inferenceUri": "https://www.contoso.com/example", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:12", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:12", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Premium", + "size": "string", + "family": "string", + "capacity": 1 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json new file mode 100644 index 000000000000..87d1ed08c290 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-08-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json new file mode 100644 index 000000000000..fa5b9a25b546 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/regenerateKeys.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-08-01-preview", + "body": { + "keyType": "Primary", + "keyValue": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/update.json new file mode 100644 index 000000000000..0863566b96f3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/examples/Workspace/ServerlessEndpoint/update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-08-01-preview", + "body": { + "tags": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "modelProfile": { + "modelUri": "string" + }, + "inferenceUri": "https://www.contoso.com/example", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:12", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:12", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "userAssignedIdentities": { + "string": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/locations/centraluseuap/mfeOperationResults/prefix:F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/mfe.json index c016c6ac9007..b0e007311c3a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-08-01-preview/mfe.json @@ -6878,6 +6878,41 @@ "name": "description", "description": "Description of the featureset.", "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" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "Page size.", + "type": "integer", + "format": "int32", + "default": 1000 } ], "responses": { @@ -8999,20 +9034,6 @@ }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "query", - "name": "includeJobInstructions", - "description": "Boolean value to indicate whether to include JobInstructions in response.", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "includeLabelCategories", - "description": "Boolean value to indicate Whether to include LabelCategories in response.", - "type": "boolean", - "default": false } ], "responses": { @@ -9125,7 +9146,7 @@ "tags": [ "LabelingJob" ], - "summary": "Export labels from a labeling job (asynchronous).", + "summary": "Export labels from a labeling job (asynchronous). Using the URL in the Location header, the status of the job export operation can be tracked.", "operationId": "LabelingJobs_ExportLabels", "consumes": [ "application/json" @@ -9243,7 +9264,10 @@ } }, "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJob" + } } }, "x-ms-examples": { @@ -9292,7 +9316,10 @@ } }, "200": { - "description": "Success" + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJob" + } }, "202": { "description": "Accepted", @@ -11211,22 +11238,498 @@ } }, "x-ms-examples": { - "List Schedules.": { - "$ref": "./examples/Schedule/list.json" + "List Schedules.": { + "$ref": "./examples/Schedule/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "delete": { + "tags": [ + "Schedule" + ], + "summary": "Delete schedule.", + "operationId": "Schedules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Schedule.": { + "$ref": "./examples/Schedule/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Schedule" + ], + "summary": "Get schedule.", + "operationId": "Schedules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + }, + "x-ms-examples": { + "Get Schedule.": { + "$ref": "./examples/Schedule/get.json" + } + } + }, + "put": { + "tags": [ + "Schedule" + ], + "summary": "Create or update schedule.", + "operationId": "Schedules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Schedule definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ScheduleResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Schedule.": { + "$ref": "./examples/Schedule/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints": { + "get": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "List Serverless Endpoints.", + "operationId": "ServerlessEndpoints_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" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}": { + "delete": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Delete Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_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": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Delete Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Get Serverless Endpoint.", + "operationId": "ServerlessEndpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "ServerlessEndpoint" + ], + "summary": "Update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_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": "name", + "description": "Serverless Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSkuAndIdentity" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/update.json" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { - "delete": { + "x-ms-long-running-operation": true + }, + "put": { "tags": [ - "Schedule" + "ServerlessEndpoint" + ], + "summary": "Create or update Serverless Endpoint (asynchronous).", + "operationId": "ServerlessEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" ], - "summary": "Delete schedule.", - "operationId": "Schedules_Delete", "produces": [ "application/json" ], @@ -11243,12 +11746,22 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Serverless Endpoint 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" + }, + { + "in": "body", + "name": "body", + "description": "Serverless Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } } ], "responses": { @@ -11259,49 +11772,47 @@ } }, "200": { - "description": "Success" + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } }, - "202": { - "description": "Accepted", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + }, "headers": { "x-ms-async-operation-timeout": { "description": "Timeout for the client to use when polling the asynchronous operation.", "type": "string", "format": "duration" }, - "Location": { - "description": "URI to poll for asynchronous operation result.", + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", "type": "string" - }, - "Retry-After": { - "description": "Duration the client should wait between requests, in seconds.", - "type": "integer", - "format": "int32", - "maximum": 600, - "minimum": 10 } } - }, - "204": { - "description": "No Content" } }, "x-ms-examples": { - "Delete Schedule.": { - "$ref": "./examples/Schedule/delete.json" + "CreateOrUpdate Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/createOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "original-uri" } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/listKeys": { + "post": { "tags": [ - "Schedule" + "ServerlessEndpoint" ], - "summary": "Get schedule.", - "operationId": "Schedules_Get", + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "ServerlessEndpoints_ListKeys", "produces": [ "application/json" ], @@ -11318,9 +11829,10 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Serverless Endpoint 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" @@ -11336,22 +11848,24 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/EndpointAuthKeys" } } }, "x-ms-examples": { - "Get Schedule.": { - "$ref": "./examples/Schedule/get.json" + "ListKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/listKeys.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/regenerateKeys": { + "post": { "tags": [ - "Schedule" + "ServerlessEndpoint" ], - "summary": "Create or update schedule.", - "operationId": "Schedules_CreateOrUpdate", + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "ServerlessEndpoints_RegenerateKeys", "consumes": [ "application/json" ], @@ -11371,7 +11885,7 @@ { "in": "path", "name": "name", - "description": "Schedule name.", + "description": "Serverless Endpoint name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" @@ -11382,10 +11896,10 @@ { "in": "body", "name": "body", - "description": "Schedule definition.", + "description": "RegenerateKeys request .", "required": true, "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/RegenerateEndpointKeysRequest" } } ], @@ -11397,37 +11911,36 @@ } }, "200": { - "description": "Create or update request is successful.", + "description": "Success", "schema": { - "$ref": "#/definitions/ScheduleResource" + "$ref": "#/definitions/EndpointAuthKeys" } }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ScheduleResource" - }, + "202": { + "description": "Accepted", "headers": { - "x-ms-async-operation-timeout": { - "description": "Timeout for the client to use when polling the asynchronous operation.", - "type": "string", - "format": "duration" - }, - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", + "Location": { + "description": "URI to poll for asynchronous operation result.", "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 } } } }, "x-ms-examples": { - "CreateOrUpdate Schedule.": { - "$ref": "./examples/Schedule/createOrUpdate.json" + "RegenerateKeys Workspace Serverless Endpoint.": { + "$ref": "./examples/Workspace/ServerlessEndpoint/regenerateKeys.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" + "final-state-via": "location" } } } @@ -20214,6 +20727,21 @@ "x-ms-discriminator-value": "ModelPerformance", "additionalProperties": false }, + "ModelProfile": { + "required": [ + "modelUri" + ], + "type": "object", + "properties": { + "modelUri": { + "description": "[Required] The model to create a serverless endpoint of", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, "ModelSize": { "description": "Image model size.", "enum": [ @@ -22331,6 +22859,19 @@ ], "x-nullable": true }, + "properties": { + "description": "Property dictionary. Properties can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, "tags": { "description": "Tag dictionary. Tags can be added, removed, and updated.", "type": "object", @@ -22440,6 +22981,19 @@ ], "x-nullable": true }, + "properties": { + "description": "Property dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, "tags": { "description": "Tag dictionary. Tags can be added, removed, and updated.", "type": "object", @@ -22584,6 +23138,26 @@ }, "additionalProperties": false }, + "PartialMinimalTrackedResourceWithSkuAndIdentity": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/PartialManagedServiceIdentity" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + } + }, + "additionalProperties": false + }, "PartialNotificationSetting": { "description": "Mutable configuration for notification.", "type": "object", @@ -24080,6 +24654,88 @@ }, "additionalProperties": false }, + "ServerlessEndpoint": { + "required": [ + "modelProfile" + ], + "type": "object", + "properties": { + "inferenceUri": { + "format": "uri", + "description": "The inference uri to target when making requests against the serverless endpoint", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "modelProfile": { + "description": "[Required] The model profile to configure the serverless endpoint with", + "$ref": "#/definitions/ModelProfile" + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ServerlessEndpointProperties", + "additionalProperties": false + }, + "ServerlessEndpointTrackedResource": { + "required": [ + "location", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", + "type": "string" + }, + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ServerlessEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "ServerlessEndpoint", + "additionalProperties": false + }, + "ServerlessEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of ServerlessEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ServerlessEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerlessEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, "ServiceDataAccessAuthIdentity": { "enum": [ "None",