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 73acdce27ded..f52ee8931fd7 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,9370 +9,150 @@
"https"
],
"paths": {
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": {
- "put": {
- "tags": [
- "BatchDeployment"
- ],
- "summary": "Creates a batch inference deployment.",
- "operationId": "BatchDeployments_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "The identifier for the Batch inference deployment.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Batch inference deployment definition object.",
- "schema": {
- "description": "Batch inference deployment definition object.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "BatchDeployment"
- ],
- "summary": "Gets a batch inference deployment by id.",
- "operationId": "BatchDeployments_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Endpoint name",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "The identifier for the Batch deployments.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "BatchDeployment"
- ],
- "summary": "Delete Batch Inference deployment.",
- "operationId": "BatchDeployments_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Endpoint name",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Inference deployment identifier.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": {
- "get": {
- "tags": [
- "BatchDeployment"
- ],
- "summary": "Lists Batch inference deployments in the workspace.",
- "operationId": "BatchDeployments_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Endpoint name",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Batch Deployment.": {
- "$ref": "./examples/BatchDeployment/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": {
- "put": {
- "tags": [
- "BatchEndpoint"
- ],
- "summary": "Creates a batch inference endpoint.",
- "operationId": "BatchEndpoints_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name for the Batch inference endpoint.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Batch inference endpoint definition object.",
- "schema": {
- "description": "Batch inference endpoint definition object.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "BatchEndpoint"
- ],
- "summary": "Gets a batch inference endpoint by name.",
- "operationId": "BatchEndpoints_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name for the Batch Endpoint.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "BatchEndpoint"
- ],
- "summary": "Delete Batch Inference Endpoint.",
- "operationId": "BatchEndpoints_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": {
- "get": {
- "tags": [
- "BatchEndpoint"
- ],
- "summary": "Lists Batch inference endpoint in the workspace.",
- "operationId": "BatchEndpoints_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": {
- "post": {
- "tags": [
- "BatchEndpoint"
- ],
- "summary": "Lists batch Inference Endpoint keys.",
- "operationId": "BatchEndpoints_ListKeys",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/InferenceEndpointKeysTrackedResource"
- }
- }
- },
- "x-ms-examples": {
- "ListKeys Batch Endpoint.": {
- "$ref": "./examples/BatchEndpoint/listKeys.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/jobs": {
- "put": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Creates a batch inference endpoint job.",
- "operationId": "BatchJobEndpoints_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name of endpoint",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Batch inference endpoint Job definition object.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchJobResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Batch Job Endpoint.": {
- "$ref": "./examples/BatchJobEndpoint/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Lists batch inference endpoint jobs in this endpoint.",
- "operationId": "BatchJobEndpoints_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name of endpoint",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Batch Job Endpoint.": {
- "$ref": "./examples/BatchJobEndpoint/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/{id}": {
- "delete": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Deletes a batch inference endpoint job.",
- "operationId": "BatchJobEndpoints_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "Identifier for the batch endpoint job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "path",
- "name": "endpointName",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "204": {
- "description": "Success"
- },
- "202": {
- "description": "Success"
- },
- "200": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Batch Job Endpoint.": {
- "$ref": "./examples/BatchJobEndpoint/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/jobs/{id}": {
- "get": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Gets a batch inference endpoint job by name.",
- "operationId": "BatchJobEndpoints_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name of endpoint",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "id",
- "description": "Identifier for the batch endpoint job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Batch Job Endpoint.": {
- "$ref": "./examples/BatchJobEndpoint/get.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}/jobs": {
- "put": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Creates a batch inference job for a deployment.",
- "operationId": "BatchJobDeployments_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name of endpoint",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Name of deployment",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Batch inference endpoint Job definition object.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchJobResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Batch Job Deployment.": {
- "$ref": "./examples/BatchJobDeployment/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Lists batch inference jobs in this deployment.",
- "operationId": "BatchJobDeployments_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name of endpoint",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Name of deployment",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Batch Job Deployment.": {
- "$ref": "./examples/BatchJobDeployment/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}/jobs/{id}": {
- "delete": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Deletes a batch inference deployment job.",
- "operationId": "BatchJobDeployments_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Name of deployment",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "id",
- "description": "Identifier for the batch endpoint job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "path",
- "name": "endpointName",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "204": {
- "description": "Success"
- },
- "202": {
- "description": "Success"
- },
- "200": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Batch Job Deployment.": {
- "$ref": "./examples/BatchJobDeployment/delete.json"
- }
- }
- },
- "get": {
- "tags": [
- "BatchJob"
- ],
- "summary": "Gets a batch inference job by name at deployment.",
- "operationId": "BatchJobDeployments_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Name of endpoint",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Name of deployment",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "id",
- "description": "Identifier for the batch endpoint job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/BatchJobResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Batch Job Deployment.": {
- "$ref": "./examples/BatchJobDeployment/get.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": {
- "put": {
- "tags": [
- "CodeContainer"
- ],
- "summary": "Create or update container.",
- "operationId": "CodeContainers_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Container entity to create or update.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeContainerResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeContainerResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Code Container.": {
- "$ref": "./examples/CodeContainer/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "CodeContainer"
- ],
- "summary": "Get container.",
- "operationId": "CodeContainers_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Code Container.": {
- "$ref": "./examples/CodeContainer/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "CodeContainer"
- ],
- "summary": "Delete container.",
- "operationId": "CodeContainers_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Code Container.": {
- "$ref": "./examples/CodeContainer/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": {
- "get": {
- "tags": [
- "CodeContainer"
- ],
- "summary": "List containers.",
- "operationId": "CodeContainers_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeContainerResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Code Container.": {
- "$ref": "./examples/CodeContainer/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": {
- "put": {
- "tags": [
- "CodeVersion"
- ],
- "summary": "Create or update version.",
- "operationId": "CodeVersions_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Version entity to create or update.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeVersionResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeVersionResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Code Version.": {
- "$ref": "./examples/CodeVersion/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "CodeVersion"
- ],
- "summary": "Get version.",
- "operationId": "CodeVersions_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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Code Version.": {
- "$ref": "./examples/CodeVersion/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "CodeVersion"
- ],
- "summary": "Delete version.",
- "operationId": "CodeVersions_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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Code Version.": {
- "$ref": "./examples/CodeVersion/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": {
- "get": {
- "tags": [
- "CodeVersion"
- ],
- "summary": "List versions.",
- "operationId": "CodeVersions_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/CodeVersionResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Code Version.": {
- "$ref": "./examples/CodeVersion/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": {
- "put": {
- "tags": [
- "DataContainer"
- ],
- "summary": "Create or update container.",
- "operationId": "DataContainers_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Container entity to create or update.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/DataContainerResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataContainerResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Data Container.": {
- "$ref": "./examples/DataContainer/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "DataContainer"
- ],
- "summary": "Get container.",
- "operationId": "DataContainers_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Data Container.": {
- "$ref": "./examples/DataContainer/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "DataContainer"
- ],
- "summary": "Delete container.",
- "operationId": "DataContainers_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Data Container.": {
- "$ref": "./examples/DataContainer/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": {
- "get": {
- "tags": [
- "DataContainer"
- ],
- "summary": "List containers.",
- "operationId": "DataContainers_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataContainerResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Data Container.": {
- "$ref": "./examples/DataContainer/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": {
- "get": {
- "tags": [
- "Datastore"
- ],
- "summary": "List datastores.",
- "operationId": "Datastores_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "in": "query",
- "name": "count",
- "description": "Maximum number of results to return.",
- "type": "integer",
- "format": "int32",
- "default": 30
- },
- {
- "in": "query",
- "name": "isDefault",
- "description": "Filter down to the workspace default datastore.",
- "type": "boolean"
- },
- {
- "in": "query",
- "name": "names",
- "description": "Names of datastores to return.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- {
- "in": "query",
- "name": "searchText",
- "description": "Text to search for in the datastore names.",
- "type": "string"
- },
- {
- "in": "query",
- "name": "orderBy",
- "description": "Order by property (createdtime | modifiedtime | name).",
- "type": "string"
- },
- {
- "in": "query",
- "name": "orderByAsc",
- "description": "Order by property in ascending order.",
- "type": "boolean",
- "default": false
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DatastorePropertiesResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List datastores.": {
- "$ref": "./examples/Datastore/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}": {
- "delete": {
- "tags": [
- "Datastore"
- ],
- "summary": "Delete datastore.",
- "operationId": "Datastores_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Datastore name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete datastore.": {
- "$ref": "./examples/Datastore/delete.json"
- }
- }
- },
- "get": {
- "tags": [
- "Datastore"
- ],
- "summary": "Get datastore.",
- "operationId": "Datastores_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Datastore name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DatastorePropertiesResource"
- }
- }
- },
- "x-ms-examples": {
- "Get datastore.": {
- "$ref": "./examples/Datastore/get.json"
- }
- }
- },
- "put": {
- "tags": [
- "Datastore"
- ],
- "summary": "Create or update datastore.",
- "operationId": "Datastores_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Datastore name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Datastore entity to create or update.",
- "required": true,
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastorePropertiesResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DatastorePropertiesResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DatastorePropertiesResource"
- }
- }
- },
- "x-ms-examples": {
- "Create or update datastore.": {
- "$ref": "./examples/Datastore/createOrUpdate.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": {
- "post": {
- "tags": [
- "Datastore"
- ],
- "summary": "Get datastore secrets.",
- "operationId": "Datastores_ListSecrets",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Datastore name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- }
- },
- "x-ms-examples": {
- "Get datastore secrets.": {
- "$ref": "./examples/Datastore/listSecrets.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": {
- "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"
- },
- {
- "in": "path",
- "name": "version",
- "description": "Version identifier.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Version entity to create or update.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/DataVersionResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataVersionResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Data Version.": {
- "$ref": "./examples/DataVersion/createOrUpdate.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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Data Version.": {
- "$ref": "./examples/DataVersion/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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Data Version.": {
- "$ref": "./examples/DataVersion/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": {
- "get": {
- "tags": [
- "DataVersion"
- ],
- "summary": "List versions.",
- "operationId": "DataVersions_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DataVersionResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Data Version.": {
- "$ref": "./examples/DataVersion/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/deployments/{deploymentName}/preflight": {
- "post": {
- "tags": [
- "Deployment"
- ],
- "summary": "Perform preflight validation on a set of resources.",
- "operationId": "Deployments_Preflight",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Deployment.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "A set of resources to be deployed.",
- "schema": {
- "description": "A set of resources to be deployed.",
- "allOf": [
- {
- "$ref": "#/definitions/PreflightDeployment"
- }
- ]
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/PreflightResult"
- }
- }
- },
- "x-ms-examples": {
- "Deployment preflight check.": {
- "$ref": "./examples/Deployment/preflight.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": {
- "put": {
- "tags": [
- "EnvironmentContainer"
- ],
- "summary": "Create or update container.",
- "operationId": "EnvironmentContainers_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Container entity to create or update.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/EnvironmentContainerResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentContainerResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Environment Container.": {
- "$ref": "./examples/EnvironmentContainer/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "EnvironmentContainer"
- ],
- "summary": "Get container.",
- "operationId": "EnvironmentContainers_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Environment Container.": {
- "$ref": "./examples/EnvironmentContainer/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "EnvironmentContainer"
- ],
- "summary": "Delete container.",
- "operationId": "EnvironmentContainers_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Environment Container.": {
- "$ref": "./examples/EnvironmentContainer/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": {
- "get": {
- "tags": [
- "EnvironmentContainer"
- ],
- "summary": "List containers.",
- "operationId": "EnvironmentContainers_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Environment Container.": {
- "$ref": "./examples/EnvironmentContainer/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": {
- "put": {
- "tags": [
- "EnvironmentSpecification"
- ],
- "operationId": "EnvironmentSpecificationVersions_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "version",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Environment Specification Version.": {
- "$ref": "./examples/EnvironmentSpecificationVersion/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "EnvironmentSpecification"
- ],
- "summary": "Get version.",
- "operationId": "EnvironmentSpecificationVersions_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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Environment Specification Version.": {
- "$ref": "./examples/EnvironmentSpecificationVersion/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "EnvironmentSpecification"
- ],
- "summary": "Delete version.",
- "operationId": "EnvironmentSpecificationVersions_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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Environment Specification Version.": {
- "$ref": "./examples/EnvironmentSpecificationVersion/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": {
- "get": {
- "tags": [
- "EnvironmentSpecification"
- ],
- "operationId": "EnvironmentSpecificationVersions_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "in": "query",
- "name": "$orderby",
- "type": "string"
- },
- {
- "in": "query",
- "name": "$top",
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Environment Specification Version.": {
- "$ref": "./examples/EnvironmentSpecificationVersion/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": {
- "put": {
- "tags": [
- "Job"
- ],
- "summary": "Creates and executes a Job.",
- "operationId": "Jobs_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the Job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Job definition object.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/JobBaseResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/JobBaseResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/JobBaseResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Command Job.": {
- "$ref": "./examples/CommandJob/createOrUpdate.json"
- },
- "CreateOrUpdate Sweep Job.": {
- "$ref": "./examples/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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/JobBaseResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Command Job.": {
- "$ref": "./examples/CommandJob/get.json"
- },
- "Get Sweep Job.": {
- "$ref": "./examples/SweepJob/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "Job"
- ],
- "summary": "Deletes a Job.",
- "operationId": "Jobs_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the Job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "204": {
- "description": "Success"
- },
- "202": {
- "description": "Success"
- },
- "200": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Command Job.": {
- "$ref": "./examples/CommandJob/delete.json"
- },
- "Delete Sweep Job.": {
- "$ref": "./examples/SweepJob/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": {
- "get": {
- "tags": [
- "Job"
- ],
- "summary": "Lists Jobs in the workspace.",
- "operationId": "Jobs_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "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"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/JobBaseResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Command Job.": {
- "$ref": "./examples/CommandJob/list.json"
- },
- "List Sweep Job.": {
- "$ref": "./examples/SweepJob/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": {
- "post": {
- "tags": [
- "Job"
- ],
- "summary": "Cancels a Job.",
- "operationId": "Jobs_Cancel",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the Job.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Cancel Command Job.": {
- "$ref": "./examples/CommandJob/cancel.json"
- },
- "Cancel Sweep Job.": {
- "$ref": "./examples/SweepJob/cancel.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/operationresults/{operationId}": {
- "get": {
- "tags": [
- "Job"
- ],
- "summary": "Polls a Job operation.",
- "operationId": "Jobs_Poll",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the Job.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "operationId",
- "description": "The operation ID of the async operation to be polled",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "202": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Poll Command Job.": {
- "$ref": "./examples/CommandJob/poll.json"
- },
- "Poll Sweep Job.": {
- "$ref": "./examples/SweepJob/poll.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}": {
- "put": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Creates or updates a labeling job.",
- "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"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "LabelingJob definition object.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/LabelingJobResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/LabelingJobResource"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/LabelingJobResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Labeling Job.": {
- "$ref": "./examples/LabelingJob/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Gets a labeling job by name/id.",
- "operationId": "LabelingJobs_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the LabelingJob.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "in": "query",
- "name": "includeJobInstructions",
- "description": "Boolean value to indicate whether to include JobInstructions in response.",
- "type": "boolean"
- },
- {
- "in": "query",
- "name": "includeLabelCategories",
- "description": "Boolean value to indicate Whether to include LabelCategories in response.",
- "type": "boolean"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/LabelingJobResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Labeling Job.": {
- "$ref": "./examples/LabelingJob/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Delete a labeling job.",
- "operationId": "LabelingJobs_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the LabelingJob.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Labeling Job.": {
- "$ref": "./examples/LabelingJob/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs": {
- "get": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Lists labeling jobs in the workspace.",
- "operationId": "LabelingJobs_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "in": "query",
- "name": "count",
- "description": "Number of labeling jobs to return.",
- "type": "integer",
- "format": "int32"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/LabelingJobResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Labeling Job.": {
- "$ref": "./examples/LabelingJob/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/pause": {
- "post": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Pause a labeling job.",
- "operationId": "LabelingJobs_Pause",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the LabelingJob.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Pause Labeling Job.": {
- "$ref": "./examples/LabelingJob/pause.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/resume": {
- "post": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Resume a labeling job.",
- "operationId": "LabelingJobs_Resume",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the LabelingJob.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "202": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Resume Labeling Job.": {
- "$ref": "./examples/LabelingJob/resume.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels": {
- "post": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Export labels from a labeling job.",
- "operationId": "LabelingJobs_ExportLabels",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the LabelingJob.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "The desired format of export operation.",
- "schema": {
- "description": "The format of exported labels.",
- "enum": [
- "Dataset",
- "Coco",
- "CSV"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ExportFormatType",
- "modelAsString": true
- }
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "202": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "ExportLabels Labeling Job.": {
- "$ref": "./examples/LabelingJob/exportLabels.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/labelingJobs/{id}/exportLabels/{exportId}": {
- "get": {
- "tags": [
- "LabelingJob"
- ],
- "summary": "Get export summary from a labeling job.",
- "operationId": "LabelingJobs_GetExportSummary",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "description": "The name and identifier for the LabelingJob.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "in": "path",
- "name": "exportId",
- "description": "The unique identifier of Export Labels operation.",
- "required": true,
- "type": "string",
- "format": "uuid"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ExportSummaryResource"
- }
- }
- },
- "x-ms-examples": {
- "GetExportSummary Labeling Job.": {
- "$ref": "./examples/LabelingJob/getExportSummary.json"
- }
- }
- }
- },
- "/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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "in": "query",
- "name": "count",
- "description": "Maximum number of results to return.",
- "type": "integer",
- "format": "int32"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelContainerResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Model Container.": {
- "$ref": "./examples/ModelContainer/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": {
- "put": {
- "tags": [
- "ModelContainer"
- ],
- "summary": "Create or update container.",
- "operationId": "ModelContainers_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Container entity to create or update.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/ModelContainerResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelContainerResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Model Container.": {
- "$ref": "./examples/ModelContainer/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "ModelContainer"
- ],
- "summary": "Get container.",
- "operationId": "ModelContainers_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelContainerResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Model Container.": {
- "$ref": "./examples/ModelContainer/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "ModelContainer"
- ],
- "summary": "Delete container.",
- "operationId": "ModelContainers_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Container name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Model Container.": {
- "$ref": "./examples/ModelContainer/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": {
- "get": {
- "tags": [
- "ModelVersion"
- ],
- "summary": "List model versions.",
- "operationId": "ModelVersions_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "name",
- "description": "Model name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "in": "query",
- "name": "version",
- "description": "Model version.",
- "type": "string"
- },
- {
- "in": "query",
- "name": "description",
- "description": "Model description.",
- "type": "string"
- },
- {
- "in": "query",
- "name": "count",
- "description": "Maximum number of results to return.",
- "type": "integer",
- "format": "int32"
- },
- {
- "in": "query",
- "name": "offset",
- "description": "Number of initial results to skip.",
- "type": "integer",
- "format": "int32"
- },
- {
- "in": "query",
- "name": "tags",
- "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
- "type": "string"
- },
- {
- "in": "query",
- "name": "properties",
- "description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2",
- "type": "string"
- },
- {
- "in": "query",
- "name": "orderBy",
- "description": "Property by which to order the results.",
- "type": "string"
- },
- {
- "in": "query",
- "name": "latestVersionOnly",
- "description": "Only return the most recent version of a model.",
- "type": "boolean",
- "default": false
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelVersionResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Model Version.": {
- "$ref": "./examples/ModelVersion/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": {
- "put": {
- "tags": [
- "ModelVersion"
- ],
- "summary": "Create or update version.",
- "operationId": "ModelVersions_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Version entity to create or update.",
- "schema": {
- "description": "Azure Resource Manager resource envelope.",
- "allOf": [
- {
- "$ref": "#/definitions/ModelVersionResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelVersionResource"
- }
- },
- "201": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Model Version.": {
- "$ref": "./examples/ModelVersion/createOrUpdate.json"
- }
- }
- },
- "get": {
- "tags": [
- "ModelVersion"
- ],
- "summary": "Get version.",
- "operationId": "ModelVersions_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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/ModelVersionResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Model Version.": {
- "$ref": "./examples/ModelVersion/get.json"
- }
- }
- },
- "delete": {
- "tags": [
- "ModelVersion"
- ],
- "summary": "Delete version.",
- "operationId": "ModelVersions_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": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "204": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Model Version.": {
- "$ref": "./examples/ModelVersion/delete.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": {
- "get": {
- "tags": [
- "OnlineDeployment"
- ],
- "summary": "List Inference Endpoint Deployments.",
- "operationId": "OnlineDeployments_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/PaginationParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Online Deployment Properties.": {
- "$ref": "./examples/OnlineDeploymentProperties/list.json"
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": {
- "delete": {
- "tags": [
- "OnlineDeployment"
- ],
- "summary": "Delete Inference Endpoint Deployment.",
- "operationId": "OnlineDeployments_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Inference Endpoint Deployment name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "202": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/LongRunningNullResponseLongRunningOperationResponse"
- }
- },
- "204": {
- "description": "Success"
- },
- "200": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Online Deployment Properties.": {
- "$ref": "./examples/OnlineDeploymentProperties/delete.json"
- }
- }
- },
- "get": {
- "tags": [
- "OnlineDeployment"
- ],
- "summary": "Get Inference Deployment Deployment.",
- "operationId": "OnlineDeployments_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Inference Endpoint Deployment name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Online Deployment Properties.": {
- "$ref": "./examples/OnlineDeploymentProperties/get.json"
- }
- }
- },
- "put": {
- "tags": [
- "OnlineDeployment"
- ],
- "summary": "Create or update Inference Endpoint Deployment.",
- "operationId": "OnlineDeployments_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "Inference Endpoint Deployment name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Inference Endpoint entity to apply during operation.",
- "schema": {
- "description": "Inference Endpoint entity to apply during operation.",
- "allOf": [
- {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResource"
- }
- },
- "202": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResourceLongRunningOperationResponse"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Online Deployment Properties.": {
- "$ref": "./examples/OnlineDeploymentProperties/createOrUpdate.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": {
- "post": {
- "tags": [
- "OnlineDeployment"
- ],
- "summary": "Polls an Endpoint operation.",
- "operationId": "OnlineDeployments_GetLogs",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "The name and identifier for the endpoint.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "The request containing parameters for retrieving logs.",
- "schema": {
- "description": "The request containing parameters for retrieving logs.",
- "allOf": [
- {
- "$ref": "#/definitions/DeploymentLogsRequest"
- }
- ]
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/DeploymentLogs"
- }
- }
- },
- "x-ms-examples": {
- "GetLogs Online Deployment Properties.": {
- "$ref": "./examples/OnlineDeploymentProperties/getLogs.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/operationresults/{operationId}": {
- "get": {
- "tags": [
- "OnlineDeployment"
- ],
- "summary": "Polls an Endpoint operation.",
- "operationId": "OnlineDeployments_Poll",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Inference endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "deploymentName",
- "description": "The name and identifier for the endpoint.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "operationId",
- "description": "The operation ID of the async operation to be polled",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResource"
- }
- },
- "202": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResourceLongRunningOperationResponse"
- }
- }
- },
- "x-ms-examples": {
- "Poll Online Deployment Properties.": {
- "$ref": "./examples/OnlineDeploymentProperties/poll.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": {
- "get": {
- "tags": [
- "OnlineEndpoint"
- ],
- "summary": "List Online Endpoints.",
- "operationId": "OnlineEndpoints_List",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "in": "query",
- "name": "name",
- "description": "Name of the endpoint.",
- "type": "string",
- "default": ""
- },
- {
- "in": "query",
- "name": "count",
- "description": "Number of endpoints to be retrieved in a page of results.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- {
- "in": "query",
- "name": "computeType",
- "description": "EndpointComputeType to be filtered by.",
- "type": "string",
- "default": "Managed",
- "enum": [
- "Managed",
- "AKS",
- "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",
- "default": ""
- },
- {
- "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",
- "default": ""
- },
- {
- "in": "query",
- "name": "orderBy",
- "description": "The option to order the response.",
- "type": "string",
- "default": "CreatedAtDesc",
- "enum": [
- "CreatedAtDesc",
- "CreatedAtAsc",
- "UpdatedAtDesc",
- "UpdatedAtAsc"
- ],
- "x-ms-enum": {
- "name": "OrderString",
- "modelAsString": true
- }
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResourceArmPaginatedResult"
- }
- }
- },
- "x-ms-examples": {
- "List Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/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.",
- "operationId": "OnlineEndpoints_Delete",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Online Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "204": {
- "description": "Success"
- },
- "202": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/LongRunningNullResponseLongRunningOperationResponse"
- }
- },
- "200": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Delete Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/delete.json"
- }
- }
- },
- "get": {
- "tags": [
- "OnlineEndpoint"
- ],
- "summary": "Get Online Endpoint.",
- "operationId": "OnlineEndpoints_Get",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Online Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResource"
- }
- }
- },
- "x-ms-examples": {
- "Get Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/get.json"
- }
- }
- },
- "put": {
- "tags": [
- "OnlineEndpoint"
- ],
- "summary": "Create or update Online Endpoint.",
- "operationId": "OnlineEndpoints_CreateOrUpdate",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Online Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "Online Endpoint entity to apply during operation.",
- "schema": {
- "description": "Online Endpoint entity to apply during operation.",
- "allOf": [
- {
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResource"
- }
- ],
- "x-ms-azure-resource": true
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResource"
- }
- },
- "202": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResourceLongRunningOperationResponse"
- }
- }
- },
- "x-ms-examples": {
- "CreateOrUpdate Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/createOrUpdate.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": {
- "post": {
- "tags": [
- "OnlineEndpoint"
- ],
- "summary": "Regenerate AuthKeys for an Endpoint using Key-based authentication.",
- "operationId": "OnlineEndpoints_RegenerateKeys",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Online Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- },
- {
- "in": "body",
- "name": "body",
- "description": "RegenerateKeys request .",
- "schema": {
- "description": "RegenerateKeys request .",
- "allOf": [
- {
- "$ref": "#/definitions/RegenerateEndpointKeysRequest"
- }
- ]
- }
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "202": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResourceLongRunningOperationResponse"
- }
- }
- },
- "x-ms-examples": {
- "RegenerateKeys Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/regenerateKeys.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": {
- "post": {
- "tags": [
- "OnlineEndpoint"
- ],
- "summary": "List AuthKeys for an Endpoint using Key-based authentication.",
- "operationId": "OnlineEndpoints_ListKeys",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Online Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/AuthKeys"
- }
- }
- },
- "x-ms-examples": {
- "ListKeys Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/listKeys.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": {
- "post": {
- "tags": [
- "OnlineEndpoint"
- ],
- "summary": "Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.",
- "operationId": "OnlineEndpoints_GetToken",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "Online Endpoint name.",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success",
- "schema": {
- "$ref": "#/definitions/AuthToken"
- }
- }
- },
- "x-ms-examples": {
- "GetToken Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/getToken.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/operationresults/{operationId}": {
- "get": {
- "tags": [
- "OnlineEndpoint"
- ],
- "summary": "Polls an Endpoint operation.",
- "operationId": "OnlineEndpoints_Poll",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "path",
- "name": "endpointName",
- "description": "The name and identifier for the endpoint.",
- "required": true,
- "type": "string"
- },
- {
- "in": "path",
- "name": "operationId",
- "description": "The operation ID of the async operation to be polled",
- "required": true,
- "type": "string"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
- }
- ],
- "responses": {
- "default": {
- "description": "Error",
- "schema": {
- "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
- }
- },
- "200": {
- "description": "Success"
- },
- "202": {
- "description": "Success"
- }
- },
- "x-ms-examples": {
- "Poll Online Endpoint Properties.": {
- "$ref": "./examples/OnlineEndpointProperties/poll.json"
- }
- }
- }
- }
- },
- "definitions": {
- "UserAssignedIdentityMeta": {
- "type": "object",
- "properties": {
- "principalId": {
- "type": "string"
- },
- "clientId": {
- "type": "string"
- },
- "clientSecretUrl": {
- "type": "string"
- },
- "resourceId": {
- "type": "string"
- },
- "tenantId": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "ResourceIdentityInArm": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string"
- },
- "principalId": {
- "type": "string"
- },
- "tenantId": {
- "type": "string"
- },
- "userAssignedIdentities": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/UserAssignedIdentityMeta"
- }
- }
- },
- "additionalProperties": false
- },
- "DeploymentScaleSettings": {
- "type": "object",
- "properties": {
- "nodeCount": {
- "format": "int32",
- "description": "Number of Compute nodes to be used for running the deployment",
- "type": "integer",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "BatchRetrySettings": {
- "description": "Retry settings for a batch inference operation.",
- "type": "object",
- "properties": {
- "maximumRetries": {
- "format": "int32",
- "description": "Maximum retry count for a mini-batch",
- "type": "integer"
- },
- "timeoutInSeconds": {
- "format": "int32",
- "description": "Invocation timeout for a mini-batch, in seconds.",
- "type": "integer"
- }
- },
- "additionalProperties": false
- },
- "BatchPartitioningScheme": {
- "description": "Partitioning scheme for batch inference operation.",
- "type": "object",
- "properties": {
- "partitioningKeys": {
- "description": "Partition keys list used for Named partitioning.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "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",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "BatchOutputConfiguration": {
- "description": "Batch inference output configuration.",
- "type": "object",
- "properties": {
- "outputAction": {
- "description": "Indicates how the output will be organized.",
- "enum": [
- "SummaryOnly",
- "AppendRow"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "BatchOutputAction",
- "modelAsString": true
- }
- },
- "appendRowFileName": {
- "description": "Customized output file name for append_row output action.",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "BatchDeploymentSettings": {
- "description": "Batch inference specific settings per deployment.",
- "type": "object",
- "properties": {
- "computeId": {
- "description": "Resource ID of the compute resource",
- "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\n-1 value indicates, ignore all failures during batch inference\r\nFor FileDataset count of file failures\r\nFor TabularDataset, this is the count of record failures",
- "type": "integer"
- },
- "retrySettings": {
- "description": "Retry Settings for the batch inference operation.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchRetrySettings"
- }
- ]
- },
- "partitioningScheme": {
- "description": "Partitioning scheme on how data is partitioned across mini-batches for the batch inference operation.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchPartitioningScheme"
- }
- ]
- },
- "loggingLevel": {
- "description": "Logging level for batch inference operation.",
- "enum": [
- "Info",
- "Warning",
- "Debug"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "BatchLoggingLevel",
- "modelAsString": true
- }
- },
- "outputConfiguration": {
- "description": "Output configuration for the batch inference operation.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchOutputConfiguration"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "AssetReferenceBase": {
- "required": [
- "referenceType"
- ],
- "type": "object",
- "properties": {
- "referenceType": {
- "description": "Specifies the type of asset reference.",
- "enum": [
- "Id",
- "DataPath",
- "OutputPath"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ReferenceType",
- "modelAsString": true
- }
- }
- },
- "discriminator": "referenceType",
- "additionalProperties": false
- },
- "CodeConfiguration": {
- "required": [
- "command"
- ],
- "type": "object",
- "properties": {
- "codeArtifactId": {
- "description": "The 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": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "InnerErrorResponse": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "innerError": {
- "allOf": [
- {
- "$ref": "#/definitions/InnerErrorResponse"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "RootError": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "severity": {
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "type": "string"
- },
- "messageFormat": {
- "type": "string"
- },
- "messageParameters": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "referenceCode": {
- "type": "string"
- },
- "detailsUri": {
- "format": "uri",
- "type": "string"
- },
- "target": {
- "type": "string"
- },
- "details": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/RootError"
- }
- },
- "innerError": {
- "allOf": [
- {
- "$ref": "#/definitions/InnerErrorResponse"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "BatchDeployment": {
- "description": "Batch inference settings per deployment.",
- "required": [
- "modelReference"
- ],
- "type": "object",
- "properties": {
- "scaleSettings": {
- "description": "Scale settings for deployment",
- "allOf": [
- {
- "$ref": "#/definitions/DeploymentScaleSettings"
- }
- ]
- },
- "batchSettings": {
- "description": "Batch deployment settings",
- "allOf": [
- {
- "$ref": "#/definitions/BatchDeploymentSettings"
- }
- ]
- },
- "description": {
- "description": "Description of the endpoint deployment.",
- "type": "string"
- },
- "properties": {
- "description": "Property dictionary. Properties can be added, but not removed or altered.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- },
- "modelReference": {
- "$ref": "#/definitions/AssetReferenceBase"
- },
- "codeConfiguration": {
- "description": "Code configuration for the endpoint deployment.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeConfiguration"
- }
- ]
- },
- "environmentId": {
- "description": "Environment specification for the endpoint deployment.",
- "type": "string"
- },
- "provisioningState": {
- "description": "Provisioning state for the endpoint deployment.",
- "enum": [
- "Creating",
- "Deleting",
- "Scaling",
- "Updating",
- "Succeeded",
- "Failed"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "DeploymentProvisioningState",
- "modelAsString": true
- }
- },
- "error": {
- "allOf": [
- {
- "$ref": "#/definitions/RootError"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "BatchDeploymentTrackedResource": {
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
- "type": "string"
- },
- "kind": {
- "type": "string"
- },
- "identity": {
- "allOf": [
- {
- "$ref": "#/definitions/ResourceIdentityInArm"
- }
- ]
- },
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchDeployment"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "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
- },
- "ComputeConfiguration": {
- "required": [
- "computeType"
- ],
- "type": "object",
- "properties": {
- "computeType": {
- "enum": [
- "Managed",
- "AKS",
- "AzureMLCompute"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EndpointComputeType",
- "modelAsString": true
- }
- }
- },
- "discriminator": "computeType",
- "additionalProperties": false
- },
- "BatchEndpoint": {
- "description": "Batch endpoint configuration",
- "type": "object",
- "properties": {
- "authMode": {
- "enum": [
- "AMLToken",
- "Key",
- "AADToken"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EndpointAuthModeType",
- "modelAsString": true
- }
- },
- "description": {
- "description": "Description of the inference endpoint.",
- "type": "string"
- },
- "properties": {
- "description": "Property dictionary. Properties can be added, but not removed or altered.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- },
- "trafficRules": {
- "description": "Traffic rules on how the traffic will be routed across deployments.",
- "type": "object",
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- }
- },
- "computeConfiguration": {
- "$ref": "#/definitions/ComputeConfiguration"
- },
- "provisioningState": {
- "description": "State of provisioning",
- "enum": [
- "Creating",
- "Deleting",
- "Succeeded",
- "Failed"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "EndpointProvisioningState",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "read"
- ]
- },
- "endpoint": {
- "format": "uri",
- "description": "Endpoint URI",
- "type": "string",
- "readOnly": true
- },
- "swaggerEndpoint": {
- "format": "uri",
- "description": "Endpoint Swagger URI",
- "type": "string",
- "readOnly": true
- },
- "error": {
- "allOf": [
- {
- "$ref": "#/definitions/RootError"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "BatchEndpointTrackedResource": {
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
- "type": "string"
- },
- "kind": {
- "type": "string"
- },
- "identity": {
- "allOf": [
- {
- "$ref": "#/definitions/ResourceIdentityInArm"
- }
- ]
- },
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchEndpoint"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "BatchEndpointTrackedResourceArmPaginatedResult": {
- "description": "A paginated list of BatchEndpoint entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type BatchEndpoint.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/BatchEndpointTrackedResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "InferenceEndpointKeys": {
- "type": "object",
- "properties": {
- "endpointKey": {
- "description": "Endpoint keys",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "InferenceEndpointKeysTrackedResource": {
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
- "type": "string"
- },
- "kind": {
- "type": "string"
- },
- "identity": {
- "allOf": [
- {
- "$ref": "#/definitions/ResourceIdentityInArm"
- }
- ]
- },
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/InferenceEndpointKeys"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "AssetPath": {
- "description": "Details of an AssetUri.",
- "required": [
- "path"
- ],
- "type": "object",
- "properties": {
- "path": {
- "description": "The path of file/directory.",
- "pattern": "\\w",
- "type": "string"
- },
- "isDirectory": {
- "description": "Whether the path defines a directory or a single file.",
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "InferenceDataInputBase": {
- "required": [
- "dataInputType"
- ],
- "type": "object",
- "properties": {
- "dataInputType": {
- "enum": [
- "DatasetVersion",
- "DatasetId",
- "DataUrl"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "InferenceDataInputType",
- "modelAsString": true
- }
- }
- },
- "discriminator": "dataInputType",
- "additionalProperties": false
- },
- "JobOutput": {
- "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
- },
- "path": {
- "description": "Path within the datastore to the job logs and artifacts.",
- "type": "string",
- "readOnly": true
- }
- },
- "additionalProperties": false
- },
- "BatchJob": {
- "description": "Batch endpoint job",
- "required": [
- "dataset"
- ],
- "type": "object",
- "properties": {
- "dataset": {
- "$ref": "#/definitions/InferenceDataInputBase"
- },
- "partitioningScheme": {
- "description": "Partitioning scheme on how data is partitioned across mini-batches for the batch inference operation.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchPartitioningScheme"
- }
- ],
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "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\n-1 value indicates, ignore all failures during batch inference",
- "type": "integer",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "scaleSettings": {
- "description": "Scale settings for deployment",
- "allOf": [
- {
- "$ref": "#/definitions/DeploymentScaleSettings"
- }
- ],
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "output": {
- "description": "Location of the job output logs and artifacts.",
- "allOf": [
- {
- "$ref": "#/definitions/JobOutput"
- }
- ],
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "status": {
- "description": "Status of the job.",
- "enum": [
- "NotStarted",
- "Starting",
- "Provisioning",
- "Preparing",
- "Queued",
- "Running",
- "Finalizing",
- "CancelRequested",
- "Completed",
- "Failed",
- "Canceled",
- "NotResponding",
- "Paused"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "JobStatus",
- "modelAsString": true
- }
- },
- "interactionEndpoints": {
- "description": "Dictionary of endpoint URIs, keyed by enumerated job endpoints.",
- "type": "object",
- "properties": {
- "Tracking": {
- "format": "uri",
- "type": "string"
- },
- "Studio": {
- "format": "uri",
- "type": "string"
- },
- "Grafana": {
- "format": "uri",
- "type": "string"
- },
- "Tensorboard": {
- "format": "uri",
- "type": "string"
- },
- "Local": {
- "format": "uri",
- "type": "string"
- }
- },
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "description": {
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "properties": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-mutability": [
- "create",
- "read"
- ],
- "x-ms-client-flatten": true
- }
- },
- "additionalProperties": false
- },
- "BatchJobResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/BatchJob"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "BatchJobResourceArmPaginatedResult": {
- "description": "A paginated list of BatchJob entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type BatchJob.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/BatchJobResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "CodeContainer": {
- "type": "object",
- "properties": {
- "properties": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "description": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "CodeContainerResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeContainer"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "CodeContainerResourceArmPaginatedResult": {
- "description": "A paginated list of CodeContainer entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type CodeContainer.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CodeContainerResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "CodeVersion": {
- "description": "Details of an RegisteredCode",
- "type": "object",
- "properties": {
- "datastoreId": {
- "description": "The asset datastoreId",
- "type": "string"
- },
- "assetPath": {
- "description": "Details of asset path in the datastore.",
- "allOf": [
- {
- "$ref": "#/definitions/AssetPath"
- }
- ]
- },
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- }
- },
- "additionalProperties": false
- },
- "CodeVersionResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeVersion"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "CodeVersionResourceArmPaginatedResult": {
- "description": "A paginated list of CodeVersion entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type CodeVersion.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CodeVersionResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "DataContainer": {
- "type": "object",
- "properties": {
- "properties": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "description": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "DataContainerResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/DataContainer"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "DataContainerResourceArmPaginatedResult": {
- "description": "A paginated list of DataContainer entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type DataContainer.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/DataContainerResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "AccountKeySection": {
- "type": "object",
- "properties": {
- "key": {
- "description": "Storage account key.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "additionalProperties": false
- },
- "CertificateSection": {
- "required": [
- "clientId",
- "tenantId",
- "thumbprint"
- ],
- "type": "object",
- "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"
- },
- "certificate": {
- "description": "Service principal certificate.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- },
- "thumbprint": {
- "description": "Thumbprint of the certificate used for authentication.",
- "pattern": "\\w",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "SasSection": {
- "type": "object",
- "properties": {
- "sasToken": {
- "description": "Storage container SAS token.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "additionalProperties": false
- },
- "ServicePrincipalSection": {
- "required": [
- "clientId",
- "tenantId"
- ],
- "type": "object",
- "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"
- },
- "clientSecret": {
- "description": "Service principal secret.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "additionalProperties": false
- },
- "SqlAdminSection": {
- "required": [
- "userId"
- ],
- "type": "object",
- "properties": {
- "userId": {
- "description": "SQL database user name.",
- "pattern": "\\w",
- "type": "string"
- },
- "password": {
- "description": "SQL database password.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ],
- "x-ms-secret": true
- }
- },
- "additionalProperties": false
- },
- "DatastoreCredentials": {
- "required": [
- "type"
- ],
- "type": "object",
- "properties": {
- "type": {
- "description": "Credential type used to authentication with storage.",
- "enum": [
- "AccountKey",
- "Certificate",
- "None",
- "Sas",
- "ServicePrincipal",
- "SqlAdmin"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "CredentialsType",
- "modelAsString": true
- }
- },
- "accountKey": {
- "description": "Storage account key authentication.",
- "allOf": [
- {
- "$ref": "#/definitions/AccountKeySection"
- }
- ]
- },
- "certificate": {
- "description": "Service principal certificate authentication.",
- "allOf": [
- {
- "$ref": "#/definitions/CertificateSection"
- }
- ]
- },
- "sas": {
- "description": "Storage container SAS token authentication.",
- "allOf": [
- {
- "$ref": "#/definitions/SasSection"
- }
- ]
- },
- "servicePrincipal": {
- "description": "Service principal password authentication.",
- "allOf": [
- {
- "$ref": "#/definitions/ServicePrincipalSection"
- }
- ]
- },
- "sqlAdmin": {
- "description": "SQL user/password authentication.",
- "allOf": [
- {
- "$ref": "#/definitions/SqlAdminSection"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "AzureDataLakeSection": {
- "required": [
- "credentials",
- "storeName"
- ],
- "type": "object",
- "properties": {
- "credentials": {
- "description": "Azure Data Lake credentials.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ]
- },
- "storeName": {
- "description": "Azure Data Lake store name.",
- "pattern": "\\w",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "AzureMySqlSection": {
- "required": [
- "credentials",
- "databaseName",
- "endpoint",
- "portNumber",
- "serverName"
- ],
- "type": "object",
- "properties": {
- "credentials": {
- "description": "Azure SQL database credentials.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ]
- },
- "databaseName": {
- "description": "Azure SQL database name.",
- "pattern": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "endpoint": {
- "description": "Azure cloud endpoint for the database.",
- "pattern": "\\w",
- "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": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "AzurePostgreSqlSection": {
- "required": [
- "credentials",
- "databaseName",
- "endpoint",
- "portNumber",
- "serverName"
- ],
- "type": "object",
- "properties": {
- "enableSSL": {
- "description": "Whether the Azure PostgreSQL server requires SSL.",
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "credentials": {
- "description": "Azure SQL database credentials.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ]
- },
- "databaseName": {
- "description": "Azure SQL database name.",
- "pattern": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "endpoint": {
- "description": "Azure cloud endpoint for the database.",
- "pattern": "\\w",
- "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": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "AzureSqlDatabaseSection": {
- "required": [
- "credentials",
- "databaseName",
- "endpoint",
- "portNumber",
- "serverName"
- ],
- "type": "object",
- "properties": {
- "credentials": {
- "description": "Azure SQL database credentials.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ]
- },
- "databaseName": {
- "description": "Azure SQL database name.",
- "pattern": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "endpoint": {
- "description": "Azure cloud endpoint for the database.",
- "pattern": "\\w",
- "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": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "AzureStorageSection": {
- "required": [
- "accountName",
- "containerName",
- "credentials",
- "endpoint",
- "protocol"
- ],
- "type": "object",
- "properties": {
- "accountName": {
- "description": "Storage account name.",
- "pattern": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "blobCacheTimeout": {
- "format": "int32",
- "description": "Blob storage cache timeout.",
- "type": "integer",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "containerName": {
- "description": "Storage account container name.",
- "pattern": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "credentials": {
- "description": "Storage account credentials.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreCredentials"
- }
- ]
- },
- "endpoint": {
- "description": "Azure cloud endpoint for the storage account.",
- "pattern": "\\w",
- "type": "string",
- "example": "core.windows.net",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "protocol": {
- "description": "Protocol used to communicate with the storage account.",
- "pattern": "\\w",
- "type": "string",
- "example": "https",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "GlusterFsSection": {
- "required": [
- "serverAddress",
- "volumeName"
- ],
- "type": "object",
- "properties": {
- "serverAddress": {
- "description": "GlusterFS server address (can be the IP address or server name).",
- "pattern": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "volumeName": {
- "description": "GlusterFS volume name.",
- "pattern": "\\w",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "DatastoreContents": {
- "required": [
- "type"
- ],
- "type": "object",
- "properties": {
- "type": {
- "description": "Storage type backing the datastore.",
- "enum": [
- "AzureBlob",
- "AzureDataLake",
- "AzureDataLakeGen2",
- "AzureFile",
- "AzureMySql",
- "AzurePostgreSql",
- "AzureSqlDatabase",
- "GlusterFs"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ContentsType",
- "modelAsString": true
- }
- },
- "azureDataLake": {
- "description": "Azure Data Lake (Gen1/2) storage information.",
- "allOf": [
- {
- "$ref": "#/definitions/AzureDataLakeSection"
- }
- ]
- },
- "azureMySql": {
- "description": "Azure Database for MySQL information.",
- "allOf": [
- {
- "$ref": "#/definitions/AzureMySqlSection"
- }
- ]
- },
- "azurePostgreSql": {
- "description": "Azure Database for PostgreSQL information.",
- "allOf": [
- {
- "$ref": "#/definitions/AzurePostgreSqlSection"
- }
- ]
- },
- "azureSqlDatabase": {
- "description": "Azure SQL Database information.",
- "allOf": [
- {
- "$ref": "#/definitions/AzureSqlDatabaseSection"
- }
- ]
- },
- "azureStorage": {
- "description": "Azure storage account (blobs, files) information.",
- "allOf": [
- {
- "$ref": "#/definitions/AzureStorageSection"
- }
- ]
- },
- "glusterFs": {
- "description": "GlusterFS volume information.",
- "allOf": [
- {
- "$ref": "#/definitions/GlusterFsSection"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "LinkedInfo": {
- "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.",
- "enum": [
- "Synapse"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "OriginType",
- "modelAsString": true
- }
- }
- },
- "additionalProperties": false
- },
- "DatastoreProperties": {
- "required": [
- "contents"
- ],
- "type": "object",
- "properties": {
- "contents": {
- "description": "Reference to the datastore storage contents.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreContents"
- }
- ]
- },
- "hasBeenValidated": {
- "description": "Whether the service has validated access to the datastore with the provided credentials.",
- "type": "boolean",
- "readOnly": true
- },
- "isDefault": {
- "description": "Whether this datastore is the default for the workspace.",
- "type": "boolean"
- },
- "linkedInfo": {
- "description": "Information about the datastore origin, if linked.",
- "allOf": [
- {
- "$ref": "#/definitions/LinkedInfo"
- }
- ]
- },
- "properties": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- },
- "description": {
- "description": "The asset description text.",
- "type": "string"
- },
- "tags": {
- "description": "Tag dictionary. Tags can be added, removed, and updated.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "additionalProperties": false
- },
- "DatastorePropertiesResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/DatastoreProperties"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "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"
- }
- },
- "additionalProperties": false
- },
- "DataVersion": {
- "description": "Details of an DatasetDto",
- "type": "object",
- "properties": {
- "datasetType": {
- "description": "The Format of dataset.",
- "enum": [
- "Simple",
- "Dataflow"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "DatasetType",
- "modelAsString": true
- }
- },
- "datastoreId": {
- "description": "The asset datastoreId",
- "type": "string"
- },
- "assetPath": {
- "description": "Details of asset path in the datastore.",
- "allOf": [
- {
- "$ref": "#/definitions/AssetPath"
- }
- ]
- },
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- }
- },
- "additionalProperties": false
- },
- "DataVersionResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/DataVersion"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "DataVersionResourceArmPaginatedResult": {
- "description": "A paginated list of DataVersion entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type DataVersion.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/DataVersionResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "PreflightResource": {
- "description": "Represents a single resource in a preflight validation request.\r\nSee: https://armwiki.azurewebsites.net/api_contracts/preflight.html",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "apiVersion": {
- "description": "API version that will be used when calling the resource endpoint.",
- "type": "string"
- },
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "PreflightDeployment": {
- "required": [
- "resources"
- ],
- "type": "object",
- "properties": {
- "resources": {
- "description": "The resources part of an ARM deployment template with all possible\r\nproperties expanded (including copy operations) and flattened (no nested resources).",
- "type": "array",
- "items": {
- "$ref": "#/definitions/PreflightResource"
- }
- }
- },
- "additionalProperties": false
- },
- "PreflightResult": {
- "type": "object",
- "properties": {
- "error": {
- "description": "The error that occurred during validation, if any.",
- "allOf": [
- {
- "$ref": "#/definitions/RootError"
- }
- ]
- },
- "status": {
- "description": "Outcome of the preflight validation.",
- "enum": [
- "Failed",
- "Succeeded"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "PreflightStatus",
- "modelAsString": true
- }
- }
- },
- "additionalProperties": false
- },
- "EnvironmentContainer": {
- "type": "object",
- "properties": {
- "properties": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "description": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "EnvironmentContainerResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/EnvironmentContainer"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "EnvironmentContainerResourceArmPaginatedResult": {
- "description": "A paginated list of EnvironmentContainer entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type EnvironmentContainer.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/EnvironmentContainerResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "DockerSpecification": {
- "description": "Class to represent configuration settings for Docker",
- "required": [
- "type"
- ],
- "type": "object",
- "properties": {
- "type": {
- "description": "Docker specification must be either Build or Image",
- "enum": [
- "Build",
- "Image"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "DockerSpecificationType",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "discriminator": "type",
- "additionalProperties": false
- },
- "EnvironmentSpecificationVersion": {
- "description": "Data Transfer Object (DTO) for an Execution Environment Specification. Name and\r\nversion should default to the AzureML-Minimal environment version tested with the\r\ncurrent SDK client version as this is a main use-case.\r\n",
- "type": "object",
- "properties": {
- "type": {
- "description": "Environment specification is either user managed or curated by the Azure ML service\r\n",
- "enum": [
- "Curated",
- "UserCreated"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "EnvironmentSpecificationType",
- "modelAsString": true
- }
- },
- "docker": {
- "$ref": "#/definitions/DockerSpecification"
- },
- "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"
- },
- "datastoreId": {
- "description": "The asset datastoreId",
- "type": "string"
- },
- "assetPath": {
- "description": "Details of asset path in the datastore.",
- "allOf": [
- {
- "$ref": "#/definitions/AssetPath"
- }
- ]
- },
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- }
- },
- "additionalProperties": false
- },
- "EnvironmentSpecificationVersionResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/EnvironmentSpecificationVersion"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "EnvironmentSpecificationVersionResourceArmPaginatedResult": {
- "description": "A paginated list of EnvironmentSpecificationVersion entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type EnvironmentSpecificationVersion.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/EnvironmentSpecificationVersionResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "DataBinding": {
- "description": "Data binding definition.",
- "type": "object",
- "properties": {
- "sourceDataReference": {
- "description": "Reference to source data artifact.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "localReference": {
- "description": "Location of data inside the container process.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "mode": {
- "description": "Mechanism for accessing the data artifact.",
- "enum": [
- "Mount",
- "Download",
- "Upload"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "DataBindingMode",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "DistributionConfiguration": {
- "required": [
- "distributionType"
- ],
- "type": "object",
- "properties": {
- "distributionType": {
- "description": "Specifies the type of distribution framework.",
- "enum": [
- "PyTorch",
- "TensorFlow",
- "Mpi"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "DistributionType",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "discriminator": "distributionType",
- "additionalProperties": false
- },
- "ComputeBinding": {
- "description": "Compute binding definition.",
- "type": "object",
- "properties": {
- "computeId": {
- "description": "Resource ID of the compute resource.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "nodeCount": {
- "format": "int32",
- "description": "Number of nodes.",
- "type": "integer",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "isLocal": {
- "description": "Set to true for jobs running on local compute.",
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "JobBase": {
- "description": "Job base definition",
- "required": [
- "jobType"
- ],
- "type": "object",
- "properties": {
- "jobType": {
- "description": "Specifies the type of job.",
- "enum": [
- "Command",
- "Sweep",
- "Labeling",
- "Pipeline",
- "Data",
- "AutoML"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "JobType",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "interactionEndpoints": {
- "description": "Dictionary of endpoint URIs, keyed by enumerated job endpoints.\r\nFor local jobs, a job endpoint will have a value of FileStreamObject.",
- "type": "object",
- "properties": {
- "Tracking": {
- "format": "uri",
- "type": "string"
- },
- "Studio": {
- "format": "uri",
- "type": "string"
- },
- "Grafana": {
- "format": "uri",
- "type": "string"
- },
- "Tensorboard": {
- "format": "uri",
- "type": "string"
- },
- "Local": {
- "format": "uri",
- "type": "string"
- }
- },
- "readOnly": true
- },
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- }
- },
- "discriminator": "jobType",
- "additionalProperties": false
- },
- "ComputeJobBase": {
- "description": "Compute job base definition",
- "required": [
- "computeBinding",
- "jobType"
- ],
- "allOf": [
- {
- "$ref": "#/definitions/JobBase"
- },
- {
- "type": "object",
- "properties": {
- "experimentName": {
- "description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.",
- "type": "string"
- },
- "computeBinding": {
- "description": "Compute binding for the job.",
- "allOf": [
- {
- "$ref": "#/definitions/ComputeBinding"
- }
- ]
- },
- "output": {
- "description": "Location of the job output logs and artifacts.",
- "allOf": [
- {
- "$ref": "#/definitions/JobOutput"
- }
- ]
- }
- }
- }
- ],
- "discriminator": "jobType",
- "additionalProperties": false
- },
- "CommandJob": {
- "description": "Code Job definition",
- "required": [
- "codeConfiguration",
- "computeBinding",
- "jobType"
- ],
- "allOf": [
- {
- "$ref": "#/definitions/ComputeJobBase"
- },
- {
- "type": "object",
- "properties": {
- "jobType": {
- "enum": [
- "Command",
- "Sweep",
- "Labeling",
- "Pipeline",
- "Data",
- "AutoML"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "JobType",
- "modelAsString": true
- }
- },
- "status": {
- "description": "Status of the job.",
- "enum": [
- "NotStarted",
- "Starting",
- "Provisioning",
- "Preparing",
- "Queued",
- "Running",
- "Finalizing",
- "CancelRequested",
- "Completed",
- "Failed",
- "Canceled",
- "NotResponding",
- "Paused"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "JobStatus",
- "modelAsString": true
- }
- },
- "maxRunDurationSeconds": {
- "format": "int64",
- "description": "The max run duration in seconds, after which the job will be cancelled.",
- "type": "integer"
- },
- "codeConfiguration": {
- "description": "Code configuration of the job.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeConfiguration"
- }
- ]
- },
- "environmentId": {
- "description": "Environment specification of the job.",
- "type": "string"
- },
- "dataBindings": {
- "description": "Mapping of data bindings used in the job.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/DataBinding"
- }
- },
- "distributionConfiguration": {
- "$ref": "#/definitions/DistributionConfiguration"
- }
- }
- }
- ],
- "discriminator": "jobType",
- "x-ms-discriminator-value": "Command",
- "additionalProperties": false
- },
- "ParameterSamplingConfiguration": {
- "description": "class for all hyperparameter sampling algorithms",
- "required": [
- "parameterSpace",
- "samplingType"
- ],
- "type": "object",
- "properties": {
- "parameterSpace": {
- "description": "A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter",
- "type": "object"
- },
- "samplingType": {
- "description": "Type of the hyperparameter sampling algorithms",
- "enum": [
- "Grid",
- "Random",
- "Bayesian"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ParameterSamplingType",
- "modelAsString": true
- }
- }
- },
- "additionalProperties": false
- },
- "EarlyTerminationPolicyConfiguration": {
- "description": "Early termination policies enable canceling poor-performing runs before they complete",
- "required": [
- "policyType"
- ],
- "type": "object",
- "properties": {
- "policyType": {
- "description": "Name of policy configuration",
- "enum": [
- "Bandit",
- "MedianStopping",
- "TruncationSelection"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EarlyTerminationPolicyType",
- "modelAsString": true
- }
- },
- "evaluationInterval": {
- "format": "int32",
- "type": "integer"
- },
- "delayEvaluation": {
- "format": "int32",
- "type": "integer"
- }
- },
- "discriminator": "policyType",
- "additionalProperties": false
- },
- "TerminationConfiguration": {
- "type": "object",
- "properties": {
- "maxTotalRuns": {
- "format": "int32",
- "type": "integer"
- },
- "maxConcurrentRuns": {
- "format": "int32",
- "type": "integer"
- },
- "maxDurationMinutes": {
- "format": "int32",
- "type": "integer"
- },
- "earlyTerminationPolicyConfiguration": {
- "$ref": "#/definitions/EarlyTerminationPolicyConfiguration"
- }
- },
- "additionalProperties": false
- },
- "EvaluationConfiguration": {
- "required": [
- "primaryMetricGoal",
- "primaryMetricName"
- ],
- "type": "object",
- "properties": {
- "primaryMetricName": {
- "pattern": "\\w",
- "type": "string"
- },
- "primaryMetricGoal": {
- "description": "Defines supported metric goals for hyperparameter tuning",
- "enum": [
- "Minimize",
- "Maximize"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "PrimaryMetricGoal",
- "modelAsString": true
- }
- }
- },
- "additionalProperties": false
- },
- "TrialComponent": {
- "type": "object",
- "properties": {
- "codeConfiguration": {
- "description": "Code configuration of the job.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeConfiguration"
- }
- ]
- },
- "environmentId": {
- "description": "Environment id of the job.",
- "type": "string"
- },
- "dataBindings": {
- "description": "Mapping of data bindings used in the job.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/DataBinding"
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "distributionConfiguration": {
- "$ref": "#/definitions/DistributionConfiguration"
- }
- },
- "additionalProperties": false
- },
- "SweepJob": {
- "required": [
- "computeBinding",
- "evaluationConfiguration",
- "parameterSamplingConfiguration"
- ],
- "allOf": [
- {
- "$ref": "#/definitions/ComputeJobBase"
- },
- {
- "type": "object",
- "properties": {
- "jobType": {
- "enum": [
- "Command",
- "Sweep",
- "Labeling",
- "Pipeline",
- "Data",
- "AutoML"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "JobType",
- "modelAsString": true
- }
- },
- "status": {
- "description": "The status of a job.",
- "enum": [
- "NotStarted",
- "Starting",
- "Provisioning",
- "Preparing",
- "Queued",
- "Running",
- "Finalizing",
- "CancelRequested",
- "Completed",
- "Failed",
- "Canceled",
- "NotResponding",
- "Paused"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "JobStatus",
- "modelAsString": true
- }
- },
- "parameterSamplingConfiguration": {
- "description": "class for all hyperparameter sampling algorithms",
- "allOf": [
- {
- "$ref": "#/definitions/ParameterSamplingConfiguration"
- }
- ]
- },
- "terminationConfiguration": {
- "allOf": [
- {
- "$ref": "#/definitions/TerminationConfiguration"
- }
- ]
- },
- "evaluationConfiguration": {
- "allOf": [
- {
- "$ref": "#/definitions/EvaluationConfiguration"
- }
- ]
- },
- "trialComponent": {
- "allOf": [
- {
- "$ref": "#/definitions/TrialComponent"
- }
- ]
- }
- }
- }
- ],
- "x-ms-discriminator-value": "Sweep",
- "additionalProperties": false
- },
- "LabelClass": {
- "description": "Label class definition",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Display name of the label class.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "subclasses": {
- "description": "Dictionary of subclasses of the label class.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/LabelClass"
- },
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
- }
- },
- "additionalProperties": false
- },
- "LabelCategory": {
- "description": "Label category definition",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Display name of the label category.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "allowMultiSelect": {
- "description": "Indicates whether it is allowed to select multiple classes in this category.",
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
- },
- "classes": {
- "description": "Dictionary of label classes in this category.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/LabelClass"
- },
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
- }
- },
- "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
- },
- "LabelingDatasetConfiguration": {
- "description": "Labeling dataset configuration definition",
- "type": "object",
- "properties": {
- "assetName": {
- "description": "Name of the data asset to perform labeling.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "incrementalDatasetRefreshEnabled": {
- "description": "Indicates whether to enable incremental dataset refresh.",
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
- },
- "datasetVersion": {
- "description": "AML dataset version.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "MLAssistConfiguration": {
- "description": "Labeling MLAssist configuration definition",
- "type": "object",
- "properties": {
- "inferencingComputeBinding": {
- "description": "AML compute binding used in inferencing.",
- "allOf": [
- {
- "$ref": "#/definitions/ComputeBinding"
- }
- ],
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
- },
- "trainingComputeBinding": {
- "description": "AML compute binding used in training.",
- "allOf": [
- {
- "$ref": "#/definitions/ComputeBinding"
- }
- ],
- "x-ms-mutability": [
- "create",
- "read",
- "update"
- ]
- },
- "mlAssistEnabled": {
- "description": "Indicates whether MLAssist feature is enabled.",
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "LabelingJobMediaProperties": {
- "description": "Properties of a labeling job",
- "required": [
- "mediaType"
- ],
- "type": "object",
- "properties": {
- "mediaType": {
- "description": "Media type of the job.",
- "enum": [
- "Image",
- "Text"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "MediaType",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "create",
- "read"
- ]
- }
- },
- "discriminator": "mediaType",
- "additionalProperties": false
- },
- "ProgressMetrics": {
- "description": "Progress metrics definition",
- "type": "object",
- "properties": {
- "totalDatapointCount": {
- "format": "int64",
- "description": "The total datapoint count.",
- "type": "integer",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "completedDatapointCount": {
- "format": "int64",
- "description": "The completed datapoint count.",
- "type": "integer",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "skippedDatapointCount": {
- "format": "int64",
- "description": "The skipped datapoint count.",
- "type": "integer",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "incrementalDatasetLastRefreshTime": {
- "format": "date-time",
- "description": "The time of last successful incremental dataset refresh in UTC.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "StatusMessage": {
- "description": "Active message associated with project",
- "type": "object",
- "properties": {
- "level": {
- "description": "Severity level of message.",
- "enum": [
- "Error",
- "Information",
- "Warning"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "StatusMessageLevel",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "read"
- ]
- },
- "code": {
- "description": "Service-defined message code.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "message": {
- "description": "A human-readable representation of the message code.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "createdTimeUtc": {
- "format": "date-time",
- "description": "Time in UTC at which the message was created.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- }
- },
- "additionalProperties": false
- },
- "LabelingJob": {
- "description": "Labeling job definition",
- "allOf": [
- {
- "$ref": "#/definitions/JobBase"
- },
- {
- "type": "object",
- "properties": {
- "labelCategories": {
- "description": "Label categories of the job.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/LabelCategory"
- }
- },
- "jobInstructions": {
- "description": "Labeling instructions of the job.",
- "allOf": [
- {
- "$ref": "#/definitions/LabelingJobInstructions"
- }
- ]
- },
- "datasetConfiguration": {
- "description": "Configuration of dataset used in the job.",
- "allOf": [
- {
- "$ref": "#/definitions/LabelingDatasetConfiguration"
- }
- ]
- },
- "mlAssistConfiguration": {
- "description": "Configuration of MLAssist feature in the job.",
- "allOf": [
- {
- "$ref": "#/definitions/MLAssistConfiguration"
- }
- ]
- },
- "labelingJobMediaProperties": {
- "$ref": "#/definitions/LabelingJobMediaProperties"
- },
- "projectId": {
- "format": "uuid",
- "description": "Internal id of the job(Previously called project).",
- "type": "string"
- },
- "status": {
- "description": "Status of the job.",
- "enum": [
- "NotStarted",
- "Starting",
- "Provisioning",
- "Preparing",
- "Queued",
- "Running",
- "Finalizing",
- "CancelRequested",
- "Completed",
- "Failed",
- "Canceled",
- "NotResponding",
- "Paused"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "JobStatus",
- "modelAsString": true
- }
- },
- "progressMetrics": {
- "description": "Progress metrics of the job.",
- "allOf": [
- {
- "$ref": "#/definitions/ProgressMetrics"
- }
- ]
- },
- "statusMessages": {
- "description": "Status messages of the job.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StatusMessage"
- }
- },
- "createdTimeUtc": {
- "format": "date-time",
- "description": "Created time of the job in UTC timezone.",
- "type": "string"
- }
- }
- }
- ],
- "x-ms-discriminator-value": "Labeling",
- "additionalProperties": false
- },
- "JobBaseResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "$ref": "#/definitions/JobBase"
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "JobBaseResourceArmPaginatedResult": {
- "description": "A paginated list of JobBase entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type JobBase.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/JobBaseResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "LabelingJobResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/LabelingJob"
- }
- ],
- "x-ms-discriminator-value": "Labeling",
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "LabelingJobResourceArmPaginatedResult": {
- "description": "A paginated list of LabelingJob entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type LabelingJob.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/LabelingJobResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "ExportSummary": {
- "required": [
- "format"
- ],
- "type": "object",
- "properties": {
- "format": {
- "description": "The format of exported labels, also as the discriminator.",
- "enum": [
- "Dataset",
- "Coco",
- "CSV"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ExportFormatType",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "read"
- ]
- },
- "exportId": {
- "format": "uuid",
- "description": "The unique identifier of completed Export Labels operation.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "labelingJobId": {
- "description": "Name and identifier of the job containing exported labels.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "exportedRowCount": {
- "format": "int64",
- "description": "The total number of labeled datapoints exported.",
- "type": "integer",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "startTimeUtc": {
- "format": "date-time",
- "description": "The time when the export was requested.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "endTimeUtc": {
- "format": "date-time",
- "description": "The time when the export was completed.",
- "type": "string",
- "readOnly": true,
- "x-ms-mutability": [
- "read"
- ]
- },
- "state": {
- "description": "The state of the Export Labels operation.",
- "enum": [
- "Requested",
- "Running",
- "Failed",
- "Completed"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "LabelExportState",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "read"
- ]
- }
- },
- "discriminator": "format",
- "additionalProperties": false
- },
- "ExportSummaryResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "$ref": "#/definitions/ExportSummary"
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "ModelVersion": {
- "description": "Details of an ModelDto",
- "type": "object",
- "properties": {
- "stage": {
- "description": "Model asset stage.",
- "type": "string"
- },
- "datastoreId": {
- "description": "The asset datastoreId",
- "type": "string"
- },
- "assetPath": {
- "description": "Details of asset path in the datastore.",
- "allOf": [
- {
- "$ref": "#/definitions/AssetPath"
- }
- ]
- },
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- }
- },
- "additionalProperties": false
- },
- "ModelVersionResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/ModelVersion"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "ModelContainer": {
- "type": "object",
- "properties": {
- "latestVersions": {
- "description": "Latest model versions for each stage.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ModelVersionResource"
- }
- },
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-ms-client-flatten": true
- }
- },
- "additionalProperties": false
- },
- "ModelContainerResource": {
- "description": "Azure Resource Manager resource envelope.",
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/ModelContainer"
- }
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
- }
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "ModelContainerResourceArmPaginatedResult": {
- "description": "A paginated list of ModelContainer entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type ModelContainer.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ModelContainerResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "ModelVersionResourceArmPaginatedResult": {
- "description": "A paginated list of ModelVersion entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type ModelVersion.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ModelVersionResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "EnvironmentOverrides": {
- "type": "object",
- "properties": {
- "environmentVariables": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "additionalProperties": false
- },
- "DeploymentConfigurationBase": {
- "required": [
- "computeType"
- ],
- "type": "object",
- "properties": {
- "computeType": {
- "enum": [
- "Managed",
- "AKS",
- "AzureMLCompute"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EndpointComputeType",
- "modelAsString": true
- }
- },
- "appInsightsEnabled": {
- "type": "boolean"
- },
- "maxConcurrentRequestsPerInstance": {
- "format": "int32",
- "type": "integer"
- },
- "maxQueueWaitMs": {
- "format": "int32",
- "type": "integer"
- },
- "scoringTimeoutMs": {
- "format": "int32",
- "type": "integer"
- },
- "containerResourceRequirements": {
- "allOf": [
- {
- "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements"
- }
- ]
- },
- "livenessProbeRequirements": {
- "allOf": [
- {
- "$ref": "machineLearningServices.json#/definitions/LivenessProbeRequirements"
- }
- ]
- }
- },
- "discriminator": "computeType",
- "additionalProperties": false
- },
- "OnlineDeploymentProperties": {
- "required": [
- "deploymentConfiguration",
- "modelReference"
- ],
- "type": "object",
- "properties": {
- "scaleSettings": {
- "allOf": [
- {
- "$ref": "machineLearningServices.json#/definitions/ScaleSettings"
- }
- ]
- },
- "environmentOverrides": {
- "allOf": [
- {
- "$ref": "#/definitions/EnvironmentOverrides"
- }
- ]
- },
- "deploymentConfiguration": {
- "$ref": "#/definitions/DeploymentConfigurationBase"
- },
- "description": {
- "description": "Description of the endpoint deployment.",
- "type": "string"
- },
- "properties": {
- "description": "Property dictionary. Properties can be added, but not removed or altered.",
- "type": "object",
- "additionalProperties": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "OnlineDeployment"
+ ],
+ "summary": "Delete Inference Endpoint Deployment.",
+ "operationId": "OnlineDeployments_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "endpointName",
+ "description": "Inference endpoint name.",
+ "required": true,
"type": "string"
},
- "x-ms-client-flatten": true
- },
- "modelReference": {
- "$ref": "#/definitions/AssetReferenceBase"
- },
- "codeConfiguration": {
- "description": "Code configuration for the endpoint deployment.",
- "allOf": [
- {
- "$ref": "#/definitions/CodeConfiguration"
- }
- ]
- },
- "environmentId": {
- "description": "Environment specification for the endpoint deployment.",
- "type": "string"
- },
- "provisioningState": {
- "description": "Provisioning state for the endpoint deployment.",
- "enum": [
- "Creating",
- "Deleting",
- "Scaling",
- "Updating",
- "Succeeded",
- "Failed"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "DeploymentProvisioningState",
- "modelAsString": true
- }
- },
- "error": {
- "allOf": [
- {
- "$ref": "#/definitions/RootError"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "OnlineDeploymentPropertiesTrackedResource": {
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
+ {
+ "in": "path",
+ "name": "deploymentName",
+ "description": "Inference Endpoint Deployment name.",
+ "required": true,
"type": "string"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/APIVersionParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter"
}
- },
- "location": {
- "type": "string"
- },
- "kind": {
- "type": "string"
- },
- "identity": {
- "allOf": [
- {
- "$ref": "#/definitions/ResourceIdentityInArm"
- }
- ]
- },
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/OnlineDeploymentProperties"
+ ],
+ "responses": {
+ "default": {
+ "description": "Error",
+ "schema": {
+ "$ref": "machineLearningServices.json#/definitions/MachineLearningServiceError"
}
- ],
- "x-ms-client-flatten": true
- },
- "systemData": {
- "description": "System data associated with resource provider",
- "allOf": [
- {
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ },
+ "202": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/LongRunningNullResponseLongRunningOperationResponse"
}
- ],
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true,
- "additionalProperties": false
- },
- "OnlineDeploymentPropertiesTrackedResourceArmPaginatedResult": {
- "description": "A paginated list of OnlineDeploymentProperties entities.",
- "type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type OnlineDeploymentProperties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResource"
+ },
+ "204": {
+ "description": "Success"
+ },
+ "200": {
+ "description": "Success"
}
},
- "nextLink": {
- "type": "string"
+ "x-ms-examples": {
+ "Delete Online Deployment Properties.": {
+ "$ref": "./examples/OnlineDeploymentProperties/delete.json"
+ }
}
- },
- "additionalProperties": false
- },
- "LongRunningNullResponse": {
- "type": "object",
- "additionalProperties": false
- },
- "LongRunningNullResponseLongRunningOperationResponse": {
+ }
+ }
+ },
+ "definitions": {
+ "InnerErrorResponse": {
"type": "object",
"properties": {
- "completionResult": {
+ "code": {
+ "type": "string"
+ },
+ "innerError": {
"allOf": [
{
- "$ref": "#/definitions/LongRunningNullResponse"
+ "$ref": "#/definitions/InnerErrorResponse"
}
]
- },
- "location": {
- "format": "uri",
- "type": "string"
}
},
"additionalProperties": false
},
- "OnlineDeploymentPropertiesTrackedResourceLongRunningOperationResponse": {
+ "RootError": {
"type": "object",
"properties": {
- "completionResult": {
- "allOf": [
- {
- "$ref": "#/definitions/OnlineDeploymentPropertiesTrackedResource"
- }
- ],
- "x-ms-azure-resource": true
- },
- "location": {
- "format": "uri",
+ "code": {
"type": "string"
- }
- },
- "additionalProperties": false
- },
- "DeploymentLogsRequest": {
- "type": "object",
- "properties": {
- "containerType": {
- "description": "The type of container to retrieve logs from.",
- "enum": [
- "StorageInitializer",
- "InferenceServer"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ContainerType",
- "modelAsString": true
- }
},
- "tail": {
+ "severity": {
"format": "int32",
- "description": "The maximum number of lines to tail.",
"type": "integer"
- }
- },
- "additionalProperties": false
- },
- "DeploymentLogs": {
- "type": "object",
- "properties": {
- "content": {
+ },
+ "message": {
"type": "string"
- }
- },
- "additionalProperties": false
- },
- "OnlineEndpointProperties": {
- "description": "Online endpoint configuration",
- "required": [
- "authMode"
- ],
- "type": "object",
- "properties": {
- "description": {
- "description": "Description of the inference endpoint.",
+ },
+ "messageFormat": {
"type": "string"
},
- "properties": {
- "description": "Property dictionary. Properties can be added, but not removed or altered.",
+ "messageParameters": {
"type": "object",
"additionalProperties": {
"type": "string"
- },
- "x-ms-client-flatten": true
- },
- "trafficRules": {
- "description": "Traffic rules on how the traffic will be routed across deployments.",
- "type": "object",
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
}
},
- "computeConfiguration": {
- "$ref": "#/definitions/ComputeConfiguration"
- },
- "provisioningState": {
- "description": "State of provisioning",
- "enum": [
- "Creating",
- "Deleting",
- "Succeeded",
- "Failed"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "EndpointProvisioningState",
- "modelAsString": true
- },
- "x-ms-mutability": [
- "read"
- ]
- },
- "endpoint": {
- "format": "uri",
- "description": "Endpoint URI",
- "type": "string",
- "readOnly": true
+ "referenceCode": {
+ "type": "string"
},
- "swaggerEndpoint": {
+ "detailsUri": {
"format": "uri",
- "description": "Endpoint Swagger URI",
- "type": "string",
- "readOnly": true
- },
- "authMode": {
- "description": "Inference endpoint authentication mode type",
- "enum": [
- "AMLToken",
- "Key",
- "AADToken"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "EndpointAuthModeType",
- "modelAsString": true
- }
- },
- "error": {
- "allOf": [
- {
- "$ref": "#/definitions/RootError"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "OnlineEndpointPropertiesTrackedResource": {
- "required": [
- "properties"
- ],
- "type": "object",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "location": {
"type": "string"
},
- "kind": {
+ "target": {
"type": "string"
},
- "identity": {
- "allOf": [
- {
- "$ref": "#/definitions/ResourceIdentityInArm"
- }
- ]
- },
- "id": {
- "description": "The resource URL of the entity (not URL encoded).",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "The name of the resource entity.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "The resource provider and type.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Additional attributes of the entity.",
- "allOf": [
- {
- "$ref": "#/definitions/OnlineEndpointProperties"
- }
- ],
- "x-ms-client-flatten": true
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RootError"
+ }
},
- "systemData": {
- "description": "System data associated with resource provider",
+ "innerError": {
"allOf": [
{
- "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ "$ref": "#/definitions/InnerErrorResponse"
}
- ],
- "readOnly": true
+ ]
}
},
- "x-ms-azure-resource": true,
"additionalProperties": false
},
- "OnlineEndpointPropertiesTrackedResourceArmPaginatedResult": {
- "description": "A paginated list of OnlineEndpointProperties entities.",
+ "LongRunningNullResponse": {
"type": "object",
- "properties": {
- "value": {
- "description": "An array of objects of type OnlineEndpointProperties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResource"
- }
- },
- "nextLink": {
- "type": "string"
- }
- },
"additionalProperties": false
},
- "OnlineEndpointPropertiesTrackedResourceLongRunningOperationResponse": {
+ "LongRunningNullResponseLongRunningOperationResponse": {
"type": "object",
"properties": {
"completionResult": {
"allOf": [
{
- "$ref": "#/definitions/OnlineEndpointPropertiesTrackedResource"
+ "$ref": "#/definitions/LongRunningNullResponse"
}
- ],
- "x-ms-azure-resource": true
+ ]
},
"location": {
"format": "uri",
@@ -9380,68 +160,6 @@
}
},
"additionalProperties": false
- },
- "RegenerateEndpointKeysRequest": {
- "type": "object",
- "properties": {
- "keyType": {
- "description": "Specification for which type of key to generate. Primary or Secondary.",
- "enum": [
- "Primary",
- "Secondary"
- ],
- "type": "string",
- "example": "Primary",
- "x-ms-enum": {
- "name": "KeyType",
- "modelAsString": true
- }
- },
- "keyValue": {
- "description": "The value the key is set to.",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "AuthKeys": {
- "type": "object",
- "properties": {
- "primaryKey": {
- "description": "The primary key.",
- "type": "string"
- },
- "secondaryKey": {
- "description": "The secondary key.",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "AuthToken": {
- "description": "Service Token",
- "type": "object",
- "properties": {
- "accessToken": {
- "description": "Access token.",
- "type": "string"
- },
- "tokenType": {
- "description": "Access token type.",
- "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
}
},
"securityDefinitions": {