diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json
index e46c592dda02..1b4f163670f0 100644
--- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json
+++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json
@@ -9,38 +9,29 @@
"https"
],
"paths": {
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": {
- "put": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": {
+ "get": {
"tags": [
- "BatchDeployment"
- ],
- "summary": "Creates/updates a batch inference deployment.",
- "operationId": "BatchDeployments_CreateOrUpdate",
- "consumes": [
- "application/json"
+ "BatchEndpoint"
],
+ "summary": "Lists Batch inference endpoint in the workspace.",
+ "operationId": "BatchEndpoints_List",
"produces": [
"application/json"
],
"parameters": [
{
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name",
- "required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "in": "path",
- "name": "deploymentName",
- "description": "The identifier for the Batch inference deployment.",
- "required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "in": "query",
+ "name": "count",
+ "description": "Number of endpoints to be retrieved in a page of results.",
+ "type": "integer",
+ "format": "int32"
},
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -50,15 +41,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Batch inference deployment definition object.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
- }
}
],
"responses": {
@@ -71,31 +53,27 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
- }
- },
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
+ "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "CreateOrUpdate Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/createOrUpdate.json"
+ "List Batch Endpoint.": {
+ "$ref": "./examples/BatchEndpoint/list.json"
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
}
- },
- "patch": {
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": {
+ "delete": {
"tags": [
- "BatchDeployment"
- ],
- "summary": "Update a batch inference deployment.",
- "operationId": "BatchDeployments_Update",
- "consumes": [
- "application/json"
+ "BatchEndpoint"
],
+ "summary": "Delete Batch Inference Endpoint.",
+ "operationId": "BatchEndpoints_Delete",
"produces": [
"application/json"
],
@@ -103,18 +81,59 @@
{
"in": "path",
"name": "endpointName",
- "description": "Inference endpoint name",
+ "description": "Inference Endpoint name.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Success"
},
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "x-ms-examples": {
+ "Delete Batch Endpoint.": {
+ "$ref": "./examples/BatchEndpoint/delete.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "BatchEndpoint"
+ ],
+ "summary": "Gets a batch inference endpoint by name.",
+ "operationId": "BatchEndpoints_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
{
"in": "path",
- "name": "deploymentName",
- "description": "The identifier for the Batch inference deployment.",
+ "name": "endpointName",
+ "description": "Name for the Batch Endpoint.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -127,15 +146,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Batch inference deployment definition object.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/PartialBatchDeploymentPartialTrackedResource"
- }
}
],
"responses": {
@@ -148,22 +158,25 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
+ "$ref": "#/definitions/BatchEndpointTrackedResource"
}
}
},
"x-ms-examples": {
- "Update Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/update.json"
+ "Get Batch Endpoint.": {
+ "$ref": "./examples/BatchEndpoint/get.json"
}
}
},
- "get": {
+ "patch": {
"tags": [
- "BatchDeployment"
+ "BatchEndpoint"
+ ],
+ "summary": "Update a batch inference endpoint.",
+ "operationId": "BatchEndpoints_Update",
+ "consumes": [
+ "application/json"
],
- "summary": "Gets a batch inference deployment by id.",
- "operationId": "BatchDeployments_Get",
"produces": [
"application/json"
],
@@ -171,16 +184,10 @@
{
"in": "path",
"name": "endpointName",
- "description": "Endpoint name",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "The identifier for the Batch deployments.",
+ "description": "Name for the Batch inference endpoint.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -193,6 +200,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Mutable batch inference endpoint definition object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartialBatchEndpointPartialTrackedResource"
+ }
}
],
"responses": {
@@ -205,22 +221,25 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
+ "$ref": "#/definitions/BatchEndpointTrackedResource"
}
}
},
"x-ms-examples": {
- "Get Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/get.json"
+ "Update Batch Endpoint.": {
+ "$ref": "./examples/BatchEndpoint/update.json"
}
}
},
- "delete": {
+ "put": {
"tags": [
- "BatchDeployment"
+ "BatchEndpoint"
+ ],
+ "summary": "Creates a batch inference endpoint.",
+ "operationId": "BatchEndpoints_CreateOrUpdate",
+ "consumes": [
+ "application/json"
],
- "summary": "Delete Batch Inference deployment.",
- "operationId": "BatchDeployments_Delete",
"produces": [
"application/json"
],
@@ -228,16 +247,10 @@
{
"in": "path",
"name": "endpointName",
- "description": "Endpoint name",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Inference deployment identifier.",
+ "description": "Name for the Batch inference endpoint.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -250,6 +263,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Batch inference endpoint definition object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BatchEndpointTrackedResource"
+ }
}
],
"responses": {
@@ -260,15 +282,21 @@
}
},
"200": {
- "description": "Success"
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/BatchEndpointTrackedResource"
+ }
},
- "204": {
- "description": "No Content"
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BatchEndpointTrackedResource"
+ }
}
},
"x-ms-examples": {
- "Delete Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/delete.json"
+ "CreateOrUpdate Batch Endpoint.": {
+ "$ref": "./examples/BatchEndpoint/createOrUpdate.json"
}
}
}
@@ -344,16 +372,13 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": {
- "put": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": {
+ "delete": {
"tags": [
- "BatchEndpoint"
- ],
- "summary": "Creates a batch inference endpoint.",
- "operationId": "BatchEndpoints_CreateOrUpdate",
- "consumes": [
- "application/json"
+ "BatchDeployment"
],
+ "summary": "Delete Batch Inference deployment.",
+ "operationId": "BatchDeployments_Delete",
"produces": [
"application/json"
],
@@ -361,10 +386,16 @@
{
"in": "path",
"name": "endpointName",
- "description": "Name for the Batch inference endpoint.",
+ "description": "Endpoint name",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "deploymentName",
+ "description": "Inference deployment identifier.",
+ "required": true,
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -377,15 +408,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Batch inference endpoint definition object.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
}
],
"responses": {
@@ -396,33 +418,24 @@
}
},
"200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
+ "description": "Success"
},
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "CreateOrUpdate Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/createOrUpdate.json"
+ "Delete Batch Deployment.": {
+ "$ref": "./examples/BatchDeployment/delete.json"
}
}
},
- "patch": {
+ "get": {
"tags": [
- "BatchEndpoint"
- ],
- "summary": "Update a batch inference endpoint.",
- "operationId": "BatchEndpoints_Update",
- "consumes": [
- "application/json"
+ "BatchDeployment"
],
+ "summary": "Gets a batch inference deployment by id.",
+ "operationId": "BatchDeployments_Get",
"produces": [
"application/json"
],
@@ -430,10 +443,16 @@
{
"in": "path",
"name": "endpointName",
- "description": "Name for the Batch inference endpoint.",
+ "description": "Endpoint name",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "deploymentName",
+ "description": "The identifier for the Batch deployments.",
+ "required": true,
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -446,15 +465,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Mutable batch inference endpoint definition object.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/PartialBatchEndpointPartialTrackedResource"
- }
}
],
"responses": {
@@ -467,22 +477,25 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
+ "$ref": "#/definitions/BatchDeploymentTrackedResource"
}
}
},
"x-ms-examples": {
- "Update Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/update.json"
+ "Get Batch Deployment.": {
+ "$ref": "./examples/BatchDeployment/get.json"
}
}
},
- "get": {
+ "patch": {
"tags": [
- "BatchEndpoint"
+ "BatchDeployment"
+ ],
+ "summary": "Update a batch inference deployment.",
+ "operationId": "BatchDeployments_Update",
+ "consumes": [
+ "application/json"
],
- "summary": "Gets a batch inference endpoint by name.",
- "operationId": "BatchEndpoints_Get",
"produces": [
"application/json"
],
@@ -490,9 +503,18 @@
{
"in": "path",
"name": "endpointName",
- "description": "Name for the Batch Endpoint.",
+ "description": "Inference endpoint name",
"required": true,
- "type": "string"
+ "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/v2/types.json#/parameters/ApiVersionParameter"
@@ -505,6 +527,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Batch inference deployment definition object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PartialBatchDeploymentPartialTrackedResource"
+ }
}
],
"responses": {
@@ -517,22 +548,25 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
+ "$ref": "#/definitions/BatchDeploymentTrackedResource"
}
}
},
"x-ms-examples": {
- "Get Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/get.json"
+ "Update Batch Deployment.": {
+ "$ref": "./examples/BatchDeployment/update.json"
}
}
},
- "delete": {
+ "put": {
"tags": [
- "BatchEndpoint"
+ "BatchDeployment"
+ ],
+ "summary": "Creates/updates a batch inference deployment.",
+ "operationId": "BatchDeployments_CreateOrUpdate",
+ "consumes": [
+ "application/json"
],
- "summary": "Delete Batch Inference Endpoint.",
- "operationId": "BatchEndpoints_Delete",
"produces": [
"application/json"
],
@@ -540,9 +574,18 @@
{
"in": "path",
"name": "endpointName",
- "description": "Inference Endpoint name.",
+ "description": "Inference endpoint name",
"required": true,
- "type": "string"
+ "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/v2/types.json#/parameters/ApiVersionParameter"
@@ -555,6 +598,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Batch inference deployment definition object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BatchDeploymentTrackedResource"
+ }
}
],
"responses": {
@@ -565,42 +617,45 @@
}
},
"200": {
- "description": "Success"
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/BatchDeploymentTrackedResource"
+ }
},
- "204": {
- "description": "No Content"
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BatchDeploymentTrackedResource"
+ }
}
},
"x-ms-examples": {
- "Delete Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/delete.json"
+ "CreateOrUpdate Batch Deployment.": {
+ "$ref": "./examples/BatchDeployment/createOrUpdate.json"
}
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": {
- "get": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": {
+ "post": {
"tags": [
"BatchEndpoint"
],
- "summary": "Lists Batch inference endpoint in the workspace.",
- "operationId": "BatchEndpoints_List",
+ "summary": "Lists batch Inference Endpoint keys.",
+ "operationId": "BatchEndpoints_ListKeys",
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
- },
- {
- "in": "query",
- "name": "count",
- "description": "Number of endpoints to be retrieved in a page of results.",
- "type": "integer",
- "format": "int32"
+ "in": "path",
+ "name": "endpointName",
+ "description": "Inference Endpoint name.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -622,40 +677,33 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult"
+ "$ref": "#/definitions/EndpointAuthKeys"
}
}
},
"x-ms-examples": {
- "List Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/list.json"
+ "ListKeys Batch Endpoint.": {
+ "$ref": "./examples/BatchEndpoint/listKeys.json"
}
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": {
- "post": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": {
+ "get": {
"tags": [
- "BatchEndpoint"
+ "CodeContainer"
],
- "summary": "Lists batch Inference Endpoint keys.",
- "operationId": "BatchEndpoints_ListKeys",
+ "summary": "List containers.",
+ "operationId": "CodeContainers_List",
"produces": [
"application/json"
],
"parameters": [
{
- "in": "path",
- "name": "endpointName",
- "description": "Inference Endpoint name.",
- "required": true,
- "type": "string"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -677,27 +725,27 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/EndpointAuthKeys"
+ "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "ListKeys Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/listKeys.json"
+ "List Code Container.": {
+ "$ref": "./examples/CodeContainer/list.json"
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": {
- "put": {
+ "delete": {
"tags": [
"CodeContainer"
],
- "summary": "Create or update container.",
- "operationId": "CodeContainers_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
+ "summary": "Delete container.",
+ "operationId": "CodeContainers_Delete",
"produces": [
"application/json"
],
@@ -707,8 +755,7 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -721,15 +768,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Container entity to create or update.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CodeContainerResource"
- }
}
],
"responses": {
@@ -740,21 +778,15 @@
}
},
"200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeContainerResource"
- }
+ "description": "Success"
},
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/CodeContainerResource"
- }
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "CreateOrUpdate Code Container.": {
- "$ref": "./examples/CodeContainer/createOrUpdate.json"
+ "Delete Code Container.": {
+ "$ref": "./examples/CodeContainer/delete.json"
}
}
},
@@ -808,12 +840,15 @@
}
}
},
- "delete": {
+ "put": {
"tags": [
"CodeContainer"
],
- "summary": "Delete container.",
- "operationId": "CodeContainers_Delete",
+ "summary": "Create or update container.",
+ "operationId": "CodeContainers_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
@@ -823,7 +858,8 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -836,6 +872,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Container entity to create or update.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CodeContainerResource"
+ }
}
],
"responses": {
@@ -846,33 +891,59 @@
}
},
"200": {
- "description": "Success"
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/CodeContainerResource"
+ }
},
- "204": {
- "description": "No Content"
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/CodeContainerResource"
+ }
}
},
"x-ms-examples": {
- "Delete Code Container.": {
- "$ref": "./examples/CodeContainer/delete.json"
+ "CreateOrUpdate Code Container.": {
+ "$ref": "./examples/CodeContainer/createOrUpdate.json"
}
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": {
"get": {
"tags": [
- "CodeContainer"
+ "CodeVersion"
],
- "summary": "List containers.",
- "operationId": "CodeContainers_List",
+ "summary": "List versions.",
+ "operationId": "CodeVersions_List",
"produces": [
"application/json"
],
"parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "Container name.",
+ "required": true,
+ "type": "string"
+ },
{
"$ref": "../../../../../common-types/resource-management/v2/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"
},
@@ -896,13 +967,13 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult"
+ "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "List Code Container.": {
- "$ref": "./examples/CodeContainer/list.json"
+ "List Code Version.": {
+ "$ref": "./examples/CodeVersion/list.json"
}
},
"x-ms-pageable": {
@@ -911,15 +982,12 @@
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": {
- "put": {
+ "delete": {
"tags": [
"CodeVersion"
],
- "summary": "Create or update version.",
- "operationId": "CodeVersions_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
+ "summary": "Delete version.",
+ "operationId": "CodeVersions_Delete",
"produces": [
"application/json"
],
@@ -929,8 +997,7 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
},
{
"in": "path",
@@ -950,15 +1017,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Version entity to create or update.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CodeVersionResource"
- }
}
],
"responses": {
@@ -969,21 +1027,15 @@
}
},
"200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeVersionResource"
- }
+ "description": "Success"
},
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/CodeVersionResource"
- }
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "CreateOrUpdate Code Version.": {
- "$ref": "./examples/CodeVersion/createOrUpdate.json"
+ "Delete Code Version.": {
+ "$ref": "./examples/CodeVersion/delete.json"
}
}
},
@@ -1044,12 +1096,15 @@
}
}
},
- "delete": {
+ "put": {
"tags": [
"CodeVersion"
],
- "summary": "Delete version.",
- "operationId": "CodeVersions_Delete",
+ "summary": "Create or update version.",
+ "operationId": "CodeVersions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
@@ -1059,7 +1114,8 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"in": "path",
@@ -1079,6 +1135,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Version entity to create or update.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CodeVersionResource"
+ }
}
],
"responses": {
@@ -1089,53 +1154,39 @@
}
},
"200": {
- "description": "Success"
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/CodeVersionResource"
+ }
},
- "204": {
- "description": "No Content"
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/CodeVersionResource"
+ }
}
},
"x-ms-examples": {
- "Delete Code Version.": {
- "$ref": "./examples/CodeVersion/delete.json"
+ "CreateOrUpdate Code Version.": {
+ "$ref": "./examples/CodeVersion/createOrUpdate.json"
}
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": {
"get": {
"tags": [
- "CodeVersion"
+ "DataContainer"
],
- "summary": "List versions.",
- "operationId": "CodeVersions_List",
+ "summary": "List containers.",
+ "operationId": "DataContainers_List",
"produces": [
"application/json"
],
"parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
{
"$ref": "../../../../../common-types/resource-management/v2/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"
},
@@ -1159,13 +1210,13 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult"
+ "$ref": "#/definitions/DataContainerResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "List Code Version.": {
- "$ref": "./examples/CodeVersion/list.json"
+ "List Data Container.": {
+ "$ref": "./examples/DataContainer/list.json"
}
},
"x-ms-pageable": {
@@ -1174,15 +1225,12 @@
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": {
- "put": {
+ "delete": {
"tags": [
"DataContainer"
],
- "summary": "Create or update container.",
- "operationId": "DataContainers_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
+ "summary": "Delete container.",
+ "operationId": "DataContainers_Delete",
"produces": [
"application/json"
],
@@ -1192,8 +1240,7 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -1206,15 +1253,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Container entity to create or update.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DataContainerResource"
- }
}
],
"responses": {
@@ -1225,21 +1263,15 @@
}
},
"200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataContainerResource"
- }
+ "description": "Success"
},
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/DataContainerResource"
- }
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "CreateOrUpdate Data Container.": {
- "$ref": "./examples/DataContainer/createOrUpdate.json"
+ "Delete Data Container.": {
+ "$ref": "./examples/DataContainer/delete.json"
}
}
},
@@ -1293,12 +1325,15 @@
}
}
},
- "delete": {
+ "put": {
"tags": [
"DataContainer"
],
- "summary": "Delete container.",
- "operationId": "DataContainers_Delete",
+ "summary": "Create or update container.",
+ "operationId": "DataContainers_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
@@ -1308,7 +1343,8 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -1321,6 +1357,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Container entity to create or update.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataContainerResource"
+ }
}
],
"responses": {
@@ -1331,36 +1376,68 @@
}
},
"200": {
- "description": "Success"
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DataContainerResource"
+ }
},
- "204": {
- "description": "No Content"
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/DataContainerResource"
+ }
}
},
"x-ms-examples": {
- "Delete Data Container.": {
- "$ref": "./examples/DataContainer/delete.json"
+ "CreateOrUpdate Data Container.": {
+ "$ref": "./examples/DataContainer/createOrUpdate.json"
}
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": {
"get": {
"tags": [
- "DataContainer"
+ "DataVersion"
],
- "summary": "List containers.",
- "operationId": "DataContainers_List",
+ "summary": "List data versions.",
+ "operationId": "DataVersions_List",
"produces": [
"application/json"
],
"parameters": [
+ {
+ "in": "path",
+ "name": "name",
+ "description": "Data name.",
+ "required": true,
+ "type": "string"
+ },
{
"$ref": "../../../../../common-types/resource-management/v2/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": "$tags",
+ "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
+ "type": "string"
+ },
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
@@ -1381,13 +1458,13 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/DataContainerResourceArmPaginatedResult"
+ "$ref": "#/definitions/DataVersionResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "List Data Container.": {
- "$ref": "./examples/DataContainer/list.json"
+ "List Data Version.": {
+ "$ref": "./examples/DataVersion/list.json"
}
},
"x-ms-pageable": {
@@ -1395,6 +1472,198 @@
}
}
},
+ "/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": [
+ {
+ "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/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Success"
+ },
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "x-ms-examples": {
+ "Delete Data Version.": {
+ "$ref": "./examples/DataVersion/delete.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "DataVersion"
+ ],
+ "summary": "Get version.",
+ "operationId": "DataVersions_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "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/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DataVersionResource"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Data Version.": {
+ "$ref": "./examples/DataVersion/get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DataVersion"
+ ],
+ "summary": "Create or update version.",
+ "operationId": "DataVersions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "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/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Version entity to create or update.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataVersionResource"
+ }
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DataVersionResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/DataVersionResource"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CreateOrUpdate Data Version.": {
+ "$ref": "./examples/DataVersion/createOrUpdate.json"
+ }
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": {
"get": {
"tags": [
@@ -1734,49 +2003,23 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": {
"get": {
"tags": [
- "DataVersion"
+ "EnvironmentContainer"
],
- "summary": "List data versions.",
- "operationId": "DataVersions_List",
+ "summary": "List containers.",
+ "operationId": "EnvironmentContainers_List",
"produces": [
"application/json"
],
"parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Data name.",
- "required": true,
- "type": "string"
- },
{
"$ref": "../../../../../common-types/resource-management/v2/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": "$tags",
- "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
- "type": "string"
- },
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
@@ -1797,30 +2040,27 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/DataVersionResourceArmPaginatedResult"
+ "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "List Data Version.": {
- "$ref": "./examples/DataVersion/list.json"
- }
+ "List Environment Container.": {
+ "$ref": "./examples/EnvironmentContainer/list.json"
+ }
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": {
- "put": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": {
+ "delete": {
"tags": [
- "DataVersion"
- ],
- "summary": "Create or update version.",
- "operationId": "DataVersions_CreateOrUpdate",
- "consumes": [
- "application/json"
+ "EnvironmentContainer"
],
+ "summary": "Delete container.",
+ "operationId": "EnvironmentContainers_Delete",
"produces": [
"application/json"
],
@@ -1830,14 +2070,6 @@
"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"
},
{
@@ -1851,15 +2083,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Version entity to create or update.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DataVersionResource"
- }
}
],
"responses": {
@@ -1870,30 +2093,24 @@
}
},
"200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataVersionResource"
- }
+ "description": "Success"
},
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/DataVersionResource"
- }
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "CreateOrUpdate Data Version.": {
- "$ref": "./examples/DataVersion/createOrUpdate.json"
+ "Delete Environment Container.": {
+ "$ref": "./examples/EnvironmentContainer/delete.json"
}
}
},
"get": {
"tags": [
- "DataVersion"
+ "EnvironmentContainer"
],
- "summary": "Get version.",
- "operationId": "DataVersions_Get",
+ "summary": "Get container.",
+ "operationId": "EnvironmentContainers_Get",
"produces": [
"application/json"
],
@@ -1905,13 +2122,6 @@
"required": true,
"type": "string"
},
- {
- "in": "path",
- "name": "version",
- "description": "Version identifier.",
- "required": true,
- "type": "string"
- },
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
@@ -1935,75 +2145,16 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/DataVersionResource"
+ "$ref": "#/definitions/EnvironmentContainerResource"
}
}
},
"x-ms-examples": {
- "Get Data Version.": {
- "$ref": "./examples/DataVersion/get.json"
+ "Get Environment Container.": {
+ "$ref": "./examples/EnvironmentContainer/get.json"
}
}
},
- "delete": {
- "tags": [
- "DataVersion"
- ],
- "summary": "Delete version.",
- "operationId": "DataVersions_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "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/v2/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "No Content"
- }
- },
- "x-ms-examples": {
- "Delete Data Version.": {
- "$ref": "./examples/DataVersion/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": {
"put": {
"tags": [
"EnvironmentContainer"
@@ -2072,13 +2223,15 @@
"$ref": "./examples/EnvironmentContainer/createOrUpdate.json"
}
}
- },
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": {
"get": {
"tags": [
- "EnvironmentContainer"
+ "EnvironmentSpecification"
],
- "summary": "Get container.",
- "operationId": "EnvironmentContainers_Get",
+ "summary": "List versions.",
+ "operationId": "EnvironmentSpecificationVersions_List",
"produces": [
"application/json"
],
@@ -2093,6 +2246,22 @@
{
"$ref": "../../../../../common-types/resource-management/v2/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"
+ },
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
@@ -2113,22 +2282,27 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/EnvironmentContainerResource"
+ "$ref": "#/definitions/EnvironmentSpecificationVersionResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "Get Environment Container.": {
- "$ref": "./examples/EnvironmentContainer/get.json"
+ "List Environment Specification Version.": {
+ "$ref": "./examples/EnvironmentSpecificationVersion/list.json"
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
}
- },
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": {
"delete": {
"tags": [
- "EnvironmentContainer"
+ "EnvironmentSpecification"
],
- "summary": "Delete container.",
- "operationId": "EnvironmentContainers_Delete",
+ "summary": "Delete version.",
+ "operationId": "EnvironmentSpecificationVersions_Delete",
"produces": [
"application/json"
],
@@ -2140,6 +2314,13 @@
"required": true,
"type": "string"
},
+ {
+ "in": "path",
+ "name": "version",
+ "description": "Version identifier.",
+ "required": true,
+ "type": "string"
+ },
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
@@ -2168,28 +2349,37 @@
}
},
"x-ms-examples": {
- "Delete Environment Container.": {
- "$ref": "./examples/EnvironmentContainer/delete.json"
+ "Delete Environment Specification Version.": {
+ "$ref": "./examples/EnvironmentSpecificationVersion/delete.json"
}
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": {
+ },
"get": {
"tags": [
- "EnvironmentContainer"
+ "EnvironmentSpecification"
],
- "summary": "List containers.",
- "operationId": "EnvironmentContainers_List",
+ "summary": "Get version.",
+ "operationId": "EnvironmentSpecificationVersions_Get",
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ "in": "path",
+ "name": "name",
+ "description": "Container name.",
+ "required": true,
+ "type": "string"
},
{
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
+ "in": "path",
+ "name": "version",
+ "description": "Version identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -2211,21 +2401,16 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult"
+ "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
}
}
},
"x-ms-examples": {
- "List Environment Container.": {
- "$ref": "./examples/EnvironmentContainer/list.json"
+ "Get Environment Specification Version.": {
+ "$ref": "./examples/EnvironmentSpecificationVersion/get.json"
}
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": {
+ },
"put": {
"tags": [
"EnvironmentSpecification"
@@ -2301,33 +2486,42 @@
"$ref": "./examples/EnvironmentSpecificationVersion/createOrUpdate.json"
}
}
- },
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": {
"get": {
"tags": [
- "EnvironmentSpecification"
+ "Job"
],
- "summary": "Get version.",
- "operationId": "EnvironmentSpecificationVersions_Get",
+ "summary": "Lists Jobs in the workspace.",
+ "operationId": "Jobs_List",
"produces": [
"application/json"
],
"parameters": [
{
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
+ },
+ {
+ "in": "query",
+ "name": "jobType",
+ "description": "Type of job to be returned.",
"type": "string"
},
{
- "in": "path",
- "name": "version",
- "description": "Version identifier.",
- "required": true,
+ "in": "query",
+ "name": "tags",
+ "description": "Tags for job to be returned.",
"type": "string"
},
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ "in": "query",
+ "name": "tag",
+ "description": "Jobs returned will have this tag key.",
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -2349,37 +2543,38 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
+ "$ref": "#/definitions/JobBaseResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "Get Environment Specification Version.": {
- "$ref": "./examples/EnvironmentSpecificationVersion/get.json"
+ "List Command Job.": {
+ "$ref": "./examples/Job/CommandJob/list.json"
+ },
+ "List Sweep Job.": {
+ "$ref": "./examples/Job/SweepJob/list.json"
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
}
- },
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": {
"delete": {
"tags": [
- "EnvironmentSpecification"
+ "Job"
],
- "summary": "Delete version.",
- "operationId": "EnvironmentSpecificationVersions_Delete",
+ "summary": "Deletes a Job (asynchronous).",
+ "operationId": "Jobs_Delete",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "version",
- "description": "Version identifier.",
+ "name": "id",
+ "description": "The name and identifier for the Job.",
"required": true,
"type": "string"
},
@@ -2406,54 +2601,61 @@
"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 Environment Specification Version.": {
- "$ref": "./examples/EnvironmentSpecificationVersion/delete.json"
+ "Delete Job.": {
+ "$ref": "./examples/Job/delete.json"
}
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": {
+ },
"get": {
"tags": [
- "EnvironmentSpecification"
+ "Job"
],
- "summary": "List versions.",
- "operationId": "EnvironmentSpecificationVersions_List",
+ "summary": "Gets a Job by name/id.",
+ "operationId": "Jobs_Get",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
- "name": "name",
- "description": "Container name.",
+ "name": "id",
+ "description": "The name and identifier for the Job.",
"required": true,
"type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/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"
- },
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
@@ -2474,21 +2676,19 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResourceArmPaginatedResult"
+ "$ref": "#/definitions/JobBaseResource"
}
}
},
"x-ms-examples": {
- "List Environment Specification Version.": {
- "$ref": "./examples/EnvironmentSpecificationVersion/list.json"
+ "Get Command Job.": {
+ "$ref": "./examples/Job/CommandJob/get.json"
+ },
+ "Get Sweep Job.": {
+ "$ref": "./examples/Job/SweepJob/get.json"
}
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
}
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": {
+ },
"put": {
"tags": [
"Job"
@@ -2560,66 +2760,15 @@
"$ref": "./examples/Job/SweepJob/createOrUpdate.json"
}
}
- },
- "get": {
- "tags": [
- "Job"
- ],
- "summary": "Gets a Job by name/id.",
- "operationId": "Jobs_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the Job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/JobBaseResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Command Job.": {
- "$ref": "./examples/Job/CommandJob/get.json"
- },
- "Get Sweep Job.": {
- "$ref": "./examples/Job/SweepJob/get.json"
- }
- }
- },
- "delete": {
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": {
+ "post": {
"tags": [
"Job"
],
- "summary": "Deletes a Job (asynchronous).",
- "operationId": "Jobs_Delete",
+ "summary": "Cancels a Job.",
+ "operationId": "Jobs_Cancel",
"produces": [
"application/json"
],
@@ -2653,50 +2802,22 @@
},
"200": {
"description": "Success"
- },
- "202": {
- "description": "Accepted",
- "headers": {
- "x-ms-async-operation-timeout": {
- "description": "Timeout for the client to use when polling the asynchronous operation.",
- "type": "string",
- "format": "duration"
- },
- "Location": {
- "description": "URI to poll for asynchronous operation result.",
- "type": "string"
- },
- "Retry-After": {
- "description": "Duration the client should wait between requests, in seconds.",
- "type": "integer",
- "format": "int32",
- "maximum": 600,
- "minimum": 10
- }
- }
- },
- "204": {
- "description": "No Content"
}
},
"x-ms-examples": {
- "Delete Job.": {
- "$ref": "./examples/Job/delete.json"
+ "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}/jobs": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": {
"get": {
"tags": [
- "Job"
+ "LabelingJob"
],
- "summary": "Lists Jobs in the workspace.",
- "operationId": "Jobs_List",
+ "summary": "Lists labeling jobs in the workspace.",
+ "operationId": "LabelingJobs_List",
"produces": [
"application/json"
],
@@ -2709,21 +2830,10 @@
},
{
"in": "query",
- "name": "jobType",
- "description": "Type of job to be returned.",
- "type": "string"
- },
- {
- "in": "query",
- "name": "tags",
- "description": "Tags for job to be returned.",
- "type": "string"
- },
- {
- "in": "query",
- "name": "tag",
- "description": "Jobs returned will have this tag key.",
- "type": "string"
+ "name": "count",
+ "description": "Number of labeling jobs to return.",
+ "type": "integer",
+ "format": "int32"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -2745,16 +2855,13 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/JobBaseResourceArmPaginatedResult"
+ "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "List Command Job.": {
- "$ref": "./examples/Job/CommandJob/list.json"
- },
- "List Sweep Job.": {
- "$ref": "./examples/Job/SweepJob/list.json"
+ "List Labeling Job.": {
+ "$ref": "./examples/LabelingJob/list.json"
}
},
"x-ms-pageable": {
@@ -2762,13 +2869,13 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": {
- "post": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": {
+ "delete": {
"tags": [
- "Job"
+ "LabelingJob"
],
- "summary": "Cancels a Job.",
- "operationId": "Jobs_Cancel",
+ "summary": "Delete a labeling job.",
+ "operationId": "LabelingJobs_Delete",
"produces": [
"application/json"
],
@@ -2776,7 +2883,7 @@
{
"in": "path",
"name": "id",
- "description": "The name and identifier for the Job.",
+ "description": "The name and identifier for the LabelingJob.",
"required": true,
"type": "string"
},
@@ -2802,98 +2909,15 @@
},
"200": {
"description": "Success"
+ },
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "Cancel Job.": {
- "$ref": "./examples/Job/cancel.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": {
- "put": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Creates or updates a labeling job (asynchronous).",
- "operationId": "LabelingJobs_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "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/v2/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "LabelingJob definition object.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/LabelingJobResource"
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
- }
- },
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/LabelingJobResource"
- },
- "headers": {
- "x-ms-async-operation-timeout": {
- "description": "Timeout for the client to use when polling the asynchronous operation.",
- "type": "string",
- "format": "duration"
- },
- "Azure-AsyncOperation": {
- "description": "URI to poll for asynchronous operation status.",
- "type": "string"
- }
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/LabelingJobResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Labeling Job.": {
- "$ref": "./examples/LabelingJob/createOrUpdate.json"
+ "Delete Labeling Job.": {
+ "$ref": "./examples/LabelingJob/delete.json"
}
- },
- "x-ms-long-running-operation": true,
- "x-ms-long-running-operation-options": {
- "final-state-via": "azure-async-operation"
}
},
"get": {
@@ -2958,12 +2982,15 @@
}
}
},
- "delete": {
+ "put": {
"tags": [
"LabelingJob"
],
- "summary": "Delete a labeling job.",
- "operationId": "LabelingJobs_Delete",
+ "summary": "Creates or updates a labeling job (asynchronous).",
+ "operationId": "LabelingJobs_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
@@ -2973,7 +3000,8 @@
"name": "id",
"description": "The name and identifier for the LabelingJob.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -2986,6 +3014,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "LabelingJob definition object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/LabelingJobResource"
+ }
}
],
"responses": {
@@ -2995,43 +3032,64 @@
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
},
- "200": {
- "description": "Success"
+ "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"
+ }
+ }
},
- "204": {
- "description": "No Content"
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/LabelingJobResource"
+ }
}
},
"x-ms-examples": {
- "Delete Labeling Job.": {
- "$ref": "./examples/LabelingJob/delete.json"
+ "CreateOrUpdate Labeling Job.": {
+ "$ref": "./examples/LabelingJob/createOrUpdate.json"
}
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": {
- "get": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": {
+ "post": {
"tags": [
"LabelingJob"
],
- "summary": "Lists labeling jobs in the workspace.",
- "operationId": "LabelingJobs_List",
+ "summary": "Export labels from a labeling job (asynchronous).",
+ "operationId": "LabelingJobs_ExportLabels",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
+ "in": "path",
+ "name": "id",
+ "description": "The name and identifier for the LabelingJob.",
+ "required": true,
+ "type": "string"
},
{
- "in": "query",
- "name": "count",
- "description": "Number of labeling jobs to return.",
- "type": "integer",
- "format": "int32"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -3041,6 +3099,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "The export summary.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ExportSummary"
+ }
}
],
"responses": {
@@ -3053,17 +3120,34 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult"
+ "$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": {
- "List Labeling Job.": {
- "$ref": "./examples/LabelingJob/list.json"
+ "ExportLabels Labeling Job.": {
+ "$ref": "./examples/LabelingJob/exportLabels.json"
}
},
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
}
}
},
@@ -3185,29 +3269,29 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": {
- "post": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": {
+ "get": {
"tags": [
- "LabelingJob"
- ],
- "summary": "Export labels from a labeling job (asynchronous).",
- "operationId": "LabelingJobs_ExportLabels",
- "consumes": [
- "application/json"
+ "ModelContainer"
],
+ "summary": "List model containers.",
+ "operationId": "ModelContainers_List",
"produces": [
"application/json"
],
"parameters": [
{
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the LabelingJob.",
- "required": true,
- "type": "string"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
+ },
+ {
+ "in": "query",
+ "name": "count",
+ "description": "Maximum number of results to return.",
+ "type": "integer",
+ "format": "int32"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -3217,15 +3301,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "The export summary.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ExportSummary"
- }
}
],
"responses": {
@@ -3238,82 +3313,7 @@
"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}/models": {
- "get": {
- "tags": [
- "ModelContainer"
- ],
- "summary": "List model containers.",
- "operationId": "ModelContainers_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "in": "query",
- "name": "count",
- "description": "Maximum number of results to return.",
- "type": "integer",
- "format": "int32"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult"
+ "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult"
}
}
},
@@ -3328,15 +3328,12 @@
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": {
- "put": {
+ "delete": {
"tags": [
"ModelContainer"
],
- "summary": "Create or update container.",
- "operationId": "ModelContainers_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
+ "summary": "Delete container.",
+ "operationId": "ModelContainers_Delete",
"produces": [
"application/json"
],
@@ -3346,8 +3343,7 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -3360,15 +3356,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Container entity to create or update.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ModelContainerResource"
- }
}
],
"responses": {
@@ -3379,21 +3366,15 @@
}
},
"200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelContainerResource"
- }
+ "description": "Success"
},
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/ModelContainerResource"
- }
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "CreateOrUpdate Model Container.": {
- "$ref": "./examples/ModelContainer/createOrUpdate.json"
+ "Delete Model Container.": {
+ "$ref": "./examples/ModelContainer/delete.json"
}
}
},
@@ -3447,12 +3428,15 @@
}
}
},
- "delete": {
+ "put": {
"tags": [
"ModelContainer"
],
- "summary": "Delete container.",
- "operationId": "ModelContainers_Delete",
+ "summary": "Create or update container.",
+ "operationId": "ModelContainers_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
@@ -3462,7 +3446,8 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -3475,6 +3460,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Container entity to create or update.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ModelContainerResource"
+ }
}
],
"responses": {
@@ -3485,15 +3479,21 @@
}
},
"200": {
- "description": "Success"
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/ModelContainerResource"
+ }
},
- "204": {
- "description": "No Content"
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/ModelContainerResource"
+ }
}
},
"x-ms-examples": {
- "Delete Model Container.": {
- "$ref": "./examples/ModelContainer/delete.json"
+ "CreateOrUpdate Model Container.": {
+ "$ref": "./examples/ModelContainer/createOrUpdate.json"
}
}
}
@@ -3601,15 +3601,12 @@
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": {
- "put": {
+ "delete": {
"tags": [
"ModelVersion"
],
- "summary": "Create or update version.",
- "operationId": "ModelVersions_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
+ "summary": "Delete version.",
+ "operationId": "ModelVersions_Delete",
"produces": [
"application/json"
],
@@ -3619,8 +3616,7 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
},
{
"in": "path",
@@ -3640,15 +3636,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Version entity to create or update.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ModelVersionResource"
- }
}
],
"responses": {
@@ -3659,21 +3646,15 @@
}
},
"200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelVersionResource"
- }
+ "description": "Success"
},
- "201": {
- "description": "Created",
- "schema": {
- "$ref": "#/definitions/ModelVersionResource"
- }
+ "204": {
+ "description": "No Content"
}
},
"x-ms-examples": {
- "CreateOrUpdate Model Version.": {
- "$ref": "./examples/ModelVersion/createOrUpdate.json"
+ "Delete Model Version.": {
+ "$ref": "./examples/ModelVersion/delete.json"
}
}
},
@@ -3734,12 +3715,15 @@
}
}
},
- "delete": {
+ "put": {
"tags": [
"ModelVersion"
],
- "summary": "Delete version.",
- "operationId": "ModelVersions_Delete",
+ "summary": "Create or update version.",
+ "operationId": "ModelVersions_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
"produces": [
"application/json"
],
@@ -3749,7 +3733,8 @@
"name": "name",
"description": "Container name.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"in": "path",
@@ -3769,6 +3754,15 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Version entity to create or update.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ModelVersionResource"
+ }
}
],
"responses": {
@@ -3779,65 +3773,107 @@
}
},
"200": {
- "description": "Success"
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/ModelVersionResource"
+ }
},
- "204": {
- "description": "No Content"
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/ModelVersionResource"
+ }
}
},
"x-ms-examples": {
- "Delete Model Version.": {
- "$ref": "./examples/ModelVersion/delete.json"
+ "CreateOrUpdate Model Version.": {
+ "$ref": "./examples/ModelVersion/createOrUpdate.json"
}
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": {
"get": {
"tags": [
- "OnlineDeployment"
+ "OnlineEndpoint"
],
- "summary": "List Inference Endpoint Deployments.",
- "operationId": "OnlineDeployments_List",
+ "summary": "List Online Endpoints.",
+ "operationId": "OnlineEndpoints_List",
"produces": [
"application/json"
],
"parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"in": "query",
- "name": "$orderBy",
- "description": "Ordering of list.",
+ "name": "name",
+ "description": "Name of the endpoint.",
"type": "string"
},
{
"in": "query",
- "name": "$top",
- "description": "Top of list.",
+ "name": "count",
+ "description": "Number of endpoints to be retrieved in a page of results.",
"type": "integer",
"format": "int32"
},
{
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
+ "in": "query",
+ "name": "computeType",
+ "description": "EndpointComputeType to be filtered by.",
+ "type": "string",
+ "enum": [
+ "Managed",
+ "K8S",
+ "AzureMLCompute"
+ ],
+ "x-ms-enum": {
+ "name": "EndpointComputeType",
+ "modelAsString": true
+ }
},
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
+ "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"
},
{
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
+ "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
+ }
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ }
],
"responses": {
"default": {
@@ -3849,13 +3885,13 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult"
+ "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "List Online Deployments.": {
- "$ref": "./examples/OnlineDeployment/list.json"
+ "List Online Endpoint.": {
+ "$ref": "./examples/OnlineEndpoint/list.json"
}
},
"x-ms-pageable": {
@@ -3863,13 +3899,13 @@
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": {
"delete": {
"tags": [
- "OnlineDeployment"
+ "OnlineEndpoint"
],
- "summary": "Delete Inference Endpoint Deployment (asynchronous).",
- "operationId": "OnlineDeployments_Delete",
+ "summary": "Delete Online Endpoint (asynchronous).",
+ "operationId": "OnlineEndpoints_Delete",
"produces": [
"application/json"
],
@@ -3877,14 +3913,7 @@
{
"in": "path",
"name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Inference Endpoint Deployment name.",
+ "description": "Online Endpoint name.",
"required": true,
"type": "string"
},
@@ -3908,9 +3937,6 @@
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
},
- "200": {
- "description": "Success"
- },
"204": {
"description": "No Content"
},
@@ -3934,11 +3960,14 @@
"minimum": 10
}
}
+ },
+ "200": {
+ "description": "Success"
}
},
"x-ms-examples": {
- "Delete Online Deployment.": {
- "$ref": "./examples/OnlineDeployment/delete.json"
+ "Delete Online Endpoint.": {
+ "$ref": "./examples/OnlineEndpoint/delete.json"
}
},
"x-ms-long-running-operation": true,
@@ -3948,10 +3977,10 @@
},
"get": {
"tags": [
- "OnlineDeployment"
+ "OnlineEndpoint"
],
- "summary": "Get Inference Deployment Deployment.",
- "operationId": "OnlineDeployments_Get",
+ "summary": "Get Online Endpoint.",
+ "operationId": "OnlineEndpoints_Get",
"produces": [
"application/json"
],
@@ -3959,14 +3988,7 @@
{
"in": "path",
"name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Inference Endpoint Deployment name.",
+ "description": "Online Endpoint name.",
"required": true,
"type": "string"
},
@@ -3993,25 +4015,22 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/OnlineDeploymentTrackedResource"
+ "$ref": "#/definitions/OnlineEndpointTrackedResource"
}
}
},
"x-ms-examples": {
- "Get Managed Online Deployment.": {
- "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json"
- },
- "Get K8S Online Deployment.": {
- "$ref": "./examples/OnlineDeployment/K8sOnlineDeployment/get.json"
+ "Get Online Endpoint.": {
+ "$ref": "./examples/OnlineEndpoint/get.json"
}
}
},
- "put": {
+ "patch": {
"tags": [
- "OnlineDeployment"
+ "OnlineEndpoint"
],
- "summary": "Create or update Inference Endpoint Deployment (asynchronous).",
- "operationId": "OnlineDeployments_CreateOrUpdate",
+ "summary": "Update Online Endpoint (asynchronous).",
+ "operationId": "OnlineEndpoints_Update",
"consumes": [
"application/json"
],
@@ -4022,18 +4041,9 @@
{
"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.",
+ "description": "Online Endpoint name.",
"required": true,
- "type": "string",
- "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
+ "type": "string"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
@@ -4050,10 +4060,10 @@
{
"in": "body",
"name": "body",
- "description": "Inference Endpoint entity to apply during operation.",
+ "description": "Online Endpoint entity to apply during operation.",
"required": true,
"schema": {
- "$ref": "#/definitions/OnlineDeploymentTrackedResource"
+ "$ref": "#/definitions/PartialOnlineEndpointPartialTrackedResource"
}
}
],
@@ -4067,46 +4077,47 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/OnlineDeploymentTrackedResource"
+ "$ref": "#/definitions/OnlineEndpointTrackedResource"
}
},
- "201": {
- "description": "Created",
- "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"
},
- "Azure-AsyncOperation": {
- "description": "URI to poll for asynchronous operation status.",
+ "Location": {
+ "description": "URI to poll for asynchronous operation result.",
"type": "string"
+ },
+ "Retry-After": {
+ "description": "Duration the client should wait between requests, in seconds.",
+ "type": "integer",
+ "format": "int32",
+ "maximum": 600,
+ "minimum": 10
}
}
}
},
"x-ms-examples": {
- "CreateOrUpdate Managed Online Deployment.": {
- "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json"
- },
- "CreateOrUpdate K8S Online Deployment.": {
- "$ref": "./examples/OnlineDeployment/K8sOnlineDeployment/createOrUpdate.json"
+ "Update Online Endpoint.": {
+ "$ref": "./examples/OnlineEndpoint/update.json"
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
- "final-state-via": "azure-async-operation"
+ "final-state-via": "location"
}
},
- "patch": {
+ "put": {
"tags": [
- "OnlineDeployment"
+ "OnlineEndpoint"
],
- "summary": "Update Online Deployment (asynchronous).",
- "operationId": "OnlineDeployments_Update",
+ "summary": "Create or update Online Endpoint (asynchronous).",
+ "operationId": "OnlineEndpoints_CreateOrUpdate",
"consumes": [
"application/json"
],
@@ -4122,14 +4133,6 @@
"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/v2/types.json#/parameters/ApiVersionParameter"
},
@@ -4148,7 +4151,7 @@
"description": "Online Endpoint entity to apply during operation.",
"required": true,
"schema": {
- "$ref": "#/definitions/PartialOnlineDeploymentPartialTrackedResource"
+ "$ref": "#/definitions/OnlineEndpointTrackedResource"
}
}
],
@@ -4162,55 +4165,45 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/OnlineDeploymentTrackedResource"
+ "$ref": "#/definitions/OnlineEndpointTrackedResource"
}
},
- "202": {
- "description": "Accepted",
+ "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"
},
- "Location": {
- "description": "URI to poll for asynchronous operation result.",
+ "Azure-AsyncOperation": {
+ "description": "URI to poll for asynchronous operation status.",
"type": "string"
- },
- "Retry-After": {
- "description": "Duration the client should wait between requests, in seconds.",
- "type": "integer",
- "format": "int32",
- "maximum": 600,
- "minimum": 10
}
}
}
},
"x-ms-examples": {
- "Update Managed Online Deployment.": {
- "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json"
- },
- "Update K8S Online Deployment.": {
- "$ref": "./examples/OnlineDeployment/K8sOnlineDeployment/update.json"
+ "CreateOrUpdate Online Endpoint.": {
+ "$ref": "./examples/OnlineEndpoint/createOrUpdate.json"
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
- "final-state-via": "location"
+ "final-state-via": "azure-async-operation"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": {
- "post": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": {
+ "get": {
"tags": [
"OnlineDeployment"
],
- "summary": "Polls an Endpoint operation.",
- "operationId": "OnlineDeployments_GetLogs",
- "consumes": [
- "application/json"
- ],
+ "summary": "List Inference Endpoint Deployments.",
+ "operationId": "OnlineDeployments_List",
"produces": [
"application/json"
],
@@ -4223,14 +4216,23 @@
"type": "string"
},
{
- "in": "path",
- "name": "deploymentName",
- "description": "The name and identifier for the endpoint.",
- "required": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "query",
+ "name": "$orderBy",
+ "description": "Ordering of list.",
"type": "string"
},
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ "in": "query",
+ "name": "$top",
+ "description": "Top of list.",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
@@ -4240,15 +4242,6 @@
},
{
"$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "The request containing parameters for retrieving logs.",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DeploymentLogsRequest"
- }
}
],
"responses": {
@@ -4261,139 +4254,42 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/DeploymentLogs"
+ "$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult"
}
}
},
"x-ms-examples": {
- "Get Online Deployment Logs.": {
- "$ref": "./examples/OnlineDeployment/getLogs.json"
+ "List Online Deployments.": {
+ "$ref": "./examples/OnlineDeployment/list.json"
}
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": {
- "get": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": {
+ "delete": {
"tags": [
- "OnlineEndpoint"
+ "OnlineDeployment"
],
- "summary": "List Online Endpoints.",
- "operationId": "OnlineEndpoints_List",
+ "summary": "Delete Inference Endpoint Deployment (asynchronous).",
+ "operationId": "OnlineDeployments_Delete",
"produces": [
"application/json"
],
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
- },
- {
- "in": "query",
- "name": "name",
- "description": "Name of the endpoint.",
+ "in": "path",
+ "name": "endpointName",
+ "description": "Inference endpoint name.",
+ "required": true,
"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",
- "K8S",
- "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
- }
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Online Endpoint.": {
- "$ref": "./examples/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": [
{
"in": "path",
- "name": "endpointName",
- "description": "Online Endpoint name.",
+ "name": "deploymentName",
+ "description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
},
@@ -4417,6 +4313,9 @@
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
},
+ "200": {
+ "description": "Success"
+ },
"204": {
"description": "No Content"
},
@@ -4440,14 +4339,11 @@
"minimum": 10
}
}
- },
- "200": {
- "description": "Success"
}
},
"x-ms-examples": {
- "Delete Online Endpoint.": {
- "$ref": "./examples/OnlineEndpoint/delete.json"
+ "Delete Online Deployment.": {
+ "$ref": "./examples/OnlineDeployment/delete.json"
}
},
"x-ms-long-running-operation": true,
@@ -4457,10 +4353,10 @@
},
"get": {
"tags": [
- "OnlineEndpoint"
+ "OnlineDeployment"
],
- "summary": "Get Online Endpoint.",
- "operationId": "OnlineEndpoints_Get",
+ "summary": "Get Inference Deployment Deployment.",
+ "operationId": "OnlineDeployments_Get",
"produces": [
"application/json"
],
@@ -4468,7 +4364,14 @@
{
"in": "path",
"name": "endpointName",
- "description": "Online Endpoint name.",
+ "description": "Inference endpoint name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "deploymentName",
+ "description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
},
@@ -4495,22 +4398,25 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/OnlineEndpointTrackedResource"
+ "$ref": "#/definitions/OnlineDeploymentTrackedResource"
}
}
},
"x-ms-examples": {
- "Get Online Endpoint.": {
- "$ref": "./examples/OnlineEndpoint/get.json"
+ "Get Managed Online Deployment.": {
+ "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json"
+ },
+ "Get K8S Online Deployment.": {
+ "$ref": "./examples/OnlineDeployment/K8sOnlineDeployment/get.json"
}
}
},
- "put": {
+ "patch": {
"tags": [
- "OnlineEndpoint"
+ "OnlineDeployment"
],
- "summary": "Create or update Online Endpoint (asynchronous).",
- "operationId": "OnlineEndpoints_CreateOrUpdate",
+ "summary": "Update Online Deployment (asynchronous).",
+ "operationId": "OnlineDeployments_Update",
"consumes": [
"application/json"
],
@@ -4526,6 +4432,14 @@
"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/v2/types.json#/parameters/ApiVersionParameter"
},
@@ -4544,7 +4458,7 @@
"description": "Online Endpoint entity to apply during operation.",
"required": true,
"schema": {
- "$ref": "#/definitions/OnlineEndpointTrackedResource"
+ "$ref": "#/definitions/PartialOnlineDeploymentPartialTrackedResource"
}
}
],
@@ -4558,43 +4472,50 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/OnlineEndpointTrackedResource"
+ "$ref": "#/definitions/OnlineDeploymentTrackedResource"
}
},
- "201": {
- "description": "Created",
- "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"
},
- "Azure-AsyncOperation": {
- "description": "URI to poll for asynchronous operation status.",
+ "Location": {
+ "description": "URI to poll for asynchronous operation result.",
"type": "string"
+ },
+ "Retry-After": {
+ "description": "Duration the client should wait between requests, in seconds.",
+ "type": "integer",
+ "format": "int32",
+ "maximum": 600,
+ "minimum": 10
}
}
}
},
"x-ms-examples": {
- "CreateOrUpdate Online Endpoint.": {
- "$ref": "./examples/OnlineEndpoint/createOrUpdate.json"
+ "Update Managed Online Deployment.": {
+ "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json"
+ },
+ "Update K8S Online Deployment.": {
+ "$ref": "./examples/OnlineDeployment/K8sOnlineDeployment/update.json"
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
- "final-state-via": "azure-async-operation"
+ "final-state-via": "location"
}
},
- "patch": {
+ "put": {
"tags": [
- "OnlineEndpoint"
+ "OnlineDeployment"
],
- "summary": "Update Online Endpoint (asynchronous).",
- "operationId": "OnlineEndpoints_Update",
+ "summary": "Create or update Inference Endpoint Deployment (asynchronous).",
+ "operationId": "OnlineDeployments_CreateOrUpdate",
"consumes": [
"application/json"
],
@@ -4605,9 +4526,18 @@
{
"in": "path",
"name": "endpointName",
- "description": "Online Endpoint name.",
+ "description": "Inference endpoint name.",
"required": true,
- "type": "string"
+ "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/v2/types.json#/parameters/ApiVersionParameter"
@@ -4624,10 +4554,10 @@
{
"in": "body",
"name": "body",
- "description": "Online Endpoint entity to apply during operation.",
+ "description": "Inference Endpoint entity to apply during operation.",
"required": true,
"schema": {
- "$ref": "#/definitions/PartialOnlineEndpointPartialTrackedResource"
+ "$ref": "#/definitions/OnlineDeploymentTrackedResource"
}
}
],
@@ -4641,49 +4571,48 @@
"200": {
"description": "Success",
"schema": {
- "$ref": "#/definitions/OnlineEndpointTrackedResource"
+ "$ref": "#/definitions/OnlineDeploymentTrackedResource"
}
},
- "202": {
- "description": "Accepted",
+ "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"
},
- "Location": {
- "description": "URI to poll for asynchronous operation result.",
+ "Azure-AsyncOperation": {
+ "description": "URI to poll for asynchronous operation status.",
"type": "string"
- },
- "Retry-After": {
- "description": "Duration the client should wait between requests, in seconds.",
- "type": "integer",
- "format": "int32",
- "maximum": 600,
- "minimum": 10
}
}
}
},
"x-ms-examples": {
- "Update Online Endpoint.": {
- "$ref": "./examples/OnlineEndpoint/update.json"
+ "CreateOrUpdate Managed Online Deployment.": {
+ "$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json"
+ },
+ "CreateOrUpdate K8S Online Deployment.": {
+ "$ref": "./examples/OnlineDeployment/K8sOnlineDeployment/createOrUpdate.json"
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
- "final-state-via": "location"
+ "final-state-via": "azure-async-operation"
}
}
},
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": {
"post": {
"tags": [
- "OnlineEndpoint"
+ "OnlineDeployment"
],
- "summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).",
- "operationId": "OnlineEndpoints_RegenerateKeys",
+ "summary": "Polls an Endpoint operation.",
+ "operationId": "OnlineDeployments_GetLogs",
"consumes": [
"application/json"
],
@@ -4694,7 +4623,14 @@
{
"in": "path",
"name": "endpointName",
- "description": "Online Endpoint name.",
+ "description": "Inference endpoint name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "deploymentName",
+ "description": "The name and identifier for the endpoint.",
"required": true,
"type": "string"
},
@@ -4713,10 +4649,10 @@
{
"in": "body",
"name": "body",
- "description": "RegenerateKeys request .",
+ "description": "The request containing parameters for retrieving logs.",
"required": true,
"schema": {
- "$ref": "#/definitions/RegenerateEndpointKeysRequest"
+ "$ref": "#/definitions/DeploymentLogsRequest"
}
}
],
@@ -4728,33 +4664,16 @@
}
},
"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
- }
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DeploymentLogs"
}
}
},
"x-ms-examples": {
- "RegenerateKeys Online Endpoint.": {
- "$ref": "./examples/OnlineEndpoint/regenerateKeys.json"
+ "Get Online Deployment Logs.": {
+ "$ref": "./examples/OnlineDeployment/getLogs.json"
}
- },
- "x-ms-long-running-operation": true,
- "x-ms-long-running-operation-options": {
- "final-state-via": "location"
}
}
},
@@ -4810,6 +4729,87 @@
}
}
},
+ "/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": [
+ {
+ "in": "path",
+ "name": "endpointName",
+ "description": "Online Endpoint name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "RegenerateKeys request .",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegenerateEndpointKeysRequest"
+ }
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/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 Online Endpoint.": {
+ "$ref": "./examples/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": [
@@ -4864,369 +4864,520 @@
}
},
"definitions": {
- "ResourceIdentityAssignment": {
- "description": "Defines values for a ResourceIdentity's type.",
- "enum": [
- "SystemAssigned",
- "UserAssigned",
- "SystemAssigned,UserAssigned",
- "None"
+ "AccountKeyDatastoreCredentials": {
+ "description": "Account key datastore credentials configuration.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreCredentials"
+ }
],
- "type": "string",
- "x-ms-enum": {
- "name": "ResourceIdentityAssignment",
- "modelAsString": true
+ "properties": {
+ "secrets": {
+ "description": "Storage account secrets.",
+ "$ref": "#/definitions/AccountKeyDatastoreSecrets",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ],
+ "x-ms-secret": true
+ }
},
+ "x-ms-discriminator-value": "AccountKey",
"additionalProperties": false
},
- "UserAssignedIdentityMeta": {
- "description": "User assigned identities associated with a resource.",
+ "AccountKeyDatastoreSecrets": {
+ "description": "Datastore account key secrets.",
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreSecrets"
+ }
+ ],
"properties": {
- "principalId": {
- "description": "The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.",
- "type": "string"
- },
- "clientId": {
- "description": "Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.",
+ "key": {
+ "description": "Storage account key.",
"type": "string"
}
},
+ "x-ms-discriminator-value": "AccountKey",
"additionalProperties": false
},
- "ResourceIdentity": {
- "description": "Service identity associated with a resource.",
+ "AmlToken": {
+ "description": "AML Token identity configuration.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/IdentityConfiguration"
+ }
+ ],
+ "x-ms-discriminator-value": "AMLToken",
+ "additionalProperties": false
+ },
+ "AssetReferenceBase": {
+ "description": "Base definition for asset references.",
+ "required": [
+ "referenceType"
+ ],
"type": "object",
"properties": {
- "type": {
- "description": "Defines values for a ResourceIdentity's type.",
- "$ref": "#/definitions/ResourceIdentityAssignment"
- },
- "principalId": {
- "description": "Client ID that is used when authenticating.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "tenantId": {
- "description": "AAD Tenant where this identity lives.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "referenceType": {
+ "description": "Specifies the type of asset reference.",
+ "$ref": "#/definitions/ReferenceType"
+ }
+ },
+ "discriminator": "referenceType"
+ },
+ "AutoScaleSettings": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/OnlineScaleSettings"
+ }
+ ],
+ "properties": {
+ "pollingInterval": {
+ "format": "duration",
+ "description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.",
+ "type": "string"
},
- "userAssignedIdentities": {
- "description": "Dictionary of the user assigned identities, key is ARM resource ID of the UAI.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/UserAssignedIdentityMeta"
- }
+ "targetUtilizationPercentage": {
+ "format": "int32",
+ "type": "integer"
}
},
+ "x-ms-discriminator-value": "Auto",
"additionalProperties": false
},
- "ComputeConfiguration": {
- "description": "Configuration for compute binding.",
+ "AzureBlobContents": {
+ "description": "Azure Blob datastore configuration.",
+ "required": [
+ "accountName",
+ "containerName",
+ "credentials",
+ "endpoint",
+ "protocol"
+ ],
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreContents"
+ }
+ ],
"properties": {
- "target": {
- "description": "ARM resource ID of the compute resource.",
+ "accountName": {
+ "description": "Storage account name.",
+ "pattern": "[a-zA-Z0-9_]",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "instanceCount": {
- "format": "int32",
- "description": "Number of instances or nodes.",
- "type": "integer",
+ "containerName": {
+ "description": "Storage account container name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "isLocal": {
- "description": "Set to true for jobs running on local compute.",
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
+ "credentials": {
+ "description": "Account credentials.",
+ "$ref": "#/definitions/DatastoreCredentials"
},
- "location": {
- "description": "Location for virtual cluster run.",
+ "endpoint": {
+ "description": "Azure cloud endpoint for the storage account.",
+ "pattern": "[a-zA-Z0-9_]",
"type": "string",
+ "example": "core.windows.net",
"x-ms-mutability": [
"create",
"read"
]
},
- "instanceType": {
- "description": "SKU type to run on.",
+ "protocol": {
+ "description": "Protocol used to communicate with the storage account.",
+ "pattern": "[a-zA-Z0-9_]",
"type": "string",
+ "example": "https",
"x-ms-mutability": [
"create",
"read"
]
- },
- "properties": {
- "description": "Additional properties.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "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",
- "type": "integer"
- },
- "timeout": {
- "format": "duration",
- "description": "Invocation timeout for a mini-batch, in ISO 8601 format.",
- "type": "string"
- }
- },
- "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
- },
- "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
- },
- "additionalProperties": false
- },
- "BatchOutputConfiguration": {
- "description": "Batch inference output configuration.",
- "type": "object",
- "properties": {
- "outputAction": {
- "description": "Indicates how the output will be organized.",
- "$ref": "#/definitions/BatchOutputAction"
- },
- "appendRowFileName": {
- "description": "Customized output file name for append_row output action.",
- "type": "string"
}
},
+ "x-ms-discriminator-value": "AzureBlob",
"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
- },
- "additionalProperties": false
- },
- "AssetReferenceBase": {
- "description": "Base definition for asset references.",
- "required": [
- "referenceType"
- ],
- "type": "object",
- "properties": {
- "referenceType": {
- "description": "Specifies the type of asset reference.",
- "$ref": "#/definitions/ReferenceType"
- }
- },
- "discriminator": "referenceType"
- },
- "IdAssetReference": {
- "description": "Reference to an asset via its ARM resource ID.",
+ "AzureDataLakeGen1Contents": {
+ "description": "Azure Data Lake Gen1 datastore configuration.",
"required": [
- "assetId"
+ "credentials",
+ "storeName"
],
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/AssetReferenceBase"
+ "$ref": "#/definitions/DatastoreContents"
}
],
"properties": {
- "assetId": {
- "description": "ARM resource ID of the asset.",
+ "credentials": {
+ "description": "Account credentials.",
+ "$ref": "#/definitions/DatastoreCredentials"
+ },
+ "storeName": {
+ "description": "Azure Data Lake store name.",
"pattern": "[a-zA-Z0-9_]",
"type": "string"
}
},
- "x-ms-discriminator-value": "Id",
+ "x-ms-discriminator-value": "AzureDataLakeGen1",
"additionalProperties": false
},
- "DataPathAssetReference": {
- "description": "Reference to an asset via its path in a datastore.",
+ "AzureDataLakeGen2Contents": {
+ "description": "Azure Data Lake Gen2 datastore configuration.",
+ "required": [
+ "accountName",
+ "containerName",
+ "credentials",
+ "endpoint",
+ "protocol"
+ ],
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/AssetReferenceBase"
+ "$ref": "#/definitions/DatastoreContents"
}
],
"properties": {
- "path": {
- "description": "The path of the file/directory in the datastore.",
- "type": "string"
+ "accountName": {
+ "description": "Storage account name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
- "datastoreId": {
- "description": "ARM resource ID of the datastore where the asset is located.",
- "type": "string"
+ "containerName": {
+ "description": "Storage account container name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "credentials": {
+ "description": "Account credentials.",
+ "$ref": "#/definitions/DatastoreCredentials"
+ },
+ "endpoint": {
+ "description": "Azure cloud endpoint for the storage account.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "example": "core.windows.net",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "protocol": {
+ "description": "Protocol used to communicate with the storage account.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "example": "https",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
}
},
- "x-ms-discriminator-value": "DataPath",
+ "x-ms-discriminator-value": "AzureDataLakeGen2",
"additionalProperties": false
},
- "OutputPathAssetReference": {
- "description": "Reference to an asset via its path in a job output.",
+ "AzureFileContents": {
+ "description": "Azure File datastore configuration.",
+ "required": [
+ "accountName",
+ "containerName",
+ "credentials",
+ "endpoint",
+ "protocol"
+ ],
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/AssetReferenceBase"
- }
- ],
- "properties": {
- "path": {
- "description": "The path of the file/directory in the job output.",
- "type": "string"
- },
- "jobId": {
- "description": "ARM resource ID of the job.",
- "type": "string"
+ "$ref": "#/definitions/DatastoreContents"
}
- },
- "x-ms-discriminator-value": "OutputPath",
- "additionalProperties": false
- },
- "CodeConfiguration": {
- "description": "Configuration for a scoring code asset.",
- "required": [
- "scoringScript"
],
- "type": "object",
"properties": {
- "codeId": {
- "description": "ARM resource ID of the code asset.",
+ "accountName": {
+ "description": "Storage account name.",
+ "pattern": "[a-zA-Z0-9_]",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "scoringScript": {
- "description": "The script to execute on startup. eg. \"score.py\"",
- "minLength": 1,
+ "containerName": {
+ "description": "Storage account container name.",
"pattern": "[a-zA-Z0-9_]",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
- }
- },
- "additionalProperties": false
- },
- "BatchDeployment": {
- "description": "Batch inference settings per deployment.",
- "type": "object",
- "properties": {
- "compute": {
- "description": "Configuration for compute binding.",
- "$ref": "#/definitions/ComputeConfiguration"
},
- "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.",
- "type": "integer"
+ "credentials": {
+ "description": "Account credentials.",
+ "$ref": "#/definitions/DatastoreCredentials"
},
- "retrySettings": {
- "description": "Retry Settings for the batch inference operation.",
- "$ref": "#/definitions/BatchRetrySettings"
+ "endpoint": {
+ "description": "Azure cloud endpoint for the storage account.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "example": "core.windows.net",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
- "partitionKeys": {
- "description": "Partition keys list used for Named partitioning.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "protocol": {
+ "description": "Protocol used to communicate with the storage account.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "example": "https",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
+ },
+ "x-ms-discriminator-value": "AzureFile",
+ "additionalProperties": false
+ },
+ "AzurePostgreSqlContents": {
+ "description": "Azure Postgre SQL datastore configuration.",
+ "required": [
+ "credentials",
+ "databaseName",
+ "endpoint",
+ "portNumber",
+ "serverName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreContents"
+ }
+ ],
+ "properties": {
+ "credentials": {
+ "description": "Account credentials.",
+ "$ref": "#/definitions/DatastoreCredentials"
},
- "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.",
- "type": "integer"
+ "databaseName": {
+ "description": "Azure SQL database name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
- "loggingLevel": {
- "description": "Logging level for batch inference operation.",
- "$ref": "#/definitions/BatchLoggingLevel"
+ "enableSSL": {
+ "description": "Whether the Azure PostgreSQL server requires SSL.",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
- "outputConfiguration": {
- "description": "Output configuration for the batch inference operation.",
- "$ref": "#/definitions/BatchOutputConfiguration"
+ "endpoint": {
+ "description": "Azure cloud endpoint for the database.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "example": "database.windows.net",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "portNumber": {
+ "format": "int32",
+ "description": "Azure SQL server port.",
+ "type": "integer",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "serverName": {
+ "description": "Azure SQL server name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
+ },
+ "x-ms-discriminator-value": "AzurePostgreSql",
+ "additionalProperties": false
+ },
+ "AzureSqlDatabaseContents": {
+ "description": "Azure SQL Database datastore configuration.",
+ "required": [
+ "credentials",
+ "databaseName",
+ "endpoint",
+ "portNumber",
+ "serverName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreContents"
+ }
+ ],
+ "properties": {
+ "credentials": {
+ "description": "Account credentials.",
+ "$ref": "#/definitions/DatastoreCredentials"
+ },
+ "databaseName": {
+ "description": "Azure SQL database name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "endpoint": {
+ "description": "Azure cloud endpoint for the database.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "example": "database.windows.net",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "portNumber": {
+ "format": "int32",
+ "description": "Azure SQL server port.",
+ "type": "integer",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "serverName": {
+ "description": "Azure SQL server name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
+ },
+ "x-ms-discriminator-value": "AzureSqlDatabase",
+ "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",
+ "type": "number"
+ },
+ "slackFactor": {
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "x-ms-discriminator-value": "Bandit",
+ "additionalProperties": false
+ },
+ "BatchDeployment": {
+ "description": "Batch inference settings per deployment.",
+ "type": "object",
+ "properties": {
+ "codeConfiguration": {
+ "description": "Code configuration for the endpoint deployment.",
+ "$ref": "#/definitions/CodeConfiguration"
+ },
+ "compute": {
+ "description": "Configuration for compute binding.",
+ "$ref": "#/definitions/ComputeConfiguration"
},
"description": {
"description": "Description of the endpoint deployment.",
"type": "string"
},
- "properties": {
- "description": "Property dictionary. Properties can be added, but not removed or altered.",
+ "environmentId": {
+ "description": "ARM resource ID of the environment specification for the endpoint deployment.",
+ "type": "string"
+ },
+ "environmentVariables": {
+ "description": "Environment variables configuration for the deployment.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
+ "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.",
+ "type": "integer"
+ },
+ "loggingLevel": {
+ "description": "Logging level for batch inference operation.",
+ "$ref": "#/definitions/BatchLoggingLevel"
+ },
+ "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.",
+ "type": "integer"
+ },
"model": {
"description": "Reference to the model asset for the endpoint deployment.",
"$ref": "#/definitions/AssetReferenceBase"
},
- "codeConfiguration": {
- "description": "Code configuration for the endpoint deployment.",
- "$ref": "#/definitions/CodeConfiguration"
+ "outputConfiguration": {
+ "description": "Output configuration for the batch inference operation.",
+ "$ref": "#/definitions/BatchOutputConfiguration"
},
- "environmentId": {
- "description": "ARM resource ID of the environment specification for the endpoint deployment.",
- "type": "string"
+ "partitionKeys": {
+ "description": "Partition keys list used for Named partitioning.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "environmentVariables": {
- "description": "Environment variables configuration for the deployment.",
+ "properties": {
+ "description": "Property dictionary. Properties can be added, but not removed or altered.",
"type": "object",
"additionalProperties": {
"type": "string"
}
+ },
+ "retrySettings": {
+ "description": "Retry Settings for the batch inference operation.",
+ "$ref": "#/definitions/BatchRetrySettings"
}
},
"additionalProperties": false
@@ -5243,13 +5394,13 @@
}
],
"properties": {
- "kind": {
- "type": "string"
- },
"identity": {
"description": "Service identity associated with a resource.",
"$ref": "#/definitions/ResourceIdentity"
},
+ "kind": {
+ "type": "string"
+ },
"properties": {
"description": "Additional attributes of the entity.",
"$ref": "#/definitions/BatchDeployment"
@@ -5265,94 +5416,19 @@
},
"additionalProperties": false
},
- "PartialBatchDeployment": {
- "description": "Mutable batch inference settings per deployment.",
+ "BatchDeploymentTrackedResourceArmPaginatedResult": {
+ "description": "A paginated list of BatchDeployment entities.",
"type": "object",
"properties": {
- "description": {
- "description": "Description of the endpoint deployment.",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "PartialBatchDeploymentPartialTrackedResource": {
- "description": "Strictly used in update requests.",
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
+ "nextLink": {
"type": "string"
},
- "kind": {
- "type": "string"
- },
- "identity": {
- "description": "Service identity associated with a resource.",
- "$ref": "#/definitions/ResourceIdentity"
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/PartialBatchDeployment"
- }
- },
- "additionalProperties": false
- },
- "BatchDeploymentTrackedResourceArmPaginatedResult": {
- "description": "A paginated list of BatchDeployment entities.",
- "type": "object",
- "properties": {
"value": {
"description": "An array of objects of type BatchDeployment.",
"type": "array",
"items": {
"$ref": "#/definitions/BatchDeploymentTrackedResource"
}
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "EndpointAuthMode": {
- "description": "Enum to determine endpoint authentication mode.",
- "enum": [
- "AMLToken",
- "Key",
- "AADToken"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EndpointAuthMode",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "EndpointAuthKeys": {
- "description": "Keys for endpoint authentication.",
- "type": "object",
- "properties": {
- "primaryKey": {
- "description": "The primary key.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "secondaryKey": {
- "description": "The secondary key.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
}
},
"additionalProperties": false
@@ -5369,6 +5445,14 @@
"description": "Description of the inference endpoint.",
"type": "string"
},
+ "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
+ },
"properties": {
"description": "Property dictionary. Properties can be added, but not removed or altered.",
"type": "object",
@@ -5376,14 +5460,6 @@
"type": "string"
}
},
- "traffic": {
- "description": "Traffic rules on how the traffic will be routed across deployments.",
- "type": "object",
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- }
- },
"scoringUri": {
"format": "uri",
"description": "Endpoint URI.",
@@ -5402,13 +5478,13 @@
"read"
]
},
- "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
+ "traffic": {
+ "description": "Traffic rules on how the traffic will be routed across deployments.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ }
}
},
"additionalProperties": false
@@ -5425,13 +5501,13 @@
}
],
"properties": {
- "kind": {
- "type": "string"
- },
"identity": {
"description": "Service identity associated with a resource.",
"$ref": "#/definitions/ResourceIdentity"
},
+ "kind": {
+ "type": "string"
+ },
"properties": {
"description": "Additional attributes of the entity.",
"$ref": "#/definitions/BatchEndpoint"
@@ -5447,171 +5523,222 @@
},
"additionalProperties": false
},
- "PartialBatchEndpoint": {
- "description": "Mutable Batch endpoint configuration",
- "type": "object",
- "properties": {
- "traffic": {
- "description": "Traffic rules on how the traffic will be routed across deployments.",
- "type": "object",
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "additionalProperties": false
- },
- "PartialBatchEndpointPartialTrackedResource": {
- "description": "Strictly used in update requests.",
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
- "type": "string"
- },
- "kind": {
- "type": "string"
- },
- "identity": {
- "description": "Service identity associated with a resource.",
- "$ref": "#/definitions/ResourceIdentity"
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/PartialBatchEndpoint"
- }
- },
- "additionalProperties": false
- },
"BatchEndpointTrackedResourceArmPaginatedResult": {
"description": "A paginated list of BatchEndpoint entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
"description": "An array of objects of type BatchEndpoint.",
"type": "array",
"items": {
"$ref": "#/definitions/BatchEndpointTrackedResource"
}
- },
- "nextLink": {
- "type": "string"
}
},
"additionalProperties": false
},
- "CodeContainer": {
- "description": "Container for code asset versions.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The asset property dictionary.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "description": {
- "description": "The asset description text.",
- "type": "string"
- }
+ "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
},
"additionalProperties": false
},
- "CodeContainerResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
+ "BatchOutputAction": {
+ "description": "Enum to determine how batch inferencing will handle output",
+ "enum": [
+ "SummaryOnly",
+ "AppendRow"
],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "BatchOutputAction",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "BatchOutputConfiguration": {
+ "description": "Batch inference output configuration.",
"type": "object",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
- }
- ],
"properties": {
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/CodeContainer"
+ "appendRowFileName": {
+ "description": "Customized output file name for append_row output action.",
+ "type": "string"
},
- "systemData": {
- "description": "System data associated with resource provider",
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "outputAction": {
+ "description": "Indicates how the output will be organized.",
+ "$ref": "#/definitions/BatchOutputAction"
}
},
"additionalProperties": false
},
- "CodeContainerResourceArmPaginatedResult": {
- "description": "A paginated list of CodeContainer entities.",
+ "BatchRetrySettings": {
+ "description": "Retry settings for a batch inference operation.",
"type": "object",
"properties": {
- "value": {
- "description": "An array of objects of type CodeContainer.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CodeContainerResource"
- }
+ "maxRetries": {
+ "format": "int32",
+ "description": "Maximum retry count for a mini-batch",
+ "type": "integer"
},
- "nextLink": {
+ "timeout": {
+ "format": "duration",
+ "description": "Invocation timeout for a mini-batch, in ISO 8601 format.",
"type": "string"
}
},
"additionalProperties": false
},
- "CodeVersion": {
- "description": "Code asset version details.",
+ "CertificateDatastoreCredentials": {
+ "description": "Certificate datastore credentials configuration.",
"required": [
- "path"
+ "clientId",
+ "tenantId",
+ "thumbprint"
],
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreCredentials"
+ }
+ ],
"properties": {
- "datastoreId": {
- "description": "ARM resource ID of the datastore where the asset is located.",
+ "authorityUrl": {
+ "description": "Authority URL used for authentication.",
"type": "string"
},
- "path": {
- "description": "The path of the file/directory in the datastore.",
+ "clientId": {
+ "format": "uuid",
+ "description": "Service principal client ID.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "Resource the service principal has access to.",
+ "type": "string"
+ },
+ "secrets": {
+ "description": "Service principal secrets.",
+ "$ref": "#/definitions/CertificateDatastoreSecrets",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ],
+ "x-ms-secret": true
+ },
+ "tenantId": {
+ "format": "uuid",
+ "description": "ID of the tenant to which the service principal belongs.",
+ "type": "string"
+ },
+ "thumbprint": {
+ "description": "Thumbprint of the certificate used for authentication.",
"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-ms-discriminator-value": "Certificate",
+ "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"
+ ]
},
- "isAnonymous": {
- "description": "If the name version are system generated (anonymous registration).",
- "type": "boolean",
+ "snapshotPath": {
+ "description": "The output path where the labels will be exported.",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ }
+ },
+ "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"
]
},
+ "scoringScript": {
+ "description": "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",
+ "properties": {
"description": {
"description": "The asset description text.",
"type": "string"
},
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "properties": {
+ "description": "The asset property dictionary.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
- "properties": {
- "description": "The asset property dictionary.",
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
"type": "object",
"additionalProperties": {
"type": "string"
@@ -5620,7 +5747,7 @@
},
"additionalProperties": false
},
- "CodeVersionResource": {
+ "CodeContainerResource": {
"description": "Azure Resource Manager resource envelope.",
"required": [
"properties"
@@ -5634,7 +5761,7 @@
"properties": {
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/CodeVersion"
+ "$ref": "#/definitions/CodeContainer"
},
"systemData": {
"description": "System data associated with resource provider",
@@ -5647,27 +5774,51 @@
},
"additionalProperties": false
},
- "CodeVersionResourceArmPaginatedResult": {
- "description": "A paginated list of CodeVersion entities.",
+ "CodeContainerResourceArmPaginatedResult": {
+ "description": "A paginated list of CodeContainer entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
- "description": "An array of objects of type CodeVersion.",
+ "description": "An array of objects of type CodeContainer.",
"type": "array",
"items": {
- "$ref": "#/definitions/CodeVersionResource"
+ "$ref": "#/definitions/CodeContainerResource"
}
- },
- "nextLink": {
- "type": "string"
}
},
"additionalProperties": false
},
- "DataContainer": {
- "description": "Container for data asset versions.",
+ "CodeVersion": {
+ "description": "Code asset version details.",
+ "required": [
+ "path"
+ ],
"type": "object",
"properties": {
+ "datastoreId": {
+ "description": "ARM resource ID of the datastore where the asset is located.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The asset description text.",
+ "type": "string"
+ },
+ "isAnonymous": {
+ "description": "If the name version are system generated (anonymous registration).",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "path": {
+ "description": "The path of the file/directory in the datastore.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string"
+ },
"properties": {
"description": "The asset property dictionary.",
"type": "object",
@@ -5681,15 +5832,11 @@
"additionalProperties": {
"type": "string"
}
- },
- "description": {
- "description": "The asset description text.",
- "type": "string"
}
},
"additionalProperties": false
},
- "DataContainerResource": {
+ "CodeVersionResource": {
"description": "Azure Resource Manager resource envelope.",
"required": [
"properties"
@@ -5703,7 +5850,7 @@
"properties": {
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/DataContainer"
+ "$ref": "#/definitions/CodeVersion"
},
"systemData": {
"description": "System data associated with resource provider",
@@ -5716,510 +5863,47 @@
},
"additionalProperties": false
},
- "DataContainerResourceArmPaginatedResult": {
- "description": "A paginated list of DataContainer entities.",
+ "CodeVersionResourceArmPaginatedResult": {
+ "description": "A paginated list of CodeVersion entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
- "description": "An array of objects of type DataContainer.",
+ "description": "An array of objects of type CodeVersion.",
"type": "array",
"items": {
- "$ref": "#/definitions/DataContainerResource"
+ "$ref": "#/definitions/CodeVersionResource"
}
- },
- "nextLink": {
- "type": "string"
}
},
"additionalProperties": false
},
- "ContentsType": {
- "description": "Enum to determine the datastore contents type.",
- "enum": [
- "AzureBlob",
- "AzureDataLakeGen1",
- "AzureDataLakeGen2",
- "AzureFile",
- "AzureMySql",
- "AzurePostgreSql",
- "AzureSqlDatabase",
- "GlusterFs"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ContentsType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "CredentialsType": {
- "description": "Enum to determine the datastore credentials type.",
- "enum": [
- "AccountKey",
- "Certificate",
- "None",
- "Sas",
- "ServicePrincipal",
- "SqlAdmin"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "CredentialsType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "SecretsType": {
- "description": "Enum to determine the datastore secrets type.",
- "enum": [
- "AccountKey",
- "Certificate",
- "None",
- "Sas",
- "ServicePrincipal",
- "SqlAdmin"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SecretsType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "DatastoreSecrets": {
- "description": "Base definition for datastore secrets.",
+ "CommandJob": {
+ "description": "Command job definition.",
"required": [
- "secretsType"
+ "command",
+ "compute"
],
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobBase"
+ }
+ ],
"properties": {
- "secretsType": {
- "description": "Credential type used to authentication with storage.",
- "$ref": "#/definitions/SecretsType"
- }
- },
- "discriminator": "secretsType"
- },
- "AccountKeyDatastoreSecrets": {
- "description": "Datastore account key secrets.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreSecrets"
- }
- ],
- "properties": {
- "key": {
- "description": "Storage account key.",
- "type": "string"
- }
- },
- "x-ms-discriminator-value": "AccountKey",
- "additionalProperties": false
- },
- "DatastoreCredentials": {
- "description": "Base definition for datastore credentials.",
- "required": [
- "credentialsType"
- ],
- "type": "object",
- "properties": {
- "credentialsType": {
- "description": "Credential type used to authentication with storage.",
- "$ref": "#/definitions/CredentialsType"
- }
- },
- "discriminator": "credentialsType"
- },
- "AccountKeyDatastoreCredentials": {
- "description": "Account key datastore credentials configuration.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ],
- "properties": {
- "secrets": {
- "description": "Storage account secrets.",
- "$ref": "#/definitions/AccountKeyDatastoreSecrets",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "x-ms-discriminator-value": "AccountKey",
- "additionalProperties": false
- },
- "CertificateDatastoreSecrets": {
- "description": "Datastore certificate secrets.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreSecrets"
- }
- ],
- "properties": {
- "certificate": {
- "description": "Service principal certificate.",
- "type": "string"
- }
- },
- "x-ms-discriminator-value": "Certificate",
- "additionalProperties": false
- },
- "CertificateDatastoreCredentials": {
- "description": "Certificate datastore credentials configuration.",
- "required": [
- "clientId",
- "tenantId",
- "thumbprint"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ],
- "properties": {
- "authorityUrl": {
- "description": "Authority URL used for authentication.",
- "type": "string"
- },
- "resourceUri": {
- "description": "Resource the service principal has access to.",
- "type": "string"
- },
- "tenantId": {
- "format": "uuid",
- "description": "ID of the tenant to which the service principal belongs.",
- "type": "string"
- },
- "clientId": {
- "format": "uuid",
- "description": "Service principal client ID.",
- "type": "string"
- },
- "thumbprint": {
- "description": "Thumbprint of the certificate used for authentication.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string"
- },
- "secrets": {
- "description": "Service principal secrets.",
- "$ref": "#/definitions/CertificateDatastoreSecrets",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "x-ms-discriminator-value": "Certificate",
- "additionalProperties": false
- },
- "NoneDatastoreSecrets": {
- "description": "Empty/none datastore secret.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreSecrets"
- }
- ],
- "x-ms-discriminator-value": "None",
- "additionalProperties": false
- },
- "NoneDatastoreCredentials": {
- "description": "Empty/none datastore credentials.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ],
- "properties": {
- "secrets": {
- "description": "Empty/none datastore secret.",
- "$ref": "#/definitions/NoneDatastoreSecrets",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "x-ms-discriminator-value": "None",
- "additionalProperties": false
- },
- "SasDatastoreSecrets": {
- "description": "Datastore SAS secrets.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreSecrets"
- }
- ],
- "properties": {
- "sasToken": {
- "description": "Storage container SAS token.",
- "type": "string"
- }
- },
- "x-ms-discriminator-value": "Sas",
- "additionalProperties": false
- },
- "SasDatastoreCredentials": {
- "description": "SAS datastore credentials configuration.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ],
- "properties": {
- "secrets": {
- "description": "Storage container secrets.",
- "$ref": "#/definitions/SasDatastoreSecrets",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "x-ms-discriminator-value": "Sas",
- "additionalProperties": false
- },
- "ServicePrincipalDatastoreSecrets": {
- "description": "Datastore Service Principal secrets.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreSecrets"
- }
- ],
- "properties": {
- "clientSecret": {
- "description": "Service principal secret.",
- "type": "string"
- }
- },
- "x-ms-discriminator-value": "ServicePrincipal",
- "additionalProperties": false
- },
- "ServicePrincipalDatastoreCredentials": {
- "description": "Service Principal datastore credentials configuration.",
- "required": [
- "clientId",
- "tenantId"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ],
- "properties": {
- "authorityUrl": {
- "description": "Authority URL used for authentication.",
- "type": "string"
- },
- "resourceUri": {
- "description": "Resource the service principal has access to.",
- "type": "string"
- },
- "tenantId": {
- "format": "uuid",
- "description": "ID of the tenant to which the service principal belongs.",
- "type": "string"
- },
- "clientId": {
- "format": "uuid",
- "description": "Service principal client ID.",
- "type": "string"
- },
- "secrets": {
- "description": "Service principal secrets.",
- "$ref": "#/definitions/ServicePrincipalDatastoreSecrets",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "x-ms-discriminator-value": "ServicePrincipal",
- "additionalProperties": false
- },
- "SqlAdminDatastoreSecrets": {
- "description": "Datastore SQL Admin secrets.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreSecrets"
- }
- ],
- "properties": {
- "password": {
- "description": "SQL database password.",
- "type": "string"
- }
- },
- "x-ms-discriminator-value": "SqlAdmin",
- "additionalProperties": false
- },
- "SqlAdminDatastoreCredentials": {
- "description": "SQL Admin datastore credentials configuration.",
- "required": [
- "userId"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ],
- "properties": {
- "userId": {
- "description": "SQL database user name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string"
- },
- "secrets": {
- "description": "SQL database secrets.",
- "$ref": "#/definitions/SqlAdminDatastoreSecrets",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "x-ms-discriminator-value": "SqlAdmin",
- "additionalProperties": false
- },
- "DatastoreContents": {
- "description": "Base definition for datastore contents configuration.",
- "required": [
- "contentsType"
- ],
- "type": "object",
- "properties": {
- "contentsType": {
- "description": "Storage type backing the datastore.",
- "$ref": "#/definitions/ContentsType"
- }
- },
- "discriminator": "contentsType"
- },
- "AzureBlobContents": {
- "description": "Azure Blob datastore configuration.",
- "required": [
- "accountName",
- "containerName",
- "credentials",
- "endpoint",
- "protocol"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
- }
- ],
- "properties": {
- "accountName": {
- "description": "Storage account name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "containerName": {
- "description": "Storage account container name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "endpoint": {
- "description": "Azure cloud endpoint for the storage account.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "example": "core.windows.net",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "protocol": {
- "description": "Protocol used to communicate with the storage account.",
- "pattern": "[a-zA-Z0-9_]",
+ "codeId": {
+ "description": "ARM resource ID of the code asset.",
"type": "string",
- "example": "https",
"x-ms-mutability": [
"create",
"read"
]
},
- "credentials": {
- "description": "Account credentials.",
- "$ref": "#/definitions/DatastoreCredentials"
- }
- },
- "x-ms-discriminator-value": "AzureBlob",
- "additionalProperties": false
- },
- "AzureDataLakeGen1Contents": {
- "description": "Azure Data Lake Gen1 datastore configuration.",
- "required": [
- "credentials",
- "storeName"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
- }
- ],
- "properties": {
- "storeName": {
- "description": "Azure Data Lake store name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string"
- },
- "credentials": {
- "description": "Account credentials.",
- "$ref": "#/definitions/DatastoreCredentials"
- }
- },
- "x-ms-discriminator-value": "AzureDataLakeGen1",
- "additionalProperties": false
- },
- "AzureDataLakeGen2Contents": {
- "description": "Azure Data Lake Gen2 datastore configuration.",
- "required": [
- "accountName",
- "containerName",
- "credentials",
- "endpoint",
- "protocol"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
- }
- ],
- "properties": {
- "accountName": {
- "description": "Storage account name.",
+ "command": {
+ "description": "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": [
@@ -6227,260 +5911,168 @@
"read"
]
},
- "containerName": {
- "description": "Storage account container name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
+ "compute": {
+ "description": "Compute binding for the job.",
+ "$ref": "#/definitions/ComputeConfiguration",
"x-ms-mutability": [
"create",
"read"
]
},
- "endpoint": {
- "description": "Azure cloud endpoint for the storage account.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "example": "core.windows.net",
+ "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"
]
},
- "protocol": {
- "description": "Protocol used to communicate with the storage account.",
- "pattern": "[a-zA-Z0-9_]",
+ "environmentId": {
+ "description": "The ARM resource ID of the Environment specification for the job.",
"type": "string",
- "example": "https",
"x-ms-mutability": [
"create",
"read"
]
},
- "credentials": {
- "description": "Account credentials.",
- "$ref": "#/definitions/DatastoreCredentials"
- }
- },
- "x-ms-discriminator-value": "AzureDataLakeGen2",
- "additionalProperties": false
- },
- "AzureFileContents": {
- "description": "Azure File datastore configuration.",
- "required": [
- "accountName",
- "containerName",
- "credentials",
- "endpoint",
- "protocol"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
- }
- ],
- "properties": {
- "accountName": {
- "description": "Storage account name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
+ "environmentVariables": {
+ "description": "Environment variables included in the job.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
"x-ms-mutability": [
"create",
"read"
]
},
- "containerName": {
- "description": "Storage account container name.",
- "pattern": "[a-zA-Z0-9_]",
+ "experimentName": {
+ "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "endpoint": {
- "description": "Azure cloud endpoint for the storage account.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "example": "core.windows.net",
+ "identity": {
+ "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null.\r\nDefaults to AmlToken if null.",
+ "$ref": "#/definitions/IdentityConfiguration",
"x-ms-mutability": [
"create",
"read"
]
},
- "protocol": {
- "description": "Protocol used to communicate with the storage account.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "example": "https",
+ "inputDataBindings": {
+ "description": "Mapping of input data bindings used in the job.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/InputDataBinding"
+ },
"x-ms-mutability": [
"create",
"read"
]
},
- "credentials": {
- "description": "Account credentials.",
- "$ref": "#/definitions/DatastoreCredentials"
- }
- },
- "x-ms-discriminator-value": "AzureFile",
- "additionalProperties": false
- },
- "AzurePostgreSqlContents": {
- "description": "Azure Postgre SQL datastore configuration.",
- "required": [
- "credentials",
- "databaseName",
- "endpoint",
- "portNumber",
- "serverName"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
- }
- ],
- "properties": {
- "enableSSL": {
- "description": "Whether the Azure PostgreSQL server requires SSL.",
- "type": "boolean",
+ "output": {
+ "description": "Location of the job output logs and artifacts.",
+ "$ref": "#/definitions/JobOutput",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "databaseName": {
- "description": "Azure SQL database name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
+ "outputDataBindings": {
+ "description": "Mapping of output data bindings used in the job.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/OutputDataBinding"
+ },
"x-ms-mutability": [
"create",
"read"
]
},
- "endpoint": {
- "description": "Azure cloud endpoint for the database.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "example": "database.windows.net",
+ "parameters": {
+ "description": "Input parameters.",
+ "type": "object",
+ "additionalProperties": {},
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "portNumber": {
+ "priority": {
"format": "int32",
- "description": "Azure SQL server port.",
+ "description": "Job priority for scheduling policy. Only applies to AMLCompute.\r\nPrivate preview feature and only available to users on the allow list.",
"type": "integer",
"x-ms-mutability": [
"create",
"read"
]
},
- "serverName": {
- "description": "Azure SQL server name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
+ "status": {
+ "description": "Status of the job.",
+ "$ref": "#/definitions/JobStatus",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "credentials": {
- "description": "Account credentials.",
- "$ref": "#/definitions/DatastoreCredentials"
- }
- },
- "x-ms-discriminator-value": "AzurePostgreSql",
- "additionalProperties": false
- },
- "AzureSqlDatabaseContents": {
- "description": "Azure SQL Database datastore configuration.",
- "required": [
- "credentials",
- "databaseName",
- "endpoint",
- "portNumber",
- "serverName"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
+ "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-ms-discriminator-value": "Command",
+ "additionalProperties": false
+ },
+ "ComputeConfiguration": {
+ "description": "Configuration for compute binding.",
+ "type": "object",
"properties": {
- "databaseName": {
- "description": "Azure SQL database name.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
+ "instanceCount": {
+ "format": "int32",
+ "description": "Number of instances or nodes.",
+ "type": "integer",
"x-ms-mutability": [
"create",
"read"
]
},
- "endpoint": {
- "description": "Azure cloud endpoint for the database.",
- "pattern": "[a-zA-Z0-9_]",
+ "instanceType": {
+ "description": "SKU type to run on.",
"type": "string",
- "example": "database.windows.net",
"x-ms-mutability": [
"create",
"read"
]
},
- "portNumber": {
- "format": "int32",
- "description": "Azure SQL server port.",
- "type": "integer",
+ "isLocal": {
+ "description": "Set to true for jobs running on local compute.",
+ "type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
- "serverName": {
- "description": "Azure SQL server name.",
- "pattern": "[a-zA-Z0-9_]",
+ "location": {
+ "description": "Location for virtual cluster run.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "credentials": {
- "description": "Account credentials.",
- "$ref": "#/definitions/DatastoreCredentials"
- }
- },
- "x-ms-discriminator-value": "AzureSqlDatabase",
- "additionalProperties": false
- },
- "GlusterFsContents": {
- "description": "GlusterFs datastore configuration.",
- "required": [
- "serverAddress",
- "volumeName"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
- }
- ],
- "properties": {
- "serverAddress": {
- "description": "GlusterFS server address (can be the IP address or server name).",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
+ "properties": {
+ "description": "Additional properties.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
},
- "volumeName": {
- "description": "GlusterFS volume name.",
- "pattern": "[a-zA-Z0-9_]",
+ "target": {
+ "description": "ARM resource ID of the compute resource.",
"type": "string",
"x-ms-mutability": [
"create",
@@ -6488,185 +6080,115 @@
]
}
},
- "x-ms-discriminator-value": "GlusterFs",
"additionalProperties": false
},
- "OriginType": {
- "description": "Enum to determine the type of linked service.",
+ "ContainerType": {
"enum": [
- "Synapse"
+ "StorageInitializer",
+ "InferenceServer"
],
"type": "string",
"x-ms-enum": {
- "name": "OriginType",
+ "name": "ContainerType",
"modelAsString": true
},
"additionalProperties": false
},
- "LinkedInfo": {
- "description": "Information about a datastore origin, if linked.",
- "type": "object",
- "properties": {
- "linkedId": {
- "description": "Linked service ID.",
- "type": "string"
- },
- "linkedResourceName": {
- "description": "Linked service resource name.",
- "type": "string"
- },
- "origin": {
- "description": "Type of the linked service.",
- "$ref": "#/definitions/OriginType"
- }
+ "ContentsType": {
+ "description": "Enum to determine the datastore contents type.",
+ "enum": [
+ "AzureBlob",
+ "AzureDataLakeGen1",
+ "AzureDataLakeGen2",
+ "AzureFile",
+ "AzureMySql",
+ "AzurePostgreSql",
+ "AzureSqlDatabase",
+ "GlusterFs"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ContentsType",
+ "modelAsString": true
},
"additionalProperties": false
},
- "DatastoreProperties": {
- "description": "Datastore definition.",
- "required": [
- "contents"
+ "CredentialsType": {
+ "description": "Enum to determine the datastore credentials type.",
+ "enum": [
+ "AccountKey",
+ "Certificate",
+ "None",
+ "Sas",
+ "ServicePrincipal",
+ "SqlAdmin"
],
- "type": "object",
- "properties": {
- "contents": {
- "description": "Reference to the datastore storage contents.",
- "$ref": "#/definitions/DatastoreContents"
- },
- "hasBeenValidated": {
- "description": "Whether the service has validated access to the datastore with the provided credentials.",
- "type": "boolean",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "isDefault": {
- "description": "Whether this datastore is the default for the workspace.",
- "type": "boolean"
- },
- "linkedInfo": {
- "description": "Information about the datastore origin, if linked.",
- "$ref": "#/definitions/LinkedInfo"
- },
- "properties": {
- "description": "The asset property dictionary.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "description": {
- "description": "The asset description text.",
- "type": "string"
- },
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CredentialsType",
+ "modelAsString": true
},
"additionalProperties": false
},
- "DatastorePropertiesResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
+ "CsvExportSummary": {
"type": "object",
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
+ "$ref": "#/definitions/ExportSummary"
}
],
"properties": {
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/DatastoreProperties"
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "containerName": {
+ "description": "The container name to which the labels will be exported.",
+ "type": "string",
"readOnly": true,
"x-ms-mutability": [
"read"
]
- }
- },
- "additionalProperties": false
- },
- "DatastorePropertiesResourceArmPaginatedResult": {
- "description": "A paginated list of DatastoreProperties entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type DatastoreProperties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/DatastorePropertiesResource"
- }
},
- "nextLink": {
- "type": "string"
+ "snapshotPath": {
+ "description": "The output path where the labels will be exported.",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
}
},
+ "x-ms-discriminator-value": "CSV",
"additionalProperties": false
},
- "DatasetType": {
+ "DataBindingMode": {
+ "description": "Describes how the data should be attached to the container.",
"enum": [
- "Simple",
- "Dataflow"
+ "Mount",
+ "Download",
+ "Upload"
],
"type": "string",
"x-ms-enum": {
- "name": "DatasetType",
+ "name": "DataBindingMode",
"modelAsString": true
},
"additionalProperties": false
},
- "DataVersion": {
- "description": "Data asset version details.",
- "required": [
- "path"
- ],
+ "DataContainer": {
+ "description": "Container for data asset versions.",
"type": "object",
"properties": {
- "datasetType": {
- "description": "The Format of dataset.",
- "$ref": "#/definitions/DatasetType"
- },
- "datastoreId": {
- "description": "ARM resource ID of the datastore where the asset is located.",
- "type": "string"
- },
- "path": {
- "description": "The path of the file/directory in the datastore.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string"
- },
- "isAnonymous": {
- "description": "If the name version are system generated (anonymous registration).",
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
"description": {
"description": "The asset description text.",
"type": "string"
},
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "properties": {
+ "description": "The asset property dictionary.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
- "properties": {
- "description": "The asset property dictionary.",
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
"type": "object",
"additionalProperties": {
"type": "string"
@@ -6675,7 +6197,7 @@
},
"additionalProperties": false
},
- "DataVersionResource": {
+ "DataContainerResource": {
"description": "Azure Resource Manager resource envelope.",
"required": [
"properties"
@@ -6689,7 +6211,7 @@
"properties": {
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/DataVersion"
+ "$ref": "#/definitions/DataContainer"
},
"systemData": {
"description": "System data associated with resource provider",
@@ -6702,27 +6224,76 @@
},
"additionalProperties": false
},
- "DataVersionResourceArmPaginatedResult": {
- "description": "A paginated list of DataVersion entities.",
+ "DataContainerResourceArmPaginatedResult": {
+ "description": "A paginated list of DataContainer entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
- "description": "An array of objects of type DataVersion.",
+ "description": "An array of objects of type DataContainer.",
"type": "array",
"items": {
- "$ref": "#/definitions/DataVersionResource"
+ "$ref": "#/definitions/DataContainerResource"
}
+ }
+ },
+ "additionalProperties": false
+ },
+ "DataPathAssetReference": {
+ "description": "Reference to an asset via its path in a datastore.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AssetReferenceBase"
+ }
+ ],
+ "properties": {
+ "datastoreId": {
+ "description": "ARM resource ID of the datastore where the asset is located.",
+ "type": "string"
},
- "nextLink": {
+ "path": {
+ "description": "The path of the file/directory in the datastore.",
"type": "string"
}
},
+ "x-ms-discriminator-value": "DataPath",
"additionalProperties": false
},
- "EnvironmentContainer": {
- "description": "Container for environment specification versions.",
+ "DataVersion": {
+ "description": "Data asset version details.",
+ "required": [
+ "path"
+ ],
"type": "object",
"properties": {
+ "datasetType": {
+ "description": "The Format of dataset.",
+ "$ref": "#/definitions/DatasetType"
+ },
+ "datastoreId": {
+ "description": "ARM resource ID of the datastore where the asset is located.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The asset description text.",
+ "type": "string"
+ },
+ "isAnonymous": {
+ "description": "If the name version are system generated (anonymous registration).",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "path": {
+ "description": "The path of the file/directory in the datastore.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string"
+ },
"properties": {
"description": "The asset property dictionary.",
"type": "object",
@@ -6736,15 +6307,11 @@
"additionalProperties": {
"type": "string"
}
- },
- "description": {
- "description": "The asset description text.",
- "type": "string"
}
},
"additionalProperties": false
},
- "EnvironmentContainerResource": {
+ "DataVersionResource": {
"description": "Azure Resource Manager resource envelope.",
"required": [
"properties"
@@ -6758,7 +6325,7 @@
"properties": {
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/EnvironmentContainer"
+ "$ref": "#/definitions/DataVersion"
},
"systemData": {
"description": "System data associated with resource provider",
@@ -6771,239 +6338,123 @@
},
"additionalProperties": false
},
- "EnvironmentContainerResourceArmPaginatedResult": {
- "description": "A paginated list of EnvironmentContainer entities.",
+ "DataVersionResourceArmPaginatedResult": {
+ "description": "A paginated list of DataVersion entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
- "description": "An array of objects of type EnvironmentContainer.",
+ "description": "An array of objects of type DataVersion.",
"type": "array",
"items": {
- "$ref": "#/definitions/EnvironmentContainerResource"
+ "$ref": "#/definitions/DataVersionResource"
}
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "EnvironmentSpecificationType": {
- "description": "Environment specification is either user created or curated by Azure ML service",
- "enum": [
- "Curated",
- "UserCreated"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EnvironmentSpecificationType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "DockerSpecificationType": {
- "description": "Enum to determine docker specification type. Must be either Build or Image.",
- "enum": [
- "Build",
- "Image"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "DockerSpecificationType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "OperatingSystemType": {
- "description": "The type of operating system.",
- "enum": [
- "Linux",
- "Windows"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "OperatingSystemType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "DockerImagePlatform": {
- "type": "object",
- "properties": {
- "operatingSystemType": {
- "description": "The OS type the Environment.",
- "$ref": "#/definitions/OperatingSystemType"
}
},
"additionalProperties": false
},
- "DockerSpecification": {
- "description": "Configuration settings for Docker",
- "required": [
- "dockerSpecificationType"
- ],
- "type": "object",
- "properties": {
- "dockerSpecificationType": {
- "description": "Docker specification must be either Build or Image",
- "$ref": "#/definitions/DockerSpecificationType",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "platform": {
- "description": "The platform information of the docker image.",
- "$ref": "#/definitions/DockerImagePlatform",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "discriminator": "dockerSpecificationType"
- },
- "DockerImage": {
- "description": "Class to represent configuration settings for Docker Build",
- "required": [
- "dockerImageUri"
- ],
+ "DatasetExportSummary": {
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/DockerSpecification"
+ "$ref": "#/definitions/ExportSummary"
}
],
"properties": {
- "dockerImageUri": {
- "description": "Image name of a custom base image.\r\n",
- "pattern": "[a-zA-Z0-9_]",
+ "labeledAssetName": {
+ "description": "The unique name of the labeled data asset.",
"type": "string",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
}
},
- "x-ms-discriminator-value": "Image",
+ "x-ms-discriminator-value": "Dataset",
"additionalProperties": false
},
- "DockerBuild": {
- "description": "Class to represent configuration settings for Docker Build",
- "required": [
- "dockerfile"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DockerSpecification"
- }
+ "DatasetType": {
+ "enum": [
+ "Simple",
+ "Dataflow"
],
- "properties": {
- "dockerfile": {
- "description": "Docker command line instructions to assemble an image.\r\n",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "context": {
- "description": "Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified.\r\nThe path is relative to the asset path which must contain a single Blob URI value.\r\n",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DatasetType",
+ "modelAsString": true
},
- "x-ms-discriminator-value": "Build",
"additionalProperties": false
},
- "Route": {
+ "DatastoreContents": {
+ "description": "Base definition for datastore contents configuration.",
"required": [
- "path",
- "port"
+ "contentsType"
],
"type": "object",
"properties": {
- "path": {
- "description": "The path for the route.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string"
- },
- "port": {
- "format": "int32",
- "description": "The port for the route.",
- "type": "integer"
+ "contentsType": {
+ "description": "Storage type backing the datastore.",
+ "$ref": "#/definitions/ContentsType"
}
},
- "additionalProperties": false
+ "discriminator": "contentsType"
},
- "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"
+ "DatastoreCredentials": {
+ "description": "Base definition for datastore credentials.",
+ "required": [
+ "credentialsType"
+ ],
+ "type": "object",
+ "properties": {
+ "credentialsType": {
+ "description": "Credential type used to authentication with storage.",
+ "$ref": "#/definitions/CredentialsType"
}
},
- "additionalProperties": false
+ "discriminator": "credentialsType"
},
- "EnvironmentSpecificationVersion": {
- "description": "Environment specification version details.\r\n",
+ "DatastoreProperties": {
+ "description": "Datastore definition.",
+ "required": [
+ "contents"
+ ],
"type": "object",
"properties": {
- "environmentSpecificationType": {
- "description": "Environment specification is either user managed or curated by the Azure ML service\r\n",
- "$ref": "#/definitions/EnvironmentSpecificationType",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "docker": {
- "description": "Configuration settings for Docker.",
- "$ref": "#/definitions/DockerSpecification"
+ "contents": {
+ "description": "Reference to the datastore storage contents.",
+ "$ref": "#/definitions/DatastoreContents"
},
- "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",
+ "description": {
+ "description": "The asset description text.",
"type": "string"
},
- "inferenceContainerProperties": {
- "description": "Defines configuration specific to inference.",
- "$ref": "#/definitions/InferenceContainerProperties"
- },
- "isAnonymous": {
- "description": "If the name version are system generated (anonymous registration).",
+ "hasBeenValidated": {
+ "description": "Whether the service has validated access to the datastore with the provided credentials.",
"type": "boolean",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "description": {
- "description": "The asset description text.",
- "type": "string"
+ "isDefault": {
+ "description": "Whether this datastore is the default for the workspace.",
+ "type": "boolean"
},
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "linkedInfo": {
+ "description": "Information about the datastore origin, if linked.",
+ "$ref": "#/definitions/LinkedInfo"
+ },
+ "properties": {
+ "description": "The asset property dictionary.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
- "properties": {
- "description": "The asset property dictionary.",
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
"type": "object",
"additionalProperties": {
"type": "string"
@@ -7012,7 +6463,7 @@
},
"additionalProperties": false
},
- "EnvironmentSpecificationVersionResource": {
+ "DatastorePropertiesResource": {
"description": "Azure Resource Manager resource envelope.",
"required": [
"properties"
@@ -7026,7 +6477,7 @@
"properties": {
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/EnvironmentSpecificationVersion"
+ "$ref": "#/definitions/DatastoreProperties"
},
"systemData": {
"description": "System data associated with resource provider",
@@ -7039,437 +6490,469 @@
},
"additionalProperties": false
},
- "EnvironmentSpecificationVersionResourceArmPaginatedResult": {
- "description": "A paginated list of EnvironmentSpecificationVersion entities.",
+ "DatastorePropertiesResourceArmPaginatedResult": {
+ "description": "A paginated list of DatastoreProperties entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
- "description": "An array of objects of type EnvironmentSpecificationVersion.",
+ "description": "An array of objects of type DatastoreProperties.",
"type": "array",
"items": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
+ "$ref": "#/definitions/DatastorePropertiesResource"
}
- },
- "nextLink": {
- "type": "string"
}
},
"additionalProperties": false
},
- "JobType": {
- "description": "Enum to determine the type of job.",
- "enum": [
- "Command",
- "Sweep",
- "Labeling"
+ "DatastoreSecrets": {
+ "description": "Base definition for datastore secrets.",
+ "required": [
+ "secretsType"
],
- "type": "string",
- "x-ms-enum": {
- "name": "JobType",
- "modelAsString": true
+ "type": "object",
+ "properties": {
+ "secretsType": {
+ "description": "Credential type used to authentication with storage.",
+ "$ref": "#/definitions/SecretsType"
+ }
+ },
+ "discriminator": "secretsType"
+ },
+ "DeploymentLogs": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string"
+ }
},
"additionalProperties": false
},
- "JobOutput": {
- "description": "Job output definition container information on where to find job output/logs.",
+ "DeploymentLogsRequest": {
"type": "object",
"properties": {
- "datastoreId": {
- "description": "ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container (\"azureml\") in the workspace's storage account.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "containerType": {
+ "description": "The type of container to retrieve logs from.",
+ "$ref": "#/definitions/ContainerType"
},
- "path": {
- "description": "Path within the datastore to the job logs and artifacts.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "tail": {
+ "format": "int32",
+ "description": "The maximum number of lines to tail.",
+ "type": "integer"
}
},
"additionalProperties": false
},
- "JobStatus": {
- "description": "The status of a job.",
+ "DeploymentProvisioningState": {
"enum": [
- "NotStarted",
- "Starting",
- "Provisioning",
- "Preparing",
- "Queued",
- "Running",
- "Finalizing",
- "CancelRequested",
- "Completed",
+ "Creating",
+ "Deleting",
+ "Scaling",
+ "Updating",
+ "Succeeded",
"Failed",
- "Canceled",
- "NotResponding",
- "Paused",
- "Unknown"
+ "Canceled"
],
"type": "string",
"x-ms-enum": {
- "name": "JobStatus",
+ "name": "DeploymentProvisioningState",
"modelAsString": true
},
"additionalProperties": false
},
- "DataBindingMode": {
- "description": "Describes how the data should be attached to the container.",
+ "DistributionConfiguration": {
+ "description": "Base definition for job distribution configuration.",
+ "required": [
+ "distributionType"
+ ],
+ "type": "object",
+ "properties": {
+ "distributionType": {
+ "description": "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": [
- "Mount",
- "Download",
- "Upload"
+ "PyTorch",
+ "TensorFlow",
+ "Mpi"
],
"type": "string",
"x-ms-enum": {
- "name": "DataBindingMode",
+ "name": "DistributionType",
"modelAsString": true
},
"additionalProperties": false
},
- "InputDataBinding": {
+ "DockerBuild": {
+ "description": "Class to represent configuration settings for Docker Build",
+ "required": [
+ "dockerfile"
+ ],
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DockerSpecification"
+ }
+ ],
"properties": {
- "dataId": {
- "description": "ARM resource ID of the registered dataVersion.",
+ "context": {
+ "description": "Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified.\r\nThe path is relative to the asset path which must contain a single Blob URI value.\r\n",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "pathOnCompute": {
- "description": "Location of data inside the container process.",
+ "dockerfile": {
+ "description": "Docker command line instructions to assemble an image.\r\n",
+ "pattern": "[a-zA-Z0-9_]",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
- },
- "mode": {
- "description": "Mechanism for accessing the data artifact.",
- "$ref": "#/definitions/DataBindingMode",
- "x-ms-mutability": [
- "create",
- "read"
- ]
}
},
+ "x-ms-discriminator-value": "Build",
"additionalProperties": false
},
- "OutputDataBinding": {
+ "DockerImage": {
+ "description": "Class to represent configuration settings for Docker Build",
+ "required": [
+ "dockerImageUri"
+ ],
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DockerSpecification"
+ }
+ ],
"properties": {
- "datastoreId": {
- "description": "ARM resource ID of the datastore where the data output will be stored.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "pathOnDatastore": {
- "description": "Path within the datastore to the data.",
+ "dockerImageUri": {
+ "description": "Image name of a custom base image.\r\n",
+ "pattern": "[a-zA-Z0-9_]",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
- },
- "pathOnCompute": {
- "description": "Location of data inside the container process.",
- "type": "string",
+ }
+ },
+ "x-ms-discriminator-value": "Image",
+ "additionalProperties": false
+ },
+ "DockerImagePlatform": {
+ "type": "object",
+ "properties": {
+ "operatingSystemType": {
+ "description": "The OS type the Environment.",
+ "$ref": "#/definitions/OperatingSystemType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "DockerSpecification": {
+ "description": "Configuration settings for Docker",
+ "required": [
+ "dockerSpecificationType"
+ ],
+ "type": "object",
+ "properties": {
+ "dockerSpecificationType": {
+ "description": "Docker specification must be either Build or Image",
+ "$ref": "#/definitions/DockerSpecificationType",
"x-ms-mutability": [
"create",
"read"
]
},
- "mode": {
- "description": "Mechanism for data movement to datastore.",
- "$ref": "#/definitions/DataBindingMode",
+ "platform": {
+ "description": "The platform information of the docker image.",
+ "$ref": "#/definitions/DockerImagePlatform",
"x-ms-mutability": [
"create",
"read"
]
}
},
- "additionalProperties": false
+ "discriminator": "dockerSpecificationType"
},
- "DistributionType": {
- "description": "Enum to determine the job distribution type.",
+ "DockerSpecificationType": {
+ "description": "Enum to determine docker specification type. Must be either Build or Image.",
"enum": [
- "PyTorch",
- "TensorFlow",
- "Mpi"
+ "Build",
+ "Image"
],
"type": "string",
"x-ms-enum": {
- "name": "DistributionType",
+ "name": "DockerSpecificationType",
"modelAsString": true
},
"additionalProperties": false
},
- "DistributionConfiguration": {
- "description": "Base definition for job distribution configuration.",
+ "EarlyTerminationPolicy": {
+ "description": "Early termination policies enable canceling poor-performing runs before they complete",
"required": [
- "distributionType"
+ "policyType"
],
"type": "object",
"properties": {
- "distributionType": {
- "description": "Specifies the type of distribution framework.",
- "$ref": "#/definitions/DistributionType",
- "x-ms-mutability": [
- "create",
- "read"
- ]
+ "delayEvaluation": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "evaluationInterval": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "policyType": {
+ "description": "Name of policy configuration",
+ "$ref": "#/definitions/EarlyTerminationPolicyType"
}
},
- "discriminator": "distributionType"
+ "discriminator": "policyType"
},
- "TensorFlow": {
- "description": "TensorFlow distribution configuration.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DistributionConfiguration"
- }
+ "EarlyTerminationPolicyType": {
+ "enum": [
+ "Bandit",
+ "MedianStopping",
+ "TruncationSelection"
],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EarlyTerminationPolicyType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "EndpointAuthKeys": {
+ "description": "Keys for endpoint authentication.",
+ "type": "object",
"properties": {
- "workerCount": {
- "format": "int32",
- "description": "Number of workers. Overwrites the node count in compute binding.",
- "type": "integer",
+ "primaryKey": {
+ "description": "The primary key.",
+ "type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "parameterServerCount": {
- "format": "int32",
- "type": "integer",
+ "secondaryKey": {
+ "description": "The secondary key.",
+ "type": "string",
"x-ms-mutability": [
"create",
"read"
]
}
},
- "x-ms-discriminator-value": "TensorFlow",
"additionalProperties": false
},
- "Mpi": {
- "description": "MPI distribution configuration.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DistributionConfiguration"
- }
+ "EndpointAuthMode": {
+ "description": "Enum to determine endpoint authentication mode.",
+ "enum": [
+ "AMLToken",
+ "Key",
+ "AADToken"
],
- "properties": {
- "processCountPerInstance": {
- "format": "int32",
- "type": "integer",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EndpointAuthMode",
+ "modelAsString": true
},
- "x-ms-discriminator-value": "Mpi",
"additionalProperties": false
},
- "PyTorch": {
- "description": "PyTorch distribution configuration.",
+ "EndpointAuthToken": {
+ "description": "Service Token",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/DistributionConfiguration"
- }
- ],
"properties": {
- "processCount": {
- "format": "int32",
- "description": "Total process count for the distributed job.",
+ "accessToken": {
+ "description": "Access token.",
+ "type": "string"
+ },
+ "expiryTimeUtc": {
+ "format": "int64",
+ "description": "Access token expiry time (UTC).",
+ "type": "integer"
+ },
+ "refreshAfterTimeUtc": {
+ "format": "int64",
+ "description": "Refresh access token after time (UTC).",
"type": "integer"
+ },
+ "tokenType": {
+ "description": "Access token type.",
+ "type": "string"
}
},
- "x-ms-discriminator-value": "PyTorch",
"additionalProperties": false
},
- "IdentityConfigurationType": {
- "description": "Enum to determine identity framework.",
+ "EndpointComputeType": {
+ "description": "Enum to determine endpoint compute type.",
"enum": [
"Managed",
- "AMLToken"
+ "K8S",
+ "AzureMLCompute"
],
"type": "string",
"x-ms-enum": {
- "name": "IdentityConfigurationType",
+ "name": "EndpointComputeType",
"modelAsString": true
},
"additionalProperties": false
},
- "IdentityConfiguration": {
- "description": "Base definition for identity configuration.",
- "required": [
- "identityType"
+ "EndpointProvisioningState": {
+ "description": "State of endpoint provisioning.",
+ "enum": [
+ "Creating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Updating",
+ "Canceled"
],
- "type": "object",
- "properties": {
- "identityType": {
- "description": "Specifies the type of identity framework.",
- "$ref": "#/definitions/IdentityConfigurationType",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EndpointProvisioningState",
+ "modelAsString": true
},
- "discriminator": "identityType"
+ "additionalProperties": false
},
- "AmlToken": {
- "description": "AML Token identity configuration.",
+ "EnvironmentContainer": {
+ "description": "Container for environment specification versions.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/IdentityConfiguration"
+ "properties": {
+ "description": {
+ "description": "The asset description text.",
+ "type": "string"
+ },
+ "properties": {
+ "description": "The asset property dictionary.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
- ],
- "x-ms-discriminator-value": "AMLToken",
+ },
"additionalProperties": false
},
- "ManagedIdentity": {
- "description": "Managed identity configuration.",
+ "EnvironmentContainerResource": {
+ "description": "Azure Resource Manager resource envelope.",
+ "required": [
+ "properties"
+ ],
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/IdentityConfiguration"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
}
],
"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"
- ]
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/EnvironmentContainer"
},
- "objectId": {
- "format": "uuid",
- "description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.",
- "type": "string",
+ "systemData": {
+ "description": "System data associated with resource provider",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
+ }
+ },
+ "additionalProperties": false
+ },
+ "EnvironmentContainerResourceArmPaginatedResult": {
+ "description": "A paginated list of EnvironmentContainer entities.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "type": "string"
},
- "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"
- ]
+ "value": {
+ "description": "An array of objects of type EnvironmentContainer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EnvironmentContainerResource"
+ }
}
},
- "x-ms-discriminator-value": "Managed",
"additionalProperties": false
},
- "JobProvisioningState": {
+ "EnvironmentSpecificationType": {
+ "description": "Environment specification is either user created or curated by Azure ML service",
"enum": [
- "Succeeded",
- "Failed",
- "Canceled",
- "InProgress"
+ "Curated",
+ "UserCreated"
],
"type": "string",
"x-ms-enum": {
- "name": "JobProvisioningState",
+ "name": "EnvironmentSpecificationType",
"modelAsString": true
},
"additionalProperties": false
},
- "JobEndpoint": {
- "description": "Job endpoint definition",
+ "EnvironmentSpecificationVersion": {
+ "description": "Environment specification version details.\r\n",
"type": "object",
"properties": {
- "jobEndpointType": {
- "description": "Endpoint type.",
- "type": "string",
- "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"
},
- "port": {
- "format": "int32",
- "description": "Port for endpoint.",
- "type": "integer",
+ "description": {
+ "description": "The asset description text.",
+ "type": "string"
+ },
+ "docker": {
+ "description": "Configuration settings for Docker.",
+ "$ref": "#/definitions/DockerSpecification"
+ },
+ "environmentSpecificationType": {
+ "description": "Environment specification is either user managed or curated by the Azure ML service\r\n",
+ "$ref": "#/definitions/EnvironmentSpecificationType",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "endpoint": {
- "description": "Url for endpoint.",
- "type": "string",
+ "inferenceContainerProperties": {
+ "description": "Defines configuration specific to inference.",
+ "$ref": "#/definitions/InferenceContainerProperties"
+ },
+ "isAnonymous": {
+ "description": "If the name version are system generated (anonymous registration).",
+ "type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
"properties": {
+ "description": "The asset property dictionary.",
"type": "object",
"additionalProperties": {
"type": "string"
}
- }
- },
- "additionalProperties": false
- },
- "JobBase": {
- "description": "Base definition for a job.",
- "required": [
- "jobType"
- ],
- "type": "object",
- "properties": {
- "jobType": {
- "description": "Specifies the type of job.",
- "$ref": "#/definitions/JobType",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "provisioningState": {
- "$ref": "#/definitions/JobProvisioningState",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "interactionEndpoints": {
- "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/JobEndpoint"
- },
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "description": {
- "description": "The asset description text.",
- "type": "string"
},
"tags": {
"description": "Tag dictionary. Tags can be added, removed, and updated.",
@@ -7477,517 +6960,565 @@
"additionalProperties": {
"type": "string"
}
- },
- "properties": {
- "description": "The asset property dictionary.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
}
},
- "discriminator": "jobType"
+ "additionalProperties": false
},
- "CommandJob": {
- "description": "Command job definition.",
+ "EnvironmentSpecificationVersionResource": {
+ "description": "Azure Resource Manager resource envelope.",
"required": [
- "command",
- "compute"
+ "properties"
],
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/JobBase"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
}
],
"properties": {
- "compute": {
- "description": "Compute binding for the job.",
- "$ref": "#/definitions/ComputeConfiguration",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "priority": {
- "format": "int32",
- "description": "Job priority for scheduling policy. Only applies to AMLCompute.\r\nPrivate preview feature and only available to users on the allow list.",
- "type": "integer",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "experimentName": {
- "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "output": {
- "description": "Location of the job output logs and artifacts.",
- "$ref": "#/definitions/JobOutput",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/EnvironmentSpecificationVersion"
},
- "status": {
- "description": "Status of the job.",
- "$ref": "#/definitions/JobStatus",
+ "systemData": {
+ "description": "System data associated with resource provider",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"readOnly": true,
"x-ms-mutability": [
"read"
]
- },
- "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.",
+ }
+ },
+ "additionalProperties": false
+ },
+ "EnvironmentSpecificationVersionResourceArmPaginatedResult": {
+ "description": "A paginated list of EnvironmentSpecificationVersion entities.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
"type": "string"
},
- "codeId": {
- "description": "ARM resource ID of the code asset.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "command": {
- "description": "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"
- ]
- },
- "environmentId": {
- "description": "The ARM resource ID of the Environment specification for the job.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "inputDataBindings": {
- "description": "Mapping of input data bindings used in the job.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/InputDataBinding"
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "outputDataBindings": {
- "description": "Mapping of output data bindings used in the job.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/OutputDataBinding"
- },
+ "value": {
+ "description": "An array of objects of type EnvironmentSpecificationVersion.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "ExportFormatType": {
+ "description": "The format of exported labels.",
+ "enum": [
+ "Dataset",
+ "Coco",
+ "CSV"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ExportFormatType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "ExportSummary": {
+ "required": [
+ "format"
+ ],
+ "type": "object",
+ "properties": {
+ "endTimeUtc": {
+ "format": "date-time",
+ "description": "The time when the export was completed.",
+ "type": "string",
+ "readOnly": true,
"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",
+ "exportedRowCount": {
+ "format": "int64",
+ "description": "The total number of labeled datapoints exported.",
+ "type": "integer",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "environmentVariables": {
- "description": "Environment variables included in the job.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
+ "format": {
+ "description": "The format of exported labels, also as the discriminator.",
+ "$ref": "#/definitions/ExportFormatType",
"x-ms-mutability": [
"create",
"read"
]
},
- "identity": {
- "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, or null.\r\nDefaults to AmlToken if null.",
- "$ref": "#/definitions/IdentityConfiguration",
+ "labelingJobId": {
+ "description": "Name and identifier of the job containing exported labels.",
+ "type": "string",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "parameters": {
- "description": "Input parameters.",
- "type": "object",
- "additionalProperties": {},
+ "startTimeUtc": {
+ "format": "date-time",
+ "description": "The time when the export was requested.",
+ "type": "string",
"readOnly": true,
"x-ms-mutability": [
"read"
]
}
},
- "x-ms-discriminator-value": "Command",
+ "discriminator": "format"
+ },
+ "FlavorData": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
"additionalProperties": false
},
- "SamplingAlgorithm": {
- "enum": [
- "Grid",
- "Random",
- "Bayesian"
+ "GlusterFsContents": {
+ "description": "GlusterFs datastore configuration.",
+ "required": [
+ "serverAddress",
+ "volumeName"
],
- "type": "string",
- "x-ms-enum": {
- "name": "SamplingAlgorithm",
- "modelAsString": true
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreContents"
+ }
+ ],
+ "properties": {
+ "serverAddress": {
+ "description": "GlusterFS server address (can be the IP address or server name).",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "volumeName": {
+ "description": "GlusterFS volume name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
},
+ "x-ms-discriminator-value": "GlusterFs",
"additionalProperties": false
},
- "EarlyTerminationPolicyType": {
+ "Goal": {
+ "description": "Defines supported metric goals for hyperparameter tuning",
"enum": [
- "Bandit",
- "MedianStopping",
- "TruncationSelection"
+ "Minimize",
+ "Maximize"
],
"type": "string",
"x-ms-enum": {
- "name": "EarlyTerminationPolicyType",
+ "name": "Goal",
"modelAsString": true
},
"additionalProperties": false
},
- "EarlyTerminationPolicy": {
- "description": "Early termination policies enable canceling poor-performing runs before they complete",
+ "IdAssetReference": {
+ "description": "Reference to an asset via its ARM resource ID.",
"required": [
- "policyType"
+ "assetId"
],
"type": "object",
- "properties": {
- "policyType": {
- "description": "Name of policy configuration",
- "$ref": "#/definitions/EarlyTerminationPolicyType"
- },
- "evaluationInterval": {
- "format": "int32",
- "type": "integer"
- },
- "delayEvaluation": {
- "format": "int32",
- "type": "integer"
- }
- },
- "discriminator": "policyType"
- },
- "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"
+ "$ref": "#/definitions/AssetReferenceBase"
}
],
"properties": {
- "slackFactor": {
- "format": "float",
- "type": "number"
- },
- "slackAmount": {
- "format": "float",
- "type": "number"
+ "assetId": {
+ "description": "ARM resource ID of the asset.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string"
}
},
- "x-ms-discriminator-value": "Bandit",
+ "x-ms-discriminator-value": "Id",
"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"
- }
+ "IdentityConfiguration": {
+ "description": "Base definition for identity configuration.",
+ "required": [
+ "identityType"
],
- "x-ms-discriminator-value": "MedianStopping",
- "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",
- "type": "integer"
+ "identityType": {
+ "description": "Specifies the type of identity framework.",
+ "$ref": "#/definitions/IdentityConfigurationType",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
}
},
- "x-ms-discriminator-value": "TruncationSelection",
- "additionalProperties": false
+ "discriminator": "identityType"
},
- "Goal": {
- "description": "Defines supported metric goals for hyperparameter tuning",
+ "IdentityConfigurationType": {
+ "description": "Enum to determine identity framework.",
"enum": [
- "Minimize",
- "Maximize"
+ "Managed",
+ "AMLToken"
],
"type": "string",
"x-ms-enum": {
- "name": "Goal",
+ "name": "IdentityConfigurationType",
"modelAsString": true
},
"additionalProperties": false
},
- "Objective": {
- "required": [
- "goal",
- "primaryMetric"
+ "ImageAnnotationType": {
+ "description": "Annotation type of image data.",
+ "enum": [
+ "Classification",
+ "BoundingBox",
+ "InstanceSegmentation"
],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ImageAnnotationType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "InferenceContainerProperties": {
"type": "object",
"properties": {
- "primaryMetric": {
- "pattern": "[a-zA-Z0-9_]",
- "type": "string"
+ "livenessRoute": {
+ "description": "The route to check the liveness of the inference server container.",
+ "$ref": "#/definitions/Route"
},
- "goal": {
- "description": "Defines supported metric goals for hyperparameter tuning",
- "$ref": "#/definitions/Goal"
+ "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
},
- "TrialComponent": {
- "description": "Trial component definition.",
- "required": [
- "command"
- ],
+ "InputDataBinding": {
"type": "object",
"properties": {
- "timeout": {
- "format": "duration",
- "description": "The max run duration in ISO 8601 format, after which the trial component will be cancelled.\r\nOnly supports duration with precision as low as Seconds.",
+ "dataId": {
+ "description": "ARM resource ID of the registered dataVersion.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "codeId": {
- "description": "ARM resource ID of the code asset.",
- "type": "string",
+ "mode": {
+ "description": "Mechanism for accessing the data artifact.",
+ "$ref": "#/definitions/DataBindingMode",
"x-ms-mutability": [
"create",
"read"
]
},
- "command": {
- "description": "The command to execute on startup of the job. eg. \"python train.py\"",
- "minLength": 1,
- "pattern": "[a-zA-Z0-9_]",
+ "pathOnCompute": {
+ "description": "Location of data inside the container process.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
- },
- "environmentId": {
- "description": "The ARM resource ID of the Environment specification for the job.",
+ }
+ },
+ "additionalProperties": false
+ },
+ "JobBase": {
+ "description": "Base definition for a job.",
+ "required": [
+ "jobType"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The asset description text.",
"type": "string"
},
- "inputDataBindings": {
- "description": "Mapping of input data bindings used in the job.",
+ "interactionEndpoints": {
+ "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.",
"type": "object",
"additionalProperties": {
- "$ref": "#/definitions/InputDataBinding"
+ "$ref": "#/definitions/JobEndpoint"
},
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
},
- "outputDataBindings": {
- "description": "Mapping of output data bindings used in the job.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/OutputDataBinding"
- },
+ "jobType": {
+ "description": "Specifies the type of job.",
+ "$ref": "#/definitions/JobType",
"x-ms-mutability": [
"create",
"read"
]
},
- "environmentVariables": {
- "description": "Environment variables included in the job.",
+ "properties": {
+ "description": "The asset property dictionary.",
"type": "object",
"additionalProperties": {
"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",
+ "provisioningState": {
+ "$ref": "#/definitions/JobProvisioningState",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
+ },
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
- "additionalProperties": false
+ "discriminator": "jobType"
},
- "SweepJob": {
- "description": "Sweep job definition.",
+ "JobBaseResource": {
+ "description": "Azure Resource Manager resource envelope.",
"required": [
- "algorithm",
- "compute",
- "objective",
- "searchSpace"
+ "properties"
],
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/JobBase"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
}
],
"properties": {
- "compute": {
- "description": "Compute binding for the job.",
- "$ref": "#/definitions/ComputeConfiguration",
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/JobBase"
+ },
+ "systemData": {
+ "description": "System data associated with resource provider",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
+ }
+ },
+ "additionalProperties": false
+ },
+ "JobBaseResourceArmPaginatedResult": {
+ "description": "A paginated list of JobBase entities.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "type": "string"
},
- "priority": {
- "format": "int32",
- "description": "Job priority for scheduling policy. Only applies to AMLCompute.\r\nPrivate preview feature and only available to users on the allow list.",
- "type": "integer",
+ "value": {
+ "description": "An array of objects of type JobBase.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/JobBaseResource"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "JobEndpoint": {
+ "description": "Job endpoint definition",
+ "type": "object",
+ "properties": {
+ "endpoint": {
+ "description": "Url for endpoint.",
+ "type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "experimentName": {
- "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.",
+ "jobEndpointType": {
+ "description": "Endpoint type.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "output": {
- "description": "Location of the job output logs and artifacts.",
- "$ref": "#/definitions/JobOutput",
- "readOnly": true,
+ "port": {
+ "format": "int32",
+ "description": "Port for endpoint.",
+ "type": "integer",
"x-ms-mutability": [
+ "create",
"read"
]
},
- "status": {
- "description": "The status of a job.",
- "$ref": "#/definitions/JobStatus",
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "JobOutput": {
+ "description": "Job output definition container information on where to find job output/logs.",
+ "type": "object",
+ "properties": {
+ "datastoreId": {
+ "description": "ARM ID of the datastore where the job logs and artifacts are stored, or null for the default container (\"azureml\") in the workspace's storage account.",
+ "type": "string",
"readOnly": true,
"x-ms-mutability": [
"read"
]
},
- "searchSpace": {
- "description": "A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter",
- "type": "object",
- "additionalProperties": {
- "type": "object"
- }
- },
- "algorithm": {
- "description": "Type of the hyperparameter sampling algorithms",
- "$ref": "#/definitions/SamplingAlgorithm"
- },
- "maxTotalTrials": {
- "format": "int32",
- "type": "integer"
- },
- "maxConcurrentTrials": {
- "format": "int32",
- "type": "integer"
- },
- "timeout": {
- "format": "duration",
- "description": "The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.",
- "type": "string"
- },
- "earlyTermination": {
- "description": "Early termination policies enable canceling poor-performing runs before they complete",
- "$ref": "#/definitions/EarlyTerminationPolicy"
- },
- "objective": {
- "$ref": "#/definitions/Objective"
- },
- "trial": {
- "description": "Trial component definition.",
- "$ref": "#/definitions/TrialComponent"
- },
- "identity": {
- "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null.\r\nDefaults to AmlToken if null.",
- "$ref": "#/definitions/IdentityConfiguration",
+ "path": {
+ "description": "Path within the datastore to the job logs and artifacts.",
+ "type": "string",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
}
},
- "x-ms-discriminator-value": "Sweep",
"additionalProperties": false
},
- "JobBaseResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
+ "JobProvisioningState": {
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "InProgress"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "JobProvisioningState",
+ "modelAsString": 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"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "JobStatus",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "JobType": {
+ "description": "Enum to determine the type of job.",
+ "enum": [
+ "Command",
+ "Sweep",
+ "Labeling"
],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "JobType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "K8sOnlineDeployment": {
"type": "object",
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
+ "$ref": "#/definitions/OnlineDeployment"
}
],
"properties": {
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/JobBase"
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "containerResourceRequirements": {
+ "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements"
}
},
+ "x-ms-discriminator-value": "K8S",
+ "additionalProperties": false
+ },
+ "KeyType": {
+ "enum": [
+ "Primary",
+ "Secondary"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "KeyType",
+ "modelAsString": true
+ },
"additionalProperties": false
},
- "JobBaseResourceArmPaginatedResult": {
- "description": "A paginated list of JobBase entities.",
+ "LabelCategory": {
+ "description": "Label category definition",
"type": "object",
"properties": {
- "value": {
- "description": "An array of objects of type JobBase.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/JobBaseResource"
- }
+ "allowMultiSelect": {
+ "description": "Indicates whether it is allowed to select multiple classes in this category.",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read",
+ "update"
+ ]
},
- "nextLink": {
- "type": "string"
+ "classes": {
+ "description": "Dictionary of label classes in this category.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/LabelClass"
+ },
+ "x-ms-mutability": [
+ "create",
+ "read",
+ "update"
+ ]
+ },
+ "displayName": {
+ "description": "Display name of the label category.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
}
},
"additionalProperties": false
@@ -8019,33 +7550,29 @@
},
"additionalProperties": false
},
- "LabelCategory": {
- "description": "Label category definition",
+ "LabelingDatasetConfiguration": {
+ "description": "Labeling dataset configuration definition",
"type": "object",
"properties": {
- "displayName": {
- "description": "Display name of the label category.",
+ "assetName": {
+ "description": "Name of the data asset to perform labeling.",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "allowMultiSelect": {
- "description": "Indicates whether it is allowed to select multiple classes in this category.",
- "type": "boolean",
+ "datasetVersion": {
+ "description": "AML dataset version.",
+ "type": "string",
"x-ms-mutability": [
"create",
- "read",
- "update"
+ "read"
]
},
- "classes": {
- "description": "Dictionary of label classes in this category.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/LabelClass"
- },
+ "incrementalDatasetRefreshEnabled": {
+ "description": "Indicates whether to enable incremental dataset refresh.",
+ "type": "boolean",
"x-ms-mutability": [
"create",
"read",
@@ -8055,107 +7582,180 @@
},
"additionalProperties": false
},
- "LabelingJobInstructions": {
- "description": "Instructions for labeling job",
+ "LabelingJob": {
+ "description": "Labeling job definition",
+ "required": [
+ "jobType"
+ ],
"type": "object",
"properties": {
- "uri": {
- "description": "The link to a page with detailed labeling instructions for labelers.",
+ "createdTimeUtc": {
+ "format": "date-time",
+ "description": "Created time of the job in UTC timezone.",
"type": "string",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
- "read",
- "update"
+ "read"
]
- }
- },
- "additionalProperties": false
- },
- "LabelingDatasetConfiguration": {
- "description": "Labeling dataset configuration definition",
- "type": "object",
- "properties": {
- "assetName": {
- "description": "Name of the data asset to perform labeling.",
- "type": "string",
+ },
+ "datasetConfiguration": {
+ "description": "Configuration of dataset used in the job.",
+ "$ref": "#/definitions/LabelingDatasetConfiguration",
"x-ms-mutability": [
"create",
"read"
]
},
- "incrementalDatasetRefreshEnabled": {
- "description": "Indicates whether to enable incremental dataset refresh.",
- "type": "boolean",
+ "description": {
+ "description": "The asset description text.",
+ "type": "string"
+ },
+ "interactionEndpoints": {
+ "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/JobEndpoint"
+ },
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "jobInstructions": {
+ "description": "Labeling instructions of the job.",
+ "$ref": "#/definitions/LabelingJobInstructions",
"x-ms-mutability": [
"create",
"read",
"update"
]
},
- "datasetVersion": {
- "description": "AML dataset version.",
- "type": "string",
+ "jobType": {
+ "description": "Specifies the type of job. This field should always be set to \"Labeling\".",
+ "$ref": "#/definitions/JobType",
"x-ms-mutability": [
"create",
"read"
]
- }
- },
- "additionalProperties": false
- },
- "MLAssistConfiguration": {
- "description": "Labeling MLAssist configuration definition",
- "type": "object",
- "properties": {
- "inferencingComputeBinding": {
- "description": "AML compute binding used in inferencing.",
- "$ref": "#/definitions/ComputeConfiguration",
+ },
+ "labelCategories": {
+ "description": "Label categories of the job.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/LabelCategory"
+ },
"x-ms-mutability": [
"create",
"read",
"update"
]
},
- "trainingComputeBinding": {
- "description": "AML compute binding used in training.",
- "$ref": "#/definitions/ComputeConfiguration",
+ "labelingJobMediaProperties": {
+ "description": "Media type specific properties in the job.",
+ "$ref": "#/definitions/LabelingJobMediaProperties",
"x-ms-mutability": [
"create",
- "read",
- "update"
+ "read"
]
},
- "mlAssistEnabled": {
- "description": "Indicates whether MLAssist feature is enabled.",
- "type": "boolean"
+ "mlAssistConfiguration": {
+ "description": "Configuration of MLAssist feature in the job.",
+ "$ref": "#/definitions/MLAssistConfiguration"
+ },
+ "progressMetrics": {
+ "description": "Progress metrics of the job.",
+ "$ref": "#/definitions/ProgressMetrics",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "projectId": {
+ "format": "uuid",
+ "description": "Internal id of the job(Previously called project).",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "properties": {
+ "description": "The asset property dictionary.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "provisioningState": {
+ "$ref": "#/definitions/JobProvisioningState",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "status": {
+ "description": "Status of the job.",
+ "$ref": "#/definitions/JobStatus",
+ "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"
+ ]
+ },
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
"additionalProperties": false
},
- "MediaType": {
- "description": "Media type of data asset.",
- "enum": [
- "Image",
- "Text"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "MediaType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "ImageAnnotationType": {
- "description": "Annotation type of image data.",
- "enum": [
- "Classification",
- "BoundingBox",
- "InstanceSegmentation"
+ "LabelingJobImageProperties": {
+ "description": "Properties of a labeling job for image data",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/LabelingJobMediaProperties"
+ }
],
- "type": "string",
- "x-ms-enum": {
- "name": "ImageAnnotationType",
- "modelAsString": true
+ "properties": {
+ "annotationType": {
+ "description": "Annotation type of image labeling job.",
+ "$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"
+ ]
+ }
},
"additionalProperties": false
},
@@ -8177,36 +7777,47 @@
},
"discriminator": "mediaType"
},
- "LabelingJobImageProperties": {
- "description": "Properties of a labeling job for image data",
+ "LabelingJobResource": {
+ "description": "Azure Resource Manager resource envelope.",
+ "required": [
+ "properties"
+ ],
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/LabelingJobMediaProperties"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
}
],
"properties": {
- "annotationType": {
- "description": "Annotation type of image labeling job.",
- "$ref": "#/definitions/ImageAnnotationType",
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/LabelingJob"
+ },
+ "systemData": {
+ "description": "System data associated with resource provider",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "readOnly": true,
"x-ms-mutability": [
- "create",
"read"
]
}
},
- "x-ms-discriminator-value": "Image",
"additionalProperties": false
},
- "TextAnnotationType": {
- "description": "Annotation type of text data.",
- "enum": [
- "Classification"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "TextAnnotationType",
- "modelAsString": true
+ "LabelingJobResourceArmPaginatedResult": {
+ "description": "A paginated list of LabelingJob entities.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "type": "string"
+ },
+ "value": {
+ "description": "An array of objects of type LabelingJob.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LabelingJobResource"
+ }
+ }
},
"additionalProperties": false
},
@@ -8231,257 +7842,477 @@
"x-ms-discriminator-value": "Text",
"additionalProperties": false
},
- "ProgressMetrics": {
- "description": "Progress metrics definition",
+ "LinkedInfo": {
+ "description": "Information about a datastore origin, if linked.",
"type": "object",
"properties": {
- "totalDatapointCount": {
- "format": "int64",
- "description": "The total datapoint count.",
- "type": "integer",
- "readOnly": true,
+ "linkedId": {
+ "description": "Linked service ID.",
+ "type": "string"
+ },
+ "linkedResourceName": {
+ "description": "Linked service resource name.",
+ "type": "string"
+ },
+ "origin": {
+ "description": "Type of the linked service.",
+ "$ref": "#/definitions/OriginType"
+ }
+ },
+ "additionalProperties": false
+ },
+ "MLAssistConfiguration": {
+ "description": "Labeling MLAssist configuration definition",
+ "type": "object",
+ "properties": {
+ "inferencingComputeBinding": {
+ "description": "AML compute binding used in inferencing.",
+ "$ref": "#/definitions/ComputeConfiguration",
"x-ms-mutability": [
- "read"
+ "create",
+ "read",
+ "update"
]
},
- "completedDatapointCount": {
- "format": "int64",
- "description": "The completed datapoint count.",
- "type": "integer",
- "readOnly": true,
+ "mlAssistEnabled": {
+ "description": "Indicates whether MLAssist feature is enabled.",
+ "type": "boolean"
+ },
+ "trainingComputeBinding": {
+ "description": "AML compute binding used in training.",
+ "$ref": "#/definitions/ComputeConfiguration",
+ "x-ms-mutability": [
+ "create",
+ "read",
+ "update"
+ ]
+ }
+ },
+ "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"
]
},
- "skippedDatapointCount": {
- "format": "int64",
- "description": "The skipped datapoint count.",
- "type": "integer",
- "readOnly": 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"
]
},
- "incrementalDatasetLastRefreshTime": {
- "format": "date-time",
- "description": "The time of last successful incremental dataset refresh in UTC.",
+ "resourceId": {
+ "description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.",
"type": "string",
- "readOnly": true,
"x-ms-mutability": [
+ "create",
"read"
]
}
},
+ "x-ms-discriminator-value": "Managed",
"additionalProperties": false
},
- "StatusMessageLevel": {
+ "ManagedOnlineDeployment": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/OnlineDeployment"
+ }
+ ],
+ "properties": {
+ "instanceType": {
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "readinessProbe": {
+ "$ref": "#/definitions/ProbeSettings"
+ }
+ },
+ "x-ms-discriminator-value": "Managed",
+ "additionalProperties": false
+ },
+ "ManualScaleSettings": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/OnlineScaleSettings"
+ }
+ ],
+ "properties": {
+ "instanceCount": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "x-ms-discriminator-value": "Manual",
+ "additionalProperties": false
+ },
+ "MediaType": {
+ "description": "Media type of data asset.",
"enum": [
- "Error",
- "Information",
- "Warning"
+ "Image",
+ "Text"
],
"type": "string",
"x-ms-enum": {
- "name": "StatusMessageLevel",
+ "name": "MediaType",
"modelAsString": true
},
"additionalProperties": false
},
- "StatusMessage": {
- "description": "Active message associated with project",
+ "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
+ },
+ "ModelContainer": {
"type": "object",
"properties": {
- "level": {
- "description": "Severity level of message.",
- "$ref": "#/definitions/StatusMessageLevel",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "description": {
+ "description": "The asset description text.",
+ "type": "string"
},
- "code": {
- "description": "Service-defined message code.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "properties": {
+ "description": "The asset property dictionary.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "ModelContainerResource": {
+ "description": "Azure Resource Manager resource envelope.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/ModelContainer"
},
- "message": {
- "description": "A human-readable representation of the message code.",
- "type": "string",
+ "systemData": {
+ "description": "System data associated with resource provider",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"readOnly": true,
"x-ms-mutability": [
"read"
]
+ }
+ },
+ "additionalProperties": false
+ },
+ "ModelContainerResourceArmPaginatedResult": {
+ "description": "A paginated list of ModelContainer entities.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "type": "string"
},
- "createdTimeUtc": {
- "format": "date-time",
- "description": "Time in UTC at which the message was created.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "value": {
+ "description": "An array of objects of type ModelContainer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ModelContainerResource"
+ }
}
},
"additionalProperties": false
},
- "LabelingJob": {
- "description": "Labeling job definition",
+ "ModelVersion": {
+ "description": "Model asset version details.",
"required": [
- "jobType"
+ "path"
],
"type": "object",
"properties": {
- "provisioningState": {
- "$ref": "#/definitions/JobProvisioningState",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "jobType": {
- "description": "Specifies the type of job. This field should always be set to \"Labeling\".",
- "$ref": "#/definitions/JobType",
- "x-ms-mutability": [
- "create",
- "read"
- ]
+ "datastoreId": {
+ "description": "ARM resource ID of the datastore where the asset is located.",
+ "type": "string"
},
- "interactionEndpoints": {
- "description": "List of JobEndpoints.\r\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/JobEndpoint"
- },
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "description": {
+ "description": "The asset description text.",
+ "type": "string"
},
- "labelCategories": {
- "description": "Label categories of the job.",
+ "flavors": {
+ "description": "Mapping of model flavors to their properties.",
"type": "object",
"additionalProperties": {
- "$ref": "#/definitions/LabelCategory"
- },
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
- },
- "jobInstructions": {
- "description": "Labeling instructions of the job.",
- "$ref": "#/definitions/LabelingJobInstructions",
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
+ "$ref": "#/definitions/FlavorData"
+ }
},
- "datasetConfiguration": {
- "description": "Configuration of dataset used in the job.",
- "$ref": "#/definitions/LabelingDatasetConfiguration",
+ "isAnonymous": {
+ "description": "If the name version are system generated (anonymous registration).",
+ "type": "boolean",
"x-ms-mutability": [
"create",
"read"
]
},
- "mlAssistConfiguration": {
- "description": "Configuration of MLAssist feature in the job.",
- "$ref": "#/definitions/MLAssistConfiguration"
- },
- "labelingJobMediaProperties": {
- "description": "Media type specific properties in the job.",
- "$ref": "#/definitions/LabelingJobMediaProperties",
- "x-ms-mutability": [
- "create",
- "read"
- ]
+ "path": {
+ "description": "The path of the file/directory in the datastore.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string"
},
- "projectId": {
- "format": "uuid",
- "description": "Internal id of the job(Previously called project).",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "properties": {
+ "description": "The asset property dictionary.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
},
- "status": {
- "description": "Status of the job.",
- "$ref": "#/definitions/JobStatus",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "tags": {
+ "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "ModelVersionResource": {
+ "description": "Azure Resource Manager resource envelope.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/ModelVersion"
},
- "progressMetrics": {
- "description": "Progress metrics of the job.",
- "$ref": "#/definitions/ProgressMetrics",
+ "systemData": {
+ "description": "System data associated with resource provider",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"readOnly": true,
"x-ms-mutability": [
"read"
]
+ }
+ },
+ "additionalProperties": false
+ },
+ "ModelVersionResourceArmPaginatedResult": {
+ "description": "A paginated list of ModelVersion entities.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "type": "string"
},
- "statusMessages": {
- "description": "Status messages of the job.",
+ "value": {
+ "description": "An array of objects of type ModelVersion.",
"type": "array",
"items": {
- "$ref": "#/definitions/StatusMessage"
- },
- "readOnly": true,
+ "$ref": "#/definitions/ModelVersionResource"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "Mpi": {
+ "description": "MPI distribution configuration.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DistributionConfiguration"
+ }
+ ],
+ "properties": {
+ "processCountPerInstance": {
+ "format": "int32",
+ "type": "integer",
"x-ms-mutability": [
+ "create",
"read"
]
+ }
+ },
+ "x-ms-discriminator-value": "Mpi",
+ "additionalProperties": false
+ },
+ "NoneDatastoreCredentials": {
+ "description": "Empty/none datastore credentials.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreCredentials"
+ }
+ ],
+ "properties": {
+ "secrets": {
+ "description": "Empty/none datastore secret.",
+ "$ref": "#/definitions/NoneDatastoreSecrets",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ],
+ "x-ms-secret": true
+ }
+ },
+ "x-ms-discriminator-value": "None",
+ "additionalProperties": false
+ },
+ "NoneDatastoreSecrets": {
+ "description": "Empty/none datastore secret.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreSecrets"
+ }
+ ],
+ "x-ms-discriminator-value": "None",
+ "additionalProperties": false
+ },
+ "Objective": {
+ "required": [
+ "goal",
+ "primaryMetric"
+ ],
+ "type": "object",
+ "properties": {
+ "goal": {
+ "description": "Defines supported metric goals for hyperparameter tuning",
+ "$ref": "#/definitions/Goal"
+ },
+ "primaryMetric": {
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "OnlineDeployment": {
+ "required": [
+ "endpointComputeType"
+ ],
+ "type": "object",
+ "properties": {
+ "appInsightsEnabled": {
+ "description": "If true, enables Application Insights logging.",
+ "type": "boolean"
},
- "createdTimeUtc": {
- "format": "date-time",
- "description": "Created time of the job in UTC timezone.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "codeConfiguration": {
+ "description": "Code configuration for the endpoint deployment.",
+ "$ref": "#/definitions/CodeConfiguration"
},
"description": {
- "description": "The asset description text.",
+ "description": "Description of the endpoint deployment.",
"type": "string"
},
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
+ "endpointComputeType": {
+ "description": "The compute type of the endpoint.",
+ "$ref": "#/definitions/EndpointComputeType"
+ },
+ "environmentId": {
+ "description": "ARM resource ID of the environment specification for the endpoint deployment.",
+ "type": "string"
+ },
+ "environmentVariables": {
+ "description": "Environment variables configuration for the deployment.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
+ "livenessProbe": {
+ "$ref": "#/definitions/ProbeSettings"
+ },
+ "model": {
+ "description": "Reference to the model asset for the endpoint deployment.",
+ "$ref": "#/definitions/AssetReferenceBase"
+ },
"properties": {
- "description": "The asset property dictionary.",
+ "description": "Property dictionary. Properties can be added, but not removed or altered.",
"type": "object",
"additionalProperties": {
"type": "string"
}
+ },
+ "provisioningState": {
+ "description": "Provisioning state for the endpoint deployment.",
+ "$ref": "#/definitions/DeploymentProvisioningState",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "requestSettings": {
+ "$ref": "#/definitions/OnlineRequestSettings"
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/OnlineScaleSettings"
}
},
- "additionalProperties": false
+ "discriminator": "endpointComputeType"
},
- "LabelingJobResource": {
- "description": "Azure Resource Manager resource envelope.",
+ "OnlineDeploymentTrackedResource": {
"required": [
+ "location",
"properties"
],
"type": "object",
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource"
}
],
"properties": {
+ "identity": {
+ "description": "Service identity associated with a resource.",
+ "$ref": "#/definitions/ResourceIdentity"
+ },
+ "kind": {
+ "type": "string"
+ },
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/LabelingJob"
+ "$ref": "#/definitions/OnlineDeployment"
},
"systemData": {
"description": "System data associated with resource provider",
@@ -8494,204 +8325,116 @@
},
"additionalProperties": false
},
- "LabelingJobResourceArmPaginatedResult": {
- "description": "A paginated list of LabelingJob entities.",
+ "OnlineDeploymentTrackedResourceArmPaginatedResult": {
+ "description": "A paginated list of OnlineDeployment entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
- "description": "An array of objects of type LabelingJob.",
+ "description": "An array of objects of type OnlineDeployment.",
"type": "array",
"items": {
- "$ref": "#/definitions/LabelingJobResource"
+ "$ref": "#/definitions/OnlineDeploymentTrackedResource"
}
- },
- "nextLink": {
- "type": "string"
}
},
"additionalProperties": false
},
- "ExportFormatType": {
- "description": "The format of exported labels.",
- "enum": [
- "Dataset",
- "Coco",
- "CSV"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ExportFormatType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "ExportSummary": {
+ "OnlineEndpoint": {
+ "description": "Online endpoint configuration",
"required": [
- "format"
+ "authMode"
],
"type": "object",
"properties": {
- "format": {
- "description": "The format of exported labels, also as the discriminator.",
- "$ref": "#/definitions/ExportFormatType",
- "x-ms-mutability": [
- "create",
- "read"
- ]
+ "authMode": {
+ "description": "Inference endpoint authentication mode type",
+ "$ref": "#/definitions/EndpointAuthMode"
},
- "labelingJobId": {
- "description": "Name and identifier of the job containing exported labels.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "description": {
+ "description": "Description of the inference endpoint.",
+ "type": "string"
},
- "exportedRowCount": {
- "format": "int64",
- "description": "The total number of labeled datapoints exported.",
- "type": "integer",
- "readOnly": 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": [
- "read"
- ]
+ "create"
+ ],
+ "x-ms-secret": true
},
- "startTimeUtc": {
- "format": "date-time",
- "description": "The time when the export was requested.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "properties": {
+ "description": "Property dictionary. Properties can be added, but not removed or altered.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
},
- "endTimeUtc": {
- "format": "date-time",
- "description": "The time when the export was completed.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- }
- },
- "discriminator": "format"
- },
- "CocoExportSummary": {
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ExportSummary"
- }
- ],
- "properties": {
- "snapshotPath": {
- "description": "The output path where the labels will be exported.",
- "type": "string",
+ "provisioningState": {
+ "description": "State of endpoint provisioning.",
+ "$ref": "#/definitions/EndpointProvisioningState",
"readOnly": true,
"x-ms-mutability": [
"read"
]
},
- "containerName": {
- "description": "The container name to which the labels will be exported.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- }
- },
- "x-ms-discriminator-value": "Coco",
- "additionalProperties": false
- },
- "CsvExportSummary": {
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ExportSummary"
- }
- ],
- "properties": {
- "snapshotPath": {
- "description": "The output path where the labels will be exported.",
+ "scoringUri": {
+ "format": "uri",
+ "description": "Endpoint URI.",
"type": "string",
"readOnly": true,
"x-ms-mutability": [
"read"
]
},
- "containerName": {
- "description": "The container name to which the labels will be exported.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- }
- },
- "x-ms-discriminator-value": "CSV",
- "additionalProperties": false
- },
- "DatasetExportSummary": {
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ExportSummary"
- }
- ],
- "properties": {
- "labeledAssetName": {
- "description": "The unique name of the labeled data asset.",
+ "swaggerUri": {
+ "format": "uri",
+ "description": "Endpoint Swagger URI.",
"type": "string",
"readOnly": true,
"x-ms-mutability": [
"read"
]
- }
- },
- "x-ms-discriminator-value": "Dataset",
- "additionalProperties": false
- },
- "ModelContainer": {
- "type": "object",
- "properties": {
- "description": {
- "description": "The asset description text.",
- "type": "string"
- },
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
},
- "properties": {
- "description": "The asset property dictionary.",
+ "target": {
+ "description": "ARM resource ID of the compute if it exists.\r\noptional",
+ "type": "string"
+ },
+ "traffic": {
+ "description": "Traffic rules on how the traffic will be routed across deployments.",
"type": "object",
"additionalProperties": {
- "type": "string"
+ "format": "int32",
+ "type": "integer"
}
}
},
"additionalProperties": false
},
- "ModelContainerResource": {
- "description": "Azure Resource Manager resource envelope.",
+ "OnlineEndpointTrackedResource": {
"required": [
+ "location",
"properties"
],
"type": "object",
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource"
}
],
"properties": {
+ "identity": {
+ "description": "Service identity associated with a resource.",
+ "$ref": "#/definitions/ResourceIdentity"
+ },
+ "kind": {
+ "type": "string"
+ },
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/ModelContainer"
+ "$ref": "#/definitions/OnlineEndpoint"
},
"systemData": {
"description": "System data associated with resource provider",
@@ -8704,230 +8447,362 @@
},
"additionalProperties": false
},
- "ModelContainerResourceArmPaginatedResult": {
- "description": "A paginated list of ModelContainer entities.",
+ "OnlineEndpointTrackedResourceArmPaginatedResult": {
+ "description": "A paginated list of OnlineEndpoint entities.",
"type": "object",
"properties": {
+ "nextLink": {
+ "type": "string"
+ },
"value": {
- "description": "An array of objects of type ModelContainer.",
+ "description": "An array of objects of type OnlineEndpoint.",
"type": "array",
"items": {
- "$ref": "#/definitions/ModelContainerResource"
+ "$ref": "#/definitions/OnlineEndpointTrackedResource"
}
- },
- "nextLink": {
- "type": "string"
}
},
"additionalProperties": false
},
- "FlavorData": {
+ "OnlineRequestSettings": {
"type": "object",
"properties": {
- "data": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "maxConcurrentRequestsPerInstance": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxQueueWait": {
+ "format": "duration",
+ "description": "The maximum queue wait time in ISO 8601 format. Supports millisecond precision.",
+ "type": "string"
+ },
+ "requestTimeout": {
+ "format": "duration",
+ "description": "The request timeout in ISO 8601 format. Supports millisecond precision.",
+ "type": "string"
}
},
"additionalProperties": false
},
- "ModelVersion": {
- "description": "Model asset version details.",
+ "OnlineScaleSettings": {
"required": [
- "path"
+ "scaleType"
],
"type": "object",
"properties": {
- "flavors": {
- "description": "Mapping of model flavors to their properties.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/FlavorData"
- }
+ "maxInstances": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minInstances": {
+ "format": "int32",
+ "type": "integer"
},
+ "scaleType": {
+ "$ref": "#/definitions/ScaleType"
+ }
+ },
+ "discriminator": "scaleType"
+ },
+ "OperatingSystemType": {
+ "description": "The type of operating system.",
+ "enum": [
+ "Linux",
+ "Windows"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OperatingSystemType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "OrderString": {
+ "enum": [
+ "CreatedAtDesc",
+ "CreatedAtAsc",
+ "UpdatedAtDesc",
+ "UpdatedAtAsc"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OrderString",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "OriginType": {
+ "description": "Enum to determine the type of linked service.",
+ "enum": [
+ "Synapse"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OriginType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "OutputDataBinding": {
+ "type": "object",
+ "properties": {
"datastoreId": {
- "description": "ARM resource ID of the datastore where the asset is located.",
- "type": "string"
+ "description": "ARM resource ID of the datastore where the data output will be stored.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
- "path": {
- "description": "The path of the file/directory in the datastore.",
- "pattern": "[a-zA-Z0-9_]",
- "type": "string"
+ "mode": {
+ "description": "Mechanism for data movement to datastore.",
+ "$ref": "#/definitions/DataBindingMode",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
- "isAnonymous": {
- "description": "If the name version are system generated (anonymous registration).",
- "type": "boolean",
+ "pathOnCompute": {
+ "description": "Location of data inside the container process.",
+ "type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
- "description": {
- "description": "The asset description text.",
+ "pathOnDatastore": {
+ "description": "Path within the datastore to the data.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
+ },
+ "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"
},
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "properties": {
- "description": "The asset property dictionary.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "path": {
+ "description": "The path of the file/directory in the job output.",
+ "type": "string"
}
},
+ "x-ms-discriminator-value": "OutputPath",
"additionalProperties": false
},
- "ModelVersionResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
+ "PartialAksOnlineDeployment": {
"type": "object",
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource"
+ "$ref": "#/definitions/PartialOnlineDeployment"
}
],
"properties": {
+ "containerResourceRequirements": {
+ "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements"
+ }
+ },
+ "x-ms-discriminator-value": "K8S",
+ "additionalProperties": false
+ },
+ "PartialBatchDeployment": {
+ "description": "Mutable batch inference settings per deployment.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description of the endpoint deployment.",
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "PartialBatchDeploymentPartialTrackedResource": {
+ "description": "Strictly used in update requests.",
+ "type": "object",
+ "properties": {
+ "identity": {
+ "description": "Service identity associated with a resource.",
+ "$ref": "#/definitions/ResourceIdentity"
+ },
+ "kind": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string"
+ },
"properties": {
"description": "Additional attributes of the entity.",
- "$ref": "#/definitions/ModelVersion"
+ "$ref": "#/definitions/PartialBatchDeployment"
},
- "systemData": {
- "description": "System data associated with resource provider",
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "PartialBatchEndpoint": {
+ "description": "Mutable Batch endpoint configuration",
+ "type": "object",
+ "properties": {
+ "traffic": {
+ "description": "Traffic rules on how the traffic will be routed across deployments.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ }
}
},
"additionalProperties": false
},
- "ModelVersionResourceArmPaginatedResult": {
- "description": "A paginated list of ModelVersion entities.",
+ "PartialBatchEndpointPartialTrackedResource": {
+ "description": "Strictly used in update requests.",
"type": "object",
"properties": {
- "value": {
- "description": "An array of objects of type ModelVersion.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ModelVersionResource"
- }
+ "identity": {
+ "description": "Service identity associated with a resource.",
+ "$ref": "#/definitions/ResourceIdentity"
},
- "nextLink": {
+ "kind": {
+ "type": "string"
+ },
+ "location": {
"type": "string"
+ },
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/PartialBatchEndpoint"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
"additionalProperties": false
},
- "EndpointComputeType": {
- "description": "Enum to determine endpoint compute type.",
- "enum": [
- "Managed",
- "K8S",
- "AzureMLCompute"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EndpointComputeType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "ScaleType": {
- "enum": [
- "Auto",
- "Manual"
+ "PartialManagedOnlineDeployment": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/PartialOnlineDeployment"
+ }
],
- "type": "string",
- "x-ms-enum": {
- "name": "ScaleType",
- "modelAsString": true
+ "properties": {
+ "readinessProbe": {
+ "$ref": "#/definitions/ProbeSettings"
+ }
},
+ "x-ms-discriminator-value": "Managed",
"additionalProperties": false
},
- "OnlineScaleSettings": {
+ "PartialOnlineDeployment": {
+ "description": "Mutable online deployment configuration",
"required": [
- "scaleType"
+ "endpointComputeType"
],
"type": "object",
"properties": {
- "scaleType": {
- "$ref": "#/definitions/ScaleType"
+ "appInsightsEnabled": {
+ "type": "boolean"
},
- "minInstances": {
- "format": "int32",
- "type": "integer"
+ "endpointComputeType": {
+ "description": "Enum to determine endpoint compute type.",
+ "$ref": "#/definitions/EndpointComputeType"
},
- "maxInstances": {
- "format": "int32",
- "type": "integer"
+ "livenessProbe": {
+ "$ref": "#/definitions/ProbeSettings"
+ },
+ "requestSettings": {
+ "$ref": "#/definitions/OnlineRequestSettings"
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/OnlineScaleSettings"
}
},
- "discriminator": "scaleType"
+ "discriminator": "endpointComputeType"
},
- "ManualScaleSettings": {
+ "PartialOnlineDeploymentPartialTrackedResource": {
+ "description": "Strictly used in update requests.",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/OnlineScaleSettings"
- }
- ],
"properties": {
- "instanceCount": {
- "format": "int32",
- "type": "integer"
+ "identity": {
+ "description": "Service identity associated with a resource.",
+ "$ref": "#/definitions/ResourceIdentity"
+ },
+ "kind": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string"
+ },
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/PartialOnlineDeployment"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
- "x-ms-discriminator-value": "Manual",
"additionalProperties": false
},
- "AutoScaleSettings": {
+ "PartialOnlineEndpoint": {
+ "description": "Mutable online endpoint configuration",
"type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/OnlineScaleSettings"
- }
- ],
"properties": {
- "pollingInterval": {
- "format": "duration",
- "description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.",
- "type": "string"
- },
- "targetUtilizationPercentage": {
- "format": "int32",
- "type": "integer"
+ "traffic": {
+ "description": "Traffic rules on how the traffic will be routed across deployments.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ }
}
},
- "x-ms-discriminator-value": "Auto",
"additionalProperties": false
},
- "OnlineRequestSettings": {
+ "PartialOnlineEndpointPartialTrackedResource": {
+ "description": "Strictly used in update requests.",
"type": "object",
"properties": {
- "maxQueueWait": {
- "format": "duration",
- "description": "The maximum queue wait time in ISO 8601 format. Supports millisecond precision.",
+ "identity": {
+ "description": "Service identity associated with a resource.",
+ "$ref": "#/definitions/ResourceIdentity"
+ },
+ "kind": {
"type": "string"
},
- "requestTimeout": {
- "format": "duration",
- "description": "The request timeout in ISO 8601 format. Supports millisecond precision.",
+ "location": {
"type": "string"
},
- "maxConcurrentRequestsPerInstance": {
- "format": "int32",
- "type": "integer"
+ "properties": {
+ "description": "Additional attributes of the entity.",
+ "$ref": "#/definitions/PartialOnlineEndpoint"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
"additionalProperties": false
@@ -8940,6 +8815,16 @@
"description": "The number of failures to allow before returning an unhealthy status.",
"type": "integer"
},
+ "initialDelay": {
+ "format": "duration",
+ "description": "The delay before the first probe in ISO 8601 format.",
+ "type": "string"
+ },
+ "period": {
+ "format": "duration",
+ "description": "The length of time between probes in ISO 8601 format.",
+ "type": "string"
+ },
"successThreshold": {
"format": "int32",
"description": "The number of successful probes before returning a healthy status.",
@@ -8949,553 +8834,668 @@
"format": "duration",
"description": "The probe timeout in ISO 8601 format.",
"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"
+ ]
},
- "period": {
- "format": "duration",
- "description": "The length of time between probes in ISO 8601 format.",
- "type": "string"
+ "incrementalDatasetLastRefreshTime": {
+ "format": "date-time",
+ "description": "The time of last successful incremental dataset refresh in UTC.",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
},
- "initialDelay": {
- "format": "duration",
- "description": "The delay before the first probe in ISO 8601 format.",
- "type": "string"
+ "skippedDatapointCount": {
+ "format": "int64",
+ "description": "The skipped datapoint count.",
+ "type": "integer",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "totalDatapointCount": {
+ "format": "int64",
+ "description": "The total datapoint count.",
+ "type": "integer",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
}
},
"additionalProperties": false
},
- "DeploymentProvisioningState": {
- "enum": [
- "Creating",
- "Deleting",
- "Scaling",
- "Updating",
- "Succeeded",
- "Failed",
- "Canceled"
+ "PyTorch": {
+ "description": "PyTorch distribution configuration.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DistributionConfiguration"
+ }
+ ],
+ "properties": {
+ "processCount": {
+ "format": "int32",
+ "description": "Total process count for the distributed job.",
+ "type": "integer"
+ }
+ },
+ "x-ms-discriminator-value": "PyTorch",
+ "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": "DeploymentProvisioningState",
+ "name": "ReferenceType",
"modelAsString": true
},
"additionalProperties": false
},
- "OnlineDeployment": {
+ "RegenerateEndpointKeysRequest": {
"required": [
- "endpointComputeType"
+ "keyType"
],
"type": "object",
"properties": {
- "endpointComputeType": {
- "description": "The compute type of the endpoint.",
- "$ref": "#/definitions/EndpointComputeType"
- },
- "scaleSettings": {
- "$ref": "#/definitions/OnlineScaleSettings"
- },
- "requestSettings": {
- "$ref": "#/definitions/OnlineRequestSettings"
- },
- "appInsightsEnabled": {
- "description": "If true, enables Application Insights logging.",
- "type": "boolean"
+ "keyType": {
+ "description": "Specification for which type of key to generate. Primary or Secondary.",
+ "$ref": "#/definitions/KeyType"
},
- "livenessProbe": {
- "$ref": "#/definitions/ProbeSettings"
+ "keyValue": {
+ "description": "The value the key is set to.",
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "ResourceIdentity": {
+ "description": "Service identity associated with a resource.",
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "Client ID that is used when authenticating.",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
},
- "provisioningState": {
- "description": "Provisioning state for the endpoint deployment.",
- "$ref": "#/definitions/DeploymentProvisioningState",
+ "tenantId": {
+ "description": "AAD Tenant where this identity lives.",
+ "type": "string",
"readOnly": true,
"x-ms-mutability": [
"read"
]
},
- "description": {
- "description": "Description of the endpoint deployment.",
- "type": "string"
+ "type": {
+ "description": "Defines values for a ResourceIdentity's type.",
+ "$ref": "#/definitions/ResourceIdentityAssignment"
},
- "properties": {
- "description": "Property dictionary. Properties can be added, but not removed or altered.",
+ "userAssignedIdentities": {
+ "description": "Dictionary of the user assigned identities, key is ARM resource ID of the UAI.",
"type": "object",
"additionalProperties": {
- "type": "string"
+ "$ref": "#/definitions/UserAssignedIdentityMeta"
}
- },
- "model": {
- "description": "Reference to the model asset for the endpoint deployment.",
- "$ref": "#/definitions/AssetReferenceBase"
- },
- "codeConfiguration": {
- "description": "Code configuration for the endpoint deployment.",
- "$ref": "#/definitions/CodeConfiguration"
- },
- "environmentId": {
- "description": "ARM resource ID of the environment specification for the endpoint deployment.",
+ }
+ },
+ "additionalProperties": false
+ },
+ "ResourceIdentityAssignment": {
+ "description": "Defines values for a ResourceIdentity's type.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned,UserAssigned",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceIdentityAssignment",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "Route": {
+ "required": [
+ "path",
+ "port"
+ ],
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The path for the route.",
+ "pattern": "[a-zA-Z0-9_]",
"type": "string"
},
- "environmentVariables": {
- "description": "Environment variables configuration for the deployment.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "port": {
+ "format": "int32",
+ "description": "The port for the route.",
+ "type": "integer"
}
},
- "discriminator": "endpointComputeType"
+ "additionalProperties": false
},
- "K8sOnlineDeployment": {
+ "SamplingAlgorithm": {
+ "enum": [
+ "Grid",
+ "Random",
+ "Bayesian"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SamplingAlgorithm",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "SasDatastoreCredentials": {
+ "description": "SAS datastore credentials configuration.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/OnlineDeployment"
+ "$ref": "#/definitions/DatastoreCredentials"
}
],
"properties": {
- "containerResourceRequirements": {
- "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements"
+ "secrets": {
+ "description": "Storage container secrets.",
+ "$ref": "#/definitions/SasDatastoreSecrets",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ],
+ "x-ms-secret": true
}
},
- "x-ms-discriminator-value": "K8S",
+ "x-ms-discriminator-value": "Sas",
"additionalProperties": false
},
- "ManagedOnlineDeployment": {
+ "SasDatastoreSecrets": {
+ "description": "Datastore SAS secrets.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/OnlineDeployment"
+ "$ref": "#/definitions/DatastoreSecrets"
}
],
"properties": {
- "instanceType": {
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "readinessProbe": {
- "$ref": "#/definitions/ProbeSettings"
+ "sasToken": {
+ "description": "Storage container SAS token.",
+ "type": "string"
}
},
- "x-ms-discriminator-value": "Managed",
+ "x-ms-discriminator-value": "Sas",
"additionalProperties": false
},
- "OnlineDeploymentTrackedResource": {
+ "ScaleType": {
+ "enum": [
+ "Auto",
+ "Manual"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ScaleType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "SecretsType": {
+ "description": "Enum to determine the datastore secrets type.",
+ "enum": [
+ "AccountKey",
+ "Certificate",
+ "None",
+ "Sas",
+ "ServicePrincipal",
+ "SqlAdmin"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SecretsType",
+ "modelAsString": true
+ },
+ "additionalProperties": false
+ },
+ "ServicePrincipalDatastoreCredentials": {
+ "description": "Service Principal datastore credentials configuration.",
"required": [
- "location",
- "properties"
+ "clientId",
+ "tenantId"
],
"type": "object",
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource"
+ "$ref": "#/definitions/DatastoreCredentials"
}
],
"properties": {
- "kind": {
+ "authorityUrl": {
+ "description": "Authority URL used for authentication.",
"type": "string"
},
- "identity": {
- "description": "Service identity associated with a resource.",
- "$ref": "#/definitions/ResourceIdentity"
+ "clientId": {
+ "format": "uuid",
+ "description": "Service principal client ID.",
+ "type": "string"
},
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/OnlineDeployment"
+ "resourceUri": {
+ "description": "Resource the service principal has access to.",
+ "type": "string"
},
- "systemData": {
- "description": "System data associated with resource provider",
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
- "readOnly": true,
+ "secrets": {
+ "description": "Service principal secrets.",
+ "$ref": "#/definitions/ServicePrincipalDatastoreSecrets",
"x-ms-mutability": [
- "read"
- ]
+ "create",
+ "update"
+ ],
+ "x-ms-secret": true
+ },
+ "tenantId": {
+ "format": "uuid",
+ "description": "ID of the tenant to which the service principal belongs.",
+ "type": "string"
}
},
+ "x-ms-discriminator-value": "ServicePrincipal",
"additionalProperties": false
},
- "OnlineDeploymentTrackedResourceArmPaginatedResult": {
- "description": "A paginated list of OnlineDeployment entities.",
+ "ServicePrincipalDatastoreSecrets": {
+ "description": "Datastore Service Principal secrets.",
"type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type OnlineDeployment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/OnlineDeploymentTrackedResource"
- }
- },
- "nextLink": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatastoreSecrets"
+ }
+ ],
+ "properties": {
+ "clientSecret": {
+ "description": "Service principal secret.",
"type": "string"
}
},
+ "x-ms-discriminator-value": "ServicePrincipal",
"additionalProperties": false
},
- "PartialOnlineDeployment": {
- "description": "Mutable online deployment configuration",
+ "SqlAdminDatastoreCredentials": {
+ "description": "SQL Admin datastore credentials configuration.",
"required": [
- "endpointComputeType"
+ "userId"
],
- "type": "object",
- "properties": {
- "endpointComputeType": {
- "description": "Enum to determine endpoint compute type.",
- "$ref": "#/definitions/EndpointComputeType"
- },
- "scaleSettings": {
- "$ref": "#/definitions/OnlineScaleSettings"
- },
- "requestSettings": {
- "$ref": "#/definitions/OnlineRequestSettings"
- },
- "appInsightsEnabled": {
- "type": "boolean"
- },
- "livenessProbe": {
- "$ref": "#/definitions/ProbeSettings"
- }
- },
- "discriminator": "endpointComputeType"
- },
- "PartialAksOnlineDeployment": {
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/PartialOnlineDeployment"
+ "$ref": "#/definitions/DatastoreCredentials"
}
],
"properties": {
- "containerResourceRequirements": {
- "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements"
+ "secrets": {
+ "description": "SQL database secrets.",
+ "$ref": "#/definitions/SqlAdminDatastoreSecrets",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ],
+ "x-ms-secret": true
+ },
+ "userId": {
+ "description": "SQL database user name.",
+ "pattern": "[a-zA-Z0-9_]",
+ "type": "string"
}
},
- "x-ms-discriminator-value": "K8S",
+ "x-ms-discriminator-value": "SqlAdmin",
"additionalProperties": false
},
- "PartialManagedOnlineDeployment": {
+ "SqlAdminDatastoreSecrets": {
+ "description": "Datastore SQL Admin secrets.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/PartialOnlineDeployment"
+ "$ref": "#/definitions/DatastoreSecrets"
}
],
"properties": {
- "readinessProbe": {
- "$ref": "#/definitions/ProbeSettings"
+ "password": {
+ "description": "SQL database password.",
+ "type": "string"
}
},
- "x-ms-discriminator-value": "Managed",
+ "x-ms-discriminator-value": "SqlAdmin",
"additionalProperties": false
},
- "PartialOnlineDeploymentPartialTrackedResource": {
- "description": "Strictly used in update requests.",
+ "StatusMessage": {
+ "description": "Active message associated with project",
"type": "object",
"properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
- "type": "string"
+ "code": {
+ "description": "Service-defined message code.",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
},
- "kind": {
- "type": "string"
+ "createdTimeUtc": {
+ "format": "date-time",
+ "description": "Time in UTC at which the message was created.",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
},
- "identity": {
- "description": "Service identity associated with a resource.",
- "$ref": "#/definitions/ResourceIdentity"
+ "level": {
+ "description": "Severity level of message.",
+ "$ref": "#/definitions/StatusMessageLevel",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
},
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/PartialOnlineDeployment"
+ "message": {
+ "description": "A human-readable representation of the message code.",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
}
},
"additionalProperties": false
},
- "ContainerType": {
+ "StatusMessageLevel": {
"enum": [
- "StorageInitializer",
- "InferenceServer"
+ "Error",
+ "Information",
+ "Warning"
],
"type": "string",
"x-ms-enum": {
- "name": "ContainerType",
+ "name": "StatusMessageLevel",
"modelAsString": true
},
"additionalProperties": false
},
- "DeploymentLogsRequest": {
+ "SweepJob": {
+ "description": "Sweep job definition.",
+ "required": [
+ "algorithm",
+ "compute",
+ "objective",
+ "searchSpace"
+ ],
"type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobBase"
+ }
+ ],
"properties": {
- "containerType": {
- "description": "The type of container to retrieve logs from.",
- "$ref": "#/definitions/ContainerType"
+ "algorithm": {
+ "description": "Type of the hyperparameter sampling algorithms",
+ "$ref": "#/definitions/SamplingAlgorithm"
},
- "tail": {
+ "compute": {
+ "description": "Compute binding for the job.",
+ "$ref": "#/definitions/ComputeConfiguration",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "earlyTermination": {
+ "description": "Early termination policies enable canceling poor-performing runs before they complete",
+ "$ref": "#/definitions/EarlyTerminationPolicy"
+ },
+ "experimentName": {
+ "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "identity": {
+ "description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity or null.\r\nDefaults to AmlToken if null.",
+ "$ref": "#/definitions/IdentityConfiguration",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "maxConcurrentTrials": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTotalTrials": {
"format": "int32",
- "description": "The maximum number of lines to tail.",
"type": "integer"
+ },
+ "objective": {
+ "$ref": "#/definitions/Objective"
+ },
+ "output": {
+ "description": "Location of the job output logs and artifacts.",
+ "$ref": "#/definitions/JobOutput",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "priority": {
+ "format": "int32",
+ "description": "Job priority for scheduling policy. Only applies to AMLCompute.\r\nPrivate preview feature and only available to users on the allow list.",
+ "type": "integer",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "searchSpace": {
+ "description": "A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "status": {
+ "description": "The status of a job.",
+ "$ref": "#/definitions/JobStatus",
+ "readOnly": true,
+ "x-ms-mutability": [
+ "read"
+ ]
+ },
+ "timeout": {
+ "format": "duration",
+ "description": "The total timeout in ISO 8601 format. Only supports duration with precision as low as Minutes.",
+ "type": "string"
+ },
+ "trial": {
+ "description": "Trial component definition.",
+ "$ref": "#/definitions/TrialComponent"
}
},
+ "x-ms-discriminator-value": "Sweep",
"additionalProperties": false
},
- "DeploymentLogs": {
+ "TensorFlow": {
+ "description": "TensorFlow distribution configuration.",
"type": "object",
- "properties": {
- "content": {
- "type": "string"
+ "allOf": [
+ {
+ "$ref": "#/definitions/DistributionConfiguration"
}
- },
- "additionalProperties": false
- },
- "OrderString": {
- "enum": [
- "CreatedAtDesc",
- "CreatedAtAsc",
- "UpdatedAtDesc",
- "UpdatedAtAsc"
],
- "type": "string",
- "x-ms-enum": {
- "name": "OrderString",
- "modelAsString": true
+ "properties": {
+ "parameterServerCount": {
+ "format": "int32",
+ "type": "integer",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "workerCount": {
+ "format": "int32",
+ "description": "Number of workers. Overwrites the node count in compute binding.",
+ "type": "integer",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
},
+ "x-ms-discriminator-value": "TensorFlow",
"additionalProperties": false
},
- "EndpointProvisioningState": {
- "description": "State of endpoint provisioning.",
+ "TextAnnotationType": {
+ "description": "Annotation type of text data.",
"enum": [
- "Creating",
- "Deleting",
- "Succeeded",
- "Failed",
- "Updating",
- "Canceled"
+ "Classification"
],
"type": "string",
"x-ms-enum": {
- "name": "EndpointProvisioningState",
+ "name": "TextAnnotationType",
"modelAsString": true
},
"additionalProperties": false
},
- "OnlineEndpoint": {
- "description": "Online endpoint configuration",
+ "TrialComponent": {
+ "description": "Trial component definition.",
"required": [
- "authMode"
+ "command"
],
"type": "object",
"properties": {
- "provisioningState": {
- "description": "State of endpoint provisioning.",
- "$ref": "#/definitions/EndpointProvisioningState",
- "readOnly": true,
+ "codeId": {
+ "description": "ARM resource ID of the code asset.",
+ "type": "string",
"x-ms-mutability": [
+ "create",
"read"
]
},
- "target": {
- "description": "ARM resource ID of the compute if it exists.\r\noptional",
- "type": "string"
+ "command": {
+ "description": "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"
+ ]
},
- "description": {
- "description": "Description of the inference endpoint.",
+ "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"
+ ]
+ },
+ "environmentId": {
+ "description": "The ARM resource ID of the Environment specification for the job.",
"type": "string"
},
- "properties": {
- "description": "Property dictionary. Properties can be added, but not removed or altered.",
+ "environmentVariables": {
+ "description": "Environment variables included in the job.",
"type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
- "traffic": {
- "description": "Traffic rules on how the traffic will be routed across deployments.",
+ "inputDataBindings": {
+ "description": "Mapping of input data bindings used in the job.",
"type": "object",
"additionalProperties": {
- "format": "int32",
- "type": "integer"
- }
- },
- "scoringUri": {
- "format": "uri",
- "description": "Endpoint URI.",
- "type": "string",
- "readOnly": true,
+ "$ref": "#/definitions/InputDataBinding"
+ },
"x-ms-mutability": [
+ "create",
"read"
]
},
- "swaggerUri": {
- "format": "uri",
- "description": "Endpoint Swagger URI.",
- "type": "string",
- "readOnly": true,
+ "outputDataBindings": {
+ "description": "Mapping of output data bindings used in the job.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/OutputDataBinding"
+ },
"x-ms-mutability": [
+ "create",
"read"
]
},
- "authMode": {
- "description": "Inference endpoint authentication mode type",
- "$ref": "#/definitions/EndpointAuthMode"
- },
- "keys": {
- "description": "EndpointAuthKeys to set initially on an Endpoint.\r\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.",
- "$ref": "#/definitions/EndpointAuthKeys",
- "x-ms-mutability": [
- "create"
- ],
- "x-ms-secret": true
- }
- },
- "additionalProperties": false
- },
- "OnlineEndpointTrackedResource": {
- "required": [
- "location",
- "properties"
- ],
- "type": "object",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource"
- }
- ],
- "properties": {
- "kind": {
- "type": "string"
- },
- "identity": {
- "description": "Service identity associated with a resource.",
- "$ref": "#/definitions/ResourceIdentity"
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/OnlineEndpoint"
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
- "readOnly": true,
+ "timeout": {
+ "format": "duration",
+ "description": "The max run duration in ISO 8601 format, after which the trial component will be cancelled.\r\nOnly supports duration with precision as low as Seconds.",
+ "type": "string",
"x-ms-mutability": [
+ "create",
"read"
]
}
},
"additionalProperties": false
},
- "OnlineEndpointTrackedResourceArmPaginatedResult": {
- "description": "A paginated list of OnlineEndpoint entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type OnlineEndpoint.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/OnlineEndpointTrackedResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "PartialOnlineEndpoint": {
- "description": "Mutable online endpoint configuration",
- "type": "object",
- "properties": {
- "traffic": {
- "description": "Traffic rules on how the traffic will be routed across deployments.",
- "type": "object",
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "additionalProperties": false
- },
- "PartialOnlineEndpointPartialTrackedResource": {
- "description": "Strictly used in update requests.",
+ "TruncationSelectionPolicy": {
+ "description": "Defines an early termination policy that cancels a given percentage of runs at each evaluation interval.",
"type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
- "type": "string"
- },
- "kind": {
- "type": "string"
- },
- "identity": {
- "description": "Service identity associated with a resource.",
- "$ref": "#/definitions/ResourceIdentity"
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "$ref": "#/definitions/PartialOnlineEndpoint"
+ "allOf": [
+ {
+ "$ref": "#/definitions/EarlyTerminationPolicy"
}
- },
- "additionalProperties": false
- },
- "KeyType": {
- "enum": [
- "Primary",
- "Secondary"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "KeyType",
- "modelAsString": true
- },
- "additionalProperties": false
- },
- "RegenerateEndpointKeysRequest": {
- "required": [
- "keyType"
],
- "type": "object",
"properties": {
- "keyType": {
- "description": "Specification for which type of key to generate. Primary or Secondary.",
- "$ref": "#/definitions/KeyType"
- },
- "keyValue": {
- "description": "The value the key is set to.",
- "type": "string"
+ "truncationPercentage": {
+ "format": "int32",
+ "type": "integer"
}
},
+ "x-ms-discriminator-value": "TruncationSelection",
"additionalProperties": false
},
- "EndpointAuthToken": {
- "description": "Service Token",
+ "UserAssignedIdentityMeta": {
+ "description": "User assigned identities associated with a resource.",
"type": "object",
"properties": {
- "accessToken": {
- "description": "Access token.",
+ "clientId": {
+ "description": "Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.",
"type": "string"
},
- "tokenType": {
- "description": "Access token type.",
+ "principalId": {
+ "description": "The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.",
"type": "string"
- },
- "expiryTimeUtc": {
- "format": "int64",
- "description": "Access token expiry time (UTC).",
- "type": "integer"
- },
- "refreshAfterTimeUtc": {
- "format": "int64",
- "description": "Refresh access token after time (UTC).",
- "type": "integer"
}
},
"additionalProperties": false