diff --git a/custom-words.txt b/custom-words.txt index 94f4ca338c9d..d1130b35c6f0 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1063,6 +1063,7 @@ granularities graphrbac graphservice greenplum +groundedness groundstation groupby groupedby diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/AKSCompute.json new file mode 100644 index 000000000000..0de7f2e16b52 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/AKSCompute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "agentCount": 4 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/AmlCompute.json new file mode 100644 index 000000000000..cf76b4ada147 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/AmlCompute.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "description": "some compute", + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": { + "id": "test-subnet-resource-id" + }, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicAKSCompute.json new file mode 100644 index 000000000000..4a9b06f7f6c4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicAmlCompute.json new file mode 100644 index 000000000000..338d1477f9e3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicAmlCompute.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myImageGallery/images/myImageDefinition/versions/0.0.1" + }, + "isolatedNetwork": false, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "NotSpecified", + "enableNodePublicIp": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json new file mode 100644 index 000000000000..76ac71308343 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json new file mode 100644 index 000000000000..f72d1079c039 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstance.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": { + "id": "test-subnet-resource-id" + }, + "applicationSharingPolicy": "Personal", + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "customServices": [ + { + "name": "rstudio-workbench", + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rstudio-workbench:latest" + }, + "environmentVariables": { + "RSP_LICENSE": { + "type": "local", + "value": "XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX" + } + }, + "docker": { + "privileged": true + }, + "endpoints": [ + { + "protocol": "http", + "name": "connect", + "target": 8787, + "published": 4444, + "hostIp": null + } + ], + "volumes": [ + { + "type": "bind", + "source": "/mnt/azureuser/", + "target": "/home/testuser/", + "readOnly": true + } + ] + } + ], + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json new file mode 100644 index 000000000000..3d6d5620a231 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json new file mode 100644 index 000000000000..53a0b87a8802 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "applicationSharingPolicy": "Personal", + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "schedules": { + "computeStartStop": [ + { + "status": "Enabled", + "action": "Stop", + "triggerType": "Cron", + "cron": { + "expression": "0 18 * * *", + "startTime": "2021-04-23T01:30:00", + "timeZone": "Pacific Standard Time" + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/KubernetesCompute.json new file mode 100644 index 000000000000..b481b3250257 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/createOrUpdate/KubernetesCompute.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "properties": { + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/delete.json new file mode 100644 index 000000000000..8b0b0c138096 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "underlyingResourceAction": "Delete" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/AKSCompute.json new file mode 100644 index 000000000000..675b214c0ad8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/AKSCompute.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/AmlCompute.json new file mode 100644 index 000000000000..80d5f973bd3a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/AmlCompute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": { + "id": "test-subnet-resource-id" + }, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/ComputeInstance.json new file mode 100644 index 000000000000..81e0705b3af8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/ComputeInstance.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "ComputeInstance", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": { + "id": "test-subnet-resource-id" + }, + "applicationSharingPolicy": "Shared", + "sshSettings": { + "sshPublicAccess": "Enabled", + "adminUserName": "azureuser", + "sshPort": 22 + }, + "osImageMetadata": { + "currentImageVersion": "22.06.14", + "latestImageVersion": "22.07.22", + "isLatestOsImageVersion": false + }, + "customServices": [ + { + "name": "rstudio-workbench", + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rstudio-workbench:latest" + }, + "environmentVariables": { + "RSP_LICENSE": { + "type": "local", + "value": "XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX" + } + }, + "docker": { + "privileged": true + }, + "endpoints": [ + { + "protocol": "http", + "name": "connect", + "target": 8787, + "published": 4444, + "hostIp": null + } + ], + "volumes": [ + { + "type": "bind", + "source": "/mnt/azureuser/", + "target": "/home/testuser/", + "readOnly": true, + "consistency": "test", + "bind": { + "propagation": "test", + "createHostPath": true, + "selinux": "test" + }, + "volume": { + "nocopy": true + }, + "tmpfs": { + "size": 10 + } + } + ] + } + ], + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "createdBy": { + "userName": "foobar@microsoft.com", + "userOrgId": "00000000-0000-0000-0000-000000000000", + "userId": "00000000-0000-0000-0000-000000000000" + }, + "connectivityEndpoints": { + "publicIpAddress": "10.0.0.1", + "privateIpAddress": "10.0.0.1" + }, + "applications": [ + { + "displayName": "Jupyter", + "endpointUri": "https://compute123.eastus2.azureml.net/jupyter" + } + ], + "errors": null, + "state": "Running" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/KubernetesCompute.json new file mode 100644 index 000000000000..5184c4a9874c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/get/KubernetesCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Succeeded", + "isAttachedCompute": true, + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/list.json new file mode 100644 index 000000000000..582f81a676b5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/list.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/listKeys.json new file mode 100644 index 000000000000..191b1c2cb615 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/listKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/listNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/listNodes.json new file mode 100644 index 000000000000..b039a3b40bbb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/listNodes.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nodes": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50000, + "nodeState": "running", + "runId": "2f378a44-38f2-443a-9f0d-9909d0b47890" + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50001, + "nodeState": "idle" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/patch.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/patch.json new file mode 100644 index 000000000000..daf31140050f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/patch.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "properties": { + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/restart.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/restart.json new file mode 100644 index 000000000000..271602e3cad3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/restart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/start.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/start.json new file mode 100644 index 000000000000..271602e3cad3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/start.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/stop.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/stop.json new file mode 100644 index 000000000000..271602e3cad3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/updateCustomServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/updateCustomServices.json new file mode 100644 index 000000000000..3c6945350941 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/updateCustomServices.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "customServices": [ + { + "name": "rstudio-workbench", + "image": { + "type": "docker", + "reference": "ghcr.io/azure/rstudio-workbench:latest" + }, + "environmentVariables": { + "RSP_LICENSE": { + "type": "local", + "value": "XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX" + } + }, + "docker": { + "privileged": true + }, + "endpoints": [ + { + "protocol": "http", + "name": "connect", + "target": 8787, + "published": 4444, + "hostIp": null + } + ], + "volumes": [ + { + "type": "bind", + "source": "/mnt/azureuser/", + "target": "/home/testuser/", + "readOnly": true + } + ] + } + ] + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/updateIdleShutdownSetting.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/updateIdleShutdownSetting.json new file mode 100644 index 000000000000..1a6fbb0a95a3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Compute/updateIdleShutdownSetting.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2023-06-01-preview", + "parameters": { + "idleTimeBeforeShutdown": "PT120M" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json new file mode 100644 index 000000000000..1d03ea61d182 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey", + "key": "string" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json new file mode 100644 index 000000000000..9167f981e43b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal", + "clientSecret": "string" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen1", + "storeName": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json new file mode 100644 index 000000000000..cad71e97f32b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal", + "clientSecret": "string" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "ServicePrincipal", + "authorityUrl": "string", + "resourceUrl": "string", + "tenantId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "secrets": { + "secretsType": "ServicePrincipal" + } + }, + "datastoreType": "AzureDataLakeGen2", + "filesystem": "string", + "accountName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json new file mode 100644 index 000000000000..d5f00f989d7e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "skipValidation": false, + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey", + "key": "string" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureFile", + "accountName": "string", + "fileShareName": "string", + "endpoint": "string", + "protocol": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/delete.json new file mode 100644 index 000000000000..2be4dcea1231 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/get.json new file mode 100644 index 000000000000..75e400274aa0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/list.json new file mode 100644 index 000000000000..d06bb26f8eab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "count": 1, + "isDefault": false, + "names": [ + "string" + ], + "searchText": "string", + "orderBy": "string", + "orderByAsc": false + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "isDefault": false, + "properties": null, + "credentials": { + "credentialsType": "AccountKey", + "secrets": { + "secretsType": "AccountKey" + } + }, + "datastoreType": "AzureBlob", + "accountName": "string", + "containerName": "string", + "endpoint": "core.windows.net", + "protocol": "https" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/listSecrets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/listSecrets.json new file mode 100644 index 000000000000..7aa1ed7272c3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Datastore/listSecrets.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "secretsType": "AccountKey", + "key": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ExternalFQDN/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ExternalFQDN/get.json new file mode 100644 index 000000000000..3145a459554e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ExternalFQDN/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "category": "Azure Active Directory", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + }, + { + "properties": { + "category": "Azure portal", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Feature/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Feature/get.json new file mode 100644 index 000000000000..2afc7765fcc5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-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-06-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-06-01-preview/examples/Feature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Feature/list.json new file mode 100644 index 000000000000..315c9ac8eba8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-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-06-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-06-01-preview/examples/Job/AutoMLJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/createOrUpdate.json new file mode 100644 index 000000000000..624de7614191 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/createOrUpdate.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "f69c8d5a-9b39-4183-92d3-a2b18944cf95": 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": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "CancelRequested", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "94ce04ed-3b17-4e48-a2a6-a923068268fd": 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": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "a6f57022-8e31-44db-98e6-fa9495abb01c": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Provisioning", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "0aec33cb-4916-4b3b-b610-35f3f78cc6f0": 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": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "342c3b36-f4d6-4af6-8410-7198803cff8f": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/get.json new file mode 100644 index 000000000000..a15ddc0846af --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/get.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Scheduled", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "9c4f5d89-ed21-42e3-9263-246633ca4a50": 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", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "30a01c8b-9d69-4924-8a14-63a1fbd78f3a": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:19", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:19", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/list.json new file mode 100644 index 000000000000..09c0fa721b7e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/AutoMLJob/list.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "All", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "4e53b3df-bd02-42d1-a3cd-ee4678c0b79f": 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": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "1a89709e-1af8-41de-99c1-0349bd20e005": null + }, + "queueSettings": { + "jobTier": "Spot", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:22", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:22", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/createOrUpdate.json new file mode 100644 index 000000000000..0829f1c05fbf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/createOrUpdate.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "c9ac10d0-915b-4de5-afe8-a4c78a37a558": 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", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "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": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "500bc411-5f81-4b2c-aae9-f84c33146a4c": 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", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "56fc2716-8290-4394-867e-14e89387af68": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Preparing", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "56a57b62-09f2-48ee-a4ec-a19a230a6aa0": 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", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "e3455adb-ad77-4518-985a-c60703f3d3ea": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/get.json new file mode 100644 index 000000000000..16013c3f646d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/get.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "a2da3516-d5bf-4e6f-a220-463602afc87c": 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": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Enabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "049b85fe-425d-4ec6-b194-85c0f2771fe5": null + }, + "queueSettings": { + "jobTier": "Spot", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/list.json new file mode 100644 index 000000000000..daf3ad2cc782 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/CommandJob/list.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "ActiveOnly", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "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": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "47f85ca1-a889-4417-a451-2ebca543e605": 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": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "13a3c675-c28b-4143-807e-fde07ad06a01": null + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:23", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:23", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/createOrUpdate.json new file mode 100644 index 000000000000..7729f4340875 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/createOrUpdate.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/get.json new file mode 100644 index 000000000000..c95f2a829bbe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/list.json new file mode 100644 index 000000000000..6c72a2f2a3eb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/PipelineJob/list.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "NotStarted", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "status": "string", + "errorMessage": "string", + "properties": { + "string": "string" + } + } + }, + "computeId": "string", + "jobType": "Pipeline", + "settings": {}, + "inputs": { + "string": { + "description": "string", + "jobInputType": "literal", + "value": "string" + } + }, + "outputs": { + "string": { + "description": "string", + "jobOutputType": "uri_file", + "mode": "Upload", + "uri": "string" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/createOrUpdate.json new file mode 100644 index 000000000000..cf77f15b4a1d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/createOrUpdate.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "experimentName": "string", + "services": { + "string": { + "jobServiceType": "string", + "port": 1, + "endpoint": "string", + "properties": { + "string": "string" + }, + "nodes": { + "nodesValueType": "All" + } + } + }, + "computeId": "string", + "isArchived": false, + "identity": { + "identityType": "AMLToken" + }, + "componentId": "string", + "notificationSetting": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "5fc1f627-491e-45a0-a6a2-f5b4be884911": 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": "ReadWriteMount", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "queueSettings": { + "jobTier": "Basic", + "priority": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Starting", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "b2de23ac-268c-459c-bbf3-0d8ece77d247": 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", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "5489ee88-92db-4266-b321-ed47823d52b8": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:25", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Starting", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "64db9b4b-db26-4473-9eb8-49e5e5cbeb3f": 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", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "307f11f6-ff8d-450d-b8a3-4c9d0f7d883f": null + }, + "queueSettings": { + "jobTier": "Standard", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:25", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/get.json new file mode 100644 index 000000000000..fb4f295ed6c7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/get.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Preparing", + "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": [ + "JobCancelled" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "81750226-212a-41d5-b3c3-d6ba8a48ed6e": 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": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "92ae6a47-dc8b-407a-88d1-2e8a1932e15a": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:24", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:24", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/list.json new file mode 100644 index 000000000000..71da0cab88e9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/SweepJob/list.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "jobType": "string", + "tag": "string", + "listViewType": "ActiveOnly", + "assetName": "string", + "scheduled": false, + "scheduleId": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "status": "Running", + "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" + ] + }, + "jobType": "Command", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "locations": [ + "string" + ], + "properties": { + "string": { + "0a76565a-7e17-45ce-bdea-0548a617ce27": 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": "Direct", + "jobOutputType": "uri_file" + } + }, + "distribution": { + "distributionType": "TensorFlow", + "workerCount": 1, + "parameterServerCount": 1 + }, + "autologgerSettings": { + "mlflowAutologger": "Disabled" + }, + "limits": { + "timeout": "PT5M", + "jobLimitsType": "Command" + }, + "environmentVariables": { + "string": "string" + }, + "parameters": { + "ed0b17ef-7461-4e01-92bb-376554a4ee87": null + }, + "queueSettings": { + "jobTier": "Premium", + "priority": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:25", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:25", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/cancel.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/cancel.json new file mode 100644 index 000000000000..ab35b7f656d3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/cancel.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/delete.json new file mode 100644 index 000000000000..b0772f53fa2f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "id": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Job/update.json new file mode 100644 index 000000000000..a61cc5e9cb0d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-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-06-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-06-01-preview/examples/LabelingJob/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/createOrUpdate.json new file mode 100644 index 000000000000..760cd8c5da54 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/createOrUpdate.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "id": "testLabelingJob", + "body": { + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/delete.json new file mode 100644 index 000000000000..fa9eb7f6c26c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "id": "testLabelingJob" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/exportLabels.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/exportLabels.json new file mode 100644 index 000000000000..f2f1d27c7a0a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/exportLabels.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "id": "testLabelingJob", + "body": { + "format": "Dataset" + } + }, + "responses": { + "200": { + "body": { + "format": "Dataset", + "labelingJobId": "string", + "exportedRowCount": 0, + "startDateTime": "2021-02-08T23:34:40.730Z", + "endDateTime": "2021-02-08T23:34:40.730Z" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/get.json new file mode 100644 index 000000000000..2be1f093fc60 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/get.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "id": "testLabelingJob", + "includeJobInstructions": true, + "includeLabelCategories": true + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/list.json new file mode 100644 index 000000000000..e16781e32d3e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/list.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "$skipToken": "skiptoken", + "count": "10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/labelingJobs/testLabelingJob", + "name": "testLabelingJob", + "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs", + "properties": { + "jobType": "Labeling", + "description": "string", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "labelCategories": { + "myCategory1": { + "displayName": "myCategory1Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + }, + "myCategory2": { + "displayName": "myCategory2Title", + "multiSelect": "Disabled", + "classes": { + "myLabelClass1": { + "displayName": "myLabelClass1", + "subclasses": {} + }, + "myLabelClass2": { + "displayName": "myLabelClass2", + "subclasses": {} + } + } + } + }, + "jobInstructions": { + "uri": "link/to/instructions" + }, + "mlAssistConfiguration": { + "mlAssist": "Enabled", + "inferencingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/myscoringcompute", + "trainingComputeBinding": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/computes/mytrainingompute" + }, + "labelingJobMediaProperties": { + "mediaType": "Image" + }, + "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "status": "NotStarted", + "progressMetrics": { + "totalDatapointCount": 0, + "completedDatapointCount": 0, + "skippedDatapointCount": 0, + "incrementalDataLastRefreshDateTime": "2020-12-08T01:23:37.234Z" + }, + "statusMessages": [ + { + "level": "Error", + "code": "string", + "message": "string", + "createdDateTime": "2020-12-08T01:23:37.234Z" + } + ], + "createdDateTime": "2020-12-08T01:23:37.234Z" + }, + "systemData": { + "createdAt": "2020-12-08T01:23:37.235Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-08T01:23:37.235Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/pause.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/pause.json new file mode 100644 index 000000000000..85ae711579ab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/pause.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "id": "testLabelingJob" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/resume.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/resume.json new file mode 100644 index 000000000000..ca2004342f6b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/LabelingJob/resume.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "id": "testLabelingJob" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/createOrUpdateRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/createOrUpdateRule.json new file mode 100644 index 000000000000..962aad7a4df1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/createOrUpdateRule.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "some_string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Active", + "category": "UserDefined" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": { + "headers": {}, + "body": { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Active", + "category": "UserDefined" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json new file mode 100644 index 000000000000..0584ddea1faa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/deleteRule.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "some_string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/getRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/getRule.json new file mode 100644 index 000000000000..3389e6a48c7e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/getRule.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "ruleName": "some_string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Active", + "category": "UserDefined" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/listRule.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/listRule.json new file mode 100644 index 000000000000..ad83cf61781a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/listRule.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Inactive", + "category": "Required" + } + }, + { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "type": "FQDN", + "destination": "some_string", + "status": "Inactive", + "category": "Required" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/provision.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/provision.json new file mode 100644 index 000000000000..d751a70db3e0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/ManagedNetwork/provision.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "api-version": "2023-06-01-preview", + "body": { + "includeSpark": false + } + }, + "responses": { + "202": { + "headers": { + "Location": "example_location" + } + }, + "200": { + "body": { + "status": "Active", + "sparkReady": true + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Notebook/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Notebook/listKeys.json new file mode 100644 index 000000000000..3305fdbeaf42 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Notebook/listKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Notebook/prepare.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Notebook/prepare.json new file mode 100644 index 000000000000..0f9ab72fd88b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Notebook/prepare.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json new file mode 100644 index 000000000000..5e2a09a6da42 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json new file mode 100644 index 000000000000..8893440fa081 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json new file mode 100644 index 000000000000..7a505d29b603 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.MachineLearning.Services/endpoints/deployments", + "sku": { + "name": "string", + "tier": "Free" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Automatic" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json new file mode 100644 index 000000000000..6449974443cf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json new file mode 100644 index 000000000000..f78e090be558 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/get.json new file mode 100644 index 000000000000..308beb67de37 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/get.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json new file mode 100644 index 000000000000..7a505d29b603 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.MachineLearning.Services/endpoints/deployments", + "sku": { + "name": "string", + "tier": "Free" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "Automatic" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/update.json new file mode 100644 index 000000000000..8302cebf04d4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/ManagedOnlineDeployment/update.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "body": { + "tags": {}, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Managed", + "modelMountPath": "string", + "readinessProbe": { + "failureThreshold": 30, + "successThreshold": 1, + "timeout": "PT2S", + "period": "PT10S", + "initialDelay": "PT1S" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/getLogs.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/getLogs.json new file mode 100644 index 000000000000..9b901bb51edc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/getLogs.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "endpointName": "testEndpoint", + "deploymentName": "testDeployment", + "body": { + "containerType": "StorageInitializer", + "tail": 0 + } + }, + "responses": { + "200": { + "body": { + "content": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/list.json new file mode 100644 index 000000000000..fb0e90590dfc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/OnlineDeployment/list.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "scaleSettings": { + "scaleType": "Default" + }, + "requestSettings": { + "maxQueueWait": "PT5M", + "requestTimeout": "PT5M", + "maxConcurrentRequestsPerInstance": 1 + }, + "modelMountPath": "string", + "appInsightsEnabled": false, + "livenessProbe": { + "failureThreshold": 1, + "successThreshold": 1, + "timeout": "PT5M", + "period": "PT5M", + "initialDelay": "PT5M" + }, + "provisioningState": "Creating", + "instanceType": "string", + "model": "string", + "endpointComputeType": "Kubernetes", + "containerResourceRequirements": { + "containerResourceRequests": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + }, + "containerResourceLimits": { + "cpu": "\"1\"", + "memory": "\"2Gi\"", + "gpu": "\"1\"" + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json new file mode 100644 index 000000000000..ca47c41f7437 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/createOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2023-06-01-preview", + "monitor": "true", + "body": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/delete.json new file mode 100644 index 000000000000..858dc603d743 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2023-06-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/get.json new file mode 100644 index 000000000000..fecf01062c91 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2023-06-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/list.json new file mode 100644 index 000000000000..d4d617b75664 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateEndpointConnection/list.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2023-06-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateLinkResource/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateLinkResource/list.json new file mode 100644 index 000000000000..3bf72e21c5f4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/PrivateLinkResource/list.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateLinkResources/amlworkspace", + "name": "amlworkspace", + "type": "Microsoft.MachineLearningServices/workspaces/privateLinkResources", + "properties": { + "groupId": "amlworkspace", + "requiredMembers": [ + "default" + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Quota/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Quota/list.json new file mode 100644 index 000000000000..e1407283faba --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Quota/list.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quota", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Quota/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Quota/update.json new file mode 100644 index 000000000000..32abe14c7ca9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Quota/update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-06-01-preview", + "parameters": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count", + "status": "Success" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count", + "status": "Success" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/createOrUpdate-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/createOrUpdate-SystemCreated.json new file mode 100644 index 000000000000..04c6ffc1368d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/createOrUpdate-SystemCreated.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/createOrUpdate-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/createOrUpdate-UserCreated.json new file mode 100644 index 000000000000..dc789c0daaf2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/createOrUpdate-UserCreated.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "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": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:39", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:39", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:39", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:39", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/delete.json new file mode 100644 index 000000000000..651060b4246a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location", + "Retry-After": 100 + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/get-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/get-SystemCreated.json new file mode 100644 index 000000000000..232e36cd6c54 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/get-SystemCreated.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:40", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:40", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/get-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/get-UserCreated.json new file mode 100644 index 000000000000..6c536324d8ef --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/get-UserCreated.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "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": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:45", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:45", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/list-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/list-SystemCreated.json new file mode 100644 index 000000000000..6e47c78ce350 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/list-SystemCreated.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:40", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:40", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/list-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/list-UserCreated.json new file mode 100644 index 000000000000..8aac51c26174 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/list-UserCreated.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "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": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:42", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:42", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/listBySubscription.json new file mode 100644 index 000000000000..3815ba787fac --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/listBySubscription.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/removeRegions.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/removeRegions.json new file mode 100644 index 000000000000..18a5aeca27f3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/removeRegions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "None", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + }, + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:01", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:01", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "202": { + "headers": { + "Location": "example_location", + "Retry-After": 100 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/update-SystemCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/update-SystemCreated.json new file mode 100644 index 000000000000..3203dca9dce7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/update-SystemCreated.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "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 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "systemCreatedStorageAccount": { + "storageAccountName": "string", + "storageAccountType": "string", + "storageAccountHnsEnabled": false, + "armResourceId": { + "resourceId": "string" + }, + "allowBlobPublicAccess": false + } + } + ], + "acrDetails": [ + { + "systemCreatedAcrAccount": { + "acrAccountName": "string", + "acrAccountSku": "string", + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:02", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:02", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/update-UserCreated.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/update-UserCreated.json new file mode 100644 index 000000000000..10856669c54e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registries/update-UserCreated.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "string", + "api-version": "2023-06-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Basic", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "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": "Free", + "size": "string", + "family": "string", + "capacity": 1 + }, + "id": "string", + "name": "string", + "type": "string", + "properties": { + "regionDetails": [ + { + "location": "string", + "storageAccountDetails": [ + { + "userCreatedStorageAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ], + "acrDetails": [ + { + "userCreatedAcrAccount": { + "armResourceId": { + "resourceId": "string" + } + } + } + ] + } + ], + "intellectualPropertyPublisher": "string", + "publicNetworkAccess": "string", + "discoveryUrl": "string", + "managedResourceGroup": { + "resourceId": "string" + }, + "mlFlowRegistryUri": "string", + "registryPrivateEndpointConnections": [ + { + "id": "string", + "location": "string", + "properties": { + "provisioningState": "string", + "privateEndpoint": { + "id": "string", + "subnetArmId": "string" + }, + "registryPrivateLinkServiceConnectionState": { + "status": "Approved", + "description": "string", + "actionsRequired": "string" + }, + "groupIds": [ + "string" + ] + } + } + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/createOrUpdate.json new file mode 100644 index 000000000000..e2b54e09e05f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2023-06-01-preview", + "codeName": "testContainer", + "body": { + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/delete.json new file mode 100644 index 000000000000..924d207888ef --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2023-06-01-preview", + "codeName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/get.json new file mode 100644 index 000000000000..ace9af5c0544 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2023-06-01-preview", + "codeName": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/list.json new file mode 100644 index 000000000000..514992c4abd0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeContainer/list.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2023-06-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/codes/testContainer2", + "name": "testContainer2", + "type": "Microsoft.MachineLearningServices/registries/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..28af6743b65a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-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-06-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-06-01-preview/examples/Registry/CodeVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/createOrUpdate.json new file mode 100644 index 000000000000..420a8b17b5de --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/delete.json new file mode 100644 index 000000000000..6ee5b89ffae1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/get.json new file mode 100644 index 000000000000..f31c2def4c3f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/list.json new file mode 100644 index 000000000000..e1afd7358a6c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/CodeVersion/list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "codeName": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/createOrUpdate.json new file mode 100644 index 000000000000..008fa205cdd2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/createOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/delete.json new file mode 100644 index 000000000000..1128b7083a43 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/get.json new file mode 100644 index 000000000000..1ae40072cb14 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/list.json new file mode 100644 index 000000000000..d66c6fb3152d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentContainer/list.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "testContainer", + "api-version": "2023-06-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/createOrUpdate.json new file mode 100644 index 000000000000..093dd57e09ed --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/createOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "8ced901b-d826-477d-bfef-329da9672513": null + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "2de2e74e-457d-4447-a581-933abc2b9d96": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "a6c1349d-5e45-48da-92c3-3ce176cb30e9": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/delete.json new file mode 100644 index 000000000000..8abad668acab --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/get.json new file mode 100644 index 000000000000..2113f5975cba --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "1a7c40b5-2029-4f5f-a8d6-fd0822038773": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/list.json new file mode 100644 index 000000000000..c346f0ddab68 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ComponentVersion/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "componentName": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "50acbce5-cccc-475a-8ac6-c4da402afbd8": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/createOrUpdate.json new file mode 100644 index 000000000000..a67dd2e84c46 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "dataType": "uri_folder" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "mltable" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/delete.json new file mode 100644 index 000000000000..e94d89cb5c48 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/get.json new file mode 100644 index 000000000000..fdd57805ea62 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_file" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/registryList.json new file mode 100644 index 000000000000..6da9508a9387 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataContainer/registryList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "dataType": "uri_folder" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:15", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:15", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..a05a3f5d728e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-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-06-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-06-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json new file mode 100644 index 000000000000..a6c6ebba910f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/createOrUpdate.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:13", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:13", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/delete.json new file mode 100644 index 000000000000..09ee840820cd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/get.json new file mode 100644 index 000000000000..15b90cea98a1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:14", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:14", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/registryList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/registryList.json new file mode 100644 index 000000000000..778e91111218 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/DataVersionBase/registryList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "registryName", + "name": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string", + "$tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "dataUri": "string", + "dataType": "mltable", + "referencedUris": [ + "string" + ] + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/createOrUpdate.json new file mode 100644 index 000000000000..70f843206af4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2023-06-01-preview", + "environmentName": "testEnvironment", + "body": { + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.300Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.300Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.301Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.301Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/delete.json new file mode 100644 index 000000000000..6fbf50822335 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2023-06-01-preview", + "environmentName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/get.json new file mode 100644 index 000000000000..a8e8caadfcca --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "api-version": "2023-06-01-preview", + "environmentName": "testEnvironment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/list.json new file mode 100644 index 000000000000..b99e283934d2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentContainer/list.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "testregistry", + "environmentName": "testContainer", + "api-version": "2023-06-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/testregistry/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/registries/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/createOrUpdate.json new file mode 100644 index 000000000000..8b7403bf6a9f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/createOrUpdate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/delete.json new file mode 100644 index 000000000000..f46e2d494e12 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/get.json new file mode 100644 index 000000000000..59446706b7f2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "environmentName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/list.json new file mode 100644 index 000000000000..71c8271b640f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/EnvironmentVersion/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-regsitry", + "environmentName": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/createOrUpdate.json new file mode 100644 index 000000000000..1c5a75a9d245 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2023-06-01-preview", + "modelName": "testContainer", + "body": { + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/delete.json new file mode 100644 index 000000000000..4a9ab857feb4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2023-06-01-preview", + "modelName": "testContainer" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/get.json new file mode 100644 index 000000000000..55ba66bfb674 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2023-06-01-preview", + "modelName": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/list.json new file mode 100644 index 000000000000..5343ff2fc5a9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "registryName": "registry123", + "api-version": "2023-06-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/registries/registry123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/registries/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..fe25a4e20aa6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-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-06-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-06-01-preview/examples/Registry/ModelVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/createOrUpdate.json new file mode 100644 index 000000000000..2f7533410c3b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/delete.json new file mode 100644 index 000000000000..494b19f9c99e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/get.json new file mode 100644 index 000000000000..56ffc2329fa9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/list.json new file mode 100644 index 000000000000..b8c70c5936b9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "$orderBy": "string", + "$top": 1, + "version": "string", + "description": "string", + "offset": 1, + "tags": "string", + "properties": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/package.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/package.json new file mode 100644 index 000000000000..8288be5a39f1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Registry/ModelVersion/package.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "registryName": "my-aml-registry", + "modelName": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string", + "logUrl": "string", + "buildId": "string", + "buildState": "NotStarted" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/createOrUpdate.json new file mode 100644 index 000000000000..e443ab7e7b95 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/createOrUpdate.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "9965593e-526f-4b89-bb36-761138cf2794": null + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "d77a9a9a-4bb5-4c0c-8a77-459be8b82b9f": null + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "13ea51e0-ff28-49c3-a85d-9b5199eb14e5": null + } + }, + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/delete.json new file mode 100644 index 000000000000..09b6bff322a8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/get.json new file mode 100644 index 000000000000..c8a78f22a9af --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "a108545b-def1-4c86-8e53-dbcb1de3a8bc": null + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/list.json new file mode 100644 index 000000000000..8670308c20f9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Schedule/list.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "displayName": "string", + "isEnabled": false, + "trigger": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Cron", + "expression": "string" + }, + "action": { + "actionType": "InvokeBatchEndpoint", + "endpointInvocationDefinition": { + "00cd1396-a094-4d48-8d86-14c43a55a6af": null + } + }, + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Usage/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Usage/list.json new file mode 100644 index 000000000000..692f3b3e6b22 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Usage/list.json @@ -0,0 +1,400 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/totalCores/usages", + "currentValue": 7, + "limit": 100, + "name": { + "localizedValue": "Clusters", + "value": "Clusters" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/dedicatedCores/usages", + "currentValue": 14, + "limit": 24, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "Total Cluster Dedicated Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster2_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 12, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluser1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/lowPriorityCores/usages", + "currentValue": 18, + "limit": 50, + "name": { + "localizedValue": "Total Cluster LowPriority Regional vCPUs", + "value": "Total Cluster LowPriority Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "value": "Standard D Family Cluster LowPriority vCPUs", + "localizedValue": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard DSv2 Family Cluster LowPriority vCPUs", + "value": "Standard DSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard Dv2 Family Cluster LowPriority vCPUs", + "value": "Standard Dv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard FSv2 Family Cluster LowPriority vCPUs", + "value": "Standard FSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 18, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 12, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv2 Family Cluster LowPriority vCPUs", + "value": "Standard NCv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv3 Family Cluster LowPriority vCPUs", + "value": "Standard NCv3 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard ND Family Cluster LowPriority vCPUs", + "value": "Standard ND Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NDv2 Family Cluster LowPriority vCPUs", + "value": "Standard NDv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NV Family Cluster LowPriority vCPUs", + "value": "Standard NV Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/VirtualMachineSize/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/VirtualMachineSize/list.json new file mode 100644 index 000000000000..96656ac0fa59 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/VirtualMachineSize/list.json @@ -0,0 +1,388 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2023-06-01-preview", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", + "vCPUs": 1, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 7168, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.13, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.01, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.05, + "osType": "Windows", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.03, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.1, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.25, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.2, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.06, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.5, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.29, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS4_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.12, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.4, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.01, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.58, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 1.17, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.81, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.02, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.23, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.26, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.18, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.11, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.04, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.37, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.53, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.21, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.42, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.74, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 1.06, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.3, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.48, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.84, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.11, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/createOrUpdate.json new file mode 100644 index 000000000000..e4bef12867fe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/createOrUpdate.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "cd3c37dc-2876-4ca4-8a54-21bd7619724a": null + } + } + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "4939850d-8eae-4343-8566-0826259a2ad1": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "b76755e4-16bf-45d4-b625-6634df7444cc": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/delete.json new file mode 100644 index 000000000000..d1fef4f7611b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/get.json new file mode 100644 index 000000000000..1c78158bd3f0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "843c2bb4-e5f1-4267-98c8-ba22a99dbb00": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/list.json new file mode 100644 index 000000000000..c2fef2522e25 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/list.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/update.json new file mode 100644 index 000000000000..e8bf98deadaa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchDeployment/update.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "deploymentName": "testDeploymentName", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string" + }, + "tags": {} + } + }, + "responses": { + "200": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + }, + "environmentId": "string", + "environmentVariables": { + "string": "string" + }, + "compute": "string", + "errorThreshold": 1, + "retrySettings": { + "maxRetries": 1, + "timeout": "PT5M" + }, + "miniBatchSize": 1, + "loggingLevel": "Info", + "model": { + "referenceType": "Id", + "assetId": "string" + }, + "maxConcurrencyPerInstance": 1, + "outputAction": "SummaryOnly", + "outputFileName": "string", + "resources": { + "instanceCount": 1, + "instanceType": "string", + "properties": { + "string": { + "1e5e1cf9-b0ea-4cf6-9764-e750bf85c10a": null + } + } + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..7531782b5071 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/createOrUpdate.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/delete.json new file mode 100644 index 000000000000..65186ecf33e0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1234", + "workspaceName": "testworkspace", + "endpointName": "testBatchEndpoint", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/get.json new file mode 100644 index 000000000000..3f8f8d30552d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/list.json new file mode 100644 index 000000000000..99200e1c17d7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "count": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/listKeys.json new file mode 100644 index 000000000000..7b78f668dd25 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/update.json new file mode 100644 index 000000000000..6839ebe2b174 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/BatchEndpoint/update.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": { + "Location": "example_location" + }, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "defaults": { + "deploymentName": "string" + }, + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/createOrUpdate.json new file mode 100644 index 000000000000..aac512a9aece --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "name": "testContainer", + "body": { + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/delete.json new file mode 100644 index 000000000000..f70cc784b929 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/get.json new file mode 100644 index 000000000000..40e813df84be --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/list.json new file mode 100644 index 000000000000..699f111f9649 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeContainer/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "name": "testcode", + "api-version": "2023-06-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer2", + "name": "testContainer2", + "type": "Microsoft.MachineLearningServices/workspaces/codes", + "properties": { + "description": "string", + "tags": { + "property1": "string", + "property2": "string" + } + }, + "systemData": { + "createdAt": "2020-08-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-08-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json new file mode 100644 index 000000000000..1aaf87f476c9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-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-06-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-06-01-preview/examples/Workspace/CodeVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/createOrUpdate.json new file mode 100644 index 000000000000..6e5d1dd0fbda --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/delete.json new file mode 100644 index 000000000000..5d2589289724 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/get.json new file mode 100644 index 000000000000..940f5c02a17c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/list.json new file mode 100644 index 000000000000..a2ef03f1a786 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/CodeVersion/list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "codeUri": "https://blobStorage/folderName" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/createOrUpdate.json new file mode 100644 index 000000000000..062426e34cff --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/createOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/delete.json new file mode 100644 index 000000000000..2be4dcea1231 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/get.json new file mode 100644 index 000000000000..1a0873cb56da --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/list.json new file mode 100644 index 000000000000..e821e76e9300 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentContainer/list.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/createOrUpdate.json new file mode 100644 index 000000000000..c468702e5591 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/createOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "8ced901b-d826-477d-bfef-329da9672513": null + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "2de2e74e-457d-4447-a581-933abc2b9d96": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "a6c1349d-5e45-48da-92c3-3ce176cb30e9": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/delete.json new file mode 100644 index 000000000000..5d2589289724 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/get.json new file mode 100644 index 000000000000..b3f91e8ad054 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "1a7c40b5-2029-4f5f-a8d6-fd0822038773": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/list.json new file mode 100644 index 000000000000..8db7410f38b8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ComponentVersion/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "componentSpec": { + "50acbce5-cccc-475a-8ac6-c4da402afbd8": null + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/createOrUpdate.json new file mode 100644 index 000000000000..aba358e72ca5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/createOrUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "name": "datacontainer123", + "body": { + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/delete.json new file mode 100644 index 000000000000..8b2cd6a12014 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "name": "datacontainer123" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/get.json new file mode 100644 index 000000000000..31b1dfad76e4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "name": "datacontainer123" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datacontainer123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/list.json new file mode 100644 index 000000000000..f6ab000ab23b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataContainer/list.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "name": "data123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123", + "name": "datastore123", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer124", + "name": "datastore124", + "type": "Microsoft.MachineLearningServices/workspaces/data", + "properties": { + "dataType": "UriFile", + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "properties1": "value1", + "properties2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/createOrUpdate.json new file mode 100644 index 000000000000..62d0a37a9716 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/delete.json new file mode 100644 index 000000000000..5d2589289724 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/get.json new file mode 100644 index 000000000000..956f4ee10f98 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/list.json new file mode 100644 index 000000000000..b31784baebd7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/DataVersionBase/list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string", + "$tags": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "dataType": "uri_file", + "dataUri": "string", + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/createOrUpdate.json new file mode 100644 index 000000000000..7bcfa9915085 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/createOrUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "name": "testEnvironment", + "body": { + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.300Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.300Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "properties": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "description": "string" + }, + "systemData": { + "createdAt": "2020-12-04T03:39:11.301Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-12-04T03:39:11.301Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/delete.json new file mode 100644 index 000000000000..f70cc784b929 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/get.json new file mode 100644 index 000000000000..9c6b1b382e37 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "name": "testEnvironment" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/list.json new file mode 100644 index 000000000000..5c8d8168b1fa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "$skipToken": "skiptoken" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment", + "name": "testEnvironment", + "type": "Microsoft.MachineLearningServices/workspaces/environments", + "properties": { + "description": "string", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/createOrUpdate.json new file mode 100644 index 000000000000..53aa2f475ffe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/createOrUpdate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/delete.json new file mode 100644 index 000000000000..5d2589289724 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/get.json new file mode 100644 index 000000000000..2b5a035c3012 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/list.json new file mode 100644 index 000000000000..211b84de05ed --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/EnvironmentVersion/list.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "$orderBy": "string", + "$top": 1, + "$skipToken": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "environmentType": "Curated", + "image": "docker.io/tensorflow/serving:latest", + "condaFile": "string", + "build": { + "contextUri": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "dockerfilePath": "prod/Dockerfile" + }, + "inferenceConfig": { + "livenessRoute": { + "path": "string", + "port": 1 + }, + "readinessRoute": { + "path": "string", + "port": 1 + }, + "scoringRoute": { + "path": "string", + "port": 1 + } + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json new file mode 100644 index 000000000000..29dccc754e74 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:48", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:48", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/delete.json new file mode 100644 index 000000000000..e7544c46fa5a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json new file mode 100644 index 000000000000..739c329a5f8e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/list.json new file mode 100644 index 000000000000..2289419149d9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "ArchivedOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:46", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:46", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/backfill.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/backfill.json new file mode 100644 index 000000000000..11f7572fcedc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/backfill.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "displayName": "string", + "description": "string", + "featureWindow": { + "featureWindowStart": "2020-01-01T12:34:56.999+00:51", + "featureWindowEnd": "2020-01-01T12:34:56.999+00:51" + }, + "tags": { + "string": "string" + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "string" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json new file mode 100644 index 000000000000..677c07452ffc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/createOrUpdate.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Online", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Monday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "OnlineAndOffline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Day", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Deleting" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Hour", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCancelled" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Failed" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/delete.json new file mode 100644 index 000000000000..4c19e5c8bebc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/get.json new file mode 100644 index 000000000000..a9e88556bb42 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "None", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Minute", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Wednesday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobFailed" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:52", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:52", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/list.json new file mode 100644 index 000000000000..9c7819462e63 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/list.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "specification": { + "path": "string" + }, + "materializationSettings": { + "storeType": "Offline", + "schedule": { + "endTime": "string", + "startTime": "string", + "timeZone": "string", + "triggerType": "Recurrence", + "frequency": "Month", + "interval": 1, + "schedule": { + "hours": [ + 1 + ], + "minutes": [ + 1 + ], + "weekDays": [ + "Saturday" + ], + "monthDays": [ + 1 + ] + } + }, + "notification": { + "emails": [ + "string" + ], + "emailOn": [ + "JobCompleted" + ] + }, + "resource": { + "instanceType": "string" + }, + "sparkConfiguration": { + "string": "string" + } + }, + "stage": "string", + "entities": [ + "string" + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:49", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:49", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/listMaterializationJobs.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/listMaterializationJobs.json new file mode 100644 index 000000000000..3864d26225e5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturesetVersion/listMaterializationJobs.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "filters": "string", + "featureWindowStart": "string", + "featureWindowEnd": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "RecurrentMaterialization", + "jobId": "string", + "experimentId": "string", + "displayName": "string", + "createdDate": "2020-01-01T12:34:56.999+00:53", + "duration": "PT5M", + "status": "CancelRequested", + "featureWindow": { + "featureWindowStart": "2020-01-01T12:34:56.999+00:53", + "featureWindowEnd": "2020-01-01T12:34:56.999+00:53" + }, + "tags": { + "string": "string" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json new file mode 100644 index 000000000000..abc0fd80c527 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:38", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:38", + "lastModifiedBy": "string", + "lastModifiedByType": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json new file mode 100644 index 000000000000..e7544c46fa5a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json new file mode 100644 index 000000000000..19bde4b5944b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/getEntity.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Updating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json new file mode 100644 index 000000000000..620ac037f92b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityContainer/list.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "All" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "latestVersion": "string", + "nextVersion": "string", + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:43", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:43", + "lastModifiedBy": "string", + "lastModifiedByType": "Application" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json new file mode 100644 index 000000000000..1651b21fba3e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Integer", + "columnName": "string" + } + ], + "provisioningState": "Canceled" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:58", + "createdBy": "string", + "createdByType": "Key", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:58", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json new file mode 100644 index 000000000000..4c19e5c8bebc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json new file mode 100644 index 000000000000..838583168990 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:57", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:57", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json new file mode 100644 index 000000000000..8065130438bf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/FeaturestoreEntityVersion/list.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "tags": "string", + "listViewType": "ActiveOnly" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isArchived": false, + "isAnonymous": false, + "indexColumns": [ + { + "dataType": "Datetime", + "columnName": "string" + } + ], + "provisioningState": "Creating" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999+00:55", + "createdBy": "string", + "createdByType": "Application", + "lastModifiedAt": "2020-01-01T12:34:56.999+00:55", + "lastModifiedBy": "string", + "lastModifiedByType": "Key" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/createOrUpdate.json new file mode 100644 index 000000000000..5f28d8eec36d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/createOrUpdate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "name": "testContainer", + "body": { + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/delete.json new file mode 100644 index 000000000000..d77defe75830 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "name": "testContainer" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/get.json new file mode 100644 index 000000000000..0e878e93f879 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/list.json new file mode 100644 index 000000000000..00dd3201c4c6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelContainer/list.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "name": "testContainer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer", + "name": "testContainer", + "type": "Microsoft.MachineLearningServices/workspaces/models", + "properties": { + "description": "Model container description", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "systemData": { + "createdAt": "2020-12-01T12:00:00.000Z", + "createdBy": "John Smith", + "createdByType": "User", + "lastModifiedAt": "2020-12-01T12:00:00.000Z", + "lastModifiedBy": "John Smith", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "nextlink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/createOrUpdate.json new file mode 100644 index 000000000000..f7cd6a638735 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/createOrUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/delete.json new file mode 100644 index 000000000000..5d2589289724 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/get.json new file mode 100644 index 000000000000..6eba483aa67a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/list.json new file mode 100644 index 000000000000..317fd82fd181 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/list.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "$orderBy": "string", + "$top": 1, + "version": "string", + "description": "string", + "offset": 1, + "tags": "string", + "properties": "string" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "tags": { + "string": "string" + }, + "properties": { + "string": "string" + }, + "isAnonymous": false, + "flavors": { + "string": { + "data": { + "string": "string" + } + } + }, + "modelType": "CustomModel", + "modelUri": "string" + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/package.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/package.json new file mode 100644 index 000000000000..2872a9767c22 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/ModelVersion/package.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "name": "string", + "version": "string", + "api-version": "2023-06-01-preview", + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "baseEnvironmentSource": { + "baseEnvironmentSourceType": "EnvironmentAsset", + "resourceId": "string" + }, + "inferencingServer": { + "serverType": "AzureMLBatch", + "codeConfiguration": { + "codeId": "string", + "scoringScript": "string" + } + }, + "environmentVariables": { + "string": "string" + }, + "modelConfiguration": { + "mode": "ReadOnlyMount", + "mountPath": "string" + }, + "inputs": [ + { + "inputType": "UriFile", + "mode": "Download", + "path": { + "inputPathType": "Url", + "url": "string" + }, + "mountPath": "string" + } + ], + "tags": { + "string": "string" + }, + "targetEnvironmentId": "string", + "logUrl": "string", + "buildId": "string", + "buildState": "NotStarted" + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineDeployment/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineDeployment/delete.json new file mode 100644 index 000000000000..7a5e8f5a7708 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineDeployment/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg123", + "workspaceName": "workspace123", + "api-version": "2023-06-01-preview", + "endpointName": "testEndpoint", + "deploymentName": "testDeployment" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/createOrUpdate.json new file mode 100644 index 000000000000..a46546e531c6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/createOrUpdate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "authMode": "AMLToken", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "tags": {}, + "location": "string", + "kind": "string", + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + }, + "sku": { + "name": "string", + "tier": "Free", + "size": "string", + "family": "string", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/delete.json new file mode 100644 index 000000000000..9a77cde2f128 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/get.json new file mode 100644 index 000000000000..78378d1b1d81 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/getToken.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/getToken.json new file mode 100644 index 000000000000..6bfc604135ed --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/getToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "accessToken": "string", + "tokenType": "string", + "expiryTimeUtc": 1, + "refreshAfterTimeUtc": 1 + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/list.json new file mode 100644 index 000000000000..347ababb51de --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/list.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "api-version": "2023-06-01-preview", + "$skipToken": "string", + "name": "string", + "count": 1, + "computeType": "Managed", + "tags": "string", + "properties": "string", + "orderBy": "CreatedAtDesc" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/listKeys.json new file mode 100644 index 000000000000..7b78f668dd25 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/listKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryKey": "string", + "secondaryKey": "string" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/regenerateKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/regenerateKeys.json new file mode 100644 index 000000000000..f95e1d4e84f8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/regenerateKeys.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview", + "body": { + "keyType": "Primary", + "keyValue": "string" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/update.json new file mode 100644 index 000000000000..bc664bfdf4a3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/OnlineEndpoint/update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "my-aml-workspace", + "endpointName": "testEndpointName", + "api-version": "2023-06-01-preview", + "body": { + "tags": {}, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "string": {} + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "string", + "name": "string", + "type": "string", + "properties": { + "description": "string", + "properties": { + "string": "string" + }, + "scoringUri": "https://www.contoso.com/example", + "swaggerUri": "https://www.contoso.com/example", + "authMode": "AMLToken", + "provisioningState": "Creating", + "compute": "string", + "traffic": { + "string": 1 + } + }, + "systemData": { + "createdAt": "2020-01-01T12:34:56.999Z", + "createdBy": "string", + "createdByType": "User", + "lastModifiedAt": "2020-01-01T12:34:56.999Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User" + }, + "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": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/create.json new file mode 100644 index 000000000000..cb9f8f6d1179 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/create.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "body": { + "location": "eastus2euap", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": {} + } + }, + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ], + "enableDataIsolation": false + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/delete.json new file mode 100644 index 000000000000..e29da2dd5991 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + }, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/diagnose.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/diagnose.json new file mode 100644 index 000000000000..a4cf7186fc21 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/diagnose.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "body": { + "value": { + "udr": {}, + "nsg": {}, + "resourceLock": {}, + "dnsResolution": {}, + "storageAccount": {}, + "keyVault": {}, + "containerRegistry": {}, + "applicationInsights": {}, + "others": {} + } + } + }, + "responses": { + "200": { + "body": { + "value": { + "userDefinedRouteResults": [], + "networkSecurityRuleResults": [], + "resourceLockResults": [], + "dnsResolutionResults": [ + { + "code": "CustomDNSInUse", + "level": "Warning", + "message": "We have detected an on-premise dns server is configured. Please make sure conditional forwarding is configured correctly according to doc https://foo" + } + ], + "storageAccountResults": [], + "keyVaultResults": [], + "containerRegistryResults": [], + "applicationInsightsResults": [], + "otherResults": [] + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/get.json new file mode 100644 index 000000000000..6093ef371599 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/get.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "serviceProvisionedResourceGroup": "testworkspace_0000111122223333", + "privateLinkCount": 0, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "imageBuildCompute": "testcompute", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/testprivatelinkconnection", + "name": "testprivatelinkconnection", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ], + "sharedPrivateLinkResources": [ + { + "name": "testcosmosdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testcosmosdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ], + "managedNetwork": { + "isolationMode": "AllowOnlyApprovedOutbound", + "networkId": "00000000-1111-2222-3333-444444444444", + "outboundRules": { + "some_string": { + "type": "FQDN", + "destination": "some_string", + "status": "Inactive", + "category": "Required" + } + }, + "status": { + "status": "Active", + "sparkReady": false + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listByResourceGroup.json new file mode 100644 index 000000000000..34e980c1e747 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listBySubscription.json new file mode 100644 index 000000000000..84391cbea506 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listBySubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listKeys.json new file mode 100644 index 000000000000..315ecd2da5b8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listKeys.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null, + "userStorageArmId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + }, + "notebookAccessKeys": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listNotebookAccessToken.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listNotebookAccessToken.json new file mode 100644 index 000000000000..0fe679c2bfaa --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listNotebookAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "notebookResourceId": "94350843095843059", + "hostName": "Host product name", + "publicDns": "resource.notebooks.azure.net", + "tokenType": "Bearer", + "expiresIn": 28800.0, + "scope": "aznb_identity" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listStorageAccountKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listStorageAccountKeys.json new file mode 100644 index 000000000000..3cc0e78284b9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/listStorageAccountKeys.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/operationsList.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/operationsList.json new file mode 100644 index 000000000000..b319853452d0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/operationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.MachineLearningServices/workspaces/write", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "Create/Update Machine Learning workspaces" + } + }, + { + "name": "Microsoft.MachineLearningServices/workspaces/delete", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "Delete Machine Learning workspaces" + } + }, + { + "name": "Microsoft.MachineLearningServices/workspaces/listkeys/action", + "display": { + "provider": "Microsoft MachineLearningServices", + "resource": "workspaces", + "operation": "List workspace Keys" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/resyncKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/resyncKeys.json new file mode 100644 index 000000000000..51166754d267 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/resyncKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/update.json new file mode 100644 index 000000000000..e5d65966f8de --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/Workspace/update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + }, + "202": { + "headers": { + "Location": "example_location" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/create.json new file mode 100644 index 000000000000..1d692c7c107f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "None" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "None" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/delete.json new file mode 100644 index 000000000000..a8c5d219239c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/get.json new file mode 100644 index 000000000000..10f68e471f54 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "None" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/list.json new file mode 100644 index 000000000000..803cd520a22e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/list.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "api-version": "2023-06-01-preview", + "target": "www.facebook.com", + "category": "ContainerRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "expiryTime": "2024-03-15T14:30:00Z", + "target": "www.facebook.com", + "authType": "PAT" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-2", + "name": "connection-2", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ContainerRegistry", + "target": "www.facebook.com", + "authType": "PAT" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/listSecrets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/listSecrets.json new file mode 100644 index 000000000000..5c0f93a9dbd7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/listSecrets.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "connectionName": "some_string", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "CustomKeys", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/update.json new file mode 100644 index 000000000000..2e841ac6798a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceConnection/update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "test-rg", + "workspaceName": "aml-workspace-name", + "connectionName": "some_string", + "api-version": "2023-06-01-preview", + "body": { + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "some_string", + "name": "some_string", + "type": "some_string", + "properties": { + "authType": "AccessKey", + "credentials": { + "accessKeyId": "some_string", + "secretAccessKey": "some_string" + }, + "category": "ADLSGen2", + "expiryTime": "2020-01-01T00:00:00Z", + "target": "some_string", + "metadata": {} + }, + "systemData": { + "createdAt": "2020-01-01T00:00:00Z", + "createdBy": "some_string", + "createdByType": "ManagedIdentity", + "lastModifiedAt": "2020-01-01T00:00:00Z", + "lastModifiedBy": "some_string", + "lastModifiedByType": "Application" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceFeature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceFeature/list.json new file mode 100644 index 000000000000..7f8f8963def2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/examples/WorkspaceFeature/list.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "testworkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "automatedml_createeditexperimentsui", + "displayName": "Create edit experiments UI", + "description": "Create, edit or delete AutoML experiments in the SDK" + }, + { + "id": "workspace_upgradeworkspaceui", + "displayName": "Upgrade workspace UI", + "description": "Upgrade workspace from Basic to enterprise from the UI" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json new file mode 100644 index 000000000000..359ef637c72f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json @@ -0,0 +1,3756 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2023-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Usages": { + "$ref": "./examples/Usage/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Returns supported VM Sizes in a location", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/VirtualMachineSize/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas": { + "post": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_Update", + "description": "Update quota for each VM family in workspace.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for update quota is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaUpdateParameters" + }, + "description": "Quota update parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful.", + "schema": { + "$ref": "#/definitions/UpdateWorkspaceQuotasResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "update quotas": { + "$ref": "./examples/Quota/update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas": { + "get": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_List", + "description": "Gets the currently assigned Workspace Quotas based on VMFamily.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListWorkspaceQuotas" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspace quotas by VMFamily": { + "$ref": "./examples/Quota/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "Compute_List", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { + "$ref": "./examples/Compute/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { + "$ref": "./examples/Compute/get/AKSCompute.json" + }, + "Get a AML Compute": { + "$ref": "./examples/Compute/get/AmlCompute.json" + }, + "Get an ComputeInstance": { + "$ref": "./examples/Compute/get/ComputeInstance.json" + }, + "Get a Kubernetes Compute": { + "$ref": "./examples/Compute/get/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_CreateOrUpdate", + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAmlCompute.json" + }, + "Create an ComputeInstance Compute with minimal inputs": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstanceMinimal.json" + }, + "Create an ComputeInstance Compute": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstance.json" + }, + "Create an ComputeInstance Compute with Schedules": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json" + }, + "Create an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAKSCompute.json" + }, + "Create a DataFactory Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicDataFactoryCompute.json" + }, + "Update a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/AmlCompute.json" + }, + "Update an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/AKSCompute.json" + }, + "Attach a Kubernetes Compute": { + "$ref": "./examples/Compute/createOrUpdate/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Update", + "description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a AmlCompute Compute": { + "$ref": "./examples/Compute/patch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + } + ], + "responses": { + "200": { + "description": "Compute update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Delete", + "description": "Deletes specified Machine Learning compute.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Compute": { + "$ref": "./examples/Compute/delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UnderlyingResourceActionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "204": { + "description": "No content; The target compute does not exist." + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/customServices": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_UpdateCustomServices", + "description": "Updates the custom services list. The list of custom services provided shall be overwritten", + "x-ms-examples": { + "Update Custom Services": { + "$ref": "./examples/Compute/updateCustomServices.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "customServices", + "required": true, + "description": "New list of Custom Services.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomService" + } + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "Compute_ListNodes", + "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/AmlComputeNodesInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "nodes" + }, + "x-ms-examples": { + "Get compute nodes information for a compute": { + "$ref": "./examples/Compute/listNodes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_ListKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { + "$ref": "./examples/Compute/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Start", + "description": "Posts a start action to a compute instance", + "x-ms-examples": { + "Start ComputeInstance Compute": { + "$ref": "./examples/Compute/start.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Stop", + "description": "Posts a stop action to a compute instance", + "x-ms-examples": { + "Stop ComputeInstance Compute": { + "$ref": "./examples/Compute/stop.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Restart", + "description": "Posts a restart action to a compute instance", + "x-ms-examples": { + "Restart ComputeInstance Compute": { + "$ref": "./examples/Compute/restart.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/updateIdleShutdownSetting": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "Compute_UpdateIdleShutdownSetting", + "description": "Updates the idle shutdown setting of a compute instance.", + "x-ms-examples": { + "Update idle shutdown setting of ComputeInstance": { + "$ref": "./examples/Compute/updateIdleShutdownSetting.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "description": "The object for updating idle shutdown setting of specified ComputeInstance.", + "schema": { + "$ref": "#/definitions/IdleShutdownSetting" + } + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": { + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$", + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + }, + "UnderlyingResourceActionParameter": { + "in": "query", + "name": "underlyingResourceAction", + "type": "string", + "description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.", + "required": true, + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "UnderlyingResourceAction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "UsageName": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "gpus": { + "type": "integer", + "format": "int32", + "title": "Number of gPUs", + "description": "The number of gPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { + "type": "integer", + "format": "int32", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true + }, + "lowPriorityCapable": { + "type": "boolean", + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true + }, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + }, + "estimatedVMPrices": { + "title": "Estimated VM prices", + "description": "The estimated price information for using a VM.", + "$ref": "#/definitions/EstimatedVMPrices" + }, + "supportedComputeTypes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Supported Compute Types", + "description": "Specifies the compute types supported by the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "EstimatedVMPrices": { + "type": "object", + "properties": { + "billingCurrency": { + "type": "string", + "title": "Billing currency", + "description": "Three lettered code specifying the currency of the VM price. Example: USD", + "enum": [ + "USD" + ], + "x-ms-enum": { + "name": "BillingCurrency", + "modelAsString": true + } + }, + "unitOfMeasure": { + "type": "string", + "title": "Unit of time measure", + "description": "The unit of time measurement for the specified VM price. Example: OneHour", + "enum": [ + "OneHour" + ], + "x-ms-enum": { + "name": "UnitOfMeasure", + "modelAsString": true + } + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/EstimatedVMPrice" + }, + "x-ms-identifiers": [], + "title": "List of estimated VM prices.", + "description": "The list of estimated prices for using a VM of a particular OS type, tier, etc." + } + }, + "required": [ + "billingCurrency", + "unitOfMeasure", + "values" + ], + "description": "The estimated price info for using a VM." + }, + "EstimatedVMPrice": { + "type": "object", + "properties": { + "retailPrice": { + "type": "number", + "format": "double", + "title": "Retail price", + "description": "The price charged for using the VM." + }, + "osType": { + "type": "string", + "title": "OS type", + "description": "Operating system type used by the VM.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "VMPriceOSType", + "modelAsString": true + } + }, + "vmTier": { + "type": "string", + "title": "VM tier", + "description": "The type of the VM.", + "enum": [ + "Standard", + "LowPriority", + "Spot" + ], + "x-ms-enum": { + "name": "VMTier", + "modelAsString": true + } + } + }, + "required": [ + "retailPrice", + "osType", + "vmTier" + ], + "description": "The estimated price info for using a VM of a particular OS type, tier, etc." + }, + "VirtualMachineSizeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "QuotaBaseProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The properties for Quota update or retrieval." + }, + "QuotaUpdateParameters": { + "type": "object", + "properties": { + "value": { + "description": "The list for update quota.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaBaseProperties" + } + }, + "location": { + "description": "Region of workspace quota to be updated.", + "type": "string" + } + }, + "description": "Quota update parameters." + }, + "UpdateWorkspaceQuotasResult": { + "type": "object", + "properties": { + "value": { + "description": "The list of workspace quota update result.", + "items": { + "$ref": "#/definitions/UpdateWorkspaceQuotas" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", + "readOnly": true, + "type": "string" + } + }, + "description": "The result of update workspace quota." + }, + "UpdateWorkspaceQuotas": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": false, + "title": "Update Workspace Quota Status.", + "description": "Status of update workspace quota.", + "enum": [ + "Undefined", + "Success", + "Failure", + "InvalidQuotaBelowClusterMinimum", + "InvalidQuotaExceedsSubscriptionLimit", + "InvalidVMFamilyName", + "OperationNotSupportedForSku", + "OperationNotEnabledForRegion" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + }, + "description": "The properties for update Quota response." + }, + "ResourceName": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Resource Name." + }, + "ResourceQuota": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "name": { + "$ref": "#/definitions/ResourceName", + "description": "Name of the resource.", + "readOnly": true + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The quota assigned to a resource." + }, + "ListWorkspaceQuotas": { + "type": "object", + "properties": { + "value": { + "description": "The list of Workspace Quotas by VM Family", + "items": { + "$ref": "#/definitions/ResourceQuota" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", + "readOnly": true, + "type": "string" + } + }, + "description": "The List WorkspaceQuotasByVMFamily operation response." + }, + "ResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + }, + { + "$ref": "#/definitions/ComputeResourceSchema" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku", + "description": "The sku of the workspace.", + "x-nullable": true + } + } + }, + "ComputeResourceSchema": { + "type": "object", + "properties": { + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "computeLocation": { + "description": "Location for the underlying compute", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute.", + "x-nullable": true + }, + "createdOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was created." + }, + "modifiedOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was last modified." + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the underlying compute", + "x-nullable": true + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ], + "readOnly": true, + "x-nullable": true + }, + "isAttachedCompute": { + "type": "boolean", + "description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.", + "readOnly": true + }, + "disableLocalAuth": { + "type": "boolean", + "description": "Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/AKSSchema" + } + ], + "x-ms-discriminator-value": "AKS" + }, + "AKSSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string", + "x-nullable": true + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + }, + "x-ms-identifiers": [ + "publicIpAddress" + ], + "readOnly": true, + "x-nullable": true + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "format": "int32", + "minimum": 0, + "x-nullable": true + }, + "agentVmSize": { + "description": "Agent virtual machine size", + "type": "string", + "x-nullable": true + }, + "clusterPurpose": { + "description": "Intended usage of the cluster", + "type": "string", + "default": "FastProd", + "enum": [ + "FastProd", + "DenseProd", + "DevTest" + ], + "x-ms-enum": { + "name": "ClusterPurpose", + "modelAsString": true + } + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration", + "x-nullable": true + }, + "aksNetworkingConfiguration": { + "description": "AKS networking configuration for vnet", + "$ref": "#/definitions/AksNetworkingConfiguration", + "x-nullable": true + }, + "loadBalancerType": { + "description": "Load Balancer Type", + "type": "string", + "default": "PublicIp", + "enum": [ + "PublicIp", + "InternalLoadBalancer" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + } + }, + "loadBalancerSubnet": { + "description": "Load Balancer Subnet", + "type": "string", + "x-nullable": true + } + } + } + } + }, + "Kubernetes": { + "description": "A Machine Learning compute based on Kubernetes Compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/KubernetesSchema" + } + ], + "x-ms-discriminator-value": "Kubernetes" + }, + "KubernetesSchema": { + "type": "object", + "description": "Kubernetes Compute Schema", + "properties": { + "properties": { + "description": "Properties of Kubernetes", + "$ref": "#/definitions/KubernetesProperties" + } + } + }, + "KubernetesProperties": { + "type": "object", + "description": "Kubernetes properties", + "properties": { + "relayConnectionString": { + "description": "Relay connection string.", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "serviceBusConnectionString": { + "description": "ServiceBus connection string.", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "extensionPrincipalId": { + "description": "Extension principal-id.", + "type": "string", + "x-nullable": true + }, + "extensionInstanceReleaseTrain": { + "description": "Extension instance release train.", + "type": "string" + }, + "vcName": { + "description": "VC name.", + "type": "string" + }, + "namespace": { + "description": "Compute namespace", + "type": "string", + "default": "default" + }, + "defaultInstanceType": { + "description": "Default instance type", + "type": "string" + }, + "instanceTypes": { + "description": "Instance Type Schema", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/InstanceTypeSchema" + } + } + } + }, + "AmlComputeProperties": { + "type": "object", + "description": "AML Compute properties", + "properties": { + "osType": { + "description": "Compute OS Type", + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + } + }, + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string", + "enum": [ + "Dedicated", + "LowPriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": true + } + }, + "virtualMachineImage": { + "description": "Virtual Machine image for AML Compute - windows only", + "$ref": "#/definitions/VirtualMachineImage", + "x-nullable": true + }, + "isolatedNetwork": { + "description": "Network is isolated or not", + "type": "boolean" + }, + "scaleSettings": { + "description": "Scale settings for AML Compute", + "$ref": "#/definitions/ScaleSettings" + }, + "userAccountCredentials": { + "title": "User account credentials.", + "description": "Credentials for an administrator user account that will be created on each compute node.", + "$ref": "#/definitions/UserAccountCredentials", + "x-nullable": true + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId", + "x-nullable": true + }, + "remoteLoginPortPublicAccess": { + "type": "string", + "default": "NotSpecified", + "title": "Close remote Login Access Port", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled", + "NotSpecified" + ], + "x-ms-enum": { + "name": "remoteLoginPortPublicAccess", + "modelAsString": true + } + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.", + "enum": [ + "Steady", + "Resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the compute entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "x-nullable": true, + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ] + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the compute.", + "x-nullable": true + }, + "targetNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Target node count.", + "description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.", + "x-nullable": true + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the compute.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts", + "x-nullable": true + }, + "enableNodePublicIp": { + "type": "boolean", + "default": true, + "title": "Enable node public IP.", + "description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.", + "x-nullable": true + }, + "propertyBag": { + "type": "object", + "description": "A property bag containing additional properties.", + "x-nullable": true + } + } + }, + "AmlCompute": { + "description": "An Azure Machine Learning compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/AmlComputeSchema" + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "AmlComputeSchema": { + "type": "object", + "description": "Properties(top level) of AmlCompute", + "properties": { + "properties": { + "description": "Properties of AmlCompute", + "$ref": "#/definitions/AmlComputeProperties" + } + } + }, + "ComputeInstanceProperties": { + "description": "Compute Instance properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId", + "x-nullable": true + }, + "applicationSharingPolicy": { + "type": "string", + "default": "Shared", + "title": "Sharing policy for applications on this compute instance", + "description": "Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.", + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "applicationSharingPolicy", + "modelAsString": true + } + }, + "autologgerSettings": { + "description": "Specifies settings for autologger.", + "$ref": "#/definitions/ComputeInstanceAutologgerSettings", + "x-nullable": true + }, + "sshSettings": { + "description": "Specifies policy and settings for SSH access.", + "$ref": "#/definitions/ComputeInstanceSshSettings", + "x-nullable": true + }, + "customServices": { + "type": "array", + "description": "List of Custom Services added to the compute.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/CustomService" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "osImageMetadata": { + "readOnly": true, + "description": "Returns metadata about the operating system image for this compute instance.", + "$ref": "#/definitions/ImageMetadata" + }, + "connectivityEndpoints": { + "readOnly": true, + "description": "Describes all connectivity endpoints available for this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceConnectivityEndpoints" + }, + "applications": { + "type": "array", + "readOnly": true, + "description": "Describes available applications and their endpoints on this ComputeInstance.", + "items": { + "$ref": "#/definitions/ComputeInstanceApplication" + }, + "x-ms-identifiers": [ + "displayName" + ] + }, + "createdBy": { + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceCreatedBy" + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered on this ComputeInstance.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ] + }, + "state": { + "description": "The current state of this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceState", + "readOnly": true + }, + "computeInstanceAuthorizationType": { + "type": "string", + "title": "Compute Instance Authorization type.", + "description": "The Compute Instance Authorization type. Available values are personal (default).", + "default": "personal", + "x-nullable": true, + "enum": [ + "personal" + ], + "x-ms-enum": { + "name": "ComputeInstanceAuthorizationType", + "modelAsString": true + } + }, + "personalComputeInstanceSettings": { + "title": "Personal Compute Instance settings.", + "description": "Settings for a personal compute instance.", + "$ref": "#/definitions/PersonalComputeInstanceSettings", + "x-nullable": true + }, + "setupScripts": { + "description": "Details of customized scripts to execute for setting up the cluster.", + "$ref": "#/definitions/SetupScripts", + "x-nullable": true + }, + "lastOperation": { + "description": "The last operation on ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceLastOperation", + "readOnly": true, + "x-nullable": true + }, + "schedules": { + "description": "The list of schedules to be applied on the computes.", + "$ref": "#/definitions/ComputeSchedules", + "x-nullable": true + }, + "idleTimeBeforeShutdown": { + "type": "string", + "description": "Stops compute instance after user defined period of inactivity. Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days." + }, + "enableNodePublicIp": { + "type": "boolean", + "default": true, + "title": "Enable node public IP.", + "description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.", + "x-nullable": true + }, + "containers": { + "type": "array", + "readOnly": true, + "description": "Describes informations of containers on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "dataDisks": { + "type": "array", + "readOnly": true, + "description": "Describes informations of dataDisks on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceDataDisk" + }, + "x-ms-identifiers": [] + }, + "dataMounts": { + "type": "array", + "readOnly": true, + "description": "Describes informations of dataMounts on this ComputeInstance.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/ComputeInstanceDataMount" + }, + "x-ms-identifiers": [] + }, + "versions": { + "description": "ComputeInstance version.", + "$ref": "#/definitions/ComputeInstanceVersion", + "readOnly": true + } + } + }, + "ComputeInstance": { + "description": "An Azure Machine Learning compute instance.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/ComputeInstanceSchema" + } + ], + "x-ms-discriminator-value": "ComputeInstance" + }, + "ComputeInstanceSchema": { + "type": "object", + "description": "Properties(top level) of ComputeInstance", + "properties": { + "properties": { + "description": "Properties of ComputeInstance", + "$ref": "#/definitions/ComputeInstanceProperties" + } + } + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/VirtualMachineSchema" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "sshPort": { + "description": "Port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "notebookServerPort": { + "description": "Notebook server port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the virtual machine.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + }, + "isNotebookInstanceCompute": { + "description": "Indicates whether this compute will be used for running notebooks.", + "type": "boolean" + } + } + } + } + }, + "HDInsightProperties": { + "type": "object", + "description": "HDInsight compute properties", + "properties": { + "sshPort": { + "description": "Port open for ssh connections on the master node of the cluster.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the master node of the cluster.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for master node of the cluster", + "$ref": "#/definitions/VirtualMachineSshCredentials", + "x-nullable": true + } + } + }, + "HDInsight": { + "description": "A HDInsight compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/HDInsightSchema" + } + ], + "x-ms-discriminator-value": "HDInsight" + }, + "HDInsightSchema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/HDInsightProperties" + } + } + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "DatabricksProperties": { + "type": "object", + "description": "Properties of Databricks", + "properties": { + "databricksAccessToken": { + "description": "Databricks access token", + "type": "string" + }, + "workspaceUrl": { + "description": "Workspace Url", + "type": "string" + } + } + }, + "Databricks": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/DatabricksSchema" + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "DatabricksSchema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabricksProperties" + } + } + }, + "DataLakeAnalytics": { + "description": "A DataLakeAnalytics compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/DataLakeAnalyticsSchema" + } + ], + "x-ms-discriminator-value": "DataLakeAnalytics" + }, + "DataLakeAnalyticsSchema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataLakeStoreAccountName": { + "description": "DataLake Store Account Name", + "type": "string" + } + } + } + } + }, + "SynapseSpark": { + "type": "object", + "description": "A SynapseSpark compute.", + "properties": { + "properties": { + "type": "object", + "properties": { + "autoScaleProperties": { + "description": "Auto scale properties.", + "$ref": "#/definitions/AutoScaleProperties" + }, + "autoPauseProperties": { + "description": "Auto pause properties.", + "$ref": "#/definitions/AutoPauseProperties" + }, + "sparkVersion": { + "description": "Spark version.", + "type": "string" + }, + "nodeCount": { + "description": "The number of compute nodes currently assigned to the compute.", + "type": "integer", + "format": "int32" + }, + "nodeSize": { + "description": "Node size.", + "type": "string" + }, + "nodeSizeFamily": { + "description": "Node size family.", + "type": "string" + }, + "subscriptionId": { + "description": "Azure subscription identifier.", + "type": "string" + }, + "resourceGroup": { + "description": "Name of the resource group in which workspace is located.", + "type": "string" + }, + "workspaceName": { + "description": "Name of Azure Machine Learning workspace.", + "type": "string" + }, + "poolName": { + "description": "Pool name.", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "SynapseSpark" + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configuration for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled", + "Auto" + ], + "x-ms-enum": { + "name": "SslConfigStatus", + "modelAsString": true + } + }, + "cert": { + "description": "Cert data", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "key": { + "description": "Key data", + "type": "string", + "x-ms-secret": true, + "x-nullable": true + }, + "cname": { + "description": "CNAME of the cert", + "type": "string", + "x-nullable": true + }, + "leafDomainLabel": { + "description": "Leaf domain label of public endpoint", + "type": "string", + "x-nullable": true + }, + "overwriteExistingDomain": { + "description": "Indicates whether to overwrite existing domain label.", + "type": "boolean" + } + } + }, + "AksNetworkingConfiguration": { + "type": "object", + "description": "Advance configuration for AKS networking", + "properties": { + "subnetId": { + "description": "Virtual network subnet resource ID the compute nodes belong to", + "type": "string" + }, + "serviceCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.", + "type": "string" + }, + "dnsServiceIP": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.", + "type": "string" + }, + "dockerBridgeCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.", + "type": "string" + } + } + }, + "UserAccountCredentials": { + "type": "object", + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "x-ms-secret": true, + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "x-ms-secret": true, + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a compute." + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for AML Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer", + "format": "int32" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer", + "format": "int32", + "default": 0 + }, + "nodeIdleTimeBeforeScaleDown": { + "type": "string", + "format": "duration", + "description": "Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format." + } + }, + "required": [ + "maxNodeCount" + ] + }, + "VirtualMachineImage": { + "type": "object", + "description": "Virtual Machine image for Windows AML Compute", + "properties": { + "id": { + "description": "Virtual Machine image path", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "NodeStateCounts": { + "type": "object", + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the amlCompute." + }, + "preemptedNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preempted node count.", + "description": "Number of compute nodes which are in preempted state." + } + }, + "description": "Counts of various compute node states on the amlCompute." + }, + "ScaleSettingsInformation": { + "type": "object", + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings." + } + }, + "description": "Desired scale settings for the amlCompute." + }, + "ClusterUpdateProperties": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of ClusterUpdate", + "$ref": "#/definitions/ScaleSettingsInformation" + } + }, + "description": "The properties of a amlCompute that need to be updated." + }, + "ClusterUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the amlCompute." + } + }, + "description": "AmlCompute update parameters." + }, + "AmlComputeNodesInformation": { + "type": "object", + "description": "Result of AmlCompute Nodes", + "properties": { + "nodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlComputeNodeInformation" + }, + "x-ms-identifiers": [ + "nodeId" + ], + "description": "The collection of returned AmlCompute nodes details." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + } + }, + "AmlComputeNodeInformation": { + "type": "object", + "description": "Compute node information related to a AmlCompute.", + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "privateIpAddress": { + "readOnly": true, + "type": "string", + "title": "Private IP address.", + "description": "Private IP address of the compute node.", + "x-nullable": true + }, + "publicIpAddress": { + "readOnly": true, + "type": "string", + "title": "Public IP address.", + "description": "Public IP address of the compute node.", + "x-nullable": true + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + }, + "nodeState": { + "readOnly": true, + "type": "string", + "enum": [ + "idle", + "running", + "preparing", + "unusable", + "leaving", + "preempted" + ], + "description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.", + "x-ms-enum": { + "name": "nodeState", + "modelAsString": true + } + }, + "runId": { + "readOnly": true, + "type": "string", + "title": "Run ID.", + "description": "ID of the Experiment running on the node, if any else null.", + "x-nullable": true + } + } + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string", + "x-ms-secret": true + }, + "privateKeyData": { + "description": "Private key data", + "type": "string", + "x-ms-secret": true + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecretsProperties": { + "type": "object", + "description": "Properties of AksComputeSecrets", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret.", + "x-nullable": true + } + } + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/AksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/VirtualMachineSecretsSchema" + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "VirtualMachineSecretsSchema": { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin credentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + }, + "DatabricksComputeSecretsProperties": { + "type": "object", + "description": "Properties of Databricks Compute Secrets", + "properties": { + "databricksAccessToken": { + "description": "access token for databricks account.", + "type": "string" + } + } + }, + "DatabricksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on Databricks.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/DatabricksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "Kubernetes", + "AmlCompute", + "ComputeInstance", + "DataFactory", + "VirtualMachine", + "HDInsight", + "Databricks", + "DataLakeAnalytics", + "SynapseSpark" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "ImageMetadata": { + "type": "object", + "description": "Returns metadata about the operating system image for this compute instance.", + "properties": { + "currentImageVersion": { + "type": "string", + "description": "Specifies the current operating system image version this compute instance is running on." + }, + "latestImageVersion": { + "type": "string", + "description": "Specifies the latest available operating system image version." + }, + "isLatestOsImageVersion": { + "type": "boolean", + "description": "Specifies whether this compute instance is running on the latest operating system image." + } + } + }, + "CustomService": { + "type": "object", + "description": "Specifies the custom service configuration", + "properties": { + "name": { + "type": "string", + "description": "Name of the Custom Service" + }, + "image": { + "$ref": "#/definitions/Image", + "description": "Describes the Image Specifications" + }, + "environmentVariables": { + "type": "object", + "description": "Environment Variable for the container", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "docker": { + "description": "Describes the docker settings for the image", + "$ref": "#/definitions/Docker", + "x-nullable": true + }, + "endpoints": { + "type": "array", + "description": "Configuring the endpoints for the container", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "volumes": { + "type": "array", + "description": "Configuring the volumes for the container", + "items": { + "$ref": "#/definitions/VolumeDefinition" + }, + "x-ms-identifiers": [ + "source", + "target" + ] + } + }, + "additionalProperties": true + }, + "Image": { + "type": "object", + "properties": { + "type": { + "default": "docker", + "enum": [ + "docker", + "azureml" + ], + "type": "string", + "title": "Type of the image", + "description": "Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images", + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true + } + }, + "reference": { + "type": "string", + "description": "Image reference URL" + } + }, + "additionalProperties": true + }, + "EnvironmentVariable": { + "type": "object", + "properties": { + "type": { + "enum": [ + "local" + ], + "default": "local", + "title": "Type of Environment Variable", + "description": "Type of the Environment Variable. Possible values are: local - For local variable", + "type": "string", + "x-ms-enum": { + "name": "EnvironmentVariableType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Value of the Environment variable" + } + }, + "additionalProperties": true + }, + "Docker": { + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "Indicate whether container shall run in privileged or non-privileged mode.", + "x-nullable": true + } + }, + "additionalProperties": true + }, + "Endpoint": { + "type": "object", + "properties": { + "protocol": { + "enum": [ + "tcp", + "udp", + "http" + ], + "default": "tcp", + "title": "Endpoint Communication Protocol", + "description": "Protocol over which communication will happen over this endpoint", + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + }, + "type": "string" + }, + "name": { + "type": "string", + "description": "Name of the Endpoint" + }, + "target": { + "format": "int32", + "type": "integer", + "description": "Application port inside the container." + }, + "published": { + "format": "int32", + "type": "integer", + "description": "Port over which the application is exposed from container.", + "x-nullable": true + }, + "hostIp": { + "description": "Host IP over which the application is exposed from the container", + "type": "string", + "x-nullable": true + } + } + }, + "VolumeDefinition": { + "type": "object", + "properties": { + "type": { + "enum": [ + "bind", + "volume", + "tmpfs", + "npipe" + ], + "default": "bind", + "title": "Type of Volume Definition", + "description": "Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe", + "x-ms-enum": { + "name": "VolumeDefinitionType", + "modelAsString": true + }, + "type": "string" + }, + "readOnly": { + "type": "boolean", + "description": "Indicate whether to mount volume as readOnly. Default value for this is false.", + "x-nullable": true + }, + "source": { + "type": "string", + "description": "Source of the mount. For bind mounts this is the host path." + }, + "target": { + "type": "string", + "description": "Target of the mount. For bind mounts this is the path in the container." + }, + "consistency": { + "type": "string", + "description": "Consistency of the volume", + "x-nullable": true + }, + "bind": { + "$ref": "#/definitions/BindOptions", + "description": "Bind Options of the mount", + "x-nullable": true + }, + "volume": { + "$ref": "#/definitions/VolumeOptions", + "description": "Volume Options of the mount", + "x-nullable": true + }, + "tmpfs": { + "$ref": "#/definitions/TmpfsOptions", + "description": "tmpfs option of the mount", + "x-nullable": true + } + } + }, + "VolumeOptions": { + "type": "object", + "properties": { + "nocopy": { + "type": "boolean", + "description": "Indicate whether volume is nocopy", + "x-nullable": true + } + } + }, + "BindOptions": { + "type": "object", + "properties": { + "propagation": { + "type": "string", + "description": "Type of Bind Option", + "x-nullable": true + }, + "createHostPath": { + "type": "boolean", + "description": "Indicate whether to create host path.", + "x-nullable": true + }, + "selinux": { + "type": "string", + "description": "Mention the selinux options.", + "x-nullable": true + } + } + }, + "TmpfsOptions": { + "type": "object", + "properties": { + "size": { + "format": "int32", + "type": "integer", + "description": "Mention the Tmpfs size" + } + } + }, + "ComputeInstanceAutologgerSettings": { + "type": "object", + "description": "Specifies settings for autologger.", + "properties": { + "mlflowAutologger": { + "type": "string", + "description": "Indicates whether mlflow autologger is enabled for notebooks.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "mlflowAutologger", + "modelAsString": true + } + } + } + }, + "ComputeInstanceSshSettings": { + "type": "object", + "description": "Specifies policy and settings for SSH access.", + "properties": { + "sshPublicAccess": { + "type": "string", + "default": "Disabled", + "title": "Access policy for SSH", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "sshPublicAccess", + "modelAsString": true + } + }, + "adminUserName": { + "type": "string", + "readOnly": true, + "description": "Describes the admin user name." + }, + "sshPort": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Describes the port for connecting through SSH." + }, + "adminPublicKey": { + "type": "string", + "description": "Specifies the SSH rsa public key file as a string. Use \"ssh-keygen -t rsa -b 2048\" to generate your SSH key pairs." + } + } + }, + "ComputeInstanceState": { + "type": "string", + "description": "Current state of an ComputeInstance.", + "enum": [ + "Creating", + "CreateFailed", + "Deleting", + "Running", + "Restarting", + "JobRunning", + "SettingUp", + "SetupFailed", + "Starting", + "Stopped", + "Stopping", + "UserSettingUp", + "UserSetupFailed", + "Unknown", + "Unusable" + ], + "x-ms-enum": { + "name": "ComputeInstanceState", + "modelAsString": true + } + }, + "ComputeInstanceLastOperation": { + "type": "object", + "description": "The last operation on ComputeInstance.", + "properties": { + "operationName": { + "type": "string", + "description": "Name of the last operation.", + "enum": [ + "Create", + "Start", + "Stop", + "Restart", + "Reimage", + "Delete" + ], + "x-ms-enum": { + "name": "OperationName", + "modelAsString": true + } + }, + "operationTime": { + "type": "string", + "format": "date-time", + "description": "Time of the last operation." + }, + "operationStatus": { + "type": "string", + "description": "Operation status.", + "enum": [ + "InProgress", + "Succeeded", + "CreateFailed", + "StartFailed", + "StopFailed", + "RestartFailed", + "ReimageFailed", + "DeleteFailed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + }, + "operationTrigger": { + "type": "string", + "description": "Trigger of operation.", + "enum": [ + "User", + "Schedule", + "IdleShutdown" + ], + "x-ms-enum": { + "name": "operationTrigger", + "modelAsString": true + } + } + } + }, + "ComputeInstanceVersion": { + "type": "object", + "description": "Version of computeInstance.", + "properties": { + "runtime": { + "type": "string", + "description": "Runtime of compute instance.", + "x-nullable": true + } + } + }, + "ComputeSchedules": { + "type": "object", + "description": "The list of schedules to be applied on the computes", + "properties": { + "computeStartStop": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeStartStopSchedule" + }, + "description": "The list of compute start stop schedules to be applied." + } + } + }, + "ComputeStartStopSchedule": { + "type": "object", + "description": "Compute start stop schedule properties", + "properties": { + "id": { + "description": "A system assigned id for the schedule.", + "type": "string", + "x-nullable": true, + "readOnly": true + }, + "provisioningStatus": { + "description": "The current deployment state of schedule.", + "type": "string", + "enum": [ + "Completed", + "Provisioning", + "Failed" + ], + "x-ms-enum": { + "name": "provisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Completed" + }, + { + "value": "Provisioning" + }, + { + "value": "Failed" + } + ] + }, + "readOnly": true + }, + "status": { + "$ref": "#/definitions/ScheduleStatus" + }, + "action": { + "description": "[Required] The compute power action.", + "$ref": "#/definitions/ComputePowerAction" + }, + "triggerType": { + "description": "[Required] The schedule trigger type.", + "$ref": "./mfe.json#/definitions/TriggerType" + }, + "recurrence": { + "description": "Required if triggerType is Recurrence.", + "$ref": "#/definitions/Recurrence" + }, + "cron": { + "description": "Required if triggerType is Cron.", + "$ref": "#/definitions/Cron" + }, + "schedule": { + "description": "[Deprecated] Not used any more.", + "$ref": "#/definitions/ScheduleBase" + } + } + }, + "ScheduleBase": { + "type": "object", + "properties": { + "id": { + "description": "A system assigned id for the schedule.", + "type": "string", + "x-nullable": true + }, + "provisioningStatus": { + "$ref": "#/definitions/ScheduleProvisioningState" + }, + "status": { + "$ref": "#/definitions/ScheduleStatus" + } + }, + "additionalProperties": false + }, + "ScheduleProvisioningState": { + "enum": [ + "Completed", + "Provisioning", + "Failed" + ], + "description": "The current deployment state of schedule.", + "type": "string", + "x-ms-enum": { + "name": "ScheduleProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Completed" + }, + { + "value": "Provisioning" + }, + { + "value": "Failed" + } + ] + }, + "additionalProperties": false + }, + "ScheduleStatus": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Is the schedule enabled or disabled?", + "type": "string", + "x-ms-enum": { + "name": "ScheduleStatus", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "ComputePowerAction": { + "type": "string", + "description": "[Required] The compute power action.", + "enum": [ + "Start", + "Stop" + ], + "x-ms-enum": { + "name": "ComputePowerAction", + "modelAsString": true + } + }, + "Recurrence": { + "type": "object", + "description": "The workflow trigger recurrence for ComputeStartStop schedule type.", + "properties": { + "frequency": { + "description": "[Required] The frequency to trigger schedule.", + "$ref": "./mfe.json#/definitions/RecurrenceFrequency" + }, + "interval": { + "description": "[Required] Specifies schedule interval in conjunction with frequency", + "type": "integer", + "format": "int32" + }, + "startTime": { + "description": "The start time in yyyy-MM-ddTHH:mm:ss format.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "default": "UTC", + "type": "string" + }, + "schedule": { + "description": "[Required] The recurrence schedule.", + "$ref": "./mfe.json#/definitions/RecurrenceSchedule" + } + } + }, + "Cron": { + "type": "object", + "description": "The workflow trigger cron for ComputeStartStop schedule type.", + "properties": { + "startTime": { + "description": "The start time in yyyy-MM-ddTHH:mm:ss format.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "type": "string", + "default": "UTC" + }, + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "type": "string" + } + } + }, + "ComputeInstanceDataMount": { + "type": "object", + "description": "Defines an Aml Instance DataMount.", + "properties": { + "source": { + "type": "string", + "description": "Source of the ComputeInstance data mount." + }, + "sourceType": { + "description": "Data source type.", + "type": "string", + "enum": [ + "Dataset", + "Datastore", + "URI" + ], + "x-ms-enum": { + "name": "sourceType", + "modelAsString": true + } + }, + "mountName": { + "type": "string", + "description": "name of the ComputeInstance data mount." + }, + "mountAction": { + "description": "Mount Action.", + "type": "string", + "enum": [ + "Mount", + "Unmount" + ], + "x-ms-enum": { + "name": "mountAction", + "modelAsString": true + } + }, + "createdBy": { + "type": "string", + "description": "who this data mount created by." + }, + "mountPath": { + "type": "string", + "description": "Path of this data mount." + }, + "mountState": { + "description": "Mount state.", + "type": "string", + "enum": [ + "MountRequested", + "Mounted", + "MountFailed", + "UnmountRequested", + "UnmountFailed", + "Unmounted" + ], + "x-ms-enum": { + "name": "mountState", + "modelAsString": true + } + }, + "mountedOn": { + "type": "string", + "format": "date-time", + "title": "Mounted time.", + "description": "The time when the disk mounted." + }, + "error": { + "type": "string", + "description": "Error of this data mount." + } + } + }, + "ComputeInstanceDataDisk": { + "type": "object", + "description": "Defines an Aml Instance DataDisk.", + "properties": { + "caching": { + "description": "Caching type of Data Disk.", + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "caching", + "modelAsString": true + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in gigabytes.", + "description": "The initial disk size in gigabytes." + }, + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun." + }, + "storageAccountType": { + "description": "type of this storage account.", + "type": "string", + "default": "Standard_LRS", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "storageAccountType", + "modelAsString": true + } + } + } + }, + "ComputeInstanceContainer": { + "type": "object", + "description": "Defines an Aml Instance container.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ComputeInstance container." + }, + "autosave": { + "description": "Auto save settings.", + "type": "string", + "enum": [ + "None", + "Local", + "Remote" + ], + "x-ms-enum": { + "name": "autosave", + "modelAsString": true + } + }, + "gpu": { + "type": "string", + "description": "Information of GPU." + }, + "network": { + "description": "network of this container.", + "type": "string", + "enum": [ + "Bridge", + "Host" + ], + "x-ms-enum": { + "name": "network", + "modelAsString": true + } + }, + "environment": { + "description": "Environment information of this container.", + "$ref": "#/definitions/ComputeInstanceEnvironmentInfo" + }, + "services": { + "type": "array", + "readOnly": true, + "description": "services of this containers.", + "items": { + "type": "object" + }, + "x-ms-identifiers": [] + } + } + }, + "ComputeInstanceEnvironmentInfo": { + "type": "object", + "description": "Environment information", + "properties": { + "name": { + "description": "name of environment.", + "type": "string" + }, + "version": { + "description": "version of environment.", + "type": "string" + } + } + }, + "ComputeInstanceApplication": { + "type": "object", + "description": "Defines an Aml Instance application and its connectivity endpoint URI.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the ComputeInstance application." + }, + "endpointUri": { + "type": "string", + "description": "Application' endpoint URI." + } + } + }, + "ComputeInstanceConnectivityEndpoints": { + "type": "object", + "readOnly": true, + "description": "Defines all connectivity endpoints and properties for an ComputeInstance.", + "properties": { + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP Address of this ComputeInstance.", + "x-nullable": true + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).", + "x-nullable": true + } + } + }, + "ComputeInstanceCreatedBy": { + "type": "object", + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "properties": { + "userName": { + "type": "string", + "readOnly": true, + "description": "Name of the user.", + "x-nullable": true + }, + "userOrgId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies user' Azure Active Directory organization." + }, + "userId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies the user within his/her organization.", + "x-nullable": true + } + } + }, + "PersonalComputeInstanceSettings": { + "type": "object", + "properties": { + "assignedUser": { + "$ref": "#/definitions/AssignedUser", + "title": "Assigned User.", + "description": "A user explicitly assigned to a personal compute instance." + } + }, + "description": "Settings for a personal compute instance." + }, + "AssignedUser": { + "type": "object", + "description": "A user that can be assigned to a compute instance.", + "properties": { + "objectId": { + "type": "string", + "description": "User’s AAD Object Id." + }, + "tenantId": { + "type": "string", + "description": "User’s AAD Tenant Id." + } + }, + "required": [ + "objectId", + "tenantId" + ] + }, + "SetupScripts": { + "type": "object", + "description": "Details of customized scripts to execute for setting up the cluster.", + "properties": { + "scripts": { + "description": "Customized setup scripts", + "$ref": "#/definitions/ScriptsToExecute" + } + } + }, + "ScriptsToExecute": { + "type": "object", + "description": "Customized setup scripts", + "properties": { + "startupScript": { + "description": "Script that's run every time the machine starts.", + "$ref": "#/definitions/ScriptReference" + }, + "creationScript": { + "description": "Script that's run only once during provision of the compute.", + "$ref": "#/definitions/ScriptReference" + } + } + }, + "ScriptReference": { + "type": "object", + "description": "Script reference", + "properties": { + "scriptSource": { + "description": "The storage source of the script: inline, workspace.", + "type": "string" + }, + "scriptData": { + "description": "The location of scripts in the mounted volume.", + "type": "string" + }, + "scriptArguments": { + "description": "Optional command line arguments passed to the script to run.", + "type": "string" + }, + "timeout": { + "description": "Optional time period passed to timeout command.", + "type": "string" + } + } + }, + "AutoScaleProperties": { + "type": "object", + "description": "Auto scale properties", + "properties": { + "minNodeCount": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + }, + "maxNodeCount": { + "format": "int32", + "type": "integer" + } + } + }, + "AutoPauseProperties": { + "type": "object", + "description": "Auto pause properties", + "properties": { + "delayInMinutes": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + } + } + }, + "InstanceTypeSchema": { + "type": "object", + "description": "Instance type schema.", + "properties": { + "nodeSelector": { + "type": "object", + "description": "Node Selector", + "x-nullable": true, + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "resources": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "properties": { + "requests": { + "description": "Resource requests for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + }, + "limits": { + "description": "Resource limits for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + } + } + } + } + }, + "InstanceResourceSchema": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "additionalProperties": { + "type": "string" + } + }, + "IdleShutdownSetting": { + "type": "object", + "description": "Stops compute instance after user defined period of inactivity.", + "properties": { + "idleTimeBeforeShutdown": { + "type": "string", + "description": "Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days." + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/mfe.json new file mode 100644 index 000000000000..1b34f5856dea --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/mfe.json @@ -0,0 +1,26284 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2023-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes": { + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "List containers.", + "operationId": "RegistryCodeContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$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/CodeContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}": { + "delete": { + "tags": [ + "CodeContainer" + ], + "summary": "Delete Code container.", + "operationId": "RegistryCodeContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container 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" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "Get Code container.", + "operationId": "RegistryCodeContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container 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" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "x-ms-examples": { + "Get Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/get.json" + } + } + }, + "put": { + "tags": [ + "CodeContainer" + ], + "summary": "Create or update Code container.", + "operationId": "RegistryCodeContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container 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": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + ], + "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/CodeContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + }, + "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 Registry Code Container.": { + "$ref": "./examples/Registry/CodeContainer/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/registries/{registryName}/codes/{codeName}/versions": { + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "List versions.", + "operationId": "RegistryCodeVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container 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": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}": { + "delete": { + "tags": [ + "CodeVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryCodeVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "Get version.", + "operationId": "RegistryCodeVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + }, + "x-ms-examples": { + "Get Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/get.json" + } + } + }, + "put": { + "tags": [ + "CodeVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryCodeVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "codeName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + ], + "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/CodeVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + }, + "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 Registry Code Version.": { + "$ref": "./examples/Registry/CodeVersion/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/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" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components": { + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "List containers.", + "operationId": "RegistryComponentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$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/ComponentContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}": { + "delete": { + "tags": [ + "ComponentContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryComponentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container 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" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "Get container.", + "operationId": "RegistryComponentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container 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" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + }, + "x-ms-examples": { + "Get Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentContainer" + ], + "summary": "Create or update container.", + "operationId": "RegistryComponentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container 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": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + ], + "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/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + }, + "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 Registry Component Container.": { + "$ref": "./examples/Registry/ComponentContainer/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/registries/{registryName}/components/{componentName}/versions": { + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "List versions.", + "operationId": "RegistryComponentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container 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": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "stage", + "description": "Component stage.", + "type": "string" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}": { + "delete": { + "tags": [ + "ComponentVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryComponentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "Get version.", + "operationId": "RegistryComponentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + }, + "x-ms-examples": { + "Get Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryComponentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "componentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + ], + "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/ComponentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + }, + "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 Registry Component Version.": { + "$ref": "./examples/Registry/ComponentVersion/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/registries/{registryName}/data": { + "get": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "List Data containers.", + "operationId": "RegistryDataContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "RegistryList Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/registryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}": { + "delete": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Delete container.", + "operationId": "RegistryDataContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container 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" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Get container.", + "operationId": "RegistryDataContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container 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/DataContainerResource" + } + } + }, + "x-ms-examples": { + "Get Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/get.json" + } + } + }, + "put": { + "tags": [ + "DataContainerRegistry" + ], + "summary": "Create or update container.", + "operationId": "RegistryDataContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container 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": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + ], + "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/DataContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataContainerResource" + }, + "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 Registry Data Container.": { + "$ref": "./examples/Registry/DataContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions": { + "get": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "List data versions in the data container", + "operationId": "RegistryDataVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data container's name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "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/DataVersionBaseResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "RegistryList Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/registryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}": { + "delete": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Delete version.", + "operationId": "RegistryDataVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Get version.", + "operationId": "RegistryDataVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + }, + "x-ms-examples": { + "Get Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/get.json" + } + } + }, + "put": { + "tags": [ + "DataVersionRegistry" + ], + "summary": "Create or update version.", + "operationId": "RegistryDataVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + ], + "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/DataVersionBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + }, + "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 Registry Data Version Base.": { + "$ref": "./examples/Registry/DataVersionBase/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/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": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "RegistryEnvironmentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}": { + "delete": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryEnvironmentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container 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" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Get container.", + "operationId": "RegistryEnvironmentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + }, + "x-ms-examples": { + "Get Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Create or update container.", + "operationId": "RegistryEnvironmentContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container 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": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + ], + "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/EnvironmentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + }, + "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 Registry Environment Container.": { + "$ref": "./examples/Registry/EnvironmentContainer/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/registries/{registryName}/environments/{environmentName}/versions": { + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "List versions.", + "operationId": "RegistryEnvironmentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Stage for including/excluding (for example) archived entities. Takes priority over listViewType", + "type": "string" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}": { + "delete": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryEnvironmentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Get version.", + "operationId": "RegistryEnvironmentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + }, + "x-ms-examples": { + "Get Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryEnvironmentVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "environmentName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + ], + "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/EnvironmentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + }, + "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 Registry Environment Version.": { + "$ref": "./examples/Registry/EnvironmentVersion/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/registries/{registryName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "RegistryModelContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": { + "delete": { + "tags": [ + "ModelContainer" + ], + "summary": "Delete container.", + "operationId": "RegistryModelContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container 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" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "Get container.", + "operationId": "RegistryModelContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "x-ms-examples": { + "Get Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ModelContainer" + ], + "summary": "Create or update model container.", + "operationId": "RegistryModelContainers_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container 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": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + }, + "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 Registry Model Container.": { + "$ref": "./examples/Registry/ModelContainer/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/registries/{registryName}/models/{modelName}/versions": { + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "List versions.", + "operationId": "RegistryModelVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Version identifier.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": { + "delete": { + "tags": [ + "ModelVersion" + ], + "summary": "Delete version.", + "operationId": "RegistryModelVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "Get version.", + "operationId": "RegistryModelVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "x-ms-examples": { + "Get Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ModelVersion" + ], + "summary": "Create or update version.", + "operationId": "RegistryModelVersions_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": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/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/registries/{registryName}/models/{modelName}/versions/{version}/package": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Model Version Package operation.", + "operationId": "RegistryModelVersions_Package", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "registries.json#/parameters/RegistryNameParameter" + }, + { + "in": "path", + "name": "modelName", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Package operation request body.", + "required": true, + "schema": { + "$ref": "#/definitions/PackageRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PackageResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Package Registry Model Version.": { + "$ref": "./examples/Registry/ModelVersion/package.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/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" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": { + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists Batch inference endpoint in the workspace.", + "operationId": "BatchEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": { + "delete": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Delete Batch Inference Endpoint (asynchronous).", + "operationId": "BatchEndpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference Endpoint name.", + "required": true, + "type": "string" + }, + { + "$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 Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Gets a batch inference endpoint by name.", + "operationId": "BatchEndpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch Endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Update a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", + "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": "Mutable batch inference endpoint definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Creates a batch inference endpoint (asynchronous).", + "operationId": "BatchEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Name for the Batch inference endpoint.", + "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": "Batch inference endpoint definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + ], + "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/BatchEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "BatchDeployment" + ], + "summary": "Lists Batch inference deployments in the workspace.", + "operationId": "BatchDeployments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "BatchDeployment" + ], + "summary": "Delete Batch Inference deployment (asynchronous).", + "operationId": "BatchDeployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference deployment identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BatchDeployment" + ], + "summary": "Gets a batch inference deployment by id.", + "operationId": "BatchDeployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Endpoint name", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch deployments.", + "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/BatchDeploymentTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "BatchDeployment" + ], + "summary": "Update a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + }, + "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 Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "BatchDeployment" + ], + "summary": "Creates/updates a batch inference deployment (asynchronous).", + "operationId": "BatchDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The identifier for the Batch inference deployment.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Batch inference deployment definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + } + ], + "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/BatchDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Batch Deployment.": { + "$ref": "./examples/Workspace/BatchDeployment/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}/batchEndpoints/{endpointName}/listkeys": { + "post": { + "tags": [ + "BatchEndpoint" + ], + "summary": "Lists batch Inference Endpoint keys.", + "operationId": "BatchEndpoints_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Batch Endpoint.": { + "$ref": "./examples/Workspace/BatchEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": { + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "List containers.", + "operationId": "CodeContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$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/CodeContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": { + "delete": { + "tags": [ + "CodeContainer" + ], + "summary": "Delete container.", + "operationId": "CodeContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "CodeContainer" + ], + "summary": "Get container.", + "operationId": "CodeContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/get.json" + } + } + }, + "put": { + "tags": [ + "CodeContainer" + ], + "summary": "Create or update container.", + "operationId": "CodeContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + ], + "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/CodeContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Code Container.": { + "$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": { + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "List versions.", + "operationId": "CodeVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$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": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": { + "delete": { + "tags": [ + "CodeVersion" + ], + "summary": "Delete version.", + "operationId": "CodeVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "CodeVersion" + ], + "summary": "Get version.", + "operationId": "CodeVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/get.json" + } + } + }, + "put": { + "tags": [ + "CodeVersion" + ], + "summary": "Create or update version.", + "operationId": "CodeVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + ], + "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/CodeVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CodeVersionResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Code Version.": { + "$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json" + } + } + } + }, + "/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": [ + "ComponentContainer" + ], + "summary": "List component containers.", + "operationId": "ComponentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "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/ComponentContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": { + "delete": { + "tags": [ + "ComponentContainer" + ], + "summary": "Delete container.", + "operationId": "ComponentContainers_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.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "ComponentContainer" + ], + "summary": "Get container.", + "operationId": "ComponentContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "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/ComponentContainerResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentContainer" + ], + "summary": "Create or update container.", + "operationId": "ComponentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + ], + "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/ComponentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Component Container.": { + "$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": { + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "List component versions.", + "operationId": "ComponentVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Component name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Component stage.", + "type": "string" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": { + "delete": { + "tags": [ + "ComponentVersion" + ], + "summary": "Delete version.", + "operationId": "ComponentVersions_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.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "ComponentVersion" + ], + "summary": "Get version.", + "operationId": "ComponentVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ComponentVersion" + ], + "summary": "Create or update version.", + "operationId": "ComponentVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + ], + "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/ComponentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Component Version.": { + "$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": { + "get": { + "tags": [ + "DataContainer" + ], + "summary": "List data containers.", + "operationId": "DataContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "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/DataContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": { + "delete": { + "tags": [ + "DataContainer" + ], + "summary": "Delete container.", + "operationId": "DataContainers_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.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "DataContainer" + ], + "summary": "Get container.", + "operationId": "DataContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "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/DataContainerResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/get.json" + } + } + }, + "put": { + "tags": [ + "DataContainer" + ], + "summary": "Create or update container.", + "operationId": "DataContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + ], + "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/DataContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataContainerResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Data Container.": { + "$ref": "./examples/Workspace/DataContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": { + "get": { + "tags": [ + "DataVersion" + ], + "summary": "List data versions in the data container", + "operationId": "DataVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Data container's name", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top count of results, top count cannot be greater than the page size.\r\n If topCount > page size, results with be default page size count will be returned", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.", + "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": "stage", + "description": "data stage", + "type": "string" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": { + "delete": { + "tags": [ + "DataVersion" + ], + "summary": "Delete version.", + "operationId": "DataVersions_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.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/delete.json" + } + } + }, + "get": { + "tags": [ + "DataVersion" + ], + "summary": "Get version.", + "operationId": "DataVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/get.json" + } + } + }, + "put": { + "tags": [ + "DataVersion" + ], + "summary": "Create or update version.", + "operationId": "DataVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + ], + "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/DataVersionBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Data Version Base.": { + "$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "get": { + "tags": [ + "Datastore" + ], + "summary": "List datastores.", + "operationId": "Datastores_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "in": "query", + "name": "isDefault", + "description": "Filter down to the workspace default datastore.", + "type": "boolean" + }, + { + "in": "query", + "name": "names", + "description": "Names of datastores to return.", + "type": "array", + "items": { + "type": "string" + } + }, + { + "in": "query", + "name": "searchText", + "description": "Text to search for in the datastore names.", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "Order by property (createdtime | modifiedtime | name).", + "type": "string" + }, + { + "in": "query", + "name": "orderByAsc", + "description": "Order by property in ascending order.", + "type": "boolean", + "default": false + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List datastores.": { + "$ref": "./examples/Datastore/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": { + "delete": { + "tags": [ + "Datastore" + ], + "summary": "Delete datastore.", + "operationId": "Datastores_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": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete datastore.": { + "$ref": "./examples/Datastore/delete.json" + } + } + }, + "get": { + "tags": [ + "Datastore" + ], + "summary": "Get datastore.", + "operationId": "Datastores_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": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + } + }, + "x-ms-examples": { + "Get datastore.": { + "$ref": "./examples/Datastore/get.json" + } + } + }, + "put": { + "tags": [ + "Datastore" + ], + "summary": "Create or update datastore.", + "operationId": "Datastores_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": "Datastore 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": "query", + "name": "skipValidation", + "description": "Flag to skip validation.", + "type": "boolean", + "default": false + }, + { + "in": "body", + "name": "body", + "description": "Datastore entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + } + ], + "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/DatastoreResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate datastore (AzureBlob w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": { + "$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json" + }, + "CreateOrUpdate datastore (Azure File store w/ AccountKey).": { + "$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": { + "post": { + "tags": [ + "Datastore" + ], + "summary": "Get datastore secrets.", + "operationId": "Datastores_ListSecrets", + "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": "Datastore name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "description": "Base definition for datastore secrets.", + "$ref": "#/definitions/DatastoreSecrets" + } + } + }, + "x-ms-examples": { + "Get datastore secrets.": { + "$ref": "./examples/Datastore/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": { + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "List environment containers.", + "operationId": "EnvironmentContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "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/EnvironmentContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": { + "delete": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Delete container.", + "operationId": "EnvironmentContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Get container.", + "operationId": "EnvironmentContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentContainer" + ], + "summary": "Create or update container.", + "operationId": "EnvironmentContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + ], + "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/EnvironmentContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Environment Container.": { + "$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": { + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "List versions.", + "operationId": "EnvironmentVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Stage for including/excluding (for example) archived entities. Takes priority over listViewType", + "type": "string" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": { + "delete": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Delete version.", + "operationId": "EnvironmentVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Get version.", + "operationId": "EnvironmentVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/get.json" + } + } + }, + "put": { + "tags": [ + "EnvironmentVersion" + ], + "summary": "Creates or updates an EnvironmentVersion.", + "operationId": "EnvironmentVersions_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": "Name of EnvironmentVersion. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version of EnvironmentVersion.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Definition of EnvironmentVersion.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + ], + "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/EnvironmentVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Environment Version.": { + "$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": { + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "List featurestore entity containers.", + "operationId": "FeaturesetContainers_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" + } + ] + } + }, + { + "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": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": { + "get": { + "tags": [ + "Feature" + ], + "summary": "List Features.", + "operationId": "Features_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "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": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "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", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Get container.", + "operationId": "FeaturesetContainers_GetEntity", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturesetContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featureset Container.": { + "$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": { + "get": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "List versions.", + "operationId": "FeaturesetVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Featureset name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "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" + } + ] + } + }, + { + "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": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": { + "delete": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Delete version.", + "operationId": "FeaturesetVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Get version.", + "operationId": "FeaturesetVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/get.json" + } + } + }, + "put": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturesetVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + ], + "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/FeaturesetVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturesetVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": { + "post": { + "tags": [ + "FeaturesetVersion" + ], + "summary": "Backfill.", + "operationId": "FeaturesetVersions_Backfill", + "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": "Feature set version backfill request entity.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesetVersionBackfillRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturesetJob" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Backfill Workspace Featureset Version.": { + "$ref": "./examples/Workspace/FeaturesetVersion/backfill.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/listMaterializationJobs": { + "post": { + "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" + } + ] + } + }, + { + "in": "query", + "name": "pageSize", + "description": "page size", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "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" + } + ], + "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" + ], + "summary": "Delete container.", + "operationId": "FeaturestoreEntityContainers_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", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Get container.", + "operationId": "FeaturestoreEntityContainers_GetEntity", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + } + }, + "x-ms-examples": { + "GetEntity Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json" + } + } + }, + "put": { + "tags": [ + "FeaturestoreEntityContainer" + ], + "summary": "Create or update container.", + "operationId": "FeaturestoreEntityContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + } + ], + "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/FeaturestoreEntityContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featurestore Entity Container.": { + "$ref": "./examples/Workspace/FeaturestoreEntityContainer/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}/featurestoreEntities/{name}/versions": { + "get": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "List versions.", + "operationId": "FeaturestoreEntityVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Feature entity name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "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" + } + ] + } + }, + { + "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": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": { + "delete": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Delete version.", + "operationId": "FeaturestoreEntityVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Get version.", + "operationId": "FeaturestoreEntityVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json" + } + } + }, + "put": { + "tags": [ + "FeaturestoreEntityVersion" + ], + "summary": "Create or update version.", + "operationId": "FeaturestoreEntityVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + } + ], + "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/FeaturestoreEntityVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Featurestore Entity Version.": { + "$ref": "./examples/Workspace/FeaturestoreEntityVersion/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}/jobs": { + "get": { + "tags": [ + "Job" + ], + "summary": "Lists Jobs in the workspace.", + "operationId": "Jobs_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": "jobType", + "description": "Type of job to be returned.", + "type": "string" + }, + { + "in": "query", + "name": "tag", + "description": "Jobs returned will have this tag key.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "assetName", + "description": "Asset name the job's named output is registered with", + "type": "string" + }, + { + "in": "query", + "name": "scheduled", + "description": "Indicator whether the job is scheduled job.", + "type": "boolean" + }, + { + "in": "query", + "name": "scheduleId", + "description": "The scheduled id for listing the job triggered from", + "type": "string" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/JobBaseResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Command Job.": { + "$ref": "./examples/Job/CommandJob/list.json" + }, + "List AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/list.json" + }, + "List Sweep Job.": { + "$ref": "./examples/Job/SweepJob/list.json" + }, + "List Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": { + "delete": { + "tags": [ + "Job" + ], + "summary": "Deletes a Job (asynchronous).", + "operationId": "Jobs_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": "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" + } + ], + "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 Job.": { + "$ref": "./examples/Job/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Job" + ], + "summary": "Gets a Job by name/id.", + "operationId": "Jobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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" + } + ], + "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": { + "Get Command Job.": { + "$ref": "./examples/Job/CommandJob/get.json" + }, + "Get AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/get.json" + }, + "Get Sweep Job.": { + "$ref": "./examples/Job/SweepJob/get.json" + }, + "Get Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/get.json" + } + } + }, + "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" + ], + "summary": "Creates and executes a Job.", + "operationId": "Jobs_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": "id", + "description": "The name and identifier for the Job. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Job definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + ], + "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/JobBaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobBaseResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Command Job.": { + "$ref": "./examples/Job/CommandJob/createOrUpdate.json" + }, + "CreateOrUpdate AutoML Job.": { + "$ref": "./examples/Job/AutoMLJob/createOrUpdate.json" + }, + "CreateOrUpdate Sweep Job.": { + "$ref": "./examples/Job/SweepJob/createOrUpdate.json" + }, + "CreateOrUpdate Pipeline Job.": { + "$ref": "./examples/Job/PipelineJob/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": { + "post": { + "tags": [ + "Job" + ], + "summary": "Cancels a Job (asynchronous).", + "operationId": "Jobs_Cancel", + "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" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Cancel Job.": { + "$ref": "./examples/Job/cancel.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": { + "get": { + "tags": [ + "LabelingJob" + ], + "summary": "Lists labeling jobs in the workspace.", + "operationId": "LabelingJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$top", + "description": "Number of labeling jobs to return.", + "type": "integer", + "format": "int32" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Labeling Job.": { + "$ref": "./examples/LabelingJob/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": { + "delete": { + "tags": [ + "LabelingJob" + ], + "summary": "Delete a labeling job.", + "operationId": "LabelingJobs_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": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Labeling Job.": { + "$ref": "./examples/LabelingJob/delete.json" + } + } + }, + "get": { + "tags": [ + "LabelingJob" + ], + "summary": "Gets a labeling job by name/id.", + "operationId": "LabelingJobs_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": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "includeJobInstructions", + "description": "Boolean value to indicate whether to include JobInstructions in response.", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "includeLabelCategories", + "description": "Boolean value to indicate Whether to include LabelCategories in response.", + "type": "boolean", + "default": false + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } + } + }, + "x-ms-examples": { + "Get Labeling Job.": { + "$ref": "./examples/LabelingJob/get.json" + } + } + }, + "put": { + "tags": [ + "LabelingJob" + ], + "summary": "Creates or updates a labeling job (asynchronous).", + "operationId": "LabelingJobs_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": "id", + "description": "The name and identifier for the LabelingJob.", + "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": "LabelingJob definition object.", + "required": true, + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/LabelingJobResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Labeling Job.": { + "$ref": "./examples/LabelingJob/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Export labels from a labeling job (asynchronous).", + "operationId": "LabelingJobs_ExportLabels", + "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 LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The export summary.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportSummary" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExportSummary" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "ExportLabels Labeling Job.": { + "$ref": "./examples/LabelingJob/exportLabels.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/pause": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Pause a labeling job.", + "operationId": "LabelingJobs_Pause", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Pause Labeling Job.": { + "$ref": "./examples/LabelingJob/pause.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/resume": { + "post": { + "tags": [ + "LabelingJob" + ], + "summary": "Resume a labeling job (asynchronous).", + "operationId": "LabelingJobs_Resume", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "id", + "description": "The name and identifier for the LabelingJob.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Resume Labeling Job.": { + "$ref": "./examples/LabelingJob/resume.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": { + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "List model containers.", + "operationId": "ModelContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "count", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": { + "delete": { + "tags": [ + "ModelContainer" + ], + "summary": "Delete container.", + "operationId": "ModelContainers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelContainer" + ], + "summary": "Get container.", + "operationId": "ModelContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/get.json" + } + } + }, + "put": { + "tags": [ + "ModelContainer" + ], + "summary": "Create or update container.", + "operationId": "ModelContainers_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Container entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Container.": { + "$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": { + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "List model versions.", + "operationId": "ModelVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Model name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of records to return.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "version", + "description": "Model version.", + "type": "string" + }, + { + "in": "query", + "name": "description", + "description": "Model description.", + "type": "string" + }, + { + "in": "query", + "name": "offset", + "description": "Number of initial results to skip.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "tags", + "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2", + "type": "string" + }, + { + "in": "query", + "name": "feed", + "description": "Name of the feed.", + "type": "string" + }, + { + "in": "query", + "name": "listViewType", + "description": "View type for including/excluding (for example) archived entities.", + "type": "string", + "default": "ActiveOnly", + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + } + }, + { + "in": "query", + "name": "stage", + "description": "Model stage", + "type": "string" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": { + "delete": { + "tags": [ + "ModelVersion" + ], + "summary": "Delete version.", + "operationId": "ModelVersions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/delete.json" + } + } + }, + "get": { + "tags": [ + "ModelVersion" + ], + "summary": "Get version.", + "operationId": "ModelVersions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/get.json" + } + } + }, + "put": { + "tags": [ + "ModelVersion" + ], + "summary": "Create or update version.", + "operationId": "ModelVersions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Version entity to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ModelVersionResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/package": { + "post": { + "tags": [ + "ModelVersion" + ], + "summary": "Model Version Package operation.", + "operationId": "ModelVersions_Package", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Container name. This is case-sensitive.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "version", + "description": "Version identifier. This is case-sensitive.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Package operation request body.", + "required": true, + "schema": { + "$ref": "#/definitions/PackageRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PackageResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Package Workspace Model Version.": { + "$ref": "./examples/Workspace/ModelVersion/package.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": { + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List Online Endpoints.", + "operationId": "OnlineEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the endpoint.", + "type": "string" + }, + { + "in": "query", + "name": "count", + "description": "Number of endpoints to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "computeType", + "description": "EndpointComputeType to be filtered by.", + "type": "string", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true + } + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "tags", + "description": "A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "properties", + "description": "A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "type": "string" + }, + { + "in": "query", + "name": "orderBy", + "description": "The option to order the response.", + "type": "string", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": { + "delete": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Delete Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + } + }, + "x-ms-examples": { + "Delete Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Get Online Endpoint.", + "operationId": "OnlineEndpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Create or update Online Endpoint (asynchronous).", + "operationId": "OnlineEndpoints_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployments.", + "operationId": "OnlineDeployments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$orderBy", + "description": "Ordering of list.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Top of list.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Online Deployments.": { + "$ref": "./examples/OnlineDeployment/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": { + "delete": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Delete Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Delete Workspace Online Deployment.": { + "$ref": "./examples/Workspace/OnlineDeployment/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Get Inference Deployment Deployment.", + "operationId": "OnlineDeployments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json" + }, + "Get Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json" + } + } + }, + "patch": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Update Online Deployment (asynchronous).", + "operationId": "OnlineDeployments_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Online Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialMinimalTrackedResourceWithSku" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "Update Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json" + }, + "Update Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Create or update Inference Endpoint Deployment (asynchronous).", + "operationId": "OnlineDeployments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Inference Endpoint entity to apply during operation.", + "required": true, + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Create or update request is successful.", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + }, + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Managed Online Deployment.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json" + }, + "CreateOrUpdate Kubernetes Online Deployment.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": { + "post": { + "tags": [ + "OnlineDeployment" + ], + "summary": "Polls an Endpoint operation.", + "operationId": "OnlineDeployments_GetLogs", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "The name and identifier for the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The request containing parameters for retrieving logs.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentLogsRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentLogs" + } + } + }, + "x-ms-examples": { + "Get Online Deployment Logs.": { + "$ref": "./examples/OnlineDeployment/getLogs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": { + "get": { + "tags": [ + "OnlineDeployment" + ], + "summary": "List Inference Endpoint Deployment Skus.", + "operationId": "OnlineDeployments_ListSkus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Inference endpoint name.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deploymentName", + "description": "Inference Endpoint Deployment name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "count", + "description": "Number of Skus to be retrieved in a page of results.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SkuResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Managed Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json" + }, + "List Kubernetes Online Deployment Skus.": { + "$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.", + "operationId": "OnlineEndpoints_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthKeys" + } + } + }, + "x-ms-examples": { + "ListKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).", + "operationId": "OnlineEndpoints_RegenerateKeys", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "RegenerateKeys request .", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateEndpointKeysRequest" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + } + }, + "x-ms-examples": { + "RegenerateKeys Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": { + "post": { + "tags": [ + "OnlineEndpoint" + ], + "summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.", + "operationId": "OnlineEndpoints_GetToken", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "endpointName", + "description": "Online Endpoint name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EndpointAuthToken" + } + } + }, + "x-ms-examples": { + "GetToken Workspace Online Endpoint.": { + "$ref": "./examples/Workspace/OnlineEndpoint/getToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": { + "get": { + "tags": [ + "Schedule" + ], + "summary": "List schedules in specified workspace.", + "operationId": "Schedules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/PaginationParameter" + }, + { + "in": "query", + "name": "listViewType", + "description": "Status filter for schedule.", + "type": "string", + "default": "EnabledOnly", + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List Schedules.": { + "$ref": "./examples/Schedule/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": { + "delete": { + "tags": [ + "Schedule" + ], + "summary": "Delete schedule.", + "operationId": "Schedules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Delete Schedule.": { + "$ref": "./examples/Schedule/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Schedule" + ], + "summary": "Get schedule.", + "operationId": "Schedules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + }, + "x-ms-examples": { + "Get Schedule.": { + "$ref": "./examples/Schedule/get.json" + } + } + }, + "put": { + "tags": [ + "Schedule" + ], + "summary": "Create or update schedule.", + "operationId": "Schedules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + }, + { + "in": "path", + "name": "name", + "description": "Schedule name.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Schedule definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "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" + } + } + } + }, + "definitions": { + "AccountKeyDatastoreCredentials": { + "description": "Account key datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage account secrets.", + "$ref": "#/definitions/AccountKeyDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AccountKeyDatastoreSecrets": { + "description": "Datastore account key secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "key": { + "description": "Storage account key.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AccountKey", + "additionalProperties": false + }, + "AllFeatures": { + "required": [ + "filterType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringFeatureFilterBase" + } + ], + "x-ms-discriminator-value": "AllFeatures", + "additionalProperties": false + }, + "AllNodes": { + "description": "All nodes means the service will be running on all of the nodes of the job", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Nodes" + } + ], + "x-ms-discriminator-value": "All", + "additionalProperties": false + }, + "AmlToken": { + "description": "AML Token identity configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IdentityConfiguration" + } + ], + "x-ms-discriminator-value": "AMLToken", + "additionalProperties": false + }, + "AmlTokenComputeIdentity": { + "description": "AML token compute identity definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeIdentityBase" + } + ], + "x-ms-discriminator-value": "AmlToken", + "additionalProperties": false + }, + "AssetBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "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). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "isArchived": { + "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": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "AssetContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "latestVersion": { + "description": "The latest version inside this container.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "nextVersion": { + "description": "The next auto incremental version", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetJobInput": { + "description": "Asset input type.", + "required": [ + "uri" + ], + "type": "object", + "properties": { + "mode": { + "description": "Input Asset Delivery Mode.", + "default": "ReadOnlyMount", + "$ref": "#/definitions/InputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "additionalProperties": false + }, + "AssetJobOutput": { + "description": "Asset output type.", + "type": "object", + "properties": { + "assetName": { + "description": "Output Asset Name.", + "type": "string", + "x-nullable": true + }, + "assetVersion": { + "description": "Output Asset Version.", + "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", + "$ref": "#/definitions/OutputDeliveryMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "Output Asset URI.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "AssetProvisioningState": { + "description": "Provisioning state of registry asset.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "AssetProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + }, + { + "value": "Creating" + }, + { + "value": "Updating" + }, + { + "value": "Deleting" + } + ] + }, + "additionalProperties": false + }, + "AssetReferenceBase": { + "description": "Base definition for asset references.", + "required": [ + "referenceType" + ], + "type": "object", + "properties": { + "referenceType": { + "description": "[Required] Specifies the type of asset reference.", + "$ref": "#/definitions/ReferenceType" + } + }, + "discriminator": "referenceType" + }, + "AutoDeleteCondition": { + "enum": [ + "CreatedGreaterThan", + "LastAccessedGreaterThan" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoDeleteCondition", + "modelAsString": true, + "values": [ + { + "value": "CreatedGreaterThan" + }, + { + "value": "LastAccessedGreaterThan" + } + ] + }, + "additionalProperties": false + }, + "AutoDeleteSetting": { + "type": "object", + "properties": { + "condition": { + "description": "When to check if an asset is expired", + "default": "CreatedGreaterThan", + "$ref": "#/definitions/AutoDeleteCondition", + "x-ms-mutability": [ + "create", + "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": [ + "taskDetails" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "environmentId": { + "description": "The ARM resource ID of the Environment specification for the job.\r\nThis is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "taskDetails": { + "description": "[Required] This represents scenario which can be one of Tables/NLP/Image", + "$ref": "#/definitions/AutoMLVertical" + } + }, + "x-ms-discriminator-value": "AutoML", + "additionalProperties": false + }, + "AutoMLVertical": { + "description": "AutoML vertical class.\r\nBase class for AutoML verticals - TableVertical/ImageVertical/NLPVertical", + "required": [ + "taskType", + "trainingData" + ], + "type": "object", + "properties": { + "logVerbosity": { + "description": "Log verbosity for the job.", + "default": "Info", + "$ref": "#/definitions/LogVerbosity" + }, + "targetColumnName": { + "description": "Target column name: This is prediction values column.\r\nAlso known as label column name in context of classification tasks.", + "type": "string", + "x-nullable": true + }, + "taskType": { + "description": "[Required] Task type for AutoMLJob.", + "$ref": "#/definitions/TaskType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "trainingData": { + "description": "[Required] Training data input.", + "$ref": "#/definitions/MLTableJobInput" + } + }, + "discriminator": "taskType" + }, + "AutoNCrossValidations": { + "description": "N-Cross validations determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoRebuildSetting": { + "description": "AutoRebuild setting for the derived image", + "enum": [ + "Disabled", + "OnBaseImageUpdate" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoRebuildSetting", + "modelAsString": true, + "values": [ + { + "value": "Disabled" + }, + { + "value": "OnBaseImageUpdate" + } + ] + }, + "additionalProperties": false + }, + "AutoSeasonality": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetLags": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "x-ms-discriminator-value": "Auto", + "additionalProperties": false + }, + "AutoTargetRollingWindowSize": { + "description": "Target lags rolling window determined automatically.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "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", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "Storage account name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "containerName": { + "description": "Storage account container name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "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": "AzureBlob", + "additionalProperties": false + }, + "AzureDataLakeGen1Datastore": { + "description": "Azure Data Lake Gen1 datastore configuration.", + "required": [ + "storeName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "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" + ] + }, + "storeName": { + "description": "[Required] Azure Data Lake store name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "AzureDataLakeGen1", + "additionalProperties": false + }, + "AzureDataLakeGen2Datastore": { + "description": "Azure Data Lake Gen2 datastore configuration.", + "required": [ + "accountName", + "filesystem" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "filesystem": { + "description": "[Required] The name of the Data Lake Gen2 filesystem.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "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": "AzureDataLakeGen2", + "additionalProperties": false + }, + "AzureDatastore": { + "description": "Base definition for Azure datastore contents configuration.", + "type": "object", + "properties": { + "resourceGroup": { + "description": "Azure Resource Group name", + "type": "string", + "x-nullable": true + }, + "subscriptionId": { + "description": "Azure Subscription Id", + "type": "string", + "x-nullable": true + } + }, + "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": [ + "accountName", + "fileShareName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureDatastore" + }, + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "accountName": { + "description": "[Required] Storage account name.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "endpoint": { + "description": "Azure cloud endpoint for the storage account.", + "type": "string", + "example": "core.windows.net", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "fileShareName": { + "description": "[Required] The name of the Azure file share that the datastore points to.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account.", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "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": "AzureFile", + "additionalProperties": false + }, + "AzureMLBatchInferencingServer": { + "description": "Azure ML batch inferencing server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "codeConfiguration": { + "description": "Code configuration for AML batch inferencing server.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AzureMLBatch", + "additionalProperties": false + }, + "AzureMLOnlineInferencingServer": { + "description": "Azure ML online inferencing configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "codeConfiguration": { + "description": "Code configuration for AML inferencing server.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "AzureMLOnline", + "additionalProperties": false + }, + "BanditPolicy": { + "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "properties": { + "slackAmount": { + "format": "float", + "description": "Absolute distance allowed from the best performing run.", + "default": 0, + "type": "number" + }, + "slackFactor": { + "format": "float", + "description": "Ratio of the allowed distance from the best performing run.", + "default": 0, + "type": "number" + } + }, + "x-ms-discriminator-value": "Bandit", + "additionalProperties": false + }, + "BaseEnvironmentId": { + "description": "Base environment type.", + "required": [ + "resourceId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseEnvironmentSource" + } + ], + "properties": { + "resourceId": { + "description": "[Required] Resource id accepting ArmId or AzureMlId.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "EnvironmentAsset", + "additionalProperties": false + }, + "BaseEnvironmentSource": { + "required": [ + "baseEnvironmentSourceType" + ], + "type": "object", + "properties": { + "baseEnvironmentSourceType": { + "description": "[Required] Base environment type.", + "$ref": "#/definitions/BaseEnvironmentSourceType" + } + }, + "discriminator": "baseEnvironmentSourceType" + }, + "BaseEnvironmentSourceType": { + "description": "Base environment type.", + "enum": [ + "EnvironmentAsset" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseEnvironmentSourceType", + "modelAsString": true, + "values": [ + { + "value": "EnvironmentAsset" + } + ] + }, + "additionalProperties": false + }, + "BatchDeployment": { + "description": "Batch inference settings per deployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" + } + ], + "properties": { + "compute": { + "description": "Compute target for batch inference operation.", + "type": "string", + "x-nullable": true + }, + "deploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "$ref": "#/definitions/BatchDeploymentConfiguration", + "x-nullable": true + }, + "errorThreshold": { + "format": "int32", + "description": "Error threshold, if the error count for the entire input goes above this value,\r\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\r\nFor FileDataset, this value is the count of file failures.\r\nFor TabularDataset, this value is the count of record failures.\r\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.", + "default": -1, + "type": "integer" + }, + "loggingLevel": { + "description": "Logging level for batch inference operation.", + "default": "Info", + "$ref": "#/definitions/BatchLoggingLevel" + }, + "maxConcurrencyPerInstance": { + "format": "int32", + "description": "Indicates maximum number of parallelism per instance.", + "default": 1, + "type": "integer" + }, + "miniBatchSize": { + "format": "int64", + "description": "Size of the mini-batch passed to each batch invocation.\r\nFor FileDataset, this is the number of files per mini-batch.\r\nFor TabularDataset, this is the size of the records in bytes, per mini-batch.", + "default": 10, + "type": "integer" + }, + "model": { + "description": "Reference to the model asset for the endpoint deployment.", + "$ref": "#/definitions/AssetReferenceBase", + "x-nullable": true + }, + "outputAction": { + "description": "Indicates how the output will be organized.", + "default": "AppendRow", + "$ref": "#/definitions/BatchOutputAction" + }, + "outputFileName": { + "description": "Customized output file name for append_row output action.", + "default": "predictions.csv", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "resources": { + "description": "Indicates compute configuration for the job.\r\nIf not provided, will default to the defaults defined in ResourceConfiguration.", + "$ref": "#/definitions/DeploymentResourceConfiguration", + "x-nullable": true + }, + "retrySettings": { + "description": "Retry Settings for the batch inference operation.\r\nIf not provided, will default to the defaults defined in BatchRetrySettings.", + "$ref": "#/definitions/BatchRetrySettings", + "x-nullable": true + } + }, + "x-ms-client-name": "BatchDeploymentProperties", + "additionalProperties": false + }, + "BatchDeploymentConfiguration": { + "description": "Properties relevant to different deployment types.", + "required": [ + "deploymentConfigurationType" + ], + "type": "object", + "properties": { + "deploymentConfigurationType": { + "description": "[Required] The type of the deployment", + "$ref": "#/definitions/BatchDeploymentConfigurationType" + } + }, + "discriminator": "deploymentConfigurationType" + }, + "BatchDeploymentConfigurationType": { + "description": "The enumerated property types for batch deployments.", + "enum": [ + "Model", + "PipelineComponent" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchDeploymentConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Model" + }, + { + "value": "PipelineComponent" + } + ] + }, + "additionalProperties": false + }, + "BatchDeploymentTrackedResource": { + "required": [ + "location", + "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/BatchDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchDeployment", + "additionalProperties": false + }, + "BatchDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchDeployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchDeployment.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchDeploymentTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchEndpoint": { + "description": "Batch endpoint configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], + "properties": { + "defaults": { + "description": "Default values for Batch Endpoint.", + "$ref": "#/definitions/BatchEndpointDefaults", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "BatchEndpointProperties", + "additionalProperties": false + }, + "BatchEndpointDefaults": { + "description": "Batch endpoint default values", + "type": "object", + "properties": { + "deploymentName": { + "description": "Name of the deployment that will be default for the endpoint.\r\nThis deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "BatchEndpointTrackedResource": { + "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/BatchEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "BatchEndpoint", + "additionalProperties": false + }, + "BatchEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of BatchEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type BatchEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "BatchLoggingLevel": { + "description": "Log verbosity for batch inferencing.\r\nIncreasing verbosity order for logging is : Warning, Info and Debug.\r\nThe default value is Info.", + "enum": [ + "Info", + "Warning", + "Debug" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchLoggingLevel", + "modelAsString": true, + "values": [ + { + "value": "Info" + }, + { + "value": "Warning" + }, + { + "value": "Debug" + } + ] + }, + "additionalProperties": false + }, + "BatchOutputAction": { + "description": "Enum to determine how batch inferencing will handle output", + "enum": [ + "SummaryOnly", + "AppendRow" + ], + "type": "string", + "x-ms-enum": { + "name": "BatchOutputAction", + "modelAsString": true, + "values": [ + { + "value": "SummaryOnly" + }, + { + "value": "AppendRow" + } + ] + }, + "additionalProperties": false + }, + "BatchPipelineComponentDeploymentConfiguration": { + "description": "Properties for a Batch Pipeline Component Deployment.", + "required": [ + "deploymentConfigurationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BatchDeploymentConfiguration" + } + ], + "properties": { + "componentId": { + "description": "The ARM id of the component to be run.", + "$ref": "#/definitions/IdAssetReference", + "x-nullable": true + }, + "description": { + "description": "The description which will be applied to the job.", + "type": "string", + "x-nullable": true + }, + "settings": { + "description": "Run-time settings for the pipeline job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "The tags which will be applied to the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PipelineComponent", + "additionalProperties": false + }, + "BatchRetrySettings": { + "description": "Retry settings for a batch inference operation.", + "type": "object", + "properties": { + "maxRetries": { + "format": "int32", + "description": "Maximum retry count for a mini-batch", + "default": 3, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "Invocation timeout for a mini-batch, in ISO 8601 format.", + "default": "PT30S", + "type": "string" + } + }, + "additionalProperties": false + }, + "BayesianSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values based on previous values", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "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": [ + "TextTargetEncoder", + "OneHotEncoder", + "CatTargetEncoder", + "TfIdf", + "WoETargetEncoder", + "LabelEncoder", + "WordEmbedding", + "NaiveBayes", + "CountVectorizer", + "HashOneHotEncoder" + ], + "type": "string", + "x-ms-enum": { + "name": "BlockedTransformers", + "modelAsString": true, + "values": [ + { + "value": "TextTargetEncoder", + "description": "Target encoding for text data." + }, + { + "value": "OneHotEncoder", + "description": "Ohe hot encoding creates a binary feature transformation." + }, + { + "value": "CatTargetEncoder", + "description": "Target encoding for categorical data." + }, + { + "value": "TfIdf", + "description": "Tf-Idf stands for, term-frequency times inverse document-frequency. This is a common term weighting scheme for identifying information from documents." + }, + { + "value": "WoETargetEncoder", + "description": "Weight of Evidence encoding is a technique used to encode categorical variables. It uses the natural log of the P(1)/P(0) to create weights." + }, + { + "value": "LabelEncoder", + "description": "Label encoder converts labels/categorical variables in a numerical form." + }, + { + "value": "WordEmbedding", + "description": "Word embedding helps represents words or phrases as a vector, or a series of numbers." + }, + { + "value": "NaiveBayes", + "description": "Naive Bayes is a classified that is used for classification of discrete features that are categorically distributed." + }, + { + "value": "CountVectorizer", + "description": "Count Vectorizer converts a collection of text documents to a matrix of token counts." + }, + { + "value": "HashOneHotEncoder", + "description": "Hashing One Hot Encoder can turn categorical variables into a limited number of new features. This is often used for high-cardinality categorical features." + } + ] + }, + "additionalProperties": false + }, + "BuildContext": { + "description": "Configuration settings for Docker build context", + "required": [ + "contextUri" + ], + "type": "object", + "properties": { + "contextUri": { + "description": "[Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs.\r\n", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dockerfilePath": { + "description": "Path to the Dockerfile in the build context.\r\n", + "default": "Dockerfile", + "type": "string", + "example": "prod/Dockerfile", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "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": [ + "clientId", + "secrets", + "tenantId", + "thumbprint" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/CertificateDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + }, + "thumbprint": { + "description": "[Required] Thumbprint of the certificate used for authentication.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "CertificateDatastoreSecrets": { + "description": "Datastore certificate secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "certificate": { + "description": "Service principal certificate.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Certificate", + "additionalProperties": false + }, + "Classification": { + "description": "Classification task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "positiveLabel": { + "description": "Positive label for binary metrics calculation.", + "type": "string", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for the task.", + "default": "AUCWeighted", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ClassificationTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Classification", + "additionalProperties": false + }, + "ClassificationModelPerformanceMetric": { + "enum": [ + "Accuracy", + "Precision", + "Recall" + ], + "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." + } + ] + }, + "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": [ + "LogisticRegression", + "SGD", + "MultinomialNaiveBayes", + "BernoulliNaiveBayes", + "SVM", + "LinearSVM", + "KNN", + "DecisionTree", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "GradientBoosting", + "XGBoostClassifier" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationModels", + "modelAsString": true, + "values": [ + { + "value": "LogisticRegression", + "description": "Logistic regression is a fundamental classification technique.\nIt belongs to the group of linear classifiers and is somewhat similar to polynomial and linear regression.\nLogistic regression is fast and relatively uncomplicated, and it's convenient for you to interpret the results.\nAlthough it's essentially a method for binary classification, it can also be applied to multiclass problems." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs." + }, + { + "value": "MultinomialNaiveBayes", + "description": "The multinomial Naive Bayes classifier is suitable for classification with discrete features (e.g., word counts for text classification).\nThe multinomial distribution normally requires integer feature counts. However, in practice, fractional counts such as tf-idf may also work." + }, + { + "value": "BernoulliNaiveBayes", + "description": "Naive Bayes classifier for multivariate Bernoulli models." + }, + { + "value": "SVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text." + }, + { + "value": "LinearSVM", + "description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text.\nLinear SVM performs best when input data is linear, i.e., data can be easily classified by drawing the straight line between classified values on a plotted graph." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "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." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "XGBoostClassifier", + "description": "XGBoost: Extreme Gradient Boosting Algorithm. This algorithm is used for structured data where target column values can be divided into distinct class values." + } + ] + }, + "additionalProperties": false + }, + "ClassificationMultilabelPrimaryMetrics": { + "description": "Primary metrics for classification multilabel tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted", + "IOU" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationMultilabelPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + }, + { + "value": "IOU", + "description": "Intersection Over Union. Intersection of predictions divided by union of predictions." + } + ] + }, + "additionalProperties": false + }, + "ClassificationPrimaryMetrics": { + "description": "Primary metrics for classification tasks.", + "enum": [ + "AUCWeighted", + "Accuracy", + "NormMacroRecall", + "AveragePrecisionScoreWeighted", + "PrecisionScoreWeighted" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassificationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "AUCWeighted", + "description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class." + }, + { + "value": "Accuracy", + "description": "Accuracy is the ratio of predictions that exactly match the true class labels." + }, + { + "value": "NormMacroRecall", + "description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1." + }, + { + "value": "AveragePrecisionScoreWeighted", + "description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class." + }, + { + "value": "PrecisionScoreWeighted", + "description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class." + } + ] + }, + "additionalProperties": false + }, + "ClassificationTrainingSettings": { + "description": "Classification Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for classification task.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CocoExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "containerName": { + "description": "The container name to which the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "snapshotPath": { + "description": "The output path where the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Coco", + "additionalProperties": false + }, + "CodeConfiguration": { + "description": "Configuration for a scoring code asset.", + "required": [ + "scoringScript" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "scoringScript": { + "description": "[Required] The script to execute on startup. eg. \"score.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "CodeContainer": { + "description": "Container for code asset versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the code container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "CodeContainerProperties", + "additionalProperties": false + }, + "CodeContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/CodeContainer" + } + }, + "x-ms-client-name": "CodeContainer", + "additionalProperties": false + }, + "CodeContainerResourceArmPaginatedResult": { + "description": "A paginated list of CodeContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeContainerResource" + } + } + }, + "additionalProperties": false + }, + "CodeVersion": { + "description": "Code asset version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "codeUri": { + "description": "Uri where code is located", + "type": "string", + "example": "https://blobStorage/folderName", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the code version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "CodeVersionProperties", + "additionalProperties": false + }, + "CodeVersionResource": { + "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/CodeVersion" + } + }, + "x-ms-client-name": "CodeVersion", + "additionalProperties": false + }, + "CodeVersionResourceArmPaginatedResult": { + "description": "A paginated list of CodeVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type CodeVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/CodeVersionResource" + } + } + }, + "additionalProperties": false + }, + "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", + "properties": { + "fields": { + "description": "Fields to apply transformer logic on.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "parameters": { + "description": "Different properties to be passed to transformer.\r\nInput expected is dictionary of key,value pairs in JSON format.", + "type": "object", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "CommandJob": { + "description": "Command job definition.", + "required": [ + "command", + "environmentId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "autologgerSettings": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/AutologgerSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, Ray, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Command Job limit.", + "$ref": "#/definitions/CommandJobLimits", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "parameters": { + "description": "Input parameters.", + "type": "object", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "CommandJobLimits": { + "description": "Command Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "x-ms-discriminator-value": "Command", + "additionalProperties": false + }, + "ComponentContainer": { + "description": "Component container definition.\r\n", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the component container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "ComponentContainerProperties", + "additionalProperties": false + }, + "ComponentContainerResource": { + "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/ComponentContainer" + } + }, + "x-ms-client-name": "ComponentContainer", + "additionalProperties": false + }, + "ComponentContainerResourceArmPaginatedResult": { + "description": "A paginated list of ComponentContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentContainerResource" + } + } + }, + "additionalProperties": false + }, + "ComponentVersion": { + "description": "Definition of a component version: defines resources that span component types.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "componentSpec": { + "description": "Defines Component definition details.\r\n", + "type": "object", + "example": { + "name": "Hello_Python_World", + "display_name": "Hello_Python_World", + "version": 1, + "type": "command", + "code": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/mycode/versions/1", + "environment": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/AzureML-Tutorial/versions/1", + "command": "python hello.py" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the component version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the component lifecycle", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ComponentVersionProperties", + "additionalProperties": false + }, + "ComponentVersionResource": { + "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/ComponentVersion" + } + }, + "x-ms-client-name": "ComponentVersion", + "additionalProperties": false + }, + "ComponentVersionResourceArmPaginatedResult": { + "description": "A paginated list of ComponentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ComponentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ComponentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentVersionResource" + } + } + }, + "additionalProperties": false + }, + "ContainerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", + "type": "object", + "properties": { + "containerResourceLimits": { + "description": "Container resource limit info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + }, + "containerResourceRequests": { + "description": "Container resource request info:", + "$ref": "#/definitions/ContainerResourceSettings", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerResourceSettings": { + "type": "object", + "properties": { + "cpu": { + "description": "Number of vCPUs request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "gpu": { + "description": "Number of Nvidia GPU cards request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "1", + "x-nullable": true + }, + "memory": { + "description": "Memory size request/limit for container. More info:\r\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "string", + "example": "2Gi", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ContainerType": { + "description": "The type of container to retrieve logs from.", + "enum": [ + "StorageInitializer", + "InferenceServer", + "ModelDataCollector" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "value": "StorageInitializer", + "description": "The container used to download models and score script." + }, + { + "value": "InferenceServer", + "description": "The container used to serve user's request." + }, + { + "value": "ModelDataCollector", + "description": "The container used to collect payload and custom logging when mdc is enabled." + } + ] + }, + "additionalProperties": false + }, + "CreateMonitorAction": { + "required": [ + "monitorDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "monitorDefinition": { + "description": "[Required] Defines the monitor.", + "$ref": "#/definitions/MonitorDefinition", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "CreateMonitor", + "additionalProperties": false + }, + "CredentialsType": { + "description": "Enum to determine the datastore credentials type.", + "enum": [ + "AccountKey", + "Certificate", + "None", + "Sas", + "ServicePrincipal", + "KerberosKeytab", + "KerberosPassword" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "None" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + }, + { + "value": "KerberosKeytab" + }, + { + "value": "KerberosPassword" + } + ] + }, + "additionalProperties": false + }, + "CronTrigger": { + "required": [ + "expression" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "expression": { + "description": "[Required] Specifies cron expression of schedule.\r\nThe expression should follow NCronTab format.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Cron", + "additionalProperties": false + }, + "CsvExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "containerName": { + "description": "The container name to which the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "snapshotPath": { + "description": "The output path where the labels will be exported.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "CSV", + "additionalProperties": false + }, + "CustomForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ForecastHorizon" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Forecast horizon value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomInferencingServer": { + "description": "Custom inference server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "inferenceConfiguration": { + "description": "Inference configuration for custom inferencing.", + "$ref": "#/definitions/OnlineInferenceConfiguration", + "x-nullable": true + } + }, + "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": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "custom_model", + "additionalProperties": false + }, + "CustomMonitoringSignal": { + "required": [ + "componentId", + "metricThresholds", + "workspaceConnection" + ], + "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": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "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": [] + }, + "workspaceConnection": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/MonitoringWorkspaceConnection", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomNCrossValidations": { + "description": "N-Cross validations are specified by user.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NCrossValidations" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] N-Cross validations value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomSeasonality": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Seasonality" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] Seasonality value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetLags": { + "required": [ + "values" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetLags" + } + ], + "properties": { + "values": { + "description": "[Required] Set target lags values.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "CustomTargetRollingWindowSize": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TargetRollingWindowSize" + } + ], + "properties": { + "value": { + "format": "int32", + "description": "[Required] TargetRollingWindowSize value.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "Custom", + "additionalProperties": false + }, + "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": [ + "dataType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-client-name": "DataContainerProperties", + "additionalProperties": false + }, + "DataContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/DataContainer" + } + }, + "x-ms-client-name": "DataContainer", + "additionalProperties": false + }, + "DataContainerResourceArmPaginatedResult": { + "description": "A paginated list of DataContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/DataContainerResource" + } + } + }, + "additionalProperties": false + }, + "DataDriftMetricThresholdBase": { + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "dataType": { + "description": "[Required] Specifies the data type of the metric threshold.", + "$ref": "#/definitions/MonitoringFeatureDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "The threshold value. If null, a default value will be set depending on the selected metric.", + "$ref": "#/definitions/MonitoringThreshold", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "discriminator": "dataType" + }, + "DataDriftMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "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 + }, + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The feature filter which identifies which feature to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataDriftMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "DataDrift", + "additionalProperties": false + }, + "DataImport": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "properties": { + "assetName": { + "description": "Name of the asset for data import job to create", + "type": "string", + "x-nullable": true + }, + "source": { + "description": "Source data of the asset to import from", + "$ref": "#/definitions/DataImportSource", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "DataImportSource": { + "required": [ + "sourceType" + ], + "type": "object", + "properties": { + "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": "sourceType" + }, + "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": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "datastoreId": { + "description": "ARM resource ID of the datastore where the asset is located.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the datastore.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "DataPath", + "additionalProperties": false + }, + "DataQualityMetricThresholdBase": { + "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" + }, + "DataQualityMonitoringSignal": { + "required": [ + "metricThresholds", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "featureDataTypeOverride": { + "description": "A dictionary that maps feature names to their respective data types.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MonitoringFeatureDataType" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "features": { + "description": "The features to calculate drift over.", + "$ref": "#/definitions/MonitoringFeatureFilterBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "metricThresholds": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/DataQualityMetricThresholdBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "[Required] The data produced by the production service which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "DataQuality", + "additionalProperties": false + }, + "DataType": { + "description": "Enum to determine the type of data.", + "enum": [ + "uri_file", + "uri_folder", + "mltable" + ], + "type": "string", + "x-ms-enum": { + "name": "DataType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + } + ] + }, + "additionalProperties": false + }, + "DataVersionBase": { + "description": "Data version base definition", + "required": [ + "dataType", + "dataUri" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "dataType": { + "description": "[Required] Specifies the type of data.", + "$ref": "#/definitions/DataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataUri": { + "description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "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", + "x-ms-client-name": "DataVersionBaseProperties" + }, + "DataVersionBaseResource": { + "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/DataVersionBase" + } + }, + "x-ms-client-name": "DataVersionBase", + "additionalProperties": false + }, + "DataVersionBaseResourceArmPaginatedResult": { + "description": "A paginated list of DataVersionBase entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of DataVersionBase objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type DataVersionBase.", + "type": "array", + "items": { + "$ref": "#/definitions/DataVersionBaseResource" + } + } + }, + "additionalProperties": false + }, + "DatabaseSource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataImportSource" + } + ], + "properties": { + "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 + }, + "DatasetExportSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSummary" + } + ], + "properties": { + "labeledAssetName": { + "description": "The unique name of the labeled data asset.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Dataset", + "additionalProperties": false + }, + "Datastore": { + "description": "Base definition for datastore contents configuration.", + "required": [ + "credentials", + "datastoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "credentials": { + "description": "[Required] Account credentials.", + "$ref": "#/definitions/DatastoreCredentials" + }, + "datastoreType": { + "description": "[Required] Storage type backing the datastore.", + "$ref": "#/definitions/DatastoreType" + }, + "intellectualProperty": { + "description": "Intellectual Property details.", + "$ref": "#/definitions/IntellectualProperty", + "x-ms-mutability": [ + "create", + "read" + ], + "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", + "Ray" + ], + "type": "string", + "x-ms-enum": { + "name": "DistributionType", + "modelAsString": true, + "values": [ + { + "value": "PyTorch" + }, + { + "value": "TensorFlow" + }, + { + "value": "Mpi" + }, + { + "value": "Ray" + } + ] + }, + "additionalProperties": false + }, + "EarlyTerminationPolicy": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "required": [ + "policyType" + ], + "type": "object", + "properties": { + "delayEvaluation": { + "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", + "default": 0, + "type": "integer" + }, + "evaluationInterval": { + "format": "int32", + "description": "Interval (number of runs) between policy evaluations.", + "default": 0, + "type": "integer" + }, + "policyType": { + "description": "[Required] Name of policy configuration", + "$ref": "#/definitions/EarlyTerminationPolicyType" + } + }, + "discriminator": "policyType" + }, + "EarlyTerminationPolicyType": { + "enum": [ + "Bandit", + "MedianStopping", + "TruncationSelection" + ], + "type": "string", + "x-ms-enum": { + "name": "EarlyTerminationPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Bandit" + }, + { + "value": "MedianStopping" + }, + { + "value": "TruncationSelection" + } + ] + }, + "additionalProperties": false + }, + "EgressPublicNetworkAccessType": { + "description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EgressPublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "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": [ + "JobCompleted", + "JobFailed", + "JobCancelled" + ], + "type": "string", + "x-ms-enum": { + "name": "EmailNotificationEnableType", + "modelAsString": true, + "values": [ + { + "value": "JobCompleted" + }, + { + "value": "JobFailed" + }, + { + "value": "JobCancelled" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthKeys": { + "description": "Keys for endpoint authentication.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointAuthMode": { + "description": "Enum to determine endpoint authentication mode.", + "enum": [ + "AMLToken", + "Key", + "AADToken" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointAuthMode", + "modelAsString": true, + "values": [ + { + "value": "AMLToken" + }, + { + "value": "Key" + }, + { + "value": "AADToken" + } + ] + }, + "additionalProperties": false + }, + "EndpointAuthToken": { + "description": "Service Token", + "type": "object", + "properties": { + "accessToken": { + "description": "Access token for endpoint authentication.", + "type": "string", + "x-nullable": true + }, + "expiryTimeUtc": { + "format": "int64", + "description": "Access token expiry time (UTC).", + "default": 0, + "type": "integer" + }, + "refreshAfterTimeUtc": { + "format": "int64", + "description": "Refresh access token after time (UTC).", + "default": 0, + "type": "integer" + }, + "tokenType": { + "description": "Access token type.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointComputeType": { + "description": "Enum to determine endpoint compute type.", + "enum": [ + "Managed", + "Kubernetes", + "AzureMLCompute" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointComputeType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "Kubernetes" + }, + { + "value": "AzureMLCompute" + } + ] + }, + "additionalProperties": false + }, + "EndpointDeploymentPropertiesBase": { + "description": "Base definition for endpoint deployment.", + "type": "object", + "properties": { + "codeConfiguration": { + "description": "Code configuration for the endpoint deployment.", + "$ref": "#/definitions/CodeConfiguration", + "x-nullable": true + }, + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentId": { + "description": "ARM resource ID of the environment specification for the endpoint deployment.", + "type": "string", + "x-nullable": true + }, + "environmentVariables": { + "description": "Environment variables configuration for the deployment.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointPropertiesBase": { + "description": "Inference Endpoint base definition", + "required": [ + "authMode" + ], + "type": "object", + "properties": { + "authMode": { + "description": "[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.", + "$ref": "#/definitions/EndpointAuthMode" + }, + "description": { + "description": "Description of the inference endpoint.", + "type": "string", + "x-nullable": true + }, + "keys": { + "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.", + "$ref": "#/definitions/EndpointAuthKeys", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "x-nullable": true + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "scoringUri": { + "format": "uri", + "description": "Endpoint URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "swaggerUri": { + "format": "uri", + "description": "Endpoint Swagger URI.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointProvisioningState": { + "description": "State of endpoint provisioning.", + "enum": [ + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Updating", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Updating" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "EndpointScheduleAction": { + "required": [ + "actionType", + "endpointInvocationDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "endpointInvocationDefinition": { + "description": "[Required] Defines Schedule action definition details.\r\n", + "type": "object", + "example": { + "endpoint": "azureml:/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/hello-pipeline", + "inputs": { + "create_time": "${{creation_context.trigger_time}}" + } + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "InvokeBatchEndpoint", + "additionalProperties": false + }, + "EnvironmentContainer": { + "description": "Container for environment specification versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the environment container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "EnvironmentContainerProperties", + "additionalProperties": false + }, + "EnvironmentContainerResource": { + "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/EnvironmentContainer" + } + }, + "x-ms-client-name": "EnvironmentContainer", + "additionalProperties": false + }, + "EnvironmentContainerResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentContainerResource" + } + } + }, + "additionalProperties": false + }, + "EnvironmentType": { + "description": "Environment type is either user created or curated by Azure ML service", + "enum": [ + "Curated", + "UserCreated" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true, + "values": [ + { + "value": "Curated" + }, + { + "value": "UserCreated" + } + ] + }, + "additionalProperties": false + }, + "EnvironmentVersion": { + "description": "Environment version details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "autoRebuild": { + "description": "Defines if image needs to be rebuilt based on base image changes.", + "default": "Disabled", + "$ref": "#/definitions/AutoRebuildSetting", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "build": { + "description": "Configuration settings for Docker build context.", + "$ref": "#/definitions/BuildContext", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "condaFile": { + "description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\r\n", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentType": { + "description": "Environment type is either user managed or curated by the Azure ML service\r\n", + "$ref": "#/definitions/EnvironmentType", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "image": { + "description": "Name of the image that will be used for the environment.\r\n", + "type": "string", + "example": "docker.io/tensorflow/serving:latest", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inferenceConfig": { + "description": "Defines configuration specific to inference.", + "$ref": "#/definitions/InferenceContainerProperties", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "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", + "$ref": "#/definitions/OperatingSystemType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "provisioningState": { + "description": "Provisioning state for the environment version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Stage in the environment lifecycle assigned to this environment", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "EnvironmentVersionProperties", + "additionalProperties": false + }, + "EnvironmentVersionResource": { + "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/EnvironmentVersion" + } + }, + "x-ms-client-name": "EnvironmentVersion", + "additionalProperties": false + }, + "EnvironmentVersionResourceArmPaginatedResult": { + "description": "A paginated list of EnvironmentVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type EnvironmentVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVersionResource" + } + } + }, + "additionalProperties": false + }, + "ExportFormatType": { + "description": "The format of exported labels.", + "enum": [ + "Dataset", + "Coco", + "CSV" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportFormatType", + "modelAsString": true, + "values": [ + { + "value": "Dataset" + }, + { + "value": "Coco" + }, + { + "value": "CSV" + } + ] + }, + "additionalProperties": false + }, + "ExportSummary": { + "required": [ + "format" + ], + "type": "object", + "properties": { + "endDateTime": { + "format": "date-time", + "description": "The time when the export was completed.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "exportedRowCount": { + "format": "int64", + "description": "The total number of labeled datapoints exported.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "format": { + "description": "[Required] The format of exported labels, also as the discriminator.", + "$ref": "#/definitions/ExportFormatType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "labelingJobId": { + "description": "Name and identifier of the job containing exported labels.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "startDateTime": { + "format": "date-time", + "description": "The time when the export was requested.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "discriminator": "format" + }, + "Feature": { + "description": "Dto object representing feature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "dataType": { + "description": "Specifies type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + }, + "featureName": { + "description": "Specifies name", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeatureProperties", + "additionalProperties": false + }, + "FeatureAttributionDriftMonitoringSignal": { + "required": [ + "metricThreshold", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "metricThreshold": { + "description": "[Required] A list of metrics to calculate and their associated thresholds.", + "$ref": "#/definitions/FeatureAttributionMetricThreshold", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "FeatureAttributionDrift", + "additionalProperties": false + }, + "FeatureAttributionMetric": { + "enum": [ + "NormalizedDiscountedCumulativeGain" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureAttributionMetric", + "modelAsString": true, + "values": [ + { + "value": "NormalizedDiscountedCumulativeGain", + "description": "The Normalized Discounted Cumulative Gain metric." + } + ] + }, + "additionalProperties": false + }, + "FeatureAttributionMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] The feature attribution metric to calculate.", + "$ref": "#/definitions/FeatureAttributionMetric", + "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 + }, + "FeatureDataType": { + "enum": [ + "String", + "Integer", + "Long", + "Float", + "Double", + "Binary", + "Datetime", + "Boolean" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureDataType", + "modelAsString": true, + "values": [ + { + "value": "String" + }, + { + "value": "Integer" + }, + { + "value": "Long" + }, + { + "value": "Float" + }, + { + "value": "Double" + }, + { + "value": "Binary" + }, + { + "value": "Datetime" + }, + { + "value": "Boolean" + } + ] + }, + "additionalProperties": false + }, + "FeatureLags": { + "description": "Flag for generating lags for the numeric features.", + "enum": [ + "None", + "Auto" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureLags", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No feature lags generated." + }, + { + "value": "Auto", + "description": "System auto-generates feature lags." + } + ] + }, + "additionalProperties": false + }, + "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", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the featureset container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "FeaturesetContainerProperties", + "additionalProperties": false + }, + "FeaturesetContainerResource": { + "description": "Azure Resource Manager resource envelope.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/FeaturesetContainer" + } + }, + "x-ms-client-name": "FeaturesetContainer", + "additionalProperties": false + }, + "FeaturesetContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetContainerResource" + } + } + }, + "additionalProperties": false + }, + "FeaturesetJob": { + "description": "Dto object representing the feature set job", + "type": "object", + "properties": { + "createdDate": { + "format": "date-time", + "description": "Specifies the created date", + "type": "string", + "x-nullable": true + }, + "displayName": { + "description": "Specifies the display name", + "type": "string", + "x-nullable": true + }, + "duration": { + "format": "duration", + "description": "Specifies the duration", + "type": "string", + "x-nullable": true + }, + "experimentId": { + "description": "Specifies the experiment id", + "type": "string", + "x-nullable": true + }, + "featureWindow": { + "description": "Specifies the backfill feature window to be materialized", + "$ref": "#/definitions/FeatureWindow", + "x-nullable": true + }, + "jobId": { + "description": "Specifies the job id", + "type": "string", + "x-nullable": true + }, + "status": { + "description": "Specifies the job status", + "default": "Unknown", + "$ref": "#/definitions/JobStatus" + }, + "tags": { + "description": "Specifies the tags if any", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "type": { + "description": "Specifies the feature store job type", + "default": "RecurrentMaterialization", + "$ref": "#/definitions/FeaturestoreJobType" + } + }, + "additionalProperties": false + }, + "FeaturesetJobArmPaginatedResult": { + "description": "A paginated list of FeaturesetJob entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetJob objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetJob.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetJob" + }, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "FeaturesetSpecification": { + "description": "Dto object representing specification", + "type": "object", + "properties": { + "path": { + "description": "Specifies the spec path", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "FeaturesetVersion": { + "description": "Dto object representing feature set version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "entities": { + "description": "Specifies list of entities", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "materializationSettings": { + "description": "Specifies the materialization settings", + "$ref": "#/definitions/MaterializationSettings", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the featureset version container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "specification": { + "description": "Specifies the feature spec details", + "$ref": "#/definitions/FeaturesetSpecification", + "x-nullable": true + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeaturesetVersionProperties", + "additionalProperties": false + }, + "FeaturesetVersionBackfillRequest": { + "description": "Request payload for creating a backfill request for a given feature set version", + "type": "object", + "properties": { + "description": { + "description": "Specifies description", + "type": "string" + }, + "displayName": { + "description": "Specifies description", + "type": "string" + }, + "featureWindow": { + "description": "Specifies the backfill feature window to be materialized", + "$ref": "#/definitions/FeatureWindow", + "x-nullable": true + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource" + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + }, + "tags": { + "description": "Specifies the tags", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "FeaturesetVersionResource": { + "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/FeaturesetVersion" + } + }, + "x-ms-client-name": "FeaturesetVersion", + "additionalProperties": false + }, + "FeaturesetVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturesetVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturesetVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturesetVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturesetVersionResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreEntityContainer": { + "description": "Dto object representing feature entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetContainer" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state for the featurestore entity container.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-client-name": "FeaturestoreEntityContainerProperties", + "additionalProperties": false + }, + "FeaturestoreEntityContainerResource": { + "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/FeaturestoreEntityContainer" + } + }, + "x-ms-client-name": "FeaturestoreEntityContainer", + "additionalProperties": false + }, + "FeaturestoreEntityContainerResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturestoreEntityContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturestoreEntityContainerResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreEntityVersion": { + "description": "Dto object representing feature entity version", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetBase" + } + ], + "properties": { + "indexColumns": { + "description": "Specifies index columns", + "type": "array", + "items": { + "$ref": "#/definitions/IndexColumn" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "Provisioning state for the featurestore entity version.", + "$ref": "#/definitions/AssetProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "stage": { + "description": "Specifies the asset stage", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "FeaturestoreEntityVersionProperties", + "additionalProperties": false + }, + "FeaturestoreEntityVersionResource": { + "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/FeaturestoreEntityVersion" + } + }, + "x-ms-client-name": "FeaturestoreEntityVersion", + "additionalProperties": false + }, + "FeaturestoreEntityVersionResourceArmPaginatedResult": { + "description": "A paginated list of FeaturestoreEntityVersion entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type FeaturestoreEntityVersion.", + "type": "array", + "items": { + "$ref": "#/definitions/FeaturestoreEntityVersionResource" + } + } + }, + "additionalProperties": false + }, + "FeaturestoreJobType": { + "enum": [ + "RecurrentMaterialization", + "BackfillMaterialization" + ], + "type": "string", + "x-ms-enum": { + "name": "FeaturestoreJobType", + "modelAsString": true, + "values": [ + { + "value": "RecurrentMaterialization" + }, + { + "value": "BackfillMaterialization" + } + ] + }, + "additionalProperties": false + }, + "FeaturizationMode": { + "description": "Featurization mode - determines data featurization mode.", + "enum": [ + "Auto", + "Custom", + "Off" + ], + "type": "string", + "x-ms-enum": { + "name": "FeaturizationMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Auto mode, system performs featurization without any custom featurization inputs." + }, + { + "value": "Custom", + "description": "Custom featurization." + }, + { + "value": "Off", + "description": "Featurization off. 'Forecasting' task cannot use this value." + } + ] + }, + "additionalProperties": false + }, + "FeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "properties": { + "datasetLanguage": { + "description": "Dataset language, useful for the text data.", + "type": "string", + "x-nullable": true + } + }, + "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 + }, + "FixedInputData": { + "description": "Fixed input data definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "x-ms-discriminator-value": "Fixed", + "additionalProperties": false + }, + "FlavorData": { + "type": "object", + "properties": { + "data": { + "description": "Model flavor-specific data.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ForecastHorizon": { + "description": "The desired maximum forecast horizon in units of time-series frequency.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set forecast horizon value selection mode.", + "$ref": "#/definitions/ForecastHorizonMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "ForecastHorizonMode": { + "description": "Enum to determine forecast horizon selection mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastHorizonMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Forecast horizon to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom forecast horizon." + } + ] + }, + "additionalProperties": false + }, + "Forecasting": { + "description": "Forecasting task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "forecastingSettings": { + "description": "Forecasting task specific inputs.", + "$ref": "#/definitions/ForecastingSettings", + "x-nullable": true + }, + "primaryMetric": { + "description": "Primary metric for forecasting task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/ForecastingPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/ForecastingTrainingSettings", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Forecasting", + "additionalProperties": false + }, + "ForecastingModels": { + "description": "Enum for all forecasting models supported by AutoML.", + "enum": [ + "AutoArima", + "Prophet", + "Naive", + "SeasonalNaive", + "Average", + "SeasonalAverage", + "ExponentialSmoothing", + "Arimax", + "TCNForecaster", + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastingModels", + "modelAsString": true, + "values": [ + { + "value": "AutoArima", + "description": "Auto-Autoregressive Integrated Moving Average (ARIMA) model uses time-series data and statistical analysis to interpret the data and make future predictions.\nThis model aims to explain data by using time series data on its past values and uses linear regression to make predictions." + }, + { + "value": "Prophet", + "description": "Prophet is a procedure for forecasting time series data based on an additive model where non-linear trends are fit with yearly, weekly, and daily seasonality, plus holiday effects.\nIt works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust to missing data and shifts in the trend, and typically handles outliers well." + }, + { + "value": "Naive", + "description": "The Naive forecasting model makes predictions by carrying forward the latest target value for each time-series in the training data." + }, + { + "value": "SeasonalNaive", + "description": "The Seasonal Naive forecasting model makes predictions by carrying forward the latest season of target values for each time-series in the training data." + }, + { + "value": "Average", + "description": "The Average forecasting model makes predictions by carrying forward the average of the target values for each time-series in the training data." + }, + { + "value": "SeasonalAverage", + "description": "The Seasonal Average forecasting model makes predictions by carrying forward the average value of the latest season of data for each time-series in the training data." + }, + { + "value": "ExponentialSmoothing", + "description": "Exponential smoothing is a time series forecasting method for univariate data that can be extended to support data with a systematic trend or seasonal component." + }, + { + "value": "Arimax", + "description": "An Autoregressive Integrated Moving Average with Explanatory Variable (ARIMAX) model can be viewed as a multiple regression model with one or more autoregressive (AR) terms and/or one or more moving average (MA) terms.\nThis method is suitable for forecasting when data is stationary/non stationary, and multivariate with any type of data pattern, i.e., level/trend /seasonality/cyclicity." + }, + { + "value": "TCNForecaster", + "description": "TCNForecaster: Temporal Convolutional Networks Forecaster. //TODO: Ask forecasting team for brief intro." + }, + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "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." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, + "additionalProperties": false + }, + "ForecastingPrimaryMetrics": { + "description": "Primary metrics for Forecasting task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" + ], + "type": "string", + "x-ms-enum": { + "name": "ForecastingPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a non-parametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." + } + ] + }, + "additionalProperties": false + }, + "ForecastingSettings": { + "description": "Forecasting specific parameters.", + "type": "object", + "properties": { + "countryOrRegionForHolidays": { + "description": "Country or region for holidays for forecasting tasks.\r\nThese should be ISO 3166 two-letter country/region codes, for example 'US' or 'GB'.", + "type": "string", + "x-nullable": true + }, + "cvStepSize": { + "format": "int32", + "description": "Number of periods between the origin time of one CV fold and the next fold. For\r\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\r\nthree days apart.", + "type": "integer", + "x-nullable": true + }, + "featureLags": { + "description": "Flag for generating lags for the numeric features with 'auto' or null.", + "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}", + "$ref": "#/definitions/ForecastHorizon" + }, + "frequency": { + "description": "When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.", + "type": "string", + "x-nullable": true + }, + "seasonality": { + "description": "Set time series seasonality as an integer multiple of the series frequency.\r\nIf seasonality is set to 'auto', it will be inferred.", + "default": "{\"Mode\": \"Auto\"}", + "$ref": "#/definitions/Seasonality" + }, + "shortSeriesHandlingConfig": { + "description": "The parameter defining how if AutoML should handle short time series.", + "default": "Auto", + "$ref": "#/definitions/ShortSeriesHandlingConfiguration" + }, + "targetAggregateFunction": { + "description": "The function to be used to aggregate the time series target column to conform to a user specified frequency.\r\nIf the TargetAggregateFunction is set i.e. not 'None', but the freq parameter is not set, the error is raised. The possible target aggregation functions are: \"sum\", \"max\", \"min\" and \"mean\".", + "default": "None", + "$ref": "#/definitions/TargetAggregationFunction" + }, + "targetLags": { + "description": "The number of past periods to lag from the target column.", + "$ref": "#/definitions/TargetLags", + "x-nullable": true + }, + "targetRollingWindowSize": { + "description": "The number of past periods used to create a rolling window average of the target column.", + "$ref": "#/definitions/TargetRollingWindowSize", + "x-nullable": true + }, + "timeColumnName": { + "description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.", + "type": "string", + "x-nullable": true + }, + "timeSeriesIdColumnNames": { + "description": "The names of columns used to group a timeseries. It can be used to create multiple series.\r\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "useStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "default": "None", + "$ref": "#/definitions/UseStl" + } + }, + "additionalProperties": false + }, + "ForecastingTrainingSettings": { + "description": "Forecasting Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for forecasting task.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastingModels" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "GenerationSafetyQualityMetric": { + "description": "Generation safety quality metric enum.", + "enum": [ + "AcceptableGroundednessScorePerInstance", + "AggregatedGroundednessPassRate", + "AcceptableCoherenceScorePerInstance", + "AggregatedCoherencePassRate", + "AcceptableFluencyScorePerInstance", + "AggregatedFluencyPassRate", + "AcceptableSimilarityScorePerInstance", + "AggregatedSimilarityPassRate", + "AcceptableRelevanceScorePerInstance", + "AggregatedRelevancePassRate" + ], + "type": "string", + "x-ms-enum": { + "name": "GenerationSafetyQualityMetric", + "modelAsString": true, + "values": [ + { + "value": "AcceptableGroundednessScorePerInstance" + }, + { + "value": "AggregatedGroundednessPassRate" + }, + { + "value": "AcceptableCoherenceScorePerInstance" + }, + { + "value": "AggregatedCoherencePassRate" + }, + { + "value": "AcceptableFluencyScorePerInstance" + }, + { + "value": "AggregatedFluencyPassRate" + }, + { + "value": "AcceptableSimilarityScorePerInstance" + }, + { + "value": "AggregatedSimilarityPassRate" + }, + { + "value": "AcceptableRelevanceScorePerInstance" + }, + { + "value": "AggregatedRelevancePassRate" + } + ] + }, + "additionalProperties": false + }, + "GenerationSafetyQualityMetricThreshold": { + "description": "Generation safety quality metric threshold definition.", + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] Gets or sets the feature attribution metric to calculate.", + "$ref": "#/definitions/GenerationSafetyQualityMetric", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "Gets or sets the threshold value.\r\nIf 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 + }, + "GenerationSafetyQualityMonitoringSignal": { + "description": "Generation safety quality monitoring signal definition.", + "required": [ + "metricThresholds", + "samplingRate" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "metricThresholds": { + "description": "[Required] Gets or sets the metrics to calculate and the corresponding thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/GenerationSafetyQualityMetricThreshold" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "Gets or sets the target data for computing metrics.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "samplingRate": { + "format": "double", + "description": "[Required] The sample rate of the target data, should be greater than 0 and at most 1.", + "type": "number", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workspaceConnectionId": { + "description": "Gets or sets the workspace connection ID used to connect to the content generation endpoint.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "GenerationSafetyQuality", + "additionalProperties": false + }, + "GenerationTokenStatisticsMetric": { + "description": "Generation token statistics metric enum.", + "enum": [ + "TotalTokenCount", + "TotalTokenCountPerGroup" + ], + "type": "string", + "x-ms-enum": { + "name": "GenerationTokenStatisticsMetric", + "modelAsString": true, + "values": [ + { + "value": "TotalTokenCount" + }, + { + "value": "TotalTokenCountPerGroup" + } + ] + }, + "additionalProperties": false + }, + "GenerationTokenStatisticsMetricThreshold": { + "description": "Generation token statistics metric threshold definition.", + "required": [ + "metric" + ], + "type": "object", + "properties": { + "metric": { + "description": "[Required] Gets or sets the feature attribution metric to calculate.", + "$ref": "#/definitions/GenerationTokenStatisticsMetric", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "threshold": { + "description": "Gets or sets the threshold value.\r\nIf 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 + }, + "GenerationTokenStatisticsSignal": { + "description": "Generation token statistics signal definition.", + "required": [ + "metricThresholds", + "samplingRate" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "metricThresholds": { + "description": "[Required] Gets or sets the metrics to calculate and the corresponding thresholds.", + "type": "array", + "items": { + "$ref": "#/definitions/GenerationTokenStatisticsMetricThreshold" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "productionData": { + "description": "Gets or sets the target data for computing metrics.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "samplingRate": { + "format": "double", + "description": "[Required] The sample rate of the target data, should be greater than 0 and at most 1.", + "type": "number", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "GenerationTokenStatistics", + "additionalProperties": false + }, + "Goal": { + "description": "Defines supported metric goals for hyperparameter tuning", + "enum": [ + "Minimize", + "Maximize" + ], + "type": "string", + "x-ms-enum": { + "name": "Goal", + "modelAsString": true, + "values": [ + { + "value": "Minimize" + }, + { + "value": "Maximize" + } + ] + }, + "additionalProperties": false + }, + "GridSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that exhaustively generates every value combination in the space", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "x-ms-discriminator-value": "Grid", + "additionalProperties": false + }, + "HdfsDatastore": { + "required": [ + "nameNodeAddress" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Datastore" + } + ], + "properties": { + "hdfsServerCertificate": { + "description": "The TLS cert of the HDFS server. Needs to be a base64 encoded string. Required if \"Https\" protocol is selected.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "nameNodeAddress": { + "description": "[Required] IP Address or DNS HostName.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "protocol": { + "description": "Protocol used to communicate with the storage account (Https/Http).", + "default": "http", + "type": "string", + "example": "https", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Hdfs", + "additionalProperties": false + }, + "IdAssetReference": { + "description": "Reference to an asset via its ARM resource ID.", + "required": [ + "assetId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "assetId": { + "description": "[Required] ARM resource ID of the asset.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "x-ms-discriminator-value": "Id", + "additionalProperties": false + }, + "IdentityConfiguration": { + "description": "Base definition for identity configuration.", + "required": [ + "identityType" + ], + "type": "object", + "properties": { + "identityType": { + "description": "[Required] Specifies the type of identity framework.", + "$ref": "#/definitions/IdentityConfigurationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "identityType" + }, + "IdentityConfigurationType": { + "description": "Enum to determine identity framework.", + "enum": [ + "Managed", + "AMLToken", + "UserIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Managed" + }, + { + "value": "AMLToken" + }, + { + "value": "UserIdentity" + } + ] + }, + "additionalProperties": false + }, + "ImageAnnotationType": { + "description": "Annotation type of image data.", + "enum": [ + "Classification", + "BoundingBox", + "InstanceSegmentation" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageAnnotationType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "BoundingBox" + }, + { + "value": "InstanceSegmentation" + } + ] + }, + "additionalProperties": false + }, + "ImageClassification": { + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\r\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassification", + "additionalProperties": false + }, + "ImageClassificationBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageVertical" + } + ], + "properties": { + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsClassification", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsClassification" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ImageClassificationMultilabel": { + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\r\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageClassificationBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "IOU", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageClassificationMultilabel", + "additionalProperties": false + }, + "ImageInstanceSegmentation": { + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\r\ndrawing a polygon around each object in the image.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/InstanceSegmentationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageInstanceSegmentation", + "additionalProperties": false + }, + "ImageLimitSettings": { + "description": "Limit settings for the AutoML job.", + "type": "object", + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum number of concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Maximum number of AutoML iterations.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + } + }, + "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.", + "type": "object", + "properties": { + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "augmentations": { + "description": "Settings for using Augmentations.", + "type": "string", + "example": "choice('hflip;mosaic;random_crop', 'mosaic')", + "x-nullable": true + }, + "beta1": { + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "beta2": { + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributer training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "earlyStoppingDelay": { + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "earlyStoppingPatience": { + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "evaluationFrequency": { + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "gradientAccumulationStep": { + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "string", + "example": "choice(1, 5)", + "x-nullable": true + }, + "layersToFreeze": { + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice(1, 2)", + "x-nullable": true + }, + "learningRate": { + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0.0005, 0.005)", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "type": "string", + "example": "choice('warmup_cosine', 'step')", + "x-nullable": true + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "example": "choice('seresnext', 'resnest50')", + "x-nullable": true + }, + "momentum": { + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "string", + "example": "quniform(0, 1)", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "numberOfEpochs": { + "description": "Number of training epochs. Must be a positive integer.", + "type": "string", + "example": "choice(15, 30)", + "x-nullable": true + }, + "numberOfWorkers": { + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "string", + "example": "uniform(8, 16)", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.", + "type": "string", + "example": "choice('sgd', 'adam', 'adamw')", + "x-nullable": true + }, + "randomSeed": { + "description": "Random seed to be used when using deterministic training.", + "type": "string", + "example": "loguniform(0, 1)", + "x-nullable": true + }, + "stepLRGamma": { + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "string", + "example": "choice(0.1, 0.2, 0.25)", + "x-nullable": true + }, + "stepLRStepSize": { + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "trainingBatchSize": { + "description": "Training batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "validationBatchSize": { + "description": "Validation batch size. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "string", + "example": "choice(1, 2, 3)", + "x-nullable": true + }, + "weightDecay": { + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "string", + "example": "uniform(0, 1)", + "x-nullable": true + } + }, + "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.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelDistributionSettings" + } + ], + "properties": { + "trainingCropSize": { + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationCropSize": { + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(224, 360)", + "x-nullable": true + }, + "validationResizeSize": { + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "string", + "example": "choice(128, 256)", + "x-nullable": true + }, + "weightedLoss": { + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "string", + "example": "choice(0, 1, 2)", + "x-nullable": true + } + }, + "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.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageModelDistributionSettings" + } + ], + "properties": { + "boxDetectionsPerImage": { + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(50, 100)", + "x-nullable": true + }, + "boxScoreThreshold": { + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "imageSize": { + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(224, 640)", + "x-nullable": true + }, + "maxSize": { + "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.", + "type": "string", + "example": "choice(640, 1333)", + "x-nullable": true + }, + "minSize": { + "description": "Minimum 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.", + "type": "string", + "example": "choice(300, 600)", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('small', 'medium', 'large', 'xlarge')", + "x-nullable": true + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice(true, false)", + "x-nullable": true + }, + "nmsIouThreshold": { + "description": "IOU threshold used during inference in NMS post processing. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "choice('3x2', '2x2')", + "x-nullable": true + }, + "tileOverlapRatio": { + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "uniform(0.1, 0.2)", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.\r\nNMS: Non-maximum suppression", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationIouThreshold": { + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "string", + "example": "uniform(0.2, 0.3)", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics. Must be 'none', 'coco', 'voc', or 'coco_voc'.", + "type": "string", + "example": "choice('none', 'coco', 'voc', 'coco_voc')", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettings": { + "description": "Settings used for training the model.\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": { + "advancedSettings": { + "description": "Settings for advanced scenarios.", + "type": "string", + "example": "key1:val1;key2;key3:val3;key4", + "x-nullable": true + }, + "amsGradient": { + "description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.", + "type": "boolean", + "x-nullable": true + }, + "augmentations": { + "description": "Settings for using Augmentations.", + "type": "string", + "example": "hflip;mosaic;random_crop", + "x-nullable": true + }, + "beta1": { + "format": "float", + "description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "beta2": { + "format": "float", + "description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "checkpointFrequency": { + "format": "int32", + "description": "Frequency to store model checkpoints. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "checkpointModel": { + "description": "The pretrained checkpoint model for incremental training.", + "$ref": "#/definitions/MLFlowModelJobInput", + "x-nullable": true + }, + "checkpointRunId": { + "description": "The id of a previous run that has a pretrained checkpoint for incremental training.", + "type": "string", + "x-nullable": true + }, + "distributed": { + "description": "Whether to use distributed training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStopping": { + "description": "Enable early stopping logic during training.", + "type": "boolean", + "x-nullable": true + }, + "earlyStoppingDelay": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\r\nis tracked for early stopping. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "earlyStoppingPatience": { + "format": "int32", + "description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\r\nthe run is stopped. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "enableOnnxNormalization": { + "description": "Enable normalization when exporting ONNX model.", + "type": "boolean", + "x-nullable": true + }, + "evaluationFrequency": { + "format": "int32", + "description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "gradientAccumulationStep": { + "format": "int32", + "description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\r\nupdating the model weights while accumulating the gradients of those steps, and then using\r\nthe accumulated gradients to compute the weight updates. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "layersToFreeze": { + "format": "int32", + "description": "Number of layers to freeze for the model. Must be a positive integer.\r\nFor instance, passing 2 as value for 'seresnext' means\r\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\r\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "integer", + "x-nullable": true + }, + "learningRate": { + "format": "float", + "description": "Initial learning rate. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.", + "default": "None", + "$ref": "#/definitions/LearningRateScheduler" + }, + "modelName": { + "description": "Name of the model to use for training.\r\nFor more information on the available models please visit the official documentation:\r\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.", + "type": "string", + "x-nullable": true + }, + "momentum": { + "format": "float", + "description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "nesterov": { + "description": "Enable nesterov when optimizer is 'sgd'.", + "type": "boolean", + "x-nullable": true + }, + "numberOfEpochs": { + "format": "int32", + "description": "Number of training epochs. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "numberOfWorkers": { + "format": "int32", + "description": "Number of data loader workers. Must be a non-negative integer.", + "type": "integer", + "x-nullable": true + }, + "optimizer": { + "description": "Type of optimizer.", + "default": "None", + "$ref": "#/definitions/StochasticOptimizer" + }, + "randomSeed": { + "format": "int32", + "description": "Random seed to be used when using deterministic training.", + "type": "integer", + "x-nullable": true + }, + "stepLRGamma": { + "format": "float", + "description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "stepLRStepSize": { + "format": "int32", + "description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "trainingBatchSize": { + "format": "int32", + "description": "Training batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationBatchSize": { + "format": "int32", + "description": "Validation batch size. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "warmupCosineLRCycles": { + "format": "float", + "description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "warmupCosineLRWarmupEpochs": { + "format": "int32", + "description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightDecay": { + "format": "float", + "description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettingsClassification": { + "description": "Settings used for training the model.\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": [ + { + "$ref": "#/definitions/ImageModelSettings" + } + ], + "properties": { + "trainingCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationCropSize": { + "format": "int32", + "description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "validationResizeSize": { + "format": "int32", + "description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.", + "type": "integer", + "x-nullable": true + }, + "weightedLoss": { + "format": "int32", + "description": "Weighted loss. The accepted values are 0 for no weighted loss.\r\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.", + "type": "integer", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ImageModelSettingsObjectDetection": { + "description": "Settings used for training the model.\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": [ + { + "$ref": "#/definitions/ImageModelSettings" + } + ], + "properties": { + "boxDetectionsPerImage": { + "format": "int32", + "description": "Maximum number of detections per image, for all classes. Must be a positive integer.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "integer", + "x-nullable": true + }, + "boxScoreThreshold": { + "format": "float", + "description": "During inference, only return proposals with a classification score greater than\r\nBoxScoreThreshold. Must be a float in the range[0, 1].", + "type": "number", + "x-nullable": true + }, + "imageSize": { + "format": "int32", + "description": "Image size for train and validation. Must be a positive integer.\r\nNote: The training run may get into CUDA OOM if the size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "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.", + "type": "integer", + "x-nullable": true + }, + "minSize": { + "format": "int32", + "description": "Minimum 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.", + "type": "integer", + "x-nullable": true + }, + "modelSize": { + "description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\r\nNote: training run may get into CUDA OOM if the model size is too big.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "default": "None", + "$ref": "#/definitions/ModelSize" + }, + "multiScale": { + "description": "Enable multi-scale image by varying image size by +/- 50%.\r\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\r\nNote: This settings is only supported for the 'yolov5' algorithm.", + "type": "boolean", + "x-nullable": true + }, + "nmsIouThreshold": { + "format": "float", + "description": "IOU threshold used during inference in NMS post processing. Must be a float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "tileGridSize": { + "description": "The grid size to use for tiling each image. Note: TileGridSize must not be\r\nNone to enable small object detection logic. A string containing two integers in mxn format.\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "string", + "example": "3x2", + "x-nullable": true + }, + "tileOverlapRatio": { + "format": "float", + "description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "tilePredictionsNmsThreshold": { + "format": "float", + "description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\r\nUsed in validation/ inference. Must be float in the range [0, 1].\r\nNote: This settings is not supported for the 'yolov5' algorithm.", + "type": "number", + "x-nullable": true + }, + "validationIouThreshold": { + "format": "float", + "description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].", + "type": "number", + "x-nullable": true + }, + "validationMetricType": { + "description": "Metric computation method to use for validation metrics.", + "default": "None", + "$ref": "#/definitions/ValidationMetricType" + } + }, + "additionalProperties": false + }, + "ImageObjectDetection": { + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\r\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageObjectDetectionBase" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric to optimize for this task.", + "default": "MeanAveragePrecision", + "$ref": "#/definitions/ObjectDetectionPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "ImageObjectDetection", + "additionalProperties": false + }, + "ImageObjectDetectionBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImageVertical" + } + ], + "properties": { + "modelSettings": { + "description": "Settings used for training the model.", + "$ref": "#/definitions/ImageModelSettingsObjectDetection", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageModelDistributionSettingsObjectDetection" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "ImageSweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "required": [ + "samplingAlgorithm" + ], + "type": "object", + "properties": { + "earlyTermination": { + "description": "Type of early termination policy.", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] Type of the hyperparameter sampling algorithms.", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "additionalProperties": false + }, + "ImageVertical": { + "description": "Abstract class for AutoML tasks that train image (computer vision) models -\r\nsuch as Image Classification / Image Classification Multilabel / Image Object Detection / Image Instance Segmentation.", + "required": [ + "limitSettings" + ], + "type": "object", + "properties": { + "limitSettings": { + "description": "[Required] Limit settings for the AutoML job.", + "$ref": "#/definitions/ImageLimitSettings" + }, + "sweepSettings": { + "description": "Model sweeping and hyperparameter sweeping related settings.", + "$ref": "#/definitions/ImageSweepSettings", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + } + }, + "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": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "IncrementalDataRefresh", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "IndexColumn": { + "description": "Dto object representing index column", + "type": "object", + "properties": { + "columnName": { + "description": "Specifies the column name", + "type": "string", + "x-nullable": true + }, + "dataType": { + "description": "Specifies the data type", + "default": "String", + "$ref": "#/definitions/FeatureDataType" + } + }, + "additionalProperties": false + }, + "InferenceContainerProperties": { + "type": "object", + "properties": { + "livenessRoute": { + "description": "The route to check the liveness of the inference server container.", + "$ref": "#/definitions/Route" + }, + "readinessRoute": { + "description": "The route to check the readiness of the inference server container.", + "$ref": "#/definitions/Route" + }, + "scoringRoute": { + "description": "The port to send the scoring requests to, within the inference server container.", + "$ref": "#/definitions/Route" + } + }, + "additionalProperties": false + }, + "InferencingServer": { + "required": [ + "serverType" + ], + "type": "object", + "properties": { + "serverType": { + "description": "[Required] Inferencing server type for various targets.", + "$ref": "#/definitions/InferencingServerType" + } + }, + "discriminator": "serverType" + }, + "InferencingServerType": { + "description": "Inferencing server type for various targets.", + "enum": [ + "AzureMLOnline", + "AzureMLBatch", + "Triton", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "InferencingServerType", + "modelAsString": true, + "values": [ + { + "value": "AzureMLOnline" + }, + { + "value": "AzureMLBatch" + }, + { + "value": "Triton" + }, + { + "value": "Custom" + } + ] + }, + "additionalProperties": false + }, + "InputDeliveryMode": { + "description": "Enum to determine the input data delivery mode.", + "enum": [ + "ReadOnlyMount", + "ReadWriteMount", + "Download", + "Direct", + "EvalMount", + "EvalDownload" + ], + "type": "string", + "x-ms-enum": { + "name": "InputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadOnlyMount" + }, + { + "value": "ReadWriteMount" + }, + { + "value": "Download" + }, + { + "value": "Direct" + }, + { + "value": "EvalMount" + }, + { + "value": "EvalDownload" + } + ] + }, + "additionalProperties": false + }, + "InputPathType": { + "description": "Input path type for package inputs.", + "enum": [ + "Url", + "PathId", + "PathVersion" + ], + "type": "string", + "x-ms-enum": { + "name": "InputPathType", + "modelAsString": true, + "values": [ + { + "value": "Url" + }, + { + "value": "PathId" + }, + { + "value": "PathVersion" + } + ] + }, + "additionalProperties": false + }, + "InstanceSegmentationPrimaryMetrics": { + "description": "Primary metrics for InstanceSegmentation tasks.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "InstanceSegmentationPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "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": [ + "jobType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "componentId": { + "description": "ARM resource ID of the component resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "computeId": { + "description": "ARM resource ID of the compute resource.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "displayName": { + "description": "Display name of job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "experimentName": { + "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.", + "default": "Default", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "identity": { + "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\r\nDefaults to AmlToken if null.", + "$ref": "#/definitions/IdentityConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "isArchived": { + "description": "Is the asset archived?", + "default": false, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "jobType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "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" + ], + "x-nullable": true + }, + "services": { + "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/JobService", + "x-nullable": true + }, + "x-nullable": true + }, + "status": { + "description": "Status of the job.", + "$ref": "#/definitions/JobStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "discriminator": "jobType", + "x-ms-client-name": "JobBaseProperties" + }, + "JobBaseResource": { + "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/JobBase" + } + }, + "x-ms-client-name": "JobBase", + "additionalProperties": false + }, + "JobBaseResourceArmPaginatedResult": { + "description": "A paginated list of JobBase entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type JobBase.", + "type": "array", + "items": { + "$ref": "#/definitions/JobBaseResource" + } + } + }, + "additionalProperties": false + }, + "JobInput": { + "description": "Command job definition.", + "required": [ + "jobInputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the input.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobInputType" + }, + "JobInputType": { + "description": "Enum to determine the Job Input Type.", + "enum": [ + "literal", + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobInputType", + "modelAsString": true, + "values": [ + { + "value": "literal" + }, + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobLimits": { + "required": [ + "jobLimitsType" + ], + "type": "object", + "properties": { + "jobLimitsType": { + "description": "[Required] JobLimit type.", + "$ref": "#/definitions/JobLimitsType" + }, + "timeout": { + "format": "duration", + "description": "The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.", + "type": "string", + "x-nullable": true + } + }, + "discriminator": "jobLimitsType" + }, + "JobLimitsType": { + "enum": [ + "Command", + "Sweep" + ], + "type": "string", + "x-ms-enum": { + "name": "JobLimitsType", + "modelAsString": true, + "values": [ + { + "value": "Command" + }, + { + "value": "Sweep" + } + ] + }, + "additionalProperties": false + }, + "JobOutput": { + "description": "Job output definition container information on where to find job output/logs.", + "required": [ + "jobOutputType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the output.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobOutputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobOutputType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "jobOutputType" + }, + "JobOutputType": { + "description": "Enum to determine the Job Output Type.", + "enum": [ + "uri_file", + "uri_folder", + "mltable", + "custom_model", + "mlflow_model", + "triton_model" + ], + "type": "string", + "x-ms-enum": { + "name": "JobOutputType", + "modelAsString": true, + "values": [ + { + "value": "uri_file" + }, + { + "value": "uri_folder" + }, + { + "value": "mltable" + }, + { + "value": "custom_model" + }, + { + "value": "mlflow_model" + }, + { + "value": "triton_model" + } + ] + }, + "additionalProperties": false + }, + "JobProvisioningState": { + "description": "Enum to determine the job provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + }, + { + "value": "InProgress" + } + ] + }, + "additionalProperties": false + }, + "JobResourceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceConfiguration" + } + ], + "properties": { + "dockerArgs": { + "description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "shmSize": { + "description": "Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).", + "default": "2g", + "pattern": "\\d+[bBkKmMgG]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "JobScheduleAction": { + "required": [ + "actionType", + "jobDefinition" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleActionBase" + } + ], + "properties": { + "jobDefinition": { + "description": "[Required] Defines Schedule action definition details.", + "$ref": "#/definitions/JobBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "CreateJob", + "additionalProperties": false + }, + "JobService": { + "description": "Job endpoint definition", + "type": "object", + "properties": { + "endpoint": { + "description": "Url for endpoint.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "errorMessage": { + "description": "Any error in the service.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "jobServiceType": { + "description": "Endpoint type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "nodes": { + "description": "Nodes that user would like to start the service on.\r\nIf Nodes is not set or set to null, the service will only be started on leader node.", + "$ref": "#/definitions/Nodes", + "x-nullable": true + }, + "port": { + "format": "int32", + "description": "Port for endpoint set by user.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "properties": { + "description": "Additional properties to set on the endpoint.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "status": { + "description": "Status of endpoint.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "JobStatus": { + "description": "The status of a job.", + "enum": [ + "NotStarted", + "Starting", + "Provisioning", + "Preparing", + "Queued", + "Running", + "Finalizing", + "CancelRequested", + "Completed", + "Failed", + "Canceled", + "NotResponding", + "Paused", + "Unknown", + "Scheduled" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Run hasn't started yet." + }, + { + "value": "Starting", + "description": "Run has started. The user has a run ID." + }, + { + "value": "Provisioning", + "description": "(Not used currently) It will be used if ES is creating the compute target." + }, + { + "value": "Preparing", + "description": "The run environment is being prepared." + }, + { + "value": "Queued", + "description": "The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready." + }, + { + "value": "Running", + "description": "The job started to run in the compute target." + }, + { + "value": "Finalizing", + "description": "Job is completed in the target. It is in output collection state now." + }, + { + "value": "CancelRequested", + "description": "Cancellation has been requested for the job." + }, + { + "value": "Completed", + "description": "Job completed successfully. This reflects that both the job itself and output collection states completed successfully" + }, + { + "value": "Failed", + "description": "Job failed." + }, + { + "value": "Canceled", + "description": "Following cancellation request, the job is now successfully canceled." + }, + { + "value": "NotResponding", + "description": "When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state.\nNotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states." + }, + { + "value": "Paused", + "description": "The job is paused by users. Some adjustment to labeling jobs can be made only in paused state." + }, + { + "value": "Unknown", + "description": "Default job status if not mapped to all other statuses" + }, + { + "value": "Scheduled", + "description": "The job is in a scheduled state. Job is not in any active state." + } + ] + }, + "additionalProperties": false + }, + "JobTier": { + "description": "Enum to determine the job tier.", + "enum": [ + "Null", + "Spot", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "JobTier", + "modelAsString": true, + "values": [ + { + "value": "Null" + }, + { + "value": "Spot" + }, + { + "value": "Basic" + }, + { + "value": "Standard" + }, + { + "value": "Premium" + } + ] + }, + "additionalProperties": false + }, + "JobType": { + "description": "Enum to determine the type of job.", + "enum": [ + "AutoML", + "Command", + "Labeling", + "Sweep", + "Pipeline", + "Spark" + ], + "type": "string", + "x-ms-enum": { + "name": "JobType", + "modelAsString": true, + "values": [ + { + "value": "AutoML" + }, + { + "value": "Command" + }, + { + "value": "Labeling" + }, + { + "value": "Sweep" + }, + { + "value": "Pipeline" + }, + { + "value": "Spark" + } + ] + }, + "additionalProperties": false + }, + "KerberosCredentials": { + "required": [ + "kerberosKdcAddress", + "kerberosPrincipal", + "kerberosRealm" + ], + "type": "object", + "properties": { + "kerberosKdcAddress": { + "description": "[Required] IP Address or DNS HostName.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "kerberosPrincipal": { + "description": "[Required] Kerberos Username", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "kerberosRealm": { + "description": "[Required] Domain over which a Kerberos authentication server has the authority to authenticate a user, host or service.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "KerberosKeytabCredentials": { + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/KerberosCredentials" + }, + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Keytab secrets.", + "$ref": "#/definitions/KerberosKeytabSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "KerberosKeytab", + "additionalProperties": false + }, + "KerberosKeytabSecrets": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "kerberosKeytab": { + "description": "Kerberos keytab secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "KerberosKeytab", + "additionalProperties": false + }, + "KerberosPasswordCredentials": { + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/KerberosCredentials" + }, + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Kerberos password secrets.", + "$ref": "#/definitions/KerberosPasswordSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "KerberosPassword", + "additionalProperties": false + }, + "KerberosPasswordSecrets": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "kerberosPassword": { + "description": "Kerberos password secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "KerberosPassword", + "additionalProperties": false + }, + "KeyType": { + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true, + "values": [ + { + "value": "Primary" + }, + { + "value": "Secondary" + } + ] + }, + "additionalProperties": false + }, + "KubernetesOnlineDeployment": { + "description": "Properties specific to a KubernetesOnlineDeployment.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineDeployment" + } + ], + "properties": { + "containerResourceRequirements": { + "description": "The resource requirements for the container (cpu and memory).", + "$ref": "#/definitions/ContainerResourceRequirements", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Kubernetes", + "additionalProperties": false + }, + "LabelCategory": { + "description": "Label category definition", + "type": "object", + "properties": { + "classes": { + "description": "Dictionary of label classes in this category.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelClass", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "displayName": { + "description": "Display name of the label category.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "multiSelect": { + "description": "Indicates whether it is allowed to select multiple classes in this category.", + "default": "Disabled", + "$ref": "#/definitions/MultiSelect", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "LabelClass": { + "description": "Label class definition", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the label class.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "subclasses": { + "description": "Dictionary of subclasses of the label class.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelClass", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "LabelingDataConfiguration": { + "description": "Labeling data configuration definition", + "type": "object", + "properties": { + "dataId": { + "description": "Resource Id of the data asset to perform labeling.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "incrementalDataRefresh": { + "description": "Indicates whether to enable incremental data refresh.", + "default": "Disabled", + "$ref": "#/definitions/IncrementalDataRefresh", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "additionalProperties": false + }, + "LabelingJob": { + "description": "Labeling job definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "createdDateTime": { + "format": "date-time", + "description": "Created time of the job in UTC timezone.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "dataConfiguration": { + "description": "Configuration of data used in the job.", + "$ref": "#/definitions/LabelingDataConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobInstructions": { + "description": "Labeling instructions of the job.", + "$ref": "#/definitions/LabelingJobInstructions", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "labelCategories": { + "description": "Label categories of the job.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LabelCategory", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + }, + "labelingJobMediaProperties": { + "description": "Media type specific properties in the job.", + "$ref": "#/definitions/LabelingJobMediaProperties", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "mlAssistConfiguration": { + "description": "Configuration of MLAssist feature in the job.", + "default": "{\"MLAssist\":\"Disabled\"}", + "$ref": "#/definitions/MLAssistConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "progressMetrics": { + "description": "Progress metrics of the job.", + "$ref": "#/definitions/ProgressMetrics", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "projectId": { + "format": "uuid", + "description": "Internal id of the job(Previously called project).", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "provisioningState": { + "description": "Specifies the labeling job provisioning state.", + "$ref": "#/definitions/JobProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "statusMessages": { + "description": "Status messages of the job.", + "type": "array", + "items": { + "$ref": "#/definitions/StatusMessage" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "Labeling", + "x-ms-client-name": "LabelingJobProperties", + "additionalProperties": false + }, + "LabelingJobImageProperties": { + "description": "Properties of a labeling job for image data", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LabelingJobMediaProperties" + } + ], + "properties": { + "annotationType": { + "description": "Annotation type of image labeling job.", + "default": "Classification", + "$ref": "#/definitions/ImageAnnotationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Image", + "additionalProperties": false + }, + "LabelingJobInstructions": { + "description": "Instructions for labeling job", + "type": "object", + "properties": { + "uri": { + "description": "The link to a page with detailed labeling instructions for labelers.", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "LabelingJobMediaProperties": { + "description": "Properties of a labeling job", + "required": [ + "mediaType" + ], + "type": "object", + "properties": { + "mediaType": { + "description": "[Required] Media type of the job.", + "$ref": "#/definitions/MediaType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mediaType" + }, + "LabelingJobResource": { + "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/LabelingJob" + } + }, + "x-ms-client-name": "LabelingJob", + "additionalProperties": false + }, + "LabelingJobResourceArmPaginatedResult": { + "description": "A paginated list of LabelingJob entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of LabelingJob objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type LabelingJob.", + "type": "array", + "items": { + "$ref": "#/definitions/LabelingJobResource" + } + } + }, + "additionalProperties": false + }, + "LabelingJobTextProperties": { + "description": "Properties of a labeling job for text data", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LabelingJobMediaProperties" + } + ], + "properties": { + "annotationType": { + "description": "Annotation type of text labeling job.", + "default": "Classification", + "$ref": "#/definitions/TextAnnotationType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Text", + "additionalProperties": false + }, + "LakeHouseArtifact": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OneLakeArtifact" + } + ], + "x-ms-discriminator-value": "LakeHouse", + "additionalProperties": false + }, + "LearningRateScheduler": { + "description": "Learning rate scheduler enum.", + "enum": [ + "None", + "WarmupCosine", + "Step" + ], + "type": "string", + "x-ms-enum": { + "name": "LearningRateScheduler", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No learning rate scheduler selected." + }, + { + "value": "WarmupCosine", + "description": "Cosine Annealing With Warmup." + }, + { + "value": "Step", + "description": "Step learning rate scheduler." + } + ] + }, + "additionalProperties": false + }, + "ListViewType": { + "enum": [ + "ActiveOnly", + "ArchivedOnly", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "ListViewType", + "modelAsString": true, + "values": [ + { + "value": "ActiveOnly" + }, + { + "value": "ArchivedOnly" + }, + { + "value": "All" + } + ] + }, + "additionalProperties": false + }, + "LiteralJobInput": { + "description": "Literal input type.", + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "value": { + "description": "[Required] Literal value for the input.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "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": [ + "NotSet", + "Debug", + "Info", + "Warning", + "Error", + "Critical" + ], + "type": "string", + "x-ms-enum": { + "name": "LogVerbosity", + "modelAsString": true, + "values": [ + { + "value": "NotSet", + "description": "No logs emitted." + }, + { + "value": "Debug", + "description": "Debug and above log statements logged." + }, + { + "value": "Info", + "description": "Info and above log statements logged." + }, + { + "value": "Warning", + "description": "Warning and above log statements logged." + }, + { + "value": "Error", + "description": "Error and above log statements logged." + }, + { + "value": "Critical", + "description": "Only critical statements logged." + } + ] + }, + "additionalProperties": false + }, + "MLAssistConfiguration": { + "description": "Labeling MLAssist configuration definition", + "required": [ + "mlAssist" + ], + "type": "object", + "properties": { + "mlAssist": { + "description": "[Required] Indicates whether MLAssist feature is enabled.", + "$ref": "#/definitions/MLAssistConfigurationType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "mlAssist" + }, + "MLAssistConfigurationDisabled": { + "description": "Labeling MLAssist configuration definition when MLAssist is disabled", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MLAssistConfiguration" + } + ], + "x-ms-discriminator-value": "Disabled", + "additionalProperties": false + }, + "MLAssistConfigurationEnabled": { + "description": "Labeling MLAssist configuration definition when MLAssist is enabled", + "required": [ + "inferencingComputeBinding", + "trainingComputeBinding" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MLAssistConfiguration" + } + ], + "properties": { + "inferencingComputeBinding": { + "description": "[Required] AML compute binding used in inferencing.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "trainingComputeBinding": { + "description": "[Required] AML compute binding used in training.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-discriminator-value": "Enabled", + "additionalProperties": false + }, + "MLAssistConfigurationType": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MLAssistConfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "MLFlowAutologgerState": { + "description": "Enum to determine the state of mlflow autologger.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MLFlowAutologgerState", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "MLFlowModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "mlflow_model", + "additionalProperties": false + }, + "MLFlowModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mlflow_model", + "additionalProperties": false + }, + "MLTableData": { + "description": "MLTable data definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "properties": { + "referencedUris": { + "description": "Uris referenced in the MLTable definition (required for lineage)", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "MLTableJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "MLTableJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "mltable", + "additionalProperties": false + }, + "ManagedComputeIdentity": { + "description": "Managed compute identity definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeIdentityBase" + } + ], + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ManagedIdentity", + "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 + }, + "MaterializationComputeResource": { + "description": "Dto object representing compute resource", + "type": "object", + "properties": { + "instanceType": { + "description": "Specifies the instance type", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "MaterializationSettings": { + "type": "object", + "properties": { + "notification": { + "description": "Specifies the notification details", + "$ref": "#/definitions/NotificationSetting", + "x-nullable": true + }, + "resource": { + "description": "Specifies the compute resource settings", + "$ref": "#/definitions/MaterializationComputeResource", + "x-nullable": true + }, + "schedule": { + "description": "Specifies the schedule details", + "$ref": "#/definitions/RecurrenceTrigger", + "x-nullable": true + }, + "sparkConfiguration": { + "description": "Specifies the spark compute settings", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "storeType": { + "description": "Specifies the stores to which materialization should happen", + "default": "None", + "$ref": "#/definitions/MaterializationStoreType" + } + }, + "additionalProperties": false + }, + "MaterializationStoreType": { + "enum": [ + "None", + "Online", + "Offline", + "OnlineAndOffline" + ], + "type": "string", + "x-ms-enum": { + "name": "MaterializationStoreType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "Online" + }, + { + "value": "Offline" + }, + { + "value": "OnlineAndOffline" + } + ] + }, + "additionalProperties": false + }, + "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" + } + ], + "properties": { + "properties": { + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/ModelContainer" + } + }, + "x-ms-client-name": "ModelContainer", + "additionalProperties": false + }, + "ModelContainerResourceArmPaginatedResult": { + "description": "A paginated list of ModelContainer entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type ModelContainer.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelContainerResource" + } + } + }, + "additionalProperties": false + }, + "ModelPackageInput": { + "description": "Model package input options.", + "required": [ + "inputType", + "path" + ], + "type": "object", + "properties": { + "inputType": { + "description": "[Required] Type of the input included in the target image.", + "$ref": "#/definitions/PackageInputType" + }, + "mode": { + "description": "Input delivery mode of the input.", + "default": "Copy", + "$ref": "#/definitions/PackageInputDeliveryMode" + }, + "mountPath": { + "description": "Relative mount path of the input in the target image.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "[Required] Location of the input.", + "$ref": "#/definitions/PackageInputPathBase" + } + }, + "additionalProperties": false + }, + "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" + }, + "ModelPerformanceSignal": { + "description": "Model performance signal definition.", + "required": [ + "metricThreshold", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "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" + ] + }, + "productionData": { + "description": "[Required] The data produced by the production service which drift will be calculated for.", + "type": "array", + "items": { + "description": "Monitoring input data base definition.", + "$ref": "#/definitions/MonitoringInputDataBase" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-ms-identifiers": [] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "ModelPerformance", + "additionalProperties": false + }, + "ModelSize": { + "description": "Image model size.", + "enum": [ + "None", + "Small", + "Medium", + "Large", + "ExtraLarge" + ], + "type": "string", + "x-ms-enum": { + "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 + }, + "ModelTaskType": { + "description": "Model task type enum.", + "enum": [ + "Classification", + "Regression", + "QuestionAnswering" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelTaskType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "Regression" + }, + { + "value": "QuestionAnswering" + } + ] + }, + "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 + }, + "MonitorComputeConfigurationBase": { + "description": "Monitor compute configuration base definition.", + "required": [ + "computeType" + ], + "type": "object", + "properties": { + "computeType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitorComputeType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "computeType" + }, + "MonitorComputeIdentityBase": { + "description": "Monitor compute identity base definition.", + "required": [ + "computeIdentityType" + ], + "type": "object", + "properties": { + "computeIdentityType": { + "description": "[Required] Monitor compute identity type enum.", + "$ref": "#/definitions/MonitorComputeIdentityType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "computeIdentityType" + }, + "MonitorComputeIdentityType": { + "description": "Monitor compute identity type enum.", + "enum": [ + "AmlToken", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitorComputeIdentityType", + "modelAsString": true, + "values": [ + { + "value": "AmlToken", + "description": "Authenticates through user's AML token." + }, + { + "value": "ManagedIdentity", + "description": "Authenticates through a user-provided managed identity." + } + ] + }, + "additionalProperties": false + }, + "MonitorComputeType": { + "description": "Monitor compute type enum.", + "enum": [ + "ServerlessSpark" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitorComputeType", + "modelAsString": true, + "values": [ + { + "value": "ServerlessSpark", + "description": "Serverless Spark compute." + } + ] + }, + "additionalProperties": false + }, + "MonitorDefinition": { + "required": [ + "computeConfiguration", + "signals" + ], + "type": "object", + "properties": { + "alertNotificationSetting": { + "description": "The monitor's notification settings.", + "$ref": "#/definitions/MonitoringAlertNotificationSettingsBase", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "computeConfiguration": { + "description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.", + "$ref": "#/definitions/MonitorComputeConfigurationBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "monitoringTarget": { + "description": "The ARM resource ID of either the model or deployment targeted by this monitor.", + "$ref": "#/definitions/MonitoringTarget", + "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 + }, + "MonitorServerlessSparkCompute": { + "description": "Monitor serverless spark compute definition.", + "required": [ + "computeIdentity", + "instanceType", + "runtimeVersion" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitorComputeConfigurationBase" + } + ], + "properties": { + "computeIdentity": { + "description": "[Required] The identity scheme leveraged to by the spark jobs running on serverless Spark.", + "$ref": "#/definitions/MonitorComputeIdentityBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "instanceType": { + "description": "[Required] The instance type running the Spark job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "runtimeVersion": { + "description": "[Required] The Spark runtime version.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "ServerlessSpark", + "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 + }, + "MonitoringInputDataBase": { + "description": "Monitoring input data base definition.", + "required": [ + "inputDataType", + "jobInputType", + "uri" + ], + "type": "object", + "properties": { + "columns": { + "description": "Mapping of column names to special uses.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "dataContext": { + "description": "The context metadata of the data source.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputDataType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringInputDataType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "jobInputType": { + "description": "[Required] Specifies the type of job.", + "$ref": "#/definitions/JobInputType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "uri": { + "description": "[Required] Input Asset URI.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "inputDataType" + }, + "MonitoringInputDataType": { + "description": "Monitoring input data type enum.", + "enum": [ + "Static", + "Trailing", + "Fixed" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringInputDataType", + "modelAsString": true, + "values": [ + { + "value": "Static", + "description": "An input data with a fixed window size." + }, + { + "value": "Trailing", + "description": "An input data which trailing relatively to the monitor's current run." + }, + { + "value": "Fixed", + "description": "An input data with tabular format which doesn't require preprocessing." + } + ] + }, + "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": "Disabled", + "description": "Disabled notifications will not produce emails/metrics leveraged for alerting." + }, + { + "value": "Enabled", + "description": "Enabled notification will produce emails/metrics leveraged for alerting." + } + ] + }, + "additionalProperties": false + }, + "MonitoringSignalBase": { + "required": [ + "signalType" + ], + "type": "object", + "properties": { + "mode": { + "description": "The current notification mode for this signal.", + "default": "Disabled", + "$ref": "#/definitions/MonitoringNotificationMode", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "description": "Property dictionary. Properties can be added, but not removed or altered.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "signalType": { + "description": "[Required] Specifies the type of signal to monitor.", + "$ref": "#/definitions/MonitoringSignalType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "signalType" + }, + "MonitoringSignalType": { + "enum": [ + "DataDrift", + "PredictionDrift", + "DataQuality", + "FeatureAttributionDrift", + "Custom", + "ModelPerformance", + "GenerationSafetyQuality", + "GenerationTokenStatistics" + ], + "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." + }, + { + "value": "GenerationSafetyQuality", + "description": "Tracks the safety and quality of generated content." + }, + { + "value": "GenerationTokenStatistics", + "description": "Tracks the token usage of generative endpoints." + } + ] + }, + "additionalProperties": false + }, + "MonitoringTarget": { + "description": "Monitoring target definition.", + "required": [ + "taskType" + ], + "type": "object", + "properties": { + "deploymentId": { + "description": "The ARM resource ID of either the deployment targeted by this monitor.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "modelId": { + "description": "The ARM resource ID of either the model targeted by this monitor.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "taskType": { + "description": "[Required] The machine learning task type of the model.", + "$ref": "#/definitions/ModelTaskType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "MonitoringThreshold": { + "type": "object", + "properties": { + "value": { + "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 + }, + "MonitoringWorkspaceConnection": { + "description": "Monitoring workspace connection definition.", + "type": "object", + "properties": { + "environmentVariables": { + "description": "The properties of a workspace service connection to store as environment variables in the submitted jobs.\r\nKey is workspace connection property path, name is environment variable key.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "secrets": { + "description": "The properties of a workspace service connection to store as secrets in the submitted jobs.\r\nKey is workspace connection property path, name is secret key.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Mpi": { + "description": "MPI distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per MPI node.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Mpi", + "additionalProperties": false + }, + "MultiSelect": { + "description": "Whether multiSelect is enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiSelect", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "NCrossValidations": { + "description": "N-Cross validations value.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Mode for determining N-Cross validations.", + "$ref": "#/definitions/NCrossValidationsMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "NCrossValidationsMode": { + "description": "Determines how N-Cross validations value is determined.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "NCrossValidationsMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Determine N-Cross validations value automatically. Supported only for 'Forecasting' AutoML task." + }, + { + "value": "Custom", + "description": "Use custom N-Cross validations value." + } + ] + }, + "additionalProperties": false + }, + "NlpFixedParameters": { + "description": "Fixed training parameters that won't be swept over during AutoML NLP training.", + "type": "object", + "properties": { + "gradientAccumulationSteps": { + "format": "int32", + "description": "Number of steps to accumulate gradients over before running a backward pass.", + "type": "integer", + "x-nullable": true + }, + "learningRate": { + "format": "float", + "description": "The learning rate for the training procedure.", + "type": "number", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "The type of learning rate schedule to use during the training procedure.", + "default": "None", + "$ref": "#/definitions/NlpLearningRateScheduler" + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "x-nullable": true + }, + "numberOfEpochs": { + "format": "int32", + "description": "Number of training epochs.", + "type": "integer", + "x-nullable": true + }, + "trainingBatchSize": { + "format": "int32", + "description": "The batch size for the training procedure.", + "type": "integer", + "x-nullable": true + }, + "validationBatchSize": { + "format": "int32", + "description": "The batch size to be used during evaluation.", + "type": "integer", + "x-nullable": true + }, + "warmupRatio": { + "format": "float", + "description": "The warmup ratio, used alongside LrSchedulerType.", + "type": "number", + "x-nullable": true + }, + "weightDecay": { + "format": "float", + "description": "The weight decay for the training procedure.", + "type": "number", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NlpLearningRateScheduler": { + "description": "Enum of learning rate schedulers that aligns with those supported by HF", + "enum": [ + "None", + "Linear", + "Cosine", + "CosineWithRestarts", + "Polynomial", + "Constant", + "ConstantWithWarmup" + ], + "type": "string", + "x-ms-enum": { + "name": "NlpLearningRateScheduler", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No learning rate schedule." + }, + { + "value": "Linear", + "description": "Linear warmup and decay." + }, + { + "value": "Cosine", + "description": "Linear warmup then cosine decay." + }, + { + "value": "CosineWithRestarts", + "description": "Linear warmup, cosine decay, then restart to initial LR." + }, + { + "value": "Polynomial", + "description": "Increase linearly then polynomially decay." + }, + { + "value": "Constant", + "description": "Constant learning rate." + }, + { + "value": "ConstantWithWarmup", + "description": "Linear warmup followed by constant value." + } + ] + }, + "additionalProperties": false + }, + "NlpParameterSubspace": { + "description": "Stringified search spaces for each parameter. See below examples.", + "type": "object", + "properties": { + "gradientAccumulationSteps": { + "description": "Number of steps to accumulate gradients over before running a backward pass.", + "type": "string", + "example": "choice(1, 2)", + "x-nullable": true + }, + "learningRate": { + "description": "The learning rate for the training procedure.", + "type": "string", + "example": "uniform(5e-6, 5e-5)", + "x-nullable": true + }, + "learningRateScheduler": { + "description": "The type of learning rate schedule to use during the training procedure.", + "type": "string", + "example": "choice('linear', 'cosine')", + "x-nullable": true + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "example": "choice('bert-base-cased', 'roberta-base')", + "x-nullable": true + }, + "numberOfEpochs": { + "description": "Number of training epochs.", + "type": "string", + "example": "choice(3, 4)", + "x-nullable": true + }, + "trainingBatchSize": { + "description": "The batch size for the training procedure.", + "type": "string", + "example": "choice(16, 32)", + "x-nullable": true + }, + "validationBatchSize": { + "description": "The batch size to be used during evaluation.", + "type": "string", + "example": "choice(16, 32)", + "x-nullable": true + }, + "warmupRatio": { + "description": "The warmup ratio, used alongside LrSchedulerType.", + "type": "string", + "example": "uniform(0.01, 0.1)", + "x-nullable": true + }, + "weightDecay": { + "description": "The weight decay for the training procedure.", + "type": "string", + "example": "uniform(0.01, 0.1)", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NlpSweepSettings": { + "description": "Model sweeping and hyperparameter tuning related settings.", + "required": [ + "samplingAlgorithm" + ], + "type": "object", + "properties": { + "earlyTermination": { + "description": "Type of early termination policy for the sweeping job.", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] Type of sampling algorithm.", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "additionalProperties": false + }, + "NlpVertical": { + "description": "Abstract class for NLP related AutoML tasks.\r\nNLP - Natural Language Processing.", + "type": "object", + "properties": { + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/NlpVerticalFeaturizationSettings", + "x-nullable": true + }, + "fixedParameters": { + "description": "Model/training parameters that will remain constant throughout training.", + "$ref": "#/definitions/NlpFixedParameters", + "x-nullable": true + }, + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/NlpVerticalLimitSettings", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/NlpParameterSubspace" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "sweepSettings": { + "description": "Settings for model sweeping and hyperparameter tuning.", + "$ref": "#/definitions/NlpSweepSettings", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "NlpVerticalFeaturizationSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "additionalProperties": false + }, + "NlpVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent AutoML iterations.", + "default": 1, + "type": "integer" + }, + "maxNodes": { + "format": "int32", + "description": "Maximum nodes to use for the experiment.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of AutoML iterations.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "P7D", + "type": "string" + }, + "trialTimeout": { + "format": "duration", + "description": "Timeout for individual HD trials.", + "type": "string" + } + }, + "additionalProperties": false + }, + "Nodes": { + "description": "Abstract Nodes definition", + "required": [ + "nodesValueType" + ], + "type": "object", + "properties": { + "nodesValueType": { + "description": "[Required] Type of the Nodes value", + "$ref": "#/definitions/NodesValueType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "nodesValueType" + }, + "NodesValueType": { + "description": "The enumerated types for the nodes value", + "enum": [ + "All", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "NodesValueType", + "modelAsString": true, + "values": [ + { + "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": "TwoSampleKolmogorovSmirnovTest", + "description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric." + } + ] + }, + "additionalProperties": false + }, + "NumericalPredictionDriftMetricThreshold": { + "required": [ + "metric" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PredictionDriftMetricThresholdBase" + } + ], + "properties": { + "metric": { + "description": "[Required] The numerical prediction drift metric to calculate.", + "$ref": "#/definitions/NumericalPredictionDriftMetric", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Numerical", + "additionalProperties": false + }, + "ObjectDetectionPrimaryMetrics": { + "description": "Primary metrics for Image ObjectDetection task.", + "enum": [ + "MeanAveragePrecision" + ], + "type": "string", + "x-ms-enum": { + "name": "ObjectDetectionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "MeanAveragePrecision", + "description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP." + } + ] + }, + "additionalProperties": false + }, + "Objective": { + "description": "Optimization objective.", + "required": [ + "goal", + "primaryMetric" + ], + "type": "object", + "properties": { + "goal": { + "description": "[Required] Defines supported metric goals for hyperparameter tuning", + "$ref": "#/definitions/Goal" + }, + "primaryMetric": { + "description": "[Required] Name of the metric to optimize.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + }, + "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" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointDeploymentPropertiesBase" + } + ], + "properties": { + "appInsightsEnabled": { + "description": "If true, enables Application Insights logging.", + "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", + "$ref": "#/definitions/EgressPublicNetworkAccessType" + }, + "endpointComputeType": { + "description": "[Required] The compute type of the endpoint.", + "$ref": "#/definitions/EndpointComputeType" + }, + "instanceType": { + "description": "Compute instance type.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "livenessProbe": { + "description": "Liveness probe monitors the health of the container regularly.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "model": { + "description": "The URI path to the model.", + "type": "string", + "x-nullable": true + }, + "modelMountPath": { + "description": "The path to mount the model in custom container.", + "type": "string", + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint deployment.", + "$ref": "#/definitions/DeploymentProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "readinessProbe": { + "description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.", + "$ref": "#/definitions/ProbeSettings", + "x-nullable": true + }, + "requestSettings": { + "description": "Request settings for the deployment.", + "$ref": "#/definitions/OnlineRequestSettings", + "x-nullable": true + }, + "scaleSettings": { + "description": "Scale settings for the deployment.\r\nIf it is null or not provided,\r\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\r\nand to DefaultScaleSettings for ManagedOnlineDeployment.", + "$ref": "#/definitions/OnlineScaleSettings", + "x-nullable": true + } + }, + "discriminator": "endpointComputeType", + "x-ms-client-name": "OnlineDeploymentProperties" + }, + "OnlineDeploymentTrackedResource": { + "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/OnlineDeployment" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "OnlineDeployment", + "additionalProperties": false + }, + "OnlineDeploymentTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineDeployment entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type OnlineDeployment.", + "type": "array", + "items": { + "$ref": "#/definitions/OnlineDeploymentTrackedResource" + } + } + }, + "additionalProperties": false + }, + "OnlineEndpoint": { + "description": "Online endpoint configuration", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesBase" + } + ], + "properties": { + "compute": { + "description": "ARM resource ID of the compute if it exists.\r\noptional", + "type": "string", + "x-nullable": true + }, + "mirrorTraffic": { + "description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "provisioningState": { + "description": "Provisioning state for the endpoint.", + "$ref": "#/definitions/EndpointProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicNetworkAccess": { + "description": "Set to \"Enabled\" for endpoints that should allow public access when Private Link is enabled.", + "default": "Enabled", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "traffic": { + "description": "Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + } + }, + "x-ms-client-name": "OnlineEndpointProperties", + "additionalProperties": false + }, + "OnlineEndpointTrackedResource": { + "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/OnlineEndpoint" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "OnlineEndpoint", + "additionalProperties": false + }, + "OnlineEndpointTrackedResourceArmPaginatedResult": { + "description": "A paginated list of OnlineEndpoint entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type OnlineEndpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/OnlineEndpointTrackedResource" + } + } + }, + "additionalProperties": false + }, + "OnlineInferenceConfiguration": { + "description": "Online inference configuration options.", + "type": "object", + "properties": { + "configurations": { + "description": "Additional configurations", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "entryScript": { + "description": "Entry script or command to invoke.", + "type": "string", + "x-nullable": true + }, + "livenessRoute": { + "description": "The route to check the liveness of the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + }, + "readinessRoute": { + "description": "The route to check the readiness of the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + }, + "scoringRoute": { + "description": "The port to send the scoring requests to, within the inference server container.", + "$ref": "#/definitions/Route", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "OnlineRequestSettings": { + "description": "Online deployment scoring requests configuration.", + "type": "object", + "properties": { + "maxConcurrentRequestsPerInstance": { + "format": "int32", + "description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.", + "default": 1, + "type": "integer" + }, + "maxQueueWait": { + "format": "duration", + "description": "The maximum amount of time a request will stay in the queue in ISO 8601 format.\r\nDefaults to 500ms.", + "default": "PT0.5S", + "type": "string" + }, + "requestTimeout": { + "format": "duration", + "description": "The scoring timeout in ISO 8601 format.\r\nDefaults to 5000ms.", + "default": "PT5S", + "type": "string" + } + }, + "additionalProperties": false + }, + "OnlineScaleSettings": { + "description": "Online deployment scaling configuration.", + "required": [ + "scaleType" + ], + "type": "object", + "properties": { + "scaleType": { + "description": "[Required] Type of deployment scaling algorithm", + "$ref": "#/definitions/ScaleType" + } + }, + "discriminator": "scaleType" + }, + "OperatingSystemType": { + "description": "The type of operating system.", + "enum": [ + "Linux", + "Windows" + ], + "type": "string", + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true, + "values": [ + { + "value": "Linux" + }, + { + "value": "Windows" + } + ] + }, + "additionalProperties": false + }, + "OrderString": { + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true, + "values": [ + { + "value": "CreatedAtDesc" + }, + { + "value": "CreatedAtAsc" + }, + { + "value": "UpdatedAtDesc" + }, + { + "value": "UpdatedAtAsc" + } + ] + }, + "additionalProperties": false + }, + "OutputDeliveryMode": { + "description": "Output data delivery mode enums.", + "enum": [ + "ReadWriteMount", + "Upload", + "Direct" + ], + "type": "string", + "x-ms-enum": { + "name": "OutputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "ReadWriteMount" + }, + { + "value": "Upload" + }, + { + "value": "Direct" + } + ] + }, + "additionalProperties": false + }, + "OutputPathAssetReference": { + "description": "Reference to an asset via its path in a job output.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetReferenceBase" + } + ], + "properties": { + "jobId": { + "description": "ARM resource ID of the job.", + "type": "string", + "x-nullable": true + }, + "path": { + "description": "The path of the file/directory in the job output.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "OutputPath", + "additionalProperties": false + }, + "PackageBuildState": { + "description": "Package build state returned in package response.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "PackageBuildState", + "modelAsString": true, + "values": [ + { + "value": "NotStarted" + }, + { + "value": "Running" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + } + ] + }, + "additionalProperties": false + }, + "PackageInputDeliveryMode": { + "description": "Mounting type of the model or the inputs", + "enum": [ + "Copy", + "Download" + ], + "type": "string", + "x-ms-enum": { + "name": "PackageInputDeliveryMode", + "modelAsString": true, + "values": [ + { + "value": "Copy" + }, + { + "value": "Download" + } + ] + }, + "additionalProperties": false + }, + "PackageInputPathBase": { + "required": [ + "inputPathType" + ], + "type": "object", + "properties": { + "inputPathType": { + "description": "[Required] Input path type for package inputs.", + "$ref": "#/definitions/InputPathType" + } + }, + "discriminator": "inputPathType" + }, + "PackageInputPathId": { + "description": "Package input path specified with a resource id.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "resourceId": { + "description": "Input resource id.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PathId", + "additionalProperties": false + }, + "PackageInputPathUrl": { + "description": "Package input path specified as an url.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "url": { + "description": "Input path url.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Url", + "additionalProperties": false + }, + "PackageInputPathVersion": { + "description": "Package input path specified with name and version.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PackageInputPathBase" + } + ], + "properties": { + "resourceName": { + "description": "Input resource name.", + "type": "string", + "x-nullable": true + }, + "resourceVersion": { + "description": "Input resource version.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PathVersion", + "additionalProperties": false + }, + "PackageInputType": { + "description": "Type of the inputs.", + "enum": [ + "UriFile", + "UriFolder" + ], + "type": "string", + "x-ms-enum": { + "name": "PackageInputType", + "modelAsString": true, + "values": [ + { + "value": "UriFile" + }, + { + "value": "UriFolder" + } + ] + }, + "additionalProperties": false + }, + "PackageRequest": { + "description": "Model package operation request properties.", + "required": [ + "inferencingServer", + "targetEnvironmentId" + ], + "type": "object", + "properties": { + "baseEnvironmentSource": { + "description": "Base environment to start with.", + "$ref": "#/definitions/BaseEnvironmentSource", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentVariables": { + "description": "Collection of environment variables.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inferencingServer": { + "description": "[Required] Inferencing server configurations.", + "$ref": "#/definitions/InferencingServer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "inputs": { + "description": "Collection of inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelPackageInput" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "modelConfiguration": { + "description": "Model configuration including the mount mode.", + "$ref": "#/definitions/ModelConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "targetEnvironmentId": { + "description": "[Required] Arm ID of the target environment to be created by package operation.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "PackageResponse": { + "description": "Package response returned after async package operation completes successfully.", + "type": "object", + "properties": { + "baseEnvironmentSource": { + "description": "Base environment to start with.", + "$ref": "#/definitions/BaseEnvironmentSource", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "buildId": { + "description": "Build id of the image build operation.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "buildState": { + "description": "Build state of the image build operation.", + "$ref": "#/definitions/PackageBuildState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "environmentVariables": { + "description": "Collection of environment variables.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "inferencingServer": { + "description": "Inferencing server configurations.", + "$ref": "#/definitions/InferencingServer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Collection of inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelPackageInput" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true, + "x-ms-identifiers": [] + }, + "logUrl": { + "description": "Log url of the image build operation.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "modelConfiguration": { + "description": "Model configuration including the mount mode.", + "$ref": "#/definitions/ModelConfiguration", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "tags": { + "description": "Tag 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 + }, + "targetEnvironmentId": { + "description": "Asset ID of the target environment created by package operation.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialBatchDeployment": { + "description": "Mutable batch inference settings per deployment.", + "type": "object", + "properties": { + "description": { + "description": "Description of the endpoint deployment.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/PartialBatchDeployment" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "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", + "properties": { + "type": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PartialUserAssignedIdentity" + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResource": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithIdentity": { + "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" + } + }, + "additionalProperties": false + }, + "PartialMinimalTrackedResourceWithSku": { + "description": "Strictly used in update requests.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PartialMinimalTrackedResource" + } + ], + "properties": { + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + } + }, + "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", + "properties": { + "capacity": { + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", + "type": "integer" + }, + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "name": { + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", + "type": "string" + }, + "size": { + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "PartialUserAssignedIdentity": { + "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", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "inputs": { + "description": "Inputs for the pipeline job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jobs": { + "description": "Jobs construct the Pipeline Job.", + "type": "object", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "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": [ + "metricThresholds", + "modelType", + "productionData", + "referenceData" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringSignalBase" + } + ], + "properties": { + "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-ms-identifiers": [] + }, + "modelType": { + "description": "[Required] The type of the model monitored.", + "$ref": "#/definitions/MonitoringModelType", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "productionData": { + "description": "[Required] The data which drift will be calculated for.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "referenceData": { + "description": "[Required] The data to calculate drift against.", + "$ref": "#/definitions/MonitoringInputDataBase", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "PredictionDrift", + "additionalProperties": false + }, + "ProbeSettings": { + "description": "Deployment container liveness/readiness probe configuration.", + "type": "object", + "properties": { + "failureThreshold": { + "format": "int32", + "description": "The number of failures to allow before returning an unhealthy status.", + "default": 30, + "type": "integer" + }, + "initialDelay": { + "format": "duration", + "description": "The delay before the first probe in ISO 8601 format.", + "type": "string", + "x-nullable": true + }, + "period": { + "format": "duration", + "description": "The length of time between probes in ISO 8601 format.", + "default": "PT10S", + "type": "string" + }, + "successThreshold": { + "format": "int32", + "description": "The number of successful probes before returning a healthy status.", + "default": 1, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "The probe timeout in ISO 8601 format.", + "default": "PT2S", + "type": "string" + } + }, + "additionalProperties": false + }, + "ProgressMetrics": { + "description": "Progress metrics definition", + "type": "object", + "properties": { + "completedDatapointCount": { + "format": "int64", + "description": "The completed datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "incrementalDataLastRefreshDateTime": { + "format": "date-time", + "description": "The time of last successful incremental data refresh in UTC.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "skippedDatapointCount": { + "format": "int64", + "description": "The skipped datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "totalDatapointCount": { + "format": "int64", + "description": "The total datapoint count.", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "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": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled" + }, + { + "value": "Disabled" + } + ] + }, + "additionalProperties": false + }, + "PyTorch": { + "description": "PyTorch distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "processCountPerInstance": { + "format": "int32", + "description": "Number of processes per node.", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "PyTorch", + "additionalProperties": false + }, + "QueueSettings": { + "type": "object", + "properties": { + "jobTier": { + "description": "Controls the compute job tier", + "default": "Null", + "$ref": "#/definitions/JobTier", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "priority": { + "format": "int32", + "description": "Controls the priority of the job on a compute.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RandomSamplingAlgorithm": { + "description": "Defines a Sampling Algorithm that generates values randomly", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SamplingAlgorithm" + } + ], + "properties": { + "logbase": { + "description": "An optional positive number or e in string format to be used as base for log based random sampling", + "type": "string", + "x-nullable": true + }, + "rule": { + "description": "The specific type of random algorithm", + "default": "Random", + "$ref": "#/definitions/RandomSamplingAlgorithmRule" + }, + "seed": { + "format": "int32", + "description": "An optional integer to use as the seed for random number generation", + "type": "integer", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Random", + "additionalProperties": false + }, + "RandomSamplingAlgorithmRule": { + "description": "The specific type of random algorithm", + "enum": [ + "Random", + "Sobol" + ], + "type": "string", + "x-ms-enum": { + "name": "RandomSamplingAlgorithmRule", + "modelAsString": true, + "values": [ + { + "value": "Random" + }, + { + "value": "Sobol" + } + ] + }, + "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": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "type": "string", + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true, + "values": [ + { + "value": "Minute", + "description": "Minute frequency" + }, + { + "value": "Hour", + "description": "Hour frequency" + }, + { + "value": "Day", + "description": "Day frequency" + }, + { + "value": "Week", + "description": "Week frequency" + }, + { + "value": "Month", + "description": "Month frequency" + } + ] + }, + "additionalProperties": false + }, + "RecurrenceSchedule": { + "required": [ + "hours", + "minutes" + ], + "type": "object", + "properties": { + "hours": { + "description": "[Required] List of hours for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "minutes": { + "description": "[Required] List of minutes for the schedule.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "monthDays": { + "description": "List of month days for the schedule", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "x-nullable": true + }, + "weekDays": { + "description": "List of days for the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/WeekDay" + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RecurrenceTrigger": { + "required": [ + "frequency", + "interval" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerBase" + } + ], + "properties": { + "frequency": { + "description": "[Required] The frequency to trigger schedule.", + "$ref": "#/definitions/RecurrenceFrequency" + }, + "interval": { + "format": "int32", + "description": "[Required] Specifies schedule interval in conjunction with frequency", + "type": "integer" + }, + "schedule": { + "description": "The recurrence schedule.", + "$ref": "#/definitions/RecurrenceSchedule", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Recurrence", + "additionalProperties": false + }, + "ReferenceType": { + "description": "Enum to determine which reference method to use for an asset.", + "enum": [ + "Id", + "DataPath", + "OutputPath" + ], + "type": "string", + "x-ms-enum": { + "name": "ReferenceType", + "modelAsString": true, + "values": [ + { + "value": "Id" + }, + { + "value": "DataPath" + }, + { + "value": "OutputPath" + } + ] + }, + "additionalProperties": false + }, + "RegenerateEndpointKeysRequest": { + "required": [ + "keyType" + ], + "type": "object", + "properties": { + "keyType": { + "description": "[Required] Specification for which type of key to generate. Primary or Secondary.", + "$ref": "#/definitions/KeyType", + "example": "Primary" + }, + "keyValue": { + "description": "The value the key is set to.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "Regression": { + "description": "Regression task in AutoML Table vertical.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TableVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for regression task.", + "default": "NormalizedRootMeanSquaredError", + "$ref": "#/definitions/RegressionPrimaryMetrics" + }, + "trainingSettings": { + "description": "Inputs for training phase for an AutoML Job.", + "$ref": "#/definitions/RegressionTrainingSettings", + "x-nullable": true + } + }, + "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": [ + "ElasticNet", + "GradientBoosting", + "DecisionTree", + "KNN", + "LassoLars", + "SGD", + "RandomForest", + "ExtremeRandomTrees", + "LightGBM", + "XGBoostRegressor" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionModels", + "modelAsString": true, + "values": [ + { + "value": "ElasticNet", + "description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions." + }, + { + "value": "GradientBoosting", + "description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution." + }, + { + "value": "DecisionTree", + "description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features." + }, + { + "value": "KNN", + "description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set." + }, + { + "value": "LassoLars", + "description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer." + }, + { + "value": "SGD", + "description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique." + }, + { + "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." + }, + { + "value": "ExtremeRandomTrees", + "description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm." + }, + { + "value": "LightGBM", + "description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms." + }, + { + "value": "XGBoostRegressor", + "description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners." + } + ] + }, + "additionalProperties": false + }, + "RegressionPrimaryMetrics": { + "description": "Primary metrics for Regression task.", + "enum": [ + "SpearmanCorrelation", + "NormalizedRootMeanSquaredError", + "R2Score", + "NormalizedMeanAbsoluteError" + ], + "type": "string", + "x-ms-enum": { + "name": "RegressionPrimaryMetrics", + "modelAsString": true, + "values": [ + { + "value": "SpearmanCorrelation", + "description": "The Spearman's rank coefficient of correlation is a nonparametric measure of rank correlation." + }, + { + "value": "NormalizedRootMeanSquaredError", + "description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales." + }, + { + "value": "R2Score", + "description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models." + }, + { + "value": "NormalizedMeanAbsoluteError", + "description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales." + } + ] + }, + "additionalProperties": false + }, + "RegressionTrainingSettings": { + "description": "Regression Training related configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrainingSettings" + } + ], + "properties": { + "allowedTrainingAlgorithms": { + "description": "Allowed models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, + "x-nullable": true + }, + "blockedTrainingAlgorithms": { + "description": "Blocked models for regression task.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionModels" + }, + "x-nullable": true + } + }, + "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": { + "description": { + "description": "The asset description text.", + "type": "string", + "x-nullable": true + }, + "properties": { + "description": "The asset property dictionary.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "tags": { + "description": "Tag dictionary. Tags can be added, removed, and updated.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ResourceConfiguration": { + "type": "object", + "properties": { + "instanceCount": { + "format": "int32", + "description": "Optional number of instances or nodes used by the compute target.", + "default": 1, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "locations": { + "description": "Locations where the job can run.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "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", + "additionalProperties": { + "type": "object", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "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", + "port" + ], + "type": "object", + "properties": { + "path": { + "description": "[Required] The path for the route.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "port": { + "format": "int32", + "description": "[Required] The port for the route.", + "type": "integer" + } + }, + "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": [ + "samplingAlgorithmType" + ], + "type": "object", + "properties": { + "samplingAlgorithmType": { + "description": "[Required] The algorithm used for generating hyperparameter values, along with configuration properties", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "discriminator": "samplingAlgorithmType" + }, + "SamplingAlgorithmType": { + "enum": [ + "Grid", + "Random", + "Bayesian" + ], + "type": "string", + "x-ms-enum": { + "name": "SamplingAlgorithmType", + "modelAsString": true, + "values": [ + { + "value": "Grid" + }, + { + "value": "Random" + }, + { + "value": "Bayesian" + } + ] + }, + "additionalProperties": false + }, + "SasDatastoreCredentials": { + "description": "SAS datastore credentials configuration.", + "required": [ + "secrets" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "secrets": { + "description": "[Required] Storage container secrets.", + "$ref": "#/definitions/SasDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + }, + "x-ms-discriminator-value": "Sas", + "additionalProperties": false + }, + "SasDatastoreSecrets": { + "description": "Datastore SAS secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "sasToken": { + "description": "Storage container SAS token.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Sas", + "additionalProperties": false + }, + "ScaleType": { + "enum": [ + "Default", + "TargetUtilization" + ], + "type": "string", + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true, + "values": [ + { + "value": "Default" + }, + { + "value": "TargetUtilization" + } + ] + }, + "additionalProperties": false + }, + "Schedule": { + "description": "Base definition of a schedule", + "required": [ + "action", + "trigger" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceBase" + } + ], + "properties": { + "action": { + "description": "[Required] Specifies the action of the schedule", + "$ref": "#/definitions/ScheduleActionBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "displayName": { + "description": "Display name of schedule.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "isEnabled": { + "description": "Is the schedule enabled?", + "default": true, + "type": "boolean", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "provisioningState": { + "description": "Provisioning state for the schedule.", + "$ref": "#/definitions/ScheduleProvisioningStatus", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "trigger": { + "description": "[Required] Specifies the trigger details", + "$ref": "#/definitions/TriggerBase", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "x-ms-client-name": "ScheduleProperties", + "additionalProperties": false + }, + "ScheduleActionBase": { + "required": [ + "actionType" + ], + "type": "object", + "properties": { + "actionType": { + "description": "[Required] Specifies the action type of the schedule", + "$ref": "#/definitions/ScheduleActionType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "actionType" + }, + "ScheduleActionType": { + "enum": [ + "CreateJob", + "InvokeBatchEndpoint", + "ImportData", + "CreateMonitor" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleActionType", + "modelAsString": true, + "values": [ + { + "value": "CreateJob" + }, + { + "value": "InvokeBatchEndpoint" + }, + { + "value": "ImportData" + }, + { + "value": "CreateMonitor" + } + ] + }, + "additionalProperties": false + }, + "ScheduleListViewType": { + "enum": [ + "EnabledOnly", + "DisabledOnly", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleListViewType", + "modelAsString": true, + "values": [ + { + "value": "EnabledOnly" + }, + { + "value": "DisabledOnly" + }, + { + "value": "All" + } + ] + }, + "additionalProperties": false + }, + "ScheduleProvisioningStatus": { + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleProvisioningStatus", + "modelAsString": true, + "values": [ + { + "value": "Creating" + }, + { + "value": "Updating" + }, + { + "value": "Deleting" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + }, + "additionalProperties": false + }, + "ScheduleResource": { + "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/Schedule" + } + }, + "x-ms-client-name": "Schedule", + "additionalProperties": false + }, + "ScheduleResourceArmPaginatedResult": { + "description": "A paginated list of Schedule entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Schedule objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleResource" + } + } + }, + "additionalProperties": false + }, + "Seasonality": { + "description": "Forecasting seasonality.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Seasonality mode.", + "$ref": "#/definitions/SeasonalityMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "SeasonalityMode": { + "description": "Forecasting seasonality mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "SeasonalityMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Seasonality to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom seasonality value." + } + ] + }, + "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": [ + "AccountKey", + "Certificate", + "Sas", + "ServicePrincipal", + "KerberosPassword", + "KerberosKeytab" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretsType", + "modelAsString": true, + "values": [ + { + "value": "AccountKey" + }, + { + "value": "Certificate" + }, + { + "value": "Sas" + }, + { + "value": "ServicePrincipal" + }, + { + "value": "KerberosPassword" + }, + { + "value": "KerberosKeytab" + } + ] + }, + "additionalProperties": false + }, + "ServiceDataAccessAuthIdentity": { + "enum": [ + "None", + "WorkspaceSystemAssignedIdentity", + "WorkspaceUserAssignedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceDataAccessAuthIdentity", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Do not use any identity for service data access." + }, + { + "value": "WorkspaceSystemAssignedIdentity", + "description": "Use the system assigned managed identity of the Workspace to authenticate service data access." + }, + { + "value": "WorkspaceUserAssignedIdentity", + "description": "Use the user assigned managed identity of the Workspace to authenticate service data access." + } + ] + }, + "additionalProperties": false + }, + "ServicePrincipalDatastoreCredentials": { + "description": "Service Principal datastore credentials configuration.", + "required": [ + "clientId", + "secrets", + "tenantId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreCredentials" + } + ], + "properties": { + "authorityUrl": { + "description": "Authority URL used for authentication.", + "type": "string", + "x-nullable": true + }, + "clientId": { + "format": "uuid", + "description": "[Required] Service principal client ID.", + "type": "string" + }, + "resourceUrl": { + "description": "Resource the service principal has access to.", + "type": "string", + "x-nullable": true + }, + "secrets": { + "description": "[Required] Service principal secrets.", + "$ref": "#/definitions/ServicePrincipalDatastoreSecrets", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "format": "uuid", + "description": "[Required] ID of the tenant to which the service principal belongs.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ServicePrincipal", + "additionalProperties": false + }, + "ServicePrincipalDatastoreSecrets": { + "description": "Datastore Service Principal secrets.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatastoreSecrets" + } + ], + "properties": { + "clientSecret": { + "description": "Service principal secret.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "ServicePrincipal", + "additionalProperties": false + }, + "ShortSeriesHandlingConfiguration": { + "description": "The parameter defining how if AutoML should handle short time series.", + "enum": [ + "None", + "Auto", + "Pad", + "Drop" + ], + "type": "string", + "x-ms-enum": { + "name": "ShortSeriesHandlingConfiguration", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represents no/null value." + }, + { + "value": "Auto", + "description": "Short series will be padded if there are no long series, otherwise short series will be dropped." + }, + { + "value": "Pad", + "description": "All the short series will be padded." + }, + { + "value": "Drop", + "description": "All the short series will be dropped." + } + ] + }, + "additionalProperties": false + }, + "SkuCapacity": { + "description": "SKU capacity information", + "type": "object", + "properties": { + "default": { + "format": "int32", + "description": "Gets or sets the default capacity.", + "default": 0, + "type": "integer" + }, + "maximum": { + "format": "int32", + "description": "Gets or sets the maximum.", + "default": 0, + "type": "integer" + }, + "minimum": { + "format": "int32", + "description": "Gets or sets the minimum.", + "default": 0, + "type": "integer" + }, + "scaleType": { + "description": "Gets or sets the type of the scale.", + "default": "Automatic", + "$ref": "#/definitions/SkuScaleType" + } + }, + "additionalProperties": false + }, + "SkuResource": { + "description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.", + "type": "object", + "properties": { + "capacity": { + "description": "Gets or sets the Sku Capacity.", + "$ref": "#/definitions/SkuCapacity", + "x-nullable": true + }, + "resourceType": { + "description": "The resource type name.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "sku": { + "description": "Gets or sets the Sku.", + "$ref": "#/definitions/SkuSetting", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SkuResourceArmPaginatedResult": { + "description": "A paginated list of SkuResource entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of SkuResource objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type SkuResource.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" + }, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "SkuScaleType": { + "description": "Node scaling setting for the compute sku.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuScaleType", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "Automatically scales node count." + }, + { + "value": "Manual", + "description": "Node count scaled upon user request." + }, + { + "value": "None", + "description": "Fixed set of nodes." + } + ] + }, + "additionalProperties": false + }, + "SkuSetting": { + "description": "SkuSetting fulfills the need for stripped down SKU info in ARM contract.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "[Required] The name of the SKU. Ex - P3. It is typically a letter+number code.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "default": "Basic", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "SparkJob": { + "description": "Spark job definition.", + "required": [ + "codeId", + "entry" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "archives": { + "description": "Archive files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "args": { + "description": "Arguments for the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "codeId": { + "description": "[Required] ARM resource ID of the code asset.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "conf": { + "description": "Spark configured properties.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "entry": { + "description": "[Required] The entry to execute on startup of the job.", + "$ref": "#/definitions/SparkJobEntry", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentId": { + "description": "The ARM resource ID of the Environment specification for the job.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "files": { + "description": "Files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "jars": { + "description": "Jar files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "pyFiles": { + "description": "Python files used in the job.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "$ref": "#/definitions/SparkResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Spark", + "additionalProperties": false + }, + "SparkJobEntry": { + "description": "Spark job entry point definition.", + "required": [ + "sparkJobEntryType" + ], + "type": "object", + "properties": { + "sparkJobEntryType": { + "description": "[Required] Type of the job's entry point.", + "$ref": "#/definitions/SparkJobEntryType", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "sparkJobEntryType" + }, + "SparkJobEntryType": { + "enum": [ + "SparkJobPythonEntry", + "SparkJobScalaEntry" + ], + "type": "string", + "x-ms-enum": { + "name": "SparkJobEntryType", + "modelAsString": true, + "values": [ + { + "value": "SparkJobPythonEntry" + }, + { + "value": "SparkJobScalaEntry" + } + ] + }, + "additionalProperties": false + }, + "SparkJobPythonEntry": { + "required": [ + "file" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "file": { + "description": "[Required] Relative python file path for job entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "train.py", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobPythonEntry", + "additionalProperties": false + }, + "SparkJobScalaEntry": { + "required": [ + "className" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SparkJobEntry" + } + ], + "properties": { + "className": { + "description": "[Required] Scala class name used as entry point.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "example": "microsoft.aml.sample.myapp", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "SparkJobScalaEntry", + "additionalProperties": false + }, + "SparkResourceConfiguration": { + "type": "object", + "properties": { + "instanceType": { + "description": "Optional type of VM used as supported by the compute target.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "runtimeVersion": { + "description": "Version of spark runtime used for the job.", + "default": "3.1", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "StackEnsembleSettings": { + "description": "Advances setting to customize StackEnsemble run.", + "type": "object", + "properties": { + "stackMetaLearnerKWargs": { + "description": "Optional parameters to pass to the initializer of the meta-learner.", + "type": "object", + "x-nullable": true + }, + "stackMetaLearnerTrainPercentage": { + "format": "double", + "description": "Specifies the proportion of the training set (when choosing train and validation type of training) to be reserved for training the meta-learner. Default value is 0.2.", + "default": 0.2, + "type": "number" + }, + "stackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.", + "default": "None", + "$ref": "#/definitions/StackMetaLearnerType" + } + }, + "additionalProperties": false + }, + "StackMetaLearnerType": { + "description": "The meta-learner is a model trained on the output of the individual heterogeneous models.\r\nDefault meta-learners are LogisticRegression for classification tasks (or LogisticRegressionCV if cross-validation is enabled) and ElasticNet for regression/forecasting tasks (or ElasticNetCV if cross-validation is enabled).\r\nThis parameter can be one of the following strings: LogisticRegression, LogisticRegressionCV, LightGBMClassifier, ElasticNet, ElasticNetCV, LightGBMRegressor, or LinearRegression", + "enum": [ + "None", + "LogisticRegression", + "LogisticRegressionCV", + "LightGBMClassifier", + "ElasticNet", + "ElasticNetCV", + "LightGBMRegressor", + "LinearRegression" + ], + "type": "string", + "x-ms-enum": { + "name": "StackMetaLearnerType", + "modelAsString": true, + "values": [ + { + "value": "None" + }, + { + "value": "LogisticRegression", + "description": "Default meta-learners are LogisticRegression for classification tasks." + }, + { + "value": "LogisticRegressionCV", + "description": "Default meta-learners are LogisticRegression for classification task when CV is on." + }, + { + "value": "LightGBMClassifier" + }, + { + "value": "ElasticNet", + "description": "Default meta-learners are LogisticRegression for regression task." + }, + { + "value": "ElasticNetCV", + "description": "Default meta-learners are LogisticRegression for regression task when CV is on." + }, + { + "value": "LightGBMRegressor" + }, + { + "value": "LinearRegression" + } + ] + }, + "additionalProperties": false + }, + "StaticInputData": { + "description": "Static input data definition.", + "required": [ + "windowEnd", + "windowStart" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "properties": { + "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 + }, + "windowEnd": { + "format": "date-time", + "description": "[Required] The end date of the data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "windowStart": { + "format": "date-time", + "description": "[Required] The start date of the data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Static", + "additionalProperties": false + }, + "StatusMessage": { + "description": "Active message associated with project", + "type": "object", + "properties": { + "code": { + "description": "Service-defined message code.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Time in UTC at which the message was created.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + }, + "level": { + "description": "Severity level of message.", + "$ref": "#/definitions/StatusMessageLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "message": { + "description": "A human-readable representation of the message code.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-nullable": true + } + }, + "additionalProperties": false + }, + "StatusMessageLevel": { + "enum": [ + "Error", + "Information", + "Warning" + ], + "type": "string", + "x-ms-enum": { + "name": "StatusMessageLevel", + "modelAsString": true, + "values": [ + { + "value": "Error" + }, + { + "value": "Information" + }, + { + "value": "Warning" + } + ] + }, + "additionalProperties": false + }, + "StochasticOptimizer": { + "description": "Stochastic optimizer for image models.", + "enum": [ + "None", + "Sgd", + "Adam", + "Adamw" + ], + "type": "string", + "x-ms-enum": { + "name": "StochasticOptimizer", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No optimizer selected." + }, + { + "value": "Sgd", + "description": "Stochastic Gradient Descent optimizer." + }, + { + "value": "Adam", + "description": "Adam is algorithm the optimizes stochastic objective functions based on adaptive estimates of moments" + }, + { + "value": "Adamw", + "description": "AdamW is a variant of the optimizer Adam that has an improved implementation of weight decay." + } + ] + }, + "additionalProperties": false + }, + "SweepJob": { + "description": "Sweep job definition.", + "required": [ + "objective", + "samplingAlgorithm", + "searchSpace", + "trial" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobBase" + } + ], + "properties": { + "earlyTermination": { + "description": "Early termination policies enable canceling poor-performing runs before they complete", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "inputs": { + "description": "Mapping of input data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Command job definition.", + "$ref": "#/definitions/JobInput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "limits": { + "description": "Sweep Job limit.", + "default": "{}", + "$ref": "#/definitions/SweepJobLimits", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "objective": { + "description": "[Required] Optimization objective.", + "$ref": "#/definitions/Objective" + }, + "outputs": { + "description": "Mapping of output data bindings used in the job.", + "type": "object", + "additionalProperties": { + "description": "Job output definition container information on where to find job output/logs.", + "$ref": "#/definitions/JobOutput", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "queueSettings": { + "description": "Queue settings for the job", + "$ref": "#/definitions/QueueSettings", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] The hyperparameter sampling algorithm", + "$ref": "#/definitions/SamplingAlgorithm" + }, + "searchSpace": { + "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "type": "object" + }, + "trial": { + "description": "[Required] Trial component definition.", + "$ref": "#/definitions/TrialComponent" + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "SweepJobLimits": { + "description": "Sweep Job limit class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobLimits" + } + ], + "properties": { + "maxConcurrentTrials": { + "format": "int32", + "description": "Sweep Job max concurrent trials.", + "type": "integer", + "x-nullable": true + }, + "maxTotalTrials": { + "format": "int32", + "description": "Sweep Job max total trials.", + "type": "integer", + "x-nullable": true + }, + "trialTimeout": { + "format": "duration", + "description": "Sweep Job Trial timeout value.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Sweep", + "additionalProperties": false + }, + "TableFixedParameters": { + "description": "Fixed training parameters that won't be swept over during AutoML Table training.", + "type": "object", + "properties": { + "booster": { + "description": "Specify the boosting type, e.g gbdt for XGBoost.", + "type": "string", + "x-nullable": true + }, + "boostingType": { + "description": "Specify the boosting type, e.g gbdt for LightGBM.", + "type": "string", + "x-nullable": true + }, + "growPolicy": { + "description": "Specify the grow policy, which controls the way new nodes are added to the tree.", + "type": "string", + "x-nullable": true + }, + "learningRate": { + "format": "double", + "description": "The learning rate for the training procedure.", + "type": "number", + "x-nullable": true + }, + "maxBin": { + "format": "int32", + "description": "Specify the Maximum number of discrete bins to bucket continuous features .", + "type": "integer", + "x-nullable": true + }, + "maxDepth": { + "format": "int32", + "description": "Specify the max depth to limit the tree depth explicitly.", + "type": "integer", + "x-nullable": true + }, + "maxLeaves": { + "format": "int32", + "description": "Specify the max leaves to limit the tree leaves explicitly.", + "type": "integer", + "x-nullable": true + }, + "minDataInLeaf": { + "format": "int32", + "description": "The minimum number of data per leaf.", + "type": "integer", + "x-nullable": true + }, + "minSplitGain": { + "format": "double", + "description": "Minimum loss reduction required to make a further partition on a leaf node of the tree.", + "type": "number", + "x-nullable": true + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "x-nullable": true + }, + "nEstimators": { + "format": "int32", + "description": "Specify the number of trees (or rounds) in an model.", + "type": "integer", + "x-nullable": true + }, + "numLeaves": { + "format": "int32", + "description": "Specify the number of leaves.", + "type": "integer", + "x-nullable": true + }, + "preprocessorName": { + "description": "The name of the preprocessor to use.", + "type": "string", + "x-nullable": true + }, + "regAlpha": { + "format": "double", + "description": "L1 regularization term on weights.", + "type": "number", + "x-nullable": true + }, + "regLambda": { + "format": "double", + "description": "L2 regularization term on weights.", + "type": "number", + "x-nullable": true + }, + "subsample": { + "format": "double", + "description": "Subsample ratio of the training instance.", + "type": "number", + "x-nullable": true + }, + "subsampleFreq": { + "format": "double", + "description": "Frequency of subsample.", + "type": "number", + "x-nullable": true + }, + "treeMethod": { + "description": "Specify the tree method.", + "type": "string", + "x-nullable": true + }, + "withMean": { + "description": "If true, center before scaling the data with StandardScalar.", + "default": false, + "type": "boolean" + }, + "withStd": { + "description": "If true, scaling the data with Unit Variance with StandardScalar.", + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false + }, + "TableParameterSubspace": { + "type": "object", + "properties": { + "booster": { + "description": "Specify the boosting type, e.g gbdt for XGBoost.", + "type": "string", + "x-nullable": true + }, + "boostingType": { + "description": "Specify the boosting type, e.g gbdt for LightGBM.", + "type": "string", + "x-nullable": true + }, + "growPolicy": { + "description": "Specify the grow policy, which controls the way new nodes are added to the tree.", + "type": "string", + "x-nullable": true + }, + "learningRate": { + "description": "The learning rate for the training procedure.", + "type": "string", + "x-nullable": true + }, + "maxBin": { + "description": "Specify the Maximum number of discrete bins to bucket continuous features .", + "type": "string", + "x-nullable": true + }, + "maxDepth": { + "description": "Specify the max depth to limit the tree depth explicitly.", + "type": "string", + "x-nullable": true + }, + "maxLeaves": { + "description": "Specify the max leaves to limit the tree leaves explicitly.", + "type": "string", + "x-nullable": true + }, + "minDataInLeaf": { + "description": "The minimum number of data per leaf.", + "type": "string", + "x-nullable": true + }, + "minSplitGain": { + "description": "Minimum loss reduction required to make a further partition on a leaf node of the tree.", + "type": "string", + "x-nullable": true + }, + "modelName": { + "description": "The name of the model to train.", + "type": "string", + "x-nullable": true + }, + "nEstimators": { + "description": "Specify the number of trees (or rounds) in an model.", + "type": "string", + "x-nullable": true + }, + "numLeaves": { + "description": "Specify the number of leaves.", + "type": "string", + "x-nullable": true + }, + "preprocessorName": { + "description": "The name of the preprocessor to use.", + "type": "string", + "x-nullable": true + }, + "regAlpha": { + "description": "L1 regularization term on weights.", + "type": "string", + "x-nullable": true + }, + "regLambda": { + "description": "L2 regularization term on weights.", + "type": "string", + "x-nullable": true + }, + "subsample": { + "description": "Subsample ratio of the training instance.", + "type": "string", + "x-nullable": true + }, + "subsampleFreq": { + "description": "Frequency of subsample", + "type": "string", + "x-nullable": true + }, + "treeMethod": { + "description": "Specify the tree method.", + "type": "string", + "x-nullable": true + }, + "withMean": { + "description": "If true, center before scaling the data with StandardScalar.", + "type": "string", + "x-nullable": true + }, + "withStd": { + "description": "If true, scaling the data with Unit Variance with StandardScalar.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableSweepSettings": { + "required": [ + "samplingAlgorithm" + ], + "type": "object", + "properties": { + "earlyTermination": { + "description": "Type of early termination policy for the sweeping job.", + "$ref": "#/definitions/EarlyTerminationPolicy", + "x-nullable": true + }, + "samplingAlgorithm": { + "description": "[Required] Type of sampling algorithm.", + "$ref": "#/definitions/SamplingAlgorithmType" + } + }, + "additionalProperties": false + }, + "TableVertical": { + "description": "Abstract class for AutoML tasks that use table dataset as input - such as Classification/Regression/Forecasting.", + "type": "object", + "properties": { + "cvSplitColumnNames": { + "description": "Columns to use for CVSplit data.", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "featurizationSettings": { + "description": "Featurization inputs needed for AutoML job.", + "$ref": "#/definitions/TableVerticalFeaturizationSettings", + "x-nullable": true + }, + "fixedParameters": { + "description": "Model/training parameters that will remain constant throughout training.", + "$ref": "#/definitions/TableFixedParameters", + "x-nullable": true + }, + "limitSettings": { + "description": "Execution constraints for AutoMLJob.", + "$ref": "#/definitions/TableVerticalLimitSettings", + "x-nullable": true + }, + "nCrossValidations": { + "description": "Number of cross validation folds to be applied on training dataset\r\nwhen validation dataset is not provided.", + "$ref": "#/definitions/NCrossValidations", + "x-nullable": true + }, + "searchSpace": { + "description": "Search space for sampling different combinations of models and their hyperparameters.", + "type": "array", + "items": { + "$ref": "#/definitions/TableParameterSubspace" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "sweepSettings": { + "description": "Settings for model sweeping and hyperparameter tuning.", + "$ref": "#/definitions/TableSweepSettings", + "x-nullable": true + }, + "testData": { + "description": "Test data input.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "testDataSize": { + "format": "double", + "description": "The fraction of test dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "validationData": { + "description": "Validation data inputs.", + "$ref": "#/definitions/MLTableJobInput", + "x-nullable": true + }, + "validationDataSize": { + "format": "double", + "description": "The fraction of training dataset that needs to be set aside for validation purpose.\r\nValues between (0.0 , 1.0)\r\nApplied when validation dataset is not provided.", + "type": "number", + "x-nullable": true + }, + "weightColumnName": { + "description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalFeaturizationSettings": { + "description": "Featurization Configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeaturizationSettings" + } + ], + "properties": { + "blockedTransformers": { + "description": "These transformers shall not be used in featurization.", + "type": "array", + "items": { + "$ref": "#/definitions/BlockedTransformers" + }, + "x-nullable": true + }, + "columnNameAndTypes": { + "description": "Dictionary of column name and its type (int, float, string, datetime etc).", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "enableDnnFeaturization": { + "description": "Determines whether to use Dnn based featurizers for data featurization.", + "default": false, + "type": "boolean" + }, + "mode": { + "description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\r\nIf 'Off' is selected then no featurization is done.\r\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.", + "default": "Auto", + "$ref": "#/definitions/FeaturizationMode" + }, + "transformerParams": { + "description": "User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ColumnTransformer" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "x-nullable": true + } + }, + "additionalProperties": false + }, + "TableVerticalLimitSettings": { + "description": "Job execution constraints.", + "type": "object", + "properties": { + "enableEarlyTermination": { + "description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.", + "default": true, + "type": "boolean" + }, + "exitScore": { + "format": "double", + "description": "Exit score for the AutoML job.", + "type": "number", + "x-nullable": true + }, + "maxConcurrentTrials": { + "format": "int32", + "description": "Maximum Concurrent iterations.", + "default": 1, + "type": "integer" + }, + "maxCoresPerTrial": { + "format": "int32", + "description": "Max cores per iteration.", + "default": -1, + "type": "integer" + }, + "maxNodes": { + "format": "int32", + "description": "Maximum nodes to use for the experiment.", + "default": 1, + "type": "integer" + }, + "maxTrials": { + "format": "int32", + "description": "Number of iterations.", + "default": 1000, + "type": "integer" + }, + "sweepConcurrentTrials": { + "format": "int32", + "description": "Number of concurrent sweeping runs that user wants to trigger.", + "default": 0, + "type": "integer" + }, + "sweepTrials": { + "format": "int32", + "description": "Number of sweeping runs that user wants to trigger.", + "default": 0, + "type": "integer" + }, + "timeout": { + "format": "duration", + "description": "AutoML job timeout.", + "default": "PT6H", + "type": "string" + }, + "trialTimeout": { + "format": "duration", + "description": "Iteration timeout.", + "default": "PT30M", + "type": "string" + } + }, + "additionalProperties": false + }, + "TargetAggregationFunction": { + "description": "Target aggregate function.", + "enum": [ + "None", + "Sum", + "Max", + "Min", + "Mean" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetAggregationFunction", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Represent no value set." + }, + { + "value": "Sum" + }, + { + "value": "Max" + }, + { + "value": "Min" + }, + { + "value": "Mean" + } + ] + }, + "additionalProperties": false + }, + "TargetLags": { + "description": "The number of past periods to lag from the target column.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] Set target lags mode - Auto/Custom", + "$ref": "#/definitions/TargetLagsMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "TargetLagsMode": { + "description": "Target lags selection modes.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetLagsMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Target lags to be determined automatically." + }, + { + "value": "Custom", + "description": "Use the custom target lags." + } + ] + }, + "additionalProperties": false + }, + "TargetRollingWindowSize": { + "description": "Forecasting target rolling window size.", + "required": [ + "mode" + ], + "type": "object", + "properties": { + "mode": { + "description": "[Required] TargetRollingWindowSiz detection mode.", + "$ref": "#/definitions/TargetRollingWindowSizeMode", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "mode" + }, + "TargetRollingWindowSizeMode": { + "description": "Target rolling windows size mode.", + "enum": [ + "Auto", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetRollingWindowSizeMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Determine rolling windows size automatically." + }, + { + "value": "Custom", + "description": "Use the specified rolling window size." + } + ] + }, + "additionalProperties": false + }, + "TargetUtilizationScaleSettings": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OnlineScaleSettings" + } + ], + "properties": { + "maxInstances": { + "format": "int32", + "description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.", + "default": 1, + "type": "integer" + }, + "minInstances": { + "format": "int32", + "description": "The minimum number of instances to always be present.", + "default": 1, + "type": "integer" + }, + "pollingInterval": { + "format": "duration", + "description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.", + "default": "PT1S", + "type": "string" + }, + "targetUtilizationPercentage": { + "format": "int32", + "description": "Target CPU usage for the autoscaler.", + "default": 70, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TargetUtilization", + "additionalProperties": false + }, + "TaskType": { + "description": "AutoMLJob Task type.", + "enum": [ + "Classification", + "Regression", + "Forecasting", + "ImageClassification", + "ImageClassificationMultilabel", + "ImageObjectDetection", + "ImageInstanceSegmentation", + "TextClassification", + "TextClassificationMultilabel", + "TextNER" + ], + "type": "string", + "x-ms-enum": { + "name": "TaskType", + "modelAsString": true, + "values": [ + { + "value": "Classification", + "description": "Classification in machine learning and statistics is a supervised learning approach in which\nthe computer program learns from the data given to it and make new observations or classifications." + }, + { + "value": "Regression", + "description": "Regression means to predict the value using the input data. Regression models are used to predict a continuous value." + }, + { + "value": "Forecasting", + "description": "Forecasting is a special kind of regression task that deals with time-series data and creates forecasting model\nthat can be used to predict the near future values based on the inputs." + }, + { + "value": "ImageClassification", + "description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'." + }, + { + "value": "ImageClassificationMultilabel", + "description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'." + }, + { + "value": "ImageObjectDetection", + "description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each." + }, + { + "value": "ImageInstanceSegmentation", + "description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\ndrawing a polygon around each object in the image." + }, + { + "value": "TextClassification", + "description": "Text classification (also known as text tagging or text categorization) is the process of sorting texts into categories.\nCategories are mutually exclusive." + }, + { + "value": "TextClassificationMultilabel", + "description": "Multilabel classification task assigns each sample to a group (zero or more) of target labels." + }, + { + "value": "TextNER", + "description": "Text Named Entity Recognition a.k.a. TextNER.\nNamed Entity Recognition (NER) is the ability to take free-form text and identify the occurrences of entities such as people, locations, organizations, and more." + } + ] + }, + "additionalProperties": false + }, + "TensorFlow": { + "description": "TensorFlow distribution configuration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DistributionConfiguration" + } + ], + "properties": { + "parameterServerCount": { + "format": "int32", + "description": "Number of parameter server tasks.", + "default": 0, + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workerCount": { + "format": "int32", + "description": "Number of workers. If not specified, will default to the instance count.", + "type": "integer", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + } + }, + "x-ms-discriminator-value": "TensorFlow", + "additionalProperties": false + }, + "TextAnnotationType": { + "description": "Annotation type of text data.", + "enum": [ + "Classification", + "NamedEntityRecognition" + ], + "type": "string", + "x-ms-enum": { + "name": "TextAnnotationType", + "modelAsString": true, + "values": [ + { + "value": "Classification" + }, + { + "value": "NamedEntityRecognition" + } + ] + }, + "additionalProperties": false + }, + "TextClassification": { + "description": "Text Classification task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification task.", + "default": "Accuracy", + "$ref": "#/definitions/ClassificationPrimaryMetrics" + } + }, + "x-ms-discriminator-value": "TextClassification", + "additionalProperties": false + }, + "TextClassificationMultilabel": { + "description": "Text Classification Multilabel task in AutoML NLP vertical.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-Classification-Multilabel task.\r\nCurrently only Accuracy is supported as primary metric, hence user need not set it explicitly.", + "$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics", + "readOnly": true + } + }, + "x-ms-discriminator-value": "TextClassificationMultilabel", + "additionalProperties": false + }, + "TextNer": { + "description": "Text-NER task in AutoML NLP vertical.\r\nNER - Named Entity Recognition.\r\nNLP - Natural Language Processing.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NlpVertical" + }, + { + "$ref": "#/definitions/AutoMLVertical" + } + ], + "properties": { + "primaryMetric": { + "description": "Primary metric for Text-NER task.\r\nOnly 'Accuracy' is supported for Text-NER, so user need not set this explicitly.", + "$ref": "#/definitions/ClassificationPrimaryMetrics", + "readOnly": true + } + }, + "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 + }, + "TrailingInputData": { + "description": "Trailing input data definition.", + "required": [ + "windowOffset", + "windowSize" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MonitoringInputDataBase" + } + ], + "properties": { + "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 + }, + "windowOffset": { + "format": "duration", + "description": "[Required] The time offset between the end of the data window and the monitor's current run time.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "windowSize": { + "format": "duration", + "description": "[Required] The size of the trailing data window.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-discriminator-value": "Trailing", + "additionalProperties": false + }, + "TrainingMode": { + "description": "Training mode dictates whether to use distributed training or not", + "enum": [ + "Auto", + "Distributed", + "NonDistributed" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "Auto mode" + }, + { + "value": "Distributed", + "description": "Distributed training mode" + }, + { + "value": "NonDistributed", + "description": "Non distributed training mode" + } + ] + }, + "additionalProperties": false + }, + "TrainingSettings": { + "description": "Training related configuration.", + "type": "object", + "properties": { + "enableDnnTraining": { + "description": "Enable recommendation of DNN models.", + "default": false, + "type": "boolean" + }, + "enableModelExplainability": { + "description": "Flag to turn on explainability on best model.", + "default": true, + "type": "boolean" + }, + "enableOnnxCompatibleModels": { + "description": "Flag for enabling onnx compatible models.", + "default": false, + "type": "boolean" + }, + "enableStackEnsemble": { + "description": "Enable stack ensemble run.", + "default": true, + "type": "boolean" + }, + "enableVoteEnsemble": { + "description": "Enable voting ensemble run.", + "default": true, + "type": "boolean" + }, + "ensembleModelDownloadTimeout": { + "format": "duration", + "description": "During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.\r\nConfigure this parameter with a higher value than 300 secs, if more time is needed.", + "default": "PT5M", + "type": "string" + }, + "stackEnsembleSettings": { + "description": "Stack ensemble settings for stack ensemble run.", + "$ref": "#/definitions/StackEnsembleSettings", + "x-nullable": true + }, + "trainingMode": { + "description": "TrainingMode mode - Setting to 'auto' is same as setting it to 'non-distributed' for now, however in the future may result in mixed mode or heuristics based mode selection. Default is 'auto'.\r\nIf 'Distributed' then only distributed featurization is used and distributed algorithms are chosen.\r\nIf 'NonDistributed' then only non distributed algorithms are chosen.", + "default": "Auto", + "$ref": "#/definitions/TrainingMode" + } + }, + "additionalProperties": false + }, + "TrialComponent": { + "description": "Trial component definition.", + "required": [ + "command", + "environmentId" + ], + "type": "object", + "properties": { + "codeId": { + "description": "ARM resource ID of the code asset.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "command": { + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "distribution": { + "description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.", + "$ref": "#/definitions/DistributionConfiguration", + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "environmentId": { + "description": "[Required] The ARM resource ID of the Environment specification for the job.", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "environmentVariables": { + "description": "Environment variables included in the job.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + }, + "x-ms-mutability": [ + "create", + "read" + ], + "x-nullable": true + }, + "resources": { + "description": "Compute Resource configuration for the job.", + "default": "{}", + "$ref": "#/definitions/JobResourceConfiguration", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "additionalProperties": false + }, + "TriggerBase": { + "required": [ + "triggerType" + ], + "type": "object", + "properties": { + "endTime": { + "description": "Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601.\r\nRecommented format would be \"2022-06-01T00:00:01\"\r\nIf not present, the schedule will run indefinitely", + "type": "string", + "x-nullable": true + }, + "startTime": { + "description": "Specifies start time of schedule in ISO 8601 format, but without a UTC offset.", + "type": "string", + "x-nullable": true + }, + "timeZone": { + "description": "Specifies time zone in which the schedule runs.\r\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11", + "default": "UTC", + "type": "string" + }, + "triggerType": { + "description": "[Required] ", + "$ref": "#/definitions/TriggerType", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + } + }, + "discriminator": "triggerType" + }, + "TriggerType": { + "enum": [ + "Recurrence", + "Cron" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true, + "values": [ + { + "value": "Recurrence" + }, + { + "value": "Cron" + } + ] + }, + "additionalProperties": false + }, + "TritonInferencingServer": { + "description": "Triton inferencing server configurations.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InferencingServer" + } + ], + "properties": { + "inferenceConfiguration": { + "description": "Inference configuration for Triton.", + "$ref": "#/definitions/OnlineInferenceConfiguration", + "x-nullable": true + } + }, + "x-ms-discriminator-value": "Triton", + "additionalProperties": false + }, + "TritonModelJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "triton_model", + "additionalProperties": false + }, + "TritonModelJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "triton_model", + "additionalProperties": false + }, + "TruncationSelectionPolicy": { + "description": "Defines an early termination policy that cancels a given percentage of runs at each evaluation interval.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EarlyTerminationPolicy" + } + ], + "properties": { + "truncationPercentage": { + "format": "int32", + "description": "The percentage of runs to cancel at each evaluation interval.", + "default": 0, + "type": "integer" + } + }, + "x-ms-discriminator-value": "TruncationSelection", + "additionalProperties": false + }, + "UriFileDataVersion": { + "description": "uri-file data version entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFileJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFileJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "uri_file", + "additionalProperties": false + }, + "UriFolderDataVersion": { + "description": "uri-folder data version entity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataVersionBase" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UriFolderJobInput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobInput" + }, + { + "$ref": "#/definitions/JobInput" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UriFolderJobOutput": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AssetJobOutput" + }, + { + "$ref": "#/definitions/JobOutput" + } + ], + "x-ms-discriminator-value": "uri_folder", + "additionalProperties": false + }, + "UseStl": { + "description": "Configure STL Decomposition of the time-series target column.", + "enum": [ + "None", + "Season", + "SeasonTrend" + ], + "type": "string", + "x-ms-enum": { + "name": "UseStl", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No stl decomposition." + }, + { + "value": "Season" + }, + { + "value": "SeasonTrend" + } + ] + }, + "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": [ + "None", + "Coco", + "Voc", + "CocoVoc" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationMetricType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No metric." + }, + { + "value": "Coco", + "description": "Coco metric." + }, + { + "value": "Voc", + "description": "Voc metric." + }, + { + "value": "CocoVoc", + "description": "CocoVoc metric." + } + ] + }, + "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": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true, + "values": [ + { + "value": "Monday", + "description": "Monday weekday" + }, + { + "value": "Tuesday", + "description": "Tuesday weekday" + }, + { + "value": "Wednesday", + "description": "Wednesday weekday" + }, + { + "value": "Thursday", + "description": "Thursday weekday" + }, + { + "value": "Friday", + "description": "Friday weekday" + }, + { + "value": "Saturday", + "description": "Saturday weekday" + }, + { + "value": "Sunday", + "description": "Sunday weekday" + } + ] + }, + "additionalProperties": false + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/registries.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/registries.json new file mode 100644 index 000000000000..e9cc9f7157e2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/registries.json @@ -0,0 +1,876 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2023-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/registries": { + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "List registries by subscription", + "operationId": "Registries_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$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/RegistryTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List registries by subscription.": { + "$ref": "./examples/Registries/listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries": { + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "List registries", + "operationId": "Registries_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": "../../../../../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/RegistryTrackedResourceArmPaginatedResult" + } + } + }, + "x-ms-examples": { + "List registries with system created accounts.": { + "$ref": "./examples/Registries/list-SystemCreated.json" + }, + "List registries with user created accounts.": { + "$ref": "./examples/Registries/list-UserCreated.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}": { + "delete": { + "tags": [ + "RegistryManagement" + ], + "summary": "Delete registry", + "operationId": "Registries_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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "x-ms-async-operation-timeout": { + "description": "Timeout for the client to use when polling the asynchronous operation.", + "type": "string", + "format": "duration" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success" + }, + "204": { + "description": "No content" + } + }, + "x-ms-examples": { + "Delete Registry.": { + "$ref": "./examples/Registries/delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "RegistryManagement" + ], + "summary": "Get registry", + "operationId": "Registries_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": "#/parameters/RegistryNameParameter" + }, + { + "$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/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "Get Registry with system created accounts.": { + "$ref": "./examples/Registries/get-SystemCreated.json" + }, + "Get Registry with user created accounts.": { + "$ref": "./examples/Registries/get-UserCreated.json" + } + } + }, + "patch": { + "tags": [ + "RegistryManagement" + ], + "summary": "Update tags", + "operationId": "Registries_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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/PartialRegistryPartialTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "Update Registry with system created accounts.": { + "$ref": "./examples/Registries/update-SystemCreated.json" + }, + "Update Registry with user created accounts.": { + "$ref": "./examples/Registries/update-UserCreated.json" + } + } + }, + "put": { + "tags": [ + "RegistryManagement" + ], + "summary": "Create or update registry", + "operationId": "Registries_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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate Registry with system created accounts.": { + "$ref": "./examples/Registries/createOrUpdate-SystemCreated.json" + }, + "CreateOrUpdate Registry with user created accounts.": { + "$ref": "./examples/Registries/createOrUpdate-UserCreated.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/removeRegions": { + "post": { + "tags": [ + "RegistryManagement" + ], + "summary": "Remove regions from registry", + "operationId": "Registries_RemoveRegions", + "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": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details required to create the registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RegistryTrackedResource" + } + }, + "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": { + "Remove regions from registry": { + "$ref": "./examples/Registries/removeRegions.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AcrDetails": { + "description": "Details of ACR account to be used for the Registry", + "type": "object", + "properties": { + "systemCreatedAcrAccount": { + "description": "Details of system created ACR account to be used for the Registry", + "$ref": "#/definitions/SystemCreatedAcrAccount", + "x-nullable": true + }, + "userCreatedAcrAccount": { + "description": "Details of user created ACR account to be used for the Registry", + "$ref": "#/definitions/UserCreatedAcrAccount", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "ArmResourceId": { + "description": "ARM ResourceId of a resource", + "type": "object", + "properties": { + "resourceId": { + "description": "Arm ResourceId is in the format \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}\"\r\nor \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}\"", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "EndpointServiceConnectionStatus": { + "description": "Connection status of the service consumer with the service provider", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointServiceConnectionStatus", + "modelAsString": true + }, + "additionalProperties": false + }, + "RegistryPartialManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + } + ], + "additionalProperties": false + }, + "PartialRegistry": { + "description": "Partial Registry class for PATCH", + "type": "object", + "additionalProperties": false + }, + "PartialRegistryPartialTrackedResource": { + "description": "Strictly used in update requests.", + "type": "object", + "properties": { + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "$ref": "#/definitions/RegistryPartialManagedServiceIdentity" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "#/definitions/PartialSku" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string", + "x-nullable": true + } + } + }, + "additionalProperties": false + }, + "PartialSku": { + "description": "Common SKU definition.", + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.", + "type": "integer" + }, + "family": { + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "name": { + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code.", + "type": "string" + }, + "size": { + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "tier": { + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier" + } + }, + "additionalProperties": false + }, + "RegistryPrivateEndpointConnection": { + "description": "Private endpoint connection definition.", + "type": "object", + "properties": { + "id": { + "description": "This is the private endpoint connection name created on SRP\r\nFull resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName}", + "type": "string", + "x-nullable": true + }, + "location": { + "description": "Same as workspace location.", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the Private Endpoint Connection", + "$ref": "#/definitions/RegistryPrivateEndpointConnectionProperties", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RegistryPrivateEndpointConnectionProperties": { + "description": "Properties of the Private Endpoint Connection", + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids", + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + }, + "privateEndpoint": { + "description": "The PE network resource that is linked to this PE connection.", + "$ref": "#/definitions/PrivateEndpointResource", + "x-nullable": true + }, + "registryPrivateLinkServiceConnectionState": { + "description": "The connection state.", + "$ref": "#/definitions/RegistryPrivateLinkServiceConnectionState", + "x-nullable": true + }, + "provisioningState": { + "description": "One of null, \"Succeeded\", \"Provisioning\", \"Failed\". While not approved, it's null.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "PrivateEndpointResource": { + "description": "The PE network resource that is linked to this PE connection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpoint" + } + ], + "properties": { + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "RegistryPrivateLinkServiceConnectionState": { + "description": "The connection state.", + "type": "object", + "properties": { + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", + "type": "string", + "x-nullable": true + }, + "description": { + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", + "type": "string", + "x-nullable": true + }, + "status": { + "description": "Connection status of the service consumer with the service provider", + "$ref": "#/definitions/EndpointServiceConnectionStatus" + } + }, + "additionalProperties": false + }, + "Registry": { + "description": "Details of the Registry", + "type": "object", + "properties": { + "discoveryUrl": { + "description": "Discovery URL for the Registry", + "type": "string", + "x-nullable": true + }, + "intellectualPropertyPublisher": { + "description": "IntellectualPropertyPublisher for the registry", + "type": "string", + "x-nullable": true + }, + "managedResourceGroup": { + "description": "ResourceId of the managed RG if the registry has system created resources", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + }, + "mlFlowRegistryUri": { + "description": "MLFlow Registry URI for the Registry", + "type": "string", + "x-nullable": true + }, + "registryPrivateEndpointConnections": { + "description": "Private endpoint connections info used for pending connections in private link portal", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryPrivateEndpointConnection" + }, + "x-nullable": true + }, + "publicNetworkAccess": { + "description": "Is the Registry accessible from the internet?\r\nPossible values: \"Enabled\" or \"Disabled\"", + "type": "string", + "x-nullable": true + }, + "regionDetails": { + "description": "Details of each region the registry is in", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryRegionArmDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "x-ms-client-name": "RegistryProperties", + "additionalProperties": false + }, + "RegistryRegionArmDetails": { + "description": "Details for each region the registry is in", + "type": "object", + "properties": { + "acrDetails": { + "description": "List of ACR accounts", + "type": "array", + "items": { + "$ref": "#/definitions/AcrDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + }, + "location": { + "description": "The location where the registry exists", + "type": "string", + "x-nullable": true + }, + "storageAccountDetails": { + "description": "List of storage accounts", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountDetails" + }, + "x-nullable": true, + "x-ms-identifiers": [] + } + }, + "additionalProperties": false + }, + "RegistryTrackedResource": { + "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": { + "x-ms-client-flatten": true, + "description": "[Required] Additional attributes of the entity.", + "$ref": "#/definitions/Registry" + }, + "sku": { + "description": "Sku details required for ARM contract for Autoscaling.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + }, + "x-ms-client-name": "Registry", + "additionalProperties": false + }, + "RegistryTrackedResourceArmPaginatedResult": { + "description": "A paginated list of Registry entities.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page of Registry objects. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "An array of objects of type Registry.", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryTrackedResource" + } + } + }, + "additionalProperties": false + }, + "StorageAccountDetails": { + "description": "Details of storage account to be used for the Registry", + "type": "object", + "properties": { + "systemCreatedStorageAccount": { + "description": "Details of system created storage account to be used for the registry", + "$ref": "#/definitions/SystemCreatedStorageAccount", + "x-nullable": true + }, + "userCreatedStorageAccount": { + "description": "Details of user created storage account to be used for the registry", + "$ref": "#/definitions/UserCreatedStorageAccount", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SystemCreatedAcrAccount": { + "type": "object", + "properties": { + "acrAccountName": { + "description": "Name of the ACR account", + "type": "string", + "x-nullable": true + }, + "acrAccountSku": { + "description": "SKU of the ACR account", + "type": "string", + "x-nullable": true + }, + "armResourceId": { + "description": "This is populated once the ACR account is created.", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "SystemCreatedStorageAccount": { + "type": "object", + "properties": { + "allowBlobPublicAccess": { + "description": "Public blob access allowed", + "type": "boolean" + }, + "armResourceId": { + "description": "This is populated once the storage account is created.", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + }, + "storageAccountHnsEnabled": { + "description": "HNS enabled for storage account", + "type": "boolean" + }, + "storageAccountName": { + "description": "Name of the storage account", + "type": "string", + "x-nullable": true + }, + "storageAccountType": { + "description": "Allowed values:\r\n\"Standard_LRS\",\r\n\"Standard_GRS\",\r\n\"Standard_RAGRS\",\r\n\"Standard_ZRS\",\r\n\"Standard_GZRS\",\r\n\"Standard_RAGZRS\",\r\n\"Premium_LRS\",\r\n\"Premium_ZRS\"", + "type": "string", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "UserCreatedAcrAccount": { + "type": "object", + "properties": { + "armResourceId": { + "description": "ARM ResourceId of a resource", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + }, + "UserCreatedStorageAccount": { + "type": "object", + "properties": { + "armResourceId": { + "description": "ARM ResourceId of a resource", + "$ref": "#/definitions/ArmResourceId", + "x-nullable": true + } + }, + "additionalProperties": false + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "parameters": { + "RegistryNameParameter": { + "name": "registryName", + "description": "Name of Azure Machine Learning registry. This is case-insensitive", + "in": "path", + "type": "string", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceFeatures.json new file mode 100644 index 000000000000..09003cede68e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceFeatures.json @@ -0,0 +1,114 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "version": "2023-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all enabled features for a workspace", + "operationId": "WorkspaceFeatures_List", + "x-ms-examples": { + "List Workspace features": { + "$ref": "./examples/WorkspaceFeature/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$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" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListAmlUserFeatureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AmlUserFeature": { + "description": "Features enabled for a workspace", + "type": "object", + "properties": { + "id": { + "description": "Specifies the feature ID", + "type": "string" + }, + "displayName": { + "description": "Specifies the feature name ", + "type": "string" + }, + "description": { + "description": "Describes the feature for user experience", + "type": "string" + } + } + }, + "ListAmlUserFeatureResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlUserFeature" + }, + "description": "The list of AML user facing features." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + } + }, + "description": "The List Aml user feature operation response." + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json new file mode 100644 index 000000000000..4f5280261a58 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json @@ -0,0 +1,3661 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Services", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2023-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/providers/Microsoft.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "summary": "Lists all of the available Azure Machine Learning Workspaces REST API operations", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/AmlOperationListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/Workspace/operationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/Workspace/listBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "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": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + }, + { + "$ref": "#/parameters/WorkspaceKindParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/Workspace/listByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "delete": { + "tags": [ + "Workspaces" + ], + "summary": "Deletes a machine learning workspace.", + "operationId": "Workspaces_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/WorkspaceForceToPurgeParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/Workspace/delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Workspaces" + ], + "summary": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "summary": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "summary": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "get": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Lists all the available machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListWorkspaceConnections": { + "$ref": "./examples/WorkspaceConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { + "delete": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Delete machine learning workspaces connections by name.", + "operationId": "WorkspaceConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Lists machine learning workspaces connections by name.", + "operationId": "WorkspaceConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/get.json" + } + } + }, + "patch": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_Update", + "summary": "Update machine learning workspaces connections under the specified workspace.", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Parameters for workspace connection update.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/update.json" + } + } + }, + "put": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "summary": "Create or update machine learning workspaces connections under the specified workspace.", + "operationId": "WorkspaceConnections_Create", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The object for creating or updating a new workspace connection", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": { + "post": { + "tags": [ + "V2WorkspaceConnectionResource" + ], + "operationId": "WorkspaceConnections_ListSecrets", + "summary": "List all the secrets of a machine learning workspaces connections.", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/listSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameter of diagnosing workspace health", + "schema": { + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/DiagnoseResponseResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.", + "operationId": "Workspaces_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Get Azure Machine Learning Workspace notebook access token", + "operationId": "Workspaces_ListNotebookAccessToken", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookAccessTokenResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listNotebookAccessToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists keys of Azure Machine Learning Workspaces notebook.", + "operationId": "Workspaces_ListNotebookKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListNotebookKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Lists keys of Azure Machine Learning Workspace's storage account.", + "operationId": "Workspaces_ListStorageAccountKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListStorageAccountKeysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalFQDNResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": { + "get": { + "tags": [ + "ManagedNetwork" + ], + "summary": "Lists the managed network outbound rules for a machine learning workspace.", + "operationId": "ManagedNetworkSettingsRule_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/listRule.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": { + "delete": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Delete", + "summary": "Deletes an outbound rule from the managed network of a machine learning workspace.", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/deleteRule.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_Get", + "summary": "Gets an outbound rule from the managed network of a machine learning workspace.", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/getRule.json" + } + } + }, + "put": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkSettingsRule_CreateOrUpdate", + "summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/RuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate ManagedNetworkSettingsRule": { + "$ref": "./examples/ManagedNetwork/createOrUpdateRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Prepare Azure Machine Learning Workspace's notebook resource", + "operationId": "Workspaces_PrepareNotebook", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get all PE connections.", + "operationId": "PrivateEndpointConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to delete a PE connection.", + "operationId": "PrivateEndpointConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + } + }, + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to get a PE connection.", + "operationId": "PrivateEndpointConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.", + "operationId": "PrivateEndpointConnections_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "PrivateEndpointConnection object", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".", + "operationId": "PrivateLinkResources_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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork": { + "post": { + "tags": [ + "ManagedNetwork" + ], + "operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork", + "summary": "Provisions the managed network of a machine learning workspace.", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Managed Network Provisioning Options for a machine learning workspace.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionOptions" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Provision ManagedNetwork": { + "$ref": "./examples/ManagedNetwork/provision.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "summary": "Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "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": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/Workspace/resyncKeys.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AccessKeyAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionAccessKey" + } + }, + "x-ms-discriminator-value": "AccessKey" + }, + "AmlOperation": { + "description": "Azure Machine Learning team account REST API operation", + "type": "object", + "properties": { + "display": { + "description": "Gets or sets display name of operation", + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation applies to data-plane", + "type": "boolean" + }, + "name": { + "description": "Gets or sets operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "origin": { + "description": "The intended executor of the operation: user/system", + "type": "string" + } + } + }, + "AmlOperationListResult": { + "type": "object", + "description": "An array of operations supported by the resource provider.", + "properties": { + "value": { + "description": "Gets or sets list of AML team account operations supported by the\r\nAML team account resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/AmlOperation" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ApiKeyAuthWorkspaceConnectionProperties": { + "description": "This connection type covers the generic ApiKey auth connection categories, for examples:\r\nAzureOpenAI:\r\n Category:= AzureOpenAI\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {ApiBase}\r\n \r\nCognitiveService:\r\n Category:= CognitiveService\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= ServiceRegion={serviceRegion}\r\n \r\nCognitiveSearch:\r\n Category:= CognitiveSearch\r\n AuthType:= ApiKey (as type discriminator)\r\n Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\r\n Target:= {Endpoint}\r\n \r\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionApiKey" + } + }, + "x-ms-discriminator-value": "ApiKey" + }, + "ComputeRuntimeDto": { + "type": "object", + "properties": { + "sparkRuntimeVersion": { + "type": "string" + } + } + }, + "ConnectionAuthType": { + "description": "Authentication type of the connection target", + "enum": [ + "PAT", + "ManagedIdentity", + "UsernamePassword", + "None", + "SAS", + "ServicePrincipal", + "AccessKey", + "ApiKey", + "CustomKeys" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionAuthType", + "modelAsString": true + } + }, + "ConnectionCategory": { + "description": "Category of the connection", + "enum": [ + "PythonFeed", + "ContainerRegistry", + "Git", + "S3", + "Snowflake", + "AzureSqlDb", + "AzureSynapseAnalytics", + "AzureMySqlDb", + "AzurePostgresDb", + "ADLSGen2", + "Redis", + "ApiKey", + "AzureOpenAI", + "CognitiveSearch", + "CognitiveService", + "CustomKeys" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionCategory", + "modelAsString": true + } + }, + "CosmosDbSettings": { + "type": "object", + "properties": { + "collectionsThroughput": { + "format": "int32", + "type": "integer" + } + } + }, + "CustomKeys": { + "type": "object", + "description": "Custom Keys credential object", + "properties": { + "keys": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CustomKeysWorkspaceConnectionProperties": { + "description": "Category:= CustomKeys\r\nAuthType:= CustomKeys (as type discriminator)\r\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\r\nTarget:= {any value}\r\nUse Metadata property bag for ApiVersion and other metadata fields", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/CustomKeys" + } + }, + "x-ms-discriminator-value": "CustomKeys" + }, + "DiagnoseRequestProperties": { + "type": "object", + "properties": { + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": {} + }, + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": {} + }, + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": {} + }, + "keyVault": { + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": {} + }, + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": {} + }, + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": {} + }, + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": {} + }, + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": {} + }, + "udr": { + "description": "Setting for diagnosing user defined routing", + "type": "object", + "additionalProperties": {} + } + } + }, + "DiagnoseResponseResult": { + "type": "object", + "properties": { + "value": { + "type": "object", + "properties": { + "userDefinedRouteResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "networkSecurityRuleResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "resourceLockResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "dnsResolutionResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "storageAccountResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "keyVaultResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "containerRegistryResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "applicationInsightsResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + }, + "otherResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + }, + "x-ms-identifiers": [ + "message" + ] + } + } + } + } + }, + "DiagnoseResult": { + "type": "object", + "description": "Result of Diagnose", + "properties": { + "code": { + "description": "Code for workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "level": { + "description": "Level of workspace setup error", + "$ref": "#/definitions/DiagnoseResultLevel", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "message": { + "description": "Message of workspace setup error", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "DiagnoseResultLevel": { + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", + "description": "Level of workspace setup error", + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } + }, + "DiagnoseWorkspaceParameters": { + "description": "Parameters to diagnose a workspace", + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/DiagnoseRequestProperties" + } + } + }, + "EncryptionKeyVaultUpdateProperties": { + "required": [ + "keyIdentifier" + ], + "type": "object", + "properties": { + "keyIdentifier": { + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "EncryptionProperty": { + "required": [ + "keyVaultProperties", + "status" + ], + "type": "object", + "properties": { + "cosmosDbResourceId": { + "description": "The byok cosmosdb account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + }, + "identity": { + "description": "Identity to be used with the keyVault", + "$ref": "#/definitions/IdentityForCmk" + }, + "keyVaultProperties": { + "description": "KeyVault details to do the encryption", + "$ref": "#/definitions/KeyVaultProperties" + }, + "searchAccountResourceId": { + "description": "The byok search account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + }, + "status": { + "$ref": "#/definitions/EncryptionStatus" + }, + "storageAccountResourceId": { + "description": "The byok storage account that customer brings to store customer's data\r\nwith encryption", + "type": "string" + } + } + }, + "EncryptionStatus": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "EncryptionUpdateProperties": { + "required": [ + "keyVaultProperties" + ], + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionKeyVaultUpdateProperties" + } + } + }, + "ExternalFQDNResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointsPropertyBag" + }, + "x-ms-identifiers": [ + "/properties/category" + ] + } + } + }, + "FQDNEndpoint": { + "type": "object", + "properties": { + "domainName": { + "type": "string" + }, + "endpointDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointDetail" + }, + "x-ms-identifiers": [ + "port" + ] + } + } + }, + "FQDNEndpointDetail": { + "type": "object", + "properties": { + "port": { + "format": "int32", + "type": "integer" + } + } + }, + "FQDNEndpoints": { + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoint" + }, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "FQDNEndpointsPropertyBag": { + "type": "object", + "description": "Property bag for FQDN endpoints result", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpoints" + } + } + }, + "FeatureStoreSettings": { + "type": "object", + "properties": { + "computeRuntime": { + "$ref": "#/definitions/ComputeRuntimeDto" + }, + "offlineStoreConnectionName": { + "type": "string" + }, + "onlineStoreConnectionName": { + "type": "string" + } + } + }, + "FqdnOutboundRule": { + "type": "object", + "description": "FQDN Outbound Rule for the managed network of a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "type": "string" + } + }, + "x-ms-discriminator-value": "FQDN" + }, + "IdentityForCmk": { + "type": "object", + "description": "Identity object used for encryption.", + "properties": { + "userAssignedIdentity": { + "description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault", + "type": "string" + } + } + }, + "IsolationMode": { + "description": "Isolation mode for the managed network of a machine learning workspace.", + "enum": [ + "Disabled", + "AllowInternetOutbound", + "AllowOnlyApprovedOutbound" + ], + "type": "string", + "x-ms-enum": { + "name": "IsolationMode", + "modelAsString": true + } + }, + "KeyVaultProperties": { + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object", + "description": "Customer Key vault properties.", + "properties": { + "identityClientId": { + "description": "Currently, we support only SystemAssigned MSI.\r\nWe need this when we support UserAssignedIdentities", + "type": "string" + }, + "keyIdentifier": { + "description": "KeyVault key identifier to encrypt the data", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + }, + "keyVaultArmId": { + "description": "KeyVault Arm Id that contains the data encryption key", + "minLength": 1, + "pattern": "[a-zA-Z0-9_]", + "type": "string" + } + } + }, + "ListNotebookKeysResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "description": "The primary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "secondaryAccessKey": { + "description": "The secondary access key of the Notebook", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ListStorageAccountKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "description": "The access key of the storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "appInsightsInstrumentationKey": { + "description": "The access key of the workspace app insights", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "containerRegistryCredentials": { + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "$ref": "#/definitions/ListNotebookKeysResult" + }, + "userStorageArmId": { + "description": "The arm Id key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "userStorageKey": { + "description": "The access key of the workspace storage", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "ManagedIdentityAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionManagedIdentity" + } + }, + "x-ms-discriminator-value": "ManagedIdentity" + }, + "ManagedNetworkProvisionOptions": { + "description": "Managed Network Provisioning options for managed network of a machine learning workspace.", + "type": "object", + "properties": { + "includeSpark": { + "type": "boolean" + } + } + }, + "ManagedNetworkProvisionStatus": { + "description": "Status of the Provisioning for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "sparkReady": { + "type": "boolean" + }, + "status": { + "$ref": "#/definitions/ManagedNetworkStatus" + } + } + }, + "ManagedNetworkSettings": { + "description": "Managed Network settings for a machine learning workspace.", + "type": "object", + "properties": { + "isolationMode": { + "$ref": "#/definitions/IsolationMode" + }, + "networkId": { + "type": "string", + "readOnly": true + }, + "outboundRules": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/OutboundRule" + }, + "x-nullable": true + }, + "status": { + "$ref": "#/definitions/ManagedNetworkProvisionStatus" + } + } + }, + "ManagedNetworkStatus": { + "description": "Status for the managed network of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedNetworkStatus", + "modelAsString": true + } + }, + "NoneAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "x-ms-discriminator-value": "None" + }, + "NotebookAccessTokenResult": { + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "expiresIn": { + "format": "int32", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "hostName": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "notebookResourceId": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicDns": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "refreshToken": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "scope": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "tokenType": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "NotebookPreparationError": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "NotebookResourceInfo": { + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "isPrivateLinkEnabled": { + "type": "boolean" + }, + "notebookPreparationError": { + "description": "The error that occurs when preparing notebook.", + "$ref": "#/definitions/NotebookPreparationError" + }, + "resourceId": { + "description": "the data plane resourceId that used to initialize notebook component", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "Display name of operation", + "type": "object", + "properties": { + "description": { + "description": "Gets or sets the description for the operation.", + "type": "string" + }, + "operation": { + "description": "Gets or sets the operation that users can perform.", + "type": "string" + }, + "provider": { + "description": "Gets or sets the resource provider name:\r\nMicrosoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "Gets or sets the resource on which the operation is performed.", + "type": "string" + } + } + }, + "OutboundRule": { + "description": "Outbound Rule for the managed network of a machine learning workspace.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/RuleCategory" + }, + "status": { + "$ref": "#/definitions/RuleStatus" + }, + "type": { + "$ref": "#/definitions/RuleType" + } + }, + "discriminator": "type" + }, + "OutboundRuleBasicResource": { + "description": "Outbound Rule Basic Resource for the managed network of a machine learning workspace.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OutboundRule" + } + } + }, + "OutboundRuleListResult": { + "description": "List of outbound rules for the managed network of a machine learning workspace.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRuleBasicResource" + } + } + } + }, + "PATAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken" + } + }, + "x-ms-discriminator-value": "PAT" + }, + "Password": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + }, + "value": { + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-secret": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "The Private Endpoint Connection resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", + "type": "string" + }, + "properties": { + "description": "Private endpoint connection properties.", + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "List of private endpoint connection associated with the specified workspace", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/WorkspacePrivateEndpointResource" + }, + "privateLinkServiceConnectionState": { + "description": "The connection state.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" + } + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateEndpointDestination": { + "type": "object", + "description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "properties": { + "serviceResourceId": { + "type": "string" + }, + "sparkEnabled": { + "type": "boolean" + }, + "sparkStatus": { + "$ref": "#/definitions/RuleStatus" + }, + "subresourceTarget": { + "type": "string" + } + } + }, + "PrivateEndpointOutboundRule": { + "description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/PrivateEndpointDestination" + } + }, + "x-ms-discriminator-value": "PrivateEndpoint" + }, + "PrivateEndpointServiceConnectionStatus": { + "description": "Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection)", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A private link resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "description": "Same as workspace location.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of a private link resource.", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "A collection of information about the state of the connection between service consumer and provider.", + "properties": { + "actionsRequired": { + "description": "Some RP chose \"None\". Other RPs use this for region expansion.", + "type": "string" + }, + "description": { + "description": "User-defined message that, per NRP doc, may be used for approval-related message.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + } + } + }, + "ProvisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "PublicNetworkAccessType": { + "description": "The public network access flag.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "description": "The location of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "username": { + "description": "The username of the workspace ACR", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "RuleAction": { + "description": "The action enum for networking rule.", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleAction", + "modelAsString": true + } + }, + "RuleCategory": { + "description": "Category of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Required", + "Recommended", + "UserDefined" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleCategory", + "modelAsString": true + } + }, + "RuleStatus": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true + } + }, + "RuleType": { + "description": "Type of a managed network Outbound Rule of a machine learning workspace.", + "enum": [ + "FQDN", + "PrivateEndpoint", + "ServiceTag" + ], + "type": "string", + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "SASAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature" + } + }, + "x-ms-discriminator-value": "SAS" + }, + "ServiceManagedResourcesSettings": { + "type": "object", + "properties": { + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings" + } + } + }, + "ServicePrincipalAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionServicePrincipal" + } + }, + "x-ms-discriminator-value": "ServicePrincipal" + }, + "ServiceTagDestination": { + "type": "object", + "description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "properties": { + "action": { + "$ref": "#/definitions/RuleAction" + }, + "addressPrefixes": { + "description": "Optional, if provided, the ServiceTag property will be ignored.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "portRanges": { + "type": "string" + }, + "protocol": { + "type": "string" + }, + "serviceTag": { + "type": "string" + } + } + }, + "ServiceTagOutboundRule": { + "type": "object", + "description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/OutboundRule" + } + ], + "properties": { + "destination": { + "$ref": "#/definitions/ServiceTagDestination" + } + }, + "x-ms-discriminator-value": "ServiceTag" + }, + "SharedPrivateLinkResource": { + "type": "object", + "properties": { + "name": { + "description": "Unique name of the private link", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true + } + } + }, + "SharedPrivateLinkResourceProperty": { + "type": "object", + "description": "Properties of a shared private link resource.", + "properties": { + "groupId": { + "description": "group id of the private link", + "type": "string" + }, + "privateLinkResourceId": { + "description": "the resource id that private link links to", + "type": "string" + }, + "requestMessage": { + "description": "Request message", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + } + } + }, + "UsernamePasswordAuthTypeWorkspaceConnectionProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + ], + "properties": { + "credentials": { + "$ref": "#/definitions/WorkspaceConnectionUsernamePassword" + } + }, + "x-ms-discriminator-value": "UsernamePassword" + }, + "Workspace": { + "required": [ + "properties" + ], + "type": "object", + "description": "An object that represents a machine learning workspace.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "kind": { + "type": "string" + }, + "location": { + "type": "string" + }, + "properties": { + "description": "Additional attributes of the entity.", + "$ref": "#/definitions/WorkspaceProperties", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WorkspaceConnectionAccessKey": { + "type": "object", + "properties": { + "accessKeyId": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + } + } + }, + "WorkspaceConnectionApiKey": { + "type": "object", + "description": "Api key object for workspace connection credential.", + "properties": { + "key": { + "type": "string" + } + } + }, + "WorkspaceConnectionManagedIdentity": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "resourceId": { + "type": "string" + } + } + }, + "WorkspaceConnectionPersonalAccessToken": { + "type": "object", + "properties": { + "pat": { + "type": "string" + } + } + }, + "WorkspaceConnectionPropertiesV2": { + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "Authentication type of the connection target", + "$ref": "#/definitions/ConnectionAuthType" + }, + "category": { + "description": "Category of the connection", + "$ref": "#/definitions/ConnectionCategory" + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "target": { + "type": "string" + } + }, + "discriminator": "authType" + }, + "WorkspaceConnectionPropertiesV2BasicResource": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + } + }, + "WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": { + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource" + } + } + } + }, + "WorkspaceConnectionServicePrincipal": { + "type": "object", + "properties": { + "clientId": { + "type": "string" + }, + "clientSecret": { + "type": "string" + }, + "tenantId": { + "type": "string" + } + } + }, + "WorkspaceConnectionSharedAccessSignature": { + "type": "object", + "properties": { + "sas": { + "type": "string" + } + } + }, + "WorkspaceConnectionUpdateParameter": { + "type": "object", + "description": "The properties that the machine learning workspace connection will be updated with.", + "properties": { + "properties": { + "description": "The properties that the machine learning workspace connection will be updated with.", + "$ref": "#/definitions/WorkspaceConnectionPropertiesV2" + } + } + }, + "WorkspaceConnectionUsernamePassword": { + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "WorkspaceHubConfig": { + "type": "object", + "description": "WorkspaceHub's configuration object.", + "properties": { + "additionalWorkspaceStorageAccounts": { + "type": "array", + "items": { + "type": "string" + } + }, + "defaultWorkspaceResourceGroup": { + "type": "string" + } + } + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page constructed using the continuationToken. If null, there are no additional pages.", + "type": "string" + }, + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + } + } + }, + "WorkspacePrivateEndpointResource": { + "type": "object", + "description": "The Private Endpoint resource.", + "properties": { + "id": { + "description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "subnetArmId": { + "description": "The subnetId that the private endpoint is connected to.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "WorkspaceProperties": { + "description": "The properties of a machine learning workspace.", + "type": "object", + "properties": { + "allowPublicAccessWhenBehindVnet": { + "description": "The flag to indicate whether to allow public access when behind VNet.", + "type": "boolean" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "associatedWorkspaces": { + "type": "array", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "type": "array", + "items": { + "type": "string" + } + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty" + }, + "existingWorkspaces": { + "type": "array", + "items": { + "type": "string" + } + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "hbiWorkspace": { + "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", + "type": "boolean" + }, + "hubResourceId": { + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "keyVaults": { + "type": "array", + "items": { + "type": "string" + } + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "mlFlowTrackingUri": { + "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "notebookInfo": { + "description": "The notebook info of Azure ML workspace.", + "$ref": "#/definitions/NotebookResourceInfo", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections in the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "x-ms-identifiers": [ + "name" + ] + }, + "privateLinkCount": { + "format": "int32", + "description": "Count of private connections in the workspace", + "type": "integer", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "provisioningState": { + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" + }, + "serviceProvisionedResourceGroup": { + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources in this workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "softDeleteRetentionInDays": { + "format": "int32", + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "storageAccounts": { + "type": "array", + "items": { + "type": "string" + } + }, + "storageHnsEnabled": { + "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", + "type": "boolean", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "systemDatastoresAuthMode": { + "description": "The auth mode used for accessing the system datastores of the workspace.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" + }, + "workspaceHubConfig": { + "$ref": "#/definitions/WorkspaceHubConfig" + }, + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true, + "x-ms-mutability": [ + "read" + ] + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "type": "object", + "properties": { + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace.", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace.", + "type": "string" + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "enableDataIsolation": { + "type": "boolean" + }, + "encryption": { + "$ref": "#/definitions/EncryptionUpdateProperties" + }, + "featureStoreSettings": { + "description": "Settings for feature store type workspace.", + "$ref": "#/definitions/FeatureStoreSettings" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "managedNetwork": { + "$ref": "#/definitions/ManagedNetworkSettings" + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "serviceManagedResourcesSettings": { + "description": "The service managed resource settings.", + "$ref": "#/definitions/ServiceManagedResourcesSettings" + }, + "softDeleteRetentionInDays": { + "format": "int32", + "description": "Retention time in days after workspace get soft deleted.", + "type": "integer" + }, + "v1LegacyMode": { + "description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.", + "type": "boolean" + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "The properties that the machine learning workspace will be updated with.", + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "x-ms-client-flatten": true + }, + "sku": { + "description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "WorkspaceKindParameter": { + "in": "query", + "name": "kind", + "description": "Kind of workspace.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "in": "path", + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "WorkspaceForceToPurgeParameter": { + "in": "query", + "name": "forceToPurge", + "description": "Flag to indicate delete is a purge request.", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "description": "Target of the workspace connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "description": "Category of the workspace connection.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "in": "path", + "name": "connectionName", + "description": "Friendly name of the workspace connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "RuleName": { + "in": "path", + "name": "ruleName", + "description": "Name of the workspace managed network outbound rule", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$" + }, + "PrivateEndpointConnectionName": { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "NRP Private Endpoint Connection Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index 2d78ecf43bad..7aa94dc3eef6 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -26,33 +26,46 @@ These are the global settings for the Machine Learning Services API. ``` yaml openapi-type: arm - -tag: package-2023-04 +tag: package-preview-2023-06 ``` +### Tag: package-preview-2023-06 + +These settings apply only when `--tag=package-preview-2023-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-06' +input-file: + - Microsoft.MachineLearningServices/preview/2023-06-01-preview/machineLearningServices.json + - Microsoft.MachineLearningServices/preview/2023-06-01-preview/mfe.json + - Microsoft.MachineLearningServices/preview/2023-06-01-preview/registries.json + - Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceFeatures.json + - Microsoft.MachineLearningServices/preview/2023-06-01-preview/workspaceRP.json +``` ### Tag: package-2023-04 These settings apply only when `--tag=package-2023-04` is specified on the command line. -```yaml $(tag) == 'package-2023-04' +``` yaml $(tag) == 'package-2023-04' input-file: - Microsoft.MachineLearningServices/stable/2023-04-01/machineLearningServices.json - Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json - Microsoft.MachineLearningServices/stable/2023-04-01/registries.json - Microsoft.MachineLearningServices/stable/2023-04-01/workspaceFeatures.json ``` + ### Tag: package-preview-2023-04 These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-04' +``` yaml $(tag) == 'package-preview-2023-04' input-file: - Microsoft.MachineLearningServices/preview/2023-04-01-preview/machineLearningServices.json - Microsoft.MachineLearningServices/preview/2023-04-01-preview/mfe.json - Microsoft.MachineLearningServices/preview/2023-04-01-preview/registries.json - Microsoft.MachineLearningServices/preview/2023-04-01-preview/workspaceFeatures.json ``` + ### Tag: package-preview-2023-02 These settings apply only when `--tag=package-preview-2023-02` is specified on the command line. @@ -363,4 +376,4 @@ See configuration in [readme.go.md](./readme.go.md) ## Java -See configuration in [readme.java.md](./readme.java.md) +See configuration in [readme.java.md](./readme.java.md) \ No newline at end of file