{
"swagger": "2.0",
"info": {
"title": "Azure Machine Learning Services",
"version": "2026-09-01",
"description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"host": "management.azure.com",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"tags": [
{
"name": "Operations"
},
{
"name": "ComputeResources"
},
{
"name": "Workspaces"
},
{
"name": "CodeContainers"
},
{
"name": "CodeContainerOperationGroup"
},
{
"name": "Registries"
},
{
"name": "CodeVersions"
},
{
"name": "CodeVersionOperationGroup"
},
{
"name": "ComponentContainers"
},
{
"name": "ComponentContainerOperationGroup"
},
{
"name": "ComponentVersions"
},
{
"name": "ComponentVersionOperationGroup"
},
{
"name": "DataContainers"
},
{
"name": "DataContainerOperationGroup"
},
{
"name": "DataVersionBases"
},
{
"name": "DataVersions"
},
{
"name": "EnvironmentContainers"
},
{
"name": "EnvironmentContainerOperationGroup"
},
{
"name": "EnvironmentVersions"
},
{
"name": "EnvironmentVersionOperationGroup"
},
{
"name": "ModelContainers"
},
{
"name": "ModelContainerOperationGroup"
},
{
"name": "ModelVersions"
},
{
"name": "ModelVersionOperationGroup"
},
{
"name": "BatchEndpoints"
},
{
"name": "BatchDeployments"
},
{
"name": "CapabilityHosts"
},
{
"name": "Datastores"
},
{
"name": "FeaturesetContainers"
},
{
"name": "Features"
},
{
"name": "FeaturesetVersions"
},
{
"name": "FeaturestoreEntityContainers"
},
{
"name": "FeaturestoreEntityVersions"
},
{
"name": "JobBases"
},
{
"name": "MarketplaceSubscriptions"
},
{
"name": "OnlineEndpoints"
},
{
"name": "OnlineDeployments"
},
{
"name": "Schedules"
},
{
"name": "ServerlessEndpoints"
},
{
"name": "WorkspaceConnectionPropertiesV2BasicResources"
},
{
"name": "OutboundRuleBasicResources"
},
{
"name": "PrivateEndpointConnections"
}
],
"paths": {
"/providers/Microsoft.MachineLearningServices/operations": {
"get": {
"operationId": "Operations_List",
"tags": [
"Operations"
],
"summary": "Lists all of the available Azure Machine Learning Workspaces REST API operations",
"description": "List the operations for the provider",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"OperationsList": {
"$ref": "./examples/Workspace/operationsList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas": {
"get": {
"operationId": "Quotas_List",
"description": "Gets the currently assigned Workspace Quotas based on VMFamily.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/CustomLocationParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListWorkspaceQuotas"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List workspace quotas by VMFamily": {
"$ref": "./examples/Quota/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas": {
"post": {
"operationId": "Quotas_Update",
"description": "Update quota for each VM family in workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/CustomLocationParameter"
},
{
"name": "parameters",
"in": "body",
"description": "The request body",
"required": true,
"schema": {
"$ref": "#/definitions/QuotaUpdateParameters"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/UpdateWorkspaceQuotasResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"update quotas": {
"$ref": "./examples/Quota/update.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": {
"get": {
"operationId": "Usages_List",
"description": "Gets the current usage information as well as limits for AML resources for given subscription and location.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/CustomLocationParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListUsagesResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Usages": {
"$ref": "./examples/Usage/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": {
"get": {
"operationId": "VirtualMachineSizes_List",
"description": "Returns supported VM Sizes in a location",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/CustomLocationParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/VirtualMachineSizeListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List VM Sizes": {
"$ref": "./examples/VirtualMachineSize/list.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/registries": {
"get": {
"operationId": "Registries_ListBySubscription",
"tags": [
"Registries"
],
"summary": "List registries by subscription",
"description": "List registries by subscription",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RegistryTrackedResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List registries by subscription.": {
"$ref": "./examples/Registries/listBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": {
"get": {
"operationId": "Workspaces_ListBySubscription",
"tags": [
"Workspaces"
],
"summary": "Lists all the available machine learning workspaces under the specified subscription.",
"description": "Lists all the available machine learning workspaces under the specified subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "kind",
"in": "query",
"description": "Kind of workspace.",
"required": false,
"type": "string"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "aiCapabilities",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspaces by subscription": {
"$ref": "./examples/Workspace/listBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries": {
"get": {
"operationId": "Registries_List",
"tags": [
"Registries"
],
"summary": "List registries",
"description": "List registries",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RegistryTrackedResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List registries with system created accounts.": {
"$ref": "./examples/Registries/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}": {
"get": {
"operationId": "Registries_Get",
"tags": [
"Registries"
],
"summary": "Get registry",
"description": "Get registry",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Registry"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry with system created accounts.": {
"$ref": "./examples/Registries/get.json"
}
}
},
"put": {
"operationId": "Registries_CreateOrUpdate",
"tags": [
"Registries"
],
"summary": "Create or update registry",
"description": "Create or update registry",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "Details required to create the registry.",
"required": true,
"schema": {
"$ref": "#/definitions/Registry"
}
}
],
"responses": {
"200": {
"description": "Resource 'Registry' update operation succeeded",
"schema": {
"$ref": "#/definitions/Registry"
}
},
"201": {
"description": "Resource 'Registry' create operation succeeded",
"schema": {
"$ref": "#/definitions/Registry"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry with system created accounts.": {
"$ref": "./examples/Registries/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation",
"final-state-schema": "#/definitions/Registry"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "Registries_Update",
"tags": [
"Registries"
],
"summary": "Update tags",
"description": "Update tags",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "Details required to create the registry.",
"required": true,
"schema": {
"$ref": "#/definitions/PartialRegistryPartialTrackedResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Registry"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Registry with system created accounts.": {
"$ref": "./examples/Registries/update.json"
}
}
},
"delete": {
"operationId": "Registries_Delete",
"tags": [
"Registries"
],
"summary": "Delete registry",
"description": "Delete registry",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry.": {
"$ref": "./examples/Registries/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes": {
"get": {
"operationId": "RegistryCodeContainers_List",
"tags": [
"CodeContainers"
],
"summary": "List containers.",
"description": "List containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Code Container.": {
"$ref": "./examples/Registry/CodeContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}": {
"get": {
"operationId": "RegistryCodeContainers_Get",
"tags": [
"CodeContainers"
],
"summary": "Get Code container.",
"description": "Get Code container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Code Container.": {
"$ref": "./examples/Registry/CodeContainer/get.json"
}
}
},
"put": {
"operationId": "RegistryCodeContainers_CreateOrUpdate",
"tags": [
"CodeContainers"
],
"summary": "Create or update Code container.",
"description": "Create or update Code container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/CodeContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'CodeContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/CodeContainer"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/CodeContainer"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Code Container.": {
"$ref": "./examples/Registry/CodeContainer/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/CodeContainer"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryCodeContainers_Delete",
"tags": [
"CodeContainers"
],
"summary": "Delete Code container.",
"description": "Delete Code container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Code Container.": {
"$ref": "./examples/Registry/CodeContainer/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions": {
"get": {
"operationId": "RegistryCodeVersions_List",
"tags": [
"CodeVersions"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Code Version.": {
"$ref": "./examples/Registry/CodeVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}": {
"get": {
"operationId": "RegistryCodeVersions_Get",
"tags": [
"CodeVersions"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Code Version.": {
"$ref": "./examples/Registry/CodeVersion/get.json"
}
}
},
"put": {
"operationId": "RegistryCodeVersions_CreateOrUpdate",
"tags": [
"CodeVersions"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/CodeVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'CodeVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/CodeVersion"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/CodeVersion"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Code Version.": {
"$ref": "./examples/Registry/CodeVersion/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/CodeVersion"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryCodeVersions_Delete",
"tags": [
"CodeVersions"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Code Version.": {
"$ref": "./examples/Registry/CodeVersion/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}/startPendingUpload": {
"post": {
"operationId": "RegistryCodeVersions_CreateOrGetStartPendingUpload",
"tags": [
"CodeVersions"
],
"summary": "Generate a storage location and credential for the client to upload a code asset to.",
"description": "Generate a storage location and credential for the client to upload a code asset to.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "codeName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Pending upload request object",
"required": true,
"schema": {
"$ref": "#/definitions/PendingUploadRequestDto"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PendingUploadResponseDto"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrGetStartPendingUpload Registry Code Version.": {
"$ref": "./examples/Registry/CodeVersion/createOrGetStartPendingUpload.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components": {
"get": {
"operationId": "RegistryComponentContainers_List",
"tags": [
"ComponentContainers"
],
"summary": "List containers.",
"description": "List containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Component Container.": {
"$ref": "./examples/Registry/ComponentContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}": {
"get": {
"operationId": "RegistryComponentContainers_Get",
"tags": [
"ComponentContainers"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "componentName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Component Container.": {
"$ref": "./examples/Registry/ComponentContainer/get.json"
}
}
},
"put": {
"operationId": "RegistryComponentContainers_CreateOrUpdate",
"tags": [
"ComponentContainers"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "componentName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ComponentContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'ComponentContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/ComponentContainer"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/ComponentContainer"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Component Container.": {
"$ref": "./examples/Registry/ComponentContainer/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/ComponentContainer"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryComponentContainers_Delete",
"tags": [
"ComponentContainers"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "componentName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Component Container.": {
"$ref": "./examples/Registry/ComponentContainer/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions": {
"get": {
"operationId": "RegistryComponentVersions_List",
"tags": [
"ComponentVersions"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "componentName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Component Version.": {
"$ref": "./examples/Registry/ComponentVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}": {
"get": {
"operationId": "RegistryComponentVersions_Get",
"tags": [
"ComponentVersions"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "componentName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Component Version.": {
"$ref": "./examples/Registry/ComponentVersion/get.json"
}
}
},
"put": {
"operationId": "RegistryComponentVersions_CreateOrUpdate",
"tags": [
"ComponentVersions"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "componentName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ComponentVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'ComponentVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/ComponentVersion"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/ComponentVersion"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Component Version.": {
"$ref": "./examples/Registry/ComponentVersion/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/ComponentVersion"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryComponentVersions_Delete",
"tags": [
"ComponentVersions"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "componentName",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Component Version.": {
"$ref": "./examples/Registry/ComponentVersion/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data": {
"get": {
"operationId": "RegistryDataContainers_List",
"tags": [
"DataContainers"
],
"summary": "List Data containers.",
"description": "List Data containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"RegistryList Registry Data Container.": {
"$ref": "./examples/Registry/DataContainer/registryList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}": {
"get": {
"operationId": "RegistryDataContainers_Get",
"tags": [
"DataContainers"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Data Container.": {
"$ref": "./examples/Registry/DataContainer/get.json"
}
}
},
"put": {
"operationId": "RegistryDataContainers_CreateOrUpdate",
"tags": [
"DataContainers"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/DataContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'DataContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/DataContainer"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/DataContainer"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Data Container.": {
"$ref": "./examples/Registry/DataContainer/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/DataContainer"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryDataContainers_Delete",
"tags": [
"DataContainers"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Data Container.": {
"$ref": "./examples/Registry/DataContainer/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions": {
"get": {
"operationId": "RegistryDataVersions_List",
"tags": [
"DataVersionBases"
],
"summary": "List data versions in the data container",
"description": "List data versions in the data container",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Top count of results, top count cannot be greater than the page size.\nIf topCount > page size, results with be default page size count will be returned",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "$tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"RegistryList Registry Data Version Base.": {
"$ref": "./examples/Registry/DataVersionBase/registryList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}": {
"get": {
"operationId": "RegistryDataVersions_Get",
"tags": [
"DataVersionBases"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataVersionBase"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Data Version Base.": {
"$ref": "./examples/Registry/DataVersionBase/get.json"
}
}
},
"put": {
"operationId": "RegistryDataVersions_CreateOrUpdate",
"tags": [
"DataVersionBases"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/DataVersionBase"
}
}
],
"responses": {
"200": {
"description": "Resource 'DataVersionBase' update operation succeeded",
"schema": {
"$ref": "#/definitions/DataVersionBase"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/DataVersionBase"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Data Version Base.": {
"$ref": "./examples/Registry/DataVersionBase/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/DataVersionBase"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryDataVersions_Delete",
"tags": [
"DataVersionBases"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Data Version Base.": {
"$ref": "./examples/Registry/DataVersionBase/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}/startPendingUpload": {
"post": {
"operationId": "RegistryDataVersions_CreateOrGetStartPendingUpload",
"tags": [
"DataVersionBases"
],
"summary": "Generate a storage location and credential for the client to upload a data asset to.",
"description": "Generate a storage location and credential for the client to upload a data asset to.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Pending upload request object",
"required": true,
"schema": {
"$ref": "#/definitions/PendingUploadRequestDto"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PendingUploadResponseDto"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrGetStartPendingUpload Registry Data Version Base.": {
"$ref": "./examples/Registry/DataVersionBase/createOrGetStartPendingUpload.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/datareferences/{name}/versions/{version}": {
"post": {
"operationId": "RegistryDataReferences_GetBlobReferenceSAS",
"tags": [
"Registries"
],
"summary": "Get blob reference SAS Uri.",
"description": "Get blob reference SAS Uri.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Data reference name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Asset id and blob uri.",
"required": true,
"schema": {
"$ref": "#/definitions/GetBlobReferenceSASRequestDto"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/GetBlobReferenceSASResponseDto"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"GetBlobReferenceSAS Data Reference.": {
"$ref": "./examples/DataReference/getBlobReferenceSAS.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments": {
"get": {
"operationId": "RegistryEnvironmentContainers_List",
"tags": [
"EnvironmentContainers"
],
"summary": "List environment containers.",
"description": "List environment containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Environment Container.": {
"$ref": "./examples/Registry/EnvironmentContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}": {
"get": {
"operationId": "RegistryEnvironmentContainers_Get",
"tags": [
"EnvironmentContainers"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "environmentName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Environment Container.": {
"$ref": "./examples/Registry/EnvironmentContainer/get.json"
}
}
},
"put": {
"operationId": "RegistryEnvironmentContainers_CreateOrUpdate",
"tags": [
"EnvironmentContainers"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "environmentName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'EnvironmentContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Environment Container.": {
"$ref": "./examples/Registry/EnvironmentContainer/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/EnvironmentContainer"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryEnvironmentContainers_Delete",
"tags": [
"EnvironmentContainers"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "environmentName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Environment Container.": {
"$ref": "./examples/Registry/EnvironmentContainer/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions": {
"get": {
"operationId": "RegistryEnvironmentVersions_List",
"tags": [
"EnvironmentVersions"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "environmentName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Environment Version.": {
"$ref": "./examples/Registry/EnvironmentVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}": {
"get": {
"operationId": "RegistryEnvironmentVersions_Get",
"tags": [
"EnvironmentVersions"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "environmentName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Environment Version.": {
"$ref": "./examples/Registry/EnvironmentVersion/get.json"
}
}
},
"put": {
"operationId": "RegistryEnvironmentVersions_CreateOrUpdate",
"tags": [
"EnvironmentVersions"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "environmentName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'EnvironmentVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Environment Version.": {
"$ref": "./examples/Registry/EnvironmentVersion/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/EnvironmentVersion"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryEnvironmentVersions_Delete",
"tags": [
"EnvironmentVersions"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "environmentName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Environment Version.": {
"$ref": "./examples/Registry/EnvironmentVersion/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models": {
"get": {
"operationId": "RegistryModelContainers_List",
"tags": [
"ModelContainers"
],
"summary": "List model containers.",
"description": "List model containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Model Container.": {
"$ref": "./examples/Registry/ModelContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}": {
"get": {
"operationId": "RegistryModelContainers_Get",
"tags": [
"ModelContainers"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Model Container.": {
"$ref": "./examples/Registry/ModelContainer/get.json"
}
}
},
"put": {
"operationId": "RegistryModelContainers_CreateOrUpdate",
"tags": [
"ModelContainers"
],
"summary": "Create or update model container.",
"description": "Create or update model container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ModelContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'ModelContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/ModelContainer"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/ModelContainer"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Model Container.": {
"$ref": "./examples/Registry/ModelContainer/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/ModelContainer"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryModelContainers_Delete",
"tags": [
"ModelContainers"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Model Container.": {
"$ref": "./examples/Registry/ModelContainer/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions": {
"get": {
"operationId": "RegistryModelVersions_List",
"tags": [
"ModelVersions"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "version",
"in": "query",
"description": "Version identifier.",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "Model description.",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "properties",
"in": "query",
"description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Registry Model Version.": {
"$ref": "./examples/Registry/ModelVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}": {
"get": {
"operationId": "RegistryModelVersions_Get",
"tags": [
"ModelVersions"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Registry Model Version.": {
"$ref": "./examples/Registry/ModelVersion/get.json"
}
}
},
"put": {
"operationId": "RegistryModelVersions_CreateOrUpdate",
"tags": [
"ModelVersions"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ModelVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'ModelVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/ModelVersion"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/ModelVersion"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Registry Model Version.": {
"$ref": "./examples/Registry/ModelVersion/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/ModelVersion"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "RegistryModelVersions_Delete",
"tags": [
"ModelVersions"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Registry Model Version.": {
"$ref": "./examples/Registry/ModelVersion/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload": {
"post": {
"operationId": "RegistryModelVersions_CreateOrGetStartPendingUpload",
"tags": [
"ModelVersions"
],
"summary": "Generate a storage location and credential for the client to upload a model asset to.",
"description": "Generate a storage location and credential for the client to upload a model asset to.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "modelName",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Pending upload request object",
"required": true,
"schema": {
"$ref": "#/definitions/PendingUploadRequestDto"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PendingUploadResponseDto"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrGetStartPendingUpload Registry Model Version.": {
"$ref": "./examples/Registry/ModelVersion/createOrGetStartPendingUpload.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/removeRegions": {
"post": {
"operationId": "Registries_RemoveRegions",
"tags": [
"Registries"
],
"summary": "Remove regions from registry",
"description": "Remove regions from registry",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "registryName",
"in": "path",
"description": "Name of Azure Machine Learning registry. This is case-insensitive",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "Details required to create the registry.",
"required": true,
"schema": {
"$ref": "#/definitions/Registry"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Registry"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Remove regions from registry": {
"$ref": "./examples/Registries/removeRegions.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Registry"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": {
"get": {
"operationId": "Workspaces_ListByResourceGroup",
"tags": [
"Workspaces"
],
"summary": "Lists all the available machine learning workspaces under the specified resource group.",
"description": "Lists all the available machine learning workspaces under the specified resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "kind",
"in": "query",
"description": "Kind of workspace.",
"required": false,
"type": "string"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "aiCapabilities",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspaces by Resource Group": {
"$ref": "./examples/Workspace/listByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": {
"get": {
"operationId": "Workspaces_Get",
"tags": [
"Workspaces"
],
"summary": "Gets the properties of the specified machine learning workspace.",
"description": "Gets the properties of the specified machine learning workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Workspace"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace": {
"$ref": "./examples/Workspace/get.json"
}
}
},
"put": {
"operationId": "Workspaces_CreateOrUpdate",
"tags": [
"Workspaces"
],
"summary": "Creates or updates a workspace with the specified parameters.",
"description": "Creates or updates a workspace with the specified parameters.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "The parameters for creating or updating a machine learning workspace.",
"required": true,
"schema": {
"$ref": "#/definitions/Workspace"
}
}
],
"responses": {
"200": {
"description": "Resource 'Workspace' update operation succeeded",
"schema": {
"$ref": "#/definitions/Workspace"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create Workspace": {
"$ref": "./examples/Workspace/create.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Workspace"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "Workspaces_Update",
"tags": [
"Workspaces"
],
"summary": "Updates a machine learning workspace with the specified parameters.",
"description": "Updates a machine learning workspace with the specified parameters.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "The parameters for updating a machine learning workspace.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkspaceUpdateParameters"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Workspace"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Workspace": {
"$ref": "./examples/Workspace/update.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Workspace"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "Workspaces_Delete",
"tags": [
"Workspaces"
],
"summary": "Deletes a machine learning workspace.",
"description": "Deletes a machine learning workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "forceToPurge",
"in": "query",
"description": "Flag to indicate delete is a purge request.",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace": {
"$ref": "./examples/Workspace/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints": {
"get": {
"operationId": "BatchEndpoints_List",
"tags": [
"BatchEndpoints"
],
"summary": "Lists Batch inference endpoint in the workspace.",
"description": "Lists Batch inference endpoint in the workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "count",
"in": "query",
"description": "Number of endpoints to be retrieved in a page of results.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BatchEndpointTrackedResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Batch Endpoint.": {
"$ref": "./examples/Workspace/BatchEndpoint/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}": {
"get": {
"operationId": "BatchEndpoints_Get",
"tags": [
"BatchEndpoints"
],
"summary": "Get batch inference endpoint by name.",
"description": "Gets a batch inference endpoint by name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BatchEndpoint"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Batch Endpoint.": {
"$ref": "./examples/Workspace/BatchEndpoint/get.json"
}
}
},
"put": {
"operationId": "BatchEndpoints_CreateOrUpdate",
"tags": [
"BatchEndpoints"
],
"summary": "Create a batch inference endpoint (asynchronous).",
"description": "Creates a batch inference endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Batch inference endpoint definition object.",
"required": true,
"schema": {
"$ref": "#/definitions/BatchEndpoint"
}
}
],
"responses": {
"200": {
"description": "Resource 'BatchEndpoint' update operation succeeded",
"schema": {
"$ref": "#/definitions/BatchEndpoint"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/BatchEndpoint"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Batch Endpoint.": {
"$ref": "./examples/Workspace/BatchEndpoint/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/BatchEndpoint"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "BatchEndpoints_Update",
"tags": [
"BatchEndpoints"
],
"summary": "Update a batch inference endpoint (asynchronous).",
"description": "Update a batch inference endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Mutable batch inference endpoint definition object.",
"required": true,
"schema": {
"$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchEndpoint"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Workspace Batch Endpoint.": {
"$ref": "./examples/Workspace/BatchEndpoint/update.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/BatchEndpoint"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "BatchEndpoints_Delete",
"tags": [
"BatchEndpoints"
],
"summary": "Delete Batch Inference Endpoint (asynchronous).",
"description": "Delete Batch Inference Endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Batch Endpoint.": {
"$ref": "./examples/Workspace/BatchEndpoint/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments": {
"get": {
"operationId": "BatchDeployments_List",
"tags": [
"BatchDeployments"
],
"summary": "Lists Batch inference deployments in the workspace.",
"description": "Lists Batch inference deployments in the workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Top of list.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BatchDeploymentTrackedResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Batch Deployment.": {
"$ref": "./examples/Workspace/BatchDeployment/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments/{deploymentName}": {
"get": {
"operationId": "BatchDeployments_Get",
"tags": [
"BatchDeployments"
],
"summary": "Get batch inference deployment by id.",
"description": "Gets a batch inference deployment by id.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "The identifier for the Batch deployments.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BatchDeployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Batch Deployment.": {
"$ref": "./examples/Workspace/BatchDeployment/get.json"
}
}
},
"put": {
"operationId": "BatchDeployments_CreateOrUpdate",
"tags": [
"BatchDeployments"
],
"summary": "Creates/updates a batch inference deployment (asynchronous).",
"description": "Creates/updates a batch inference deployment (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "The identifier for the Batch deployments.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Batch inference deployment definition object.",
"required": true,
"schema": {
"$ref": "#/definitions/BatchDeployment"
}
}
],
"responses": {
"200": {
"description": "Resource 'BatchDeployment' update operation succeeded",
"schema": {
"$ref": "#/definitions/BatchDeployment"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/BatchDeployment"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Batch Deployment.": {
"$ref": "./examples/Workspace/BatchDeployment/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/BatchDeployment"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "BatchDeployments_Update",
"tags": [
"BatchDeployments"
],
"summary": "Update a batch inference deployment (asynchronous).",
"description": "Update a batch inference deployment (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "The identifier for the Batch deployments.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Batch inference deployment definition object.",
"required": true,
"schema": {
"$ref": "#/definitions/PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BatchDeployment"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Workspace Batch Deployment.": {
"$ref": "./examples/Workspace/BatchDeployment/update.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/BatchDeployment"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "BatchDeployments_Delete",
"tags": [
"BatchDeployments"
],
"summary": "Delete Batch Inference deployment (asynchronous).",
"description": "Delete Batch Inference deployment (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "The identifier for the Batch deployments.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Batch Deployment.": {
"$ref": "./examples/Workspace/BatchDeployment/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys": {
"post": {
"operationId": "BatchEndpoints_ListKeys",
"tags": [
"BatchEndpoints"
],
"summary": "Lists batch Inference Endpoint keys.",
"description": "Lists batch Inference Endpoint keys.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Name for the Batch Endpoint.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EndpointAuthKeys"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ListKeys Workspace Batch Endpoint.": {
"$ref": "./examples/Workspace/BatchEndpoint/listKeys.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/capabilityHosts": {
"get": {
"operationId": "CapabilityHosts_List",
"tags": [
"CapabilityHosts"
],
"summary": "List capability hosts in the workspace.",
"description": "Lists the capability hosts associated with the specified workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CapabilityHostListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List capability hosts in the workspace.": {
"$ref": "./examples/CapabilityHost/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/capabilityHosts/{name}": {
"get": {
"operationId": "CapabilityHosts_Get",
"tags": [
"CapabilityHosts"
],
"summary": "Get capabilityHost.",
"description": "Get capabilityHost.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "CapabilityHost name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CapabilityHost"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get CapabilityHost.": {
"$ref": "./examples/CapabilityHost/get.json"
}
}
},
"put": {
"operationId": "CapabilityHosts_CreateOrUpdate",
"tags": [
"CapabilityHosts"
],
"summary": "Create or update capabilityHost.",
"description": "Create or update capabilityHost.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "CapabilityHost name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "CapabilityHost definition.",
"required": true,
"schema": {
"$ref": "#/definitions/CapabilityHost"
}
}
],
"responses": {
"200": {
"description": "Resource 'CapabilityHost' update operation succeeded",
"schema": {
"$ref": "#/definitions/CapabilityHost"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/CapabilityHost"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate CapabilityHost.": {
"$ref": "./examples/CapabilityHost/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/CapabilityHost"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "CapabilityHosts_Delete",
"tags": [
"CapabilityHosts"
],
"summary": "Delete capabilityHost.",
"description": "Delete capabilityHost.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "CapabilityHost name.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete CapabilityHost.": {
"$ref": "./examples/CapabilityHost/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes": {
"get": {
"operationId": "CodeContainers_List",
"tags": [
"CodeContainerOperationGroup"
],
"summary": "List containers.",
"description": "List containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Code Container.": {
"$ref": "./examples/Workspace/CodeContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}": {
"get": {
"operationId": "CodeContainers_Get",
"tags": [
"CodeContainerOperationGroup"
],
"summary": "Get containers.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Code Container.": {
"$ref": "./examples/Workspace/CodeContainer/get.json"
}
}
},
"put": {
"operationId": "CodeContainers_CreateOrUpdate",
"tags": [
"CodeContainerOperationGroup"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/CodeContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'CodeContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/CodeContainer"
}
},
"201": {
"description": "Resource 'CodeContainer' create operation succeeded",
"schema": {
"$ref": "#/definitions/CodeContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Code Container.": {
"$ref": "./examples/Workspace/CodeContainer/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "CodeContainers_Delete",
"tags": [
"CodeContainerOperationGroup"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Code Container.": {
"$ref": "./examples/Workspace/CodeContainer/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions": {
"get": {
"operationId": "CodeVersions_List",
"tags": [
"CodeVersionOperationGroup"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "hash",
"in": "query",
"description": "If specified, return CodeVersion assets with specified content hash value, regardless of name",
"required": false,
"type": "string"
},
{
"name": "hashVersion",
"in": "query",
"description": "Hash algorithm version when listing by hash",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Code Version.": {
"$ref": "./examples/Workspace/CodeVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}": {
"get": {
"operationId": "CodeVersions_Get",
"tags": [
"CodeVersionOperationGroup"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CodeVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Code Version.": {
"$ref": "./examples/Workspace/CodeVersion/get.json"
}
}
},
"put": {
"operationId": "CodeVersions_CreateOrUpdate",
"tags": [
"CodeVersionOperationGroup"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/CodeVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'CodeVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/CodeVersion"
}
},
"201": {
"description": "Resource 'CodeVersion' create operation succeeded",
"schema": {
"$ref": "#/definitions/CodeVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Code Version.": {
"$ref": "./examples/Workspace/CodeVersion/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "CodeVersions_Delete",
"tags": [
"CodeVersionOperationGroup"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Code Version.": {
"$ref": "./examples/Workspace/CodeVersion/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish": {
"post": {
"operationId": "CodeVersions_Publish",
"tags": [
"CodeVersionOperationGroup"
],
"summary": "Publish version asset into registry.",
"description": "Publish version asset into registry.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Destination registry info",
"required": true,
"schema": {
"$ref": "#/definitions/DestinationAsset"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Publish Workspace Code Version.": {
"$ref": "./examples/Workspace/CodeVersion/publish.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload": {
"post": {
"operationId": "CodeVersions_CreateOrGetStartPendingUpload",
"tags": [
"CodeVersionOperationGroup"
],
"summary": "Generate a storage location and credential for the client to upload a code asset to.",
"description": "Generate a storage location and credential for the client to upload a code asset to.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Pending upload request object",
"required": true,
"schema": {
"$ref": "#/definitions/PendingUploadRequestDto"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PendingUploadResponseDto"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrGetStartPendingUpload Workspace Code Version.": {
"$ref": "./examples/Workspace/CodeVersion/createOrGetStartPendingUpload.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components": {
"get": {
"operationId": "ComponentContainers_List",
"tags": [
"ComponentContainerOperationGroup"
],
"summary": "List component containers.",
"description": "List component containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Component Container.": {
"$ref": "./examples/Workspace/ComponentContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}": {
"get": {
"operationId": "ComponentContainers_Get",
"tags": [
"ComponentContainerOperationGroup"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Component Container.": {
"$ref": "./examples/Workspace/ComponentContainer/get.json"
}
}
},
"put": {
"operationId": "ComponentContainers_CreateOrUpdate",
"tags": [
"ComponentContainerOperationGroup"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ComponentContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'ComponentContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/ComponentContainer"
}
},
"201": {
"description": "Resource 'ComponentContainer' create operation succeeded",
"schema": {
"$ref": "#/definitions/ComponentContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Component Container.": {
"$ref": "./examples/Workspace/ComponentContainer/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "ComponentContainers_Delete",
"tags": [
"ComponentContainerOperationGroup"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Component Container.": {
"$ref": "./examples/Workspace/ComponentContainer/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions": {
"get": {
"operationId": "ComponentVersions_List",
"tags": [
"ComponentVersionOperationGroup"
],
"summary": "List component versions.",
"description": "List component versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Component Version.": {
"$ref": "./examples/Workspace/ComponentVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}": {
"get": {
"operationId": "ComponentVersions_Get",
"tags": [
"ComponentVersionOperationGroup"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComponentVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Component Version.": {
"$ref": "./examples/Workspace/ComponentVersion/get.json"
}
}
},
"put": {
"operationId": "ComponentVersions_CreateOrUpdate",
"tags": [
"ComponentVersionOperationGroup"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ComponentVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'ComponentVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/ComponentVersion"
}
},
"201": {
"description": "Resource 'ComponentVersion' create operation succeeded",
"schema": {
"$ref": "#/definitions/ComponentVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Component Version.": {
"$ref": "./examples/Workspace/ComponentVersion/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "ComponentVersions_Delete",
"tags": [
"ComponentVersionOperationGroup"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Component Version.": {
"$ref": "./examples/Workspace/ComponentVersion/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish": {
"post": {
"operationId": "ComponentVersions_Publish",
"tags": [
"ComponentVersionOperationGroup"
],
"summary": "Publish version asset into registry.",
"description": "Publish version asset into registry.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Destination registry info",
"required": true,
"schema": {
"$ref": "#/definitions/DestinationAsset"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Publish Workspace Component Version.": {
"$ref": "./examples/Workspace/ComponentVersion/publish.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": {
"get": {
"operationId": "Compute_List",
"tags": [
"ComputeResources"
],
"description": "Gets computes in specified workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PaginatedComputeResourcesList"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Computes": {
"$ref": "./examples/Compute/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": {
"get": {
"operationId": "Compute_Get",
"tags": [
"ComputeResources"
],
"description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComputeResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a AKS Compute": {
"$ref": "./examples/Compute/get/AKSCompute.json"
},
"Get a AML Compute": {
"$ref": "./examples/Compute/get/AmlCompute.json"
},
"Get a Kubernetes Compute": {
"$ref": "./examples/Compute/get/KubernetesCompute.json"
},
"Get an ComputeInstance": {
"$ref": "./examples/Compute/get/ComputeInstance.json"
}
}
},
"put": {
"operationId": "Compute_CreateOrUpdate",
"tags": [
"ComputeResources"
],
"description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
},
{
"name": "parameters",
"in": "body",
"description": "Payload with Machine Learning compute definition.",
"required": true,
"schema": {
"$ref": "#/definitions/ComputeResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'ComputeResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/ComputeResource"
}
},
"201": {
"description": "Resource 'ComputeResource' create operation succeeded",
"schema": {
"$ref": "#/definitions/ComputeResource"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Attach a Kubernetes Compute": {
"$ref": "./examples/Compute/createOrUpdate/KubernetesCompute.json"
},
"Create a AML Compute": {
"$ref": "./examples/Compute/createOrUpdate/BasicAmlCompute.json"
},
"Create a DataFactory Compute": {
"$ref": "./examples/Compute/createOrUpdate/BasicDataFactoryCompute.json"
},
"Create an AKS Compute": {
"$ref": "./examples/Compute/createOrUpdate/BasicAKSCompute.json"
},
"Create an ComputeInstance Compute": {
"$ref": "./examples/Compute/createOrUpdate/ComputeInstance.json"
},
"Create an ComputeInstance Compute with Schedules": {
"$ref": "./examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json"
},
"Create an ComputeInstance Compute with minimal inputs": {
"$ref": "./examples/Compute/createOrUpdate/ComputeInstanceMinimal.json"
},
"Update a AML Compute": {
"$ref": "./examples/Compute/createOrUpdate/AmlCompute.json"
},
"Update an AKS Compute": {
"$ref": "./examples/Compute/createOrUpdate/AKSCompute.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ComputeResource"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "Compute_Update",
"tags": [
"ComputeResources"
],
"description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
},
{
"name": "parameters",
"in": "body",
"description": "Additional parameters for cluster update.",
"required": true,
"schema": {
"$ref": "#/definitions/ClusterUpdateParameters"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ComputeResource"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"format": "uri",
"description": "A link to the status monitor"
},
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update a AmlCompute Compute": {
"$ref": "./examples/Compute/patch.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ComputeResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "Compute_Delete",
"tags": [
"ComputeResources"
],
"description": "Deletes specified Machine Learning compute.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
},
{
"name": "underlyingResourceAction",
"in": "query",
"description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.",
"required": true,
"type": "string",
"enum": [
"Delete",
"Detach"
],
"x-ms-enum": {
"name": "UnderlyingResourceAction",
"modelAsString": true,
"values": [
{
"name": "Delete",
"value": "Delete"
},
{
"name": "Detach",
"value": "Detach"
}
]
}
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"format": "uri",
"description": "A link to the status monitor"
},
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Compute": {
"$ref": "./examples/Compute/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": {
"post": {
"operationId": "Compute_ListKeys",
"tags": [
"ComputeResources"
],
"description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ComputeSecrets"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List AKS Compute Keys": {
"$ref": "./examples/Compute/listKeys.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": {
"post": {
"operationId": "Compute_ListNodes",
"tags": [
"ComputeResources"
],
"description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AmlComputeNodesInformation"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get compute nodes information for a compute": {
"$ref": "./examples/Compute/listNodes.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink",
"itemName": "nodes"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": {
"post": {
"operationId": "Compute_Restart",
"tags": [
"ComputeResources"
],
"description": "Posts a restart action to a compute instance",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
}
],
"responses": {
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Restart ComputeInstance Compute": {
"$ref": "./examples/Compute/restart.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": {
"post": {
"operationId": "Compute_Start",
"tags": [
"ComputeResources"
],
"description": "Posts a start action to a compute instance",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
}
],
"responses": {
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Start ComputeInstance Compute": {
"$ref": "./examples/Compute/start.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": {
"post": {
"operationId": "Compute_Stop",
"tags": [
"ComputeResources"
],
"description": "Posts a stop action to a compute instance",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "computeName",
"in": "path",
"description": "Name of the Azure Machine Learning compute.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z](?![a-zA-Z0-9-]*-\\d+$)[a-zA-Z0-9\\-]{2,23}$"
}
],
"responses": {
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Stop ComputeInstance Compute": {
"$ref": "./examples/Compute/stop.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": {
"get": {
"operationId": "WorkspaceConnections_List",
"tags": [
"WorkspaceConnectionPropertiesV2BasicResources"
],
"summary": "List all the available machine learning workspaces connections under the specified workspace.",
"description": "Lists all the available machine learning workspaces connections under the specified workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "target",
"in": "query",
"description": "Target of the workspace connection.",
"required": false,
"type": "string"
},
{
"name": "category",
"in": "query",
"description": "Category of the workspace connection.",
"required": false,
"type": "string"
},
{
"name": "includeAll",
"in": "query",
"description": "query parameter that indicates if get connection call should return both connections and datastores",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ListWorkspaceConnections": {
"$ref": "./examples/WorkspaceConnection/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": {
"get": {
"operationId": "WorkspaceConnections_Get",
"tags": [
"WorkspaceConnectionPropertiesV2BasicResources"
],
"summary": "Lists machine learning workspaces connections by name.",
"description": "Lists machine learning workspaces connections by name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "connectionName",
"in": "path",
"description": "Friendly name of the workspace connection",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"GetWorkspaceConnection": {
"$ref": "./examples/WorkspaceConnection/get.json"
}
}
},
"put": {
"operationId": "WorkspaceConnections_Create",
"tags": [
"WorkspaceConnectionPropertiesV2BasicResources"
],
"summary": "Create or update machine learning workspaces connections under the specified workspace.",
"description": "Create or update machine learning workspaces connections under the specified workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "connectionName",
"in": "path",
"description": "Friendly name of the workspace connection",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "The object for creating or updating a new workspace connection",
"required": false,
"schema": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateWorkspaceConnection": {
"$ref": "./examples/WorkspaceConnection/create.json"
}
}
},
"patch": {
"operationId": "WorkspaceConnections_Update",
"tags": [
"WorkspaceConnectionPropertiesV2BasicResources"
],
"summary": "Update machine learning workspaces connections under the specified workspace.",
"description": "Update machine learning workspaces connections under the specified workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "connectionName",
"in": "path",
"description": "Friendly name of the workspace connection",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "Parameters for workspace connection update.",
"required": false,
"schema": {
"$ref": "#/definitions/WorkspaceConnectionUpdateParameter"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"UpdateWorkspaceConnection": {
"$ref": "./examples/WorkspaceConnection/update.json"
}
}
},
"delete": {
"operationId": "WorkspaceConnections_Delete",
"tags": [
"WorkspaceConnectionPropertiesV2BasicResources"
],
"summary": "Delete machine learning workspaces connections by name.",
"description": "Delete machine learning workspaces connections by name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "connectionName",
"in": "path",
"description": "Friendly name of the workspace connection",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"DeleteWorkspaceConnection": {
"$ref": "./examples/WorkspaceConnection/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/listsecrets": {
"post": {
"operationId": "WorkspaceConnections_ListSecrets",
"tags": [
"WorkspaceConnectionPropertiesV2BasicResources"
],
"summary": "List all the secrets of a machine learning workspaces connections.",
"description": "List all the secrets of a machine learning workspaces connections.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "connectionName",
"in": "path",
"description": "Friendly name of the workspace connection",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"GetWorkspaceConnection": {
"$ref": "./examples/WorkspaceConnection/listSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data": {
"get": {
"operationId": "DataContainers_List",
"tags": [
"DataContainerOperationGroup"
],
"summary": "List data containers.",
"description": "List data containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Data Container.": {
"$ref": "./examples/Workspace/DataContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}": {
"get": {
"operationId": "DataContainers_Get",
"tags": [
"DataContainerOperationGroup"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Data Container.": {
"$ref": "./examples/Workspace/DataContainer/get.json"
}
}
},
"put": {
"operationId": "DataContainers_CreateOrUpdate",
"tags": [
"DataContainerOperationGroup"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/DataContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'DataContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/DataContainer"
}
},
"201": {
"description": "Resource 'DataContainer' create operation succeeded",
"schema": {
"$ref": "#/definitions/DataContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Data Container.": {
"$ref": "./examples/Workspace/DataContainer/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "DataContainers_Delete",
"tags": [
"DataContainerOperationGroup"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Data Container.": {
"$ref": "./examples/Workspace/DataContainer/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions": {
"get": {
"operationId": "DataVersions_List",
"tags": [
"DataVersions"
],
"summary": "List data versions in the data container",
"description": "List data versions in the data container",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Please choose OrderBy value from ['createdtime', 'modifiedtime']",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Top count of results, top count cannot be greater than the page size.\nIf topCount > page size, results with be default page size count will be returned",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "$tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataVersionBaseResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Data Version Base.": {
"$ref": "./examples/Workspace/DataVersionBase/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}": {
"get": {
"operationId": "DataVersions_Get",
"tags": [
"DataVersions"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DataVersionBase"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Data Version Base.": {
"$ref": "./examples/Workspace/DataVersionBase/get.json"
}
}
},
"put": {
"operationId": "DataVersions_CreateOrUpdate",
"tags": [
"DataVersions"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/DataVersionBase"
}
}
],
"responses": {
"200": {
"description": "Resource 'DataVersionBase' update operation succeeded",
"schema": {
"$ref": "#/definitions/DataVersionBase"
}
},
"201": {
"description": "Resource 'DataVersionBase' create operation succeeded",
"schema": {
"$ref": "#/definitions/DataVersionBase"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Data Version Base.": {
"$ref": "./examples/Workspace/DataVersionBase/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "DataVersions_Delete",
"tags": [
"DataVersions"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Data Version Base.": {
"$ref": "./examples/Workspace/DataVersionBase/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish": {
"post": {
"operationId": "DataVersions_Publish",
"tags": [
"DataVersions"
],
"summary": "Publish version asset into registry.",
"description": "Publish version asset into registry.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Destination registry info",
"required": true,
"schema": {
"$ref": "#/definitions/DestinationAsset"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Publish Workspace Data Version Base.": {
"$ref": "./examples/Workspace/DataVersionBase/publish.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": {
"get": {
"operationId": "Datastores_List",
"tags": [
"Datastores"
],
"summary": "List datastores.",
"description": "List datastores.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "count",
"in": "query",
"description": "Maximum number of results to return.",
"required": false,
"type": "integer",
"format": "int32",
"default": 30
},
{
"name": "isDefault",
"in": "query",
"description": "Filter down to the workspace default datastore.",
"required": false,
"type": "boolean"
},
{
"name": "names",
"in": "query",
"description": "Names of datastores to return.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "searchText",
"in": "query",
"description": "Text to search for in the datastore names.",
"required": false,
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"description": "Order by property (createdtime | modifiedtime | name).",
"required": false,
"type": "string"
},
{
"name": "orderByAsc",
"in": "query",
"description": "Order by property in ascending order.",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatastoreResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"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}": {
"get": {
"operationId": "Datastores_Get",
"tags": [
"Datastores"
],
"summary": "Get datastore.",
"description": "Get datastore.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Datastore name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Datastore"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get datastore.": {
"$ref": "./examples/Datastore/get.json"
}
}
},
"put": {
"operationId": "Datastores_CreateOrUpdate",
"tags": [
"Datastores"
],
"summary": "Create or update datastore.",
"description": "Create or update datastore.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Datastore name.",
"required": true,
"type": "string"
},
{
"name": "skipValidation",
"in": "query",
"description": "Flag to skip validation.",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "body",
"in": "body",
"description": "Datastore entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/Datastore"
}
}
],
"responses": {
"200": {
"description": "Resource 'Datastore' update operation succeeded",
"schema": {
"$ref": "#/definitions/Datastore"
}
},
"201": {
"description": "Resource 'Datastore' create operation succeeded",
"schema": {
"$ref": "#/definitions/Datastore"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate datastore (Azure Data Lake Gen1 w/ ServicePrincipal).": {
"$ref": "./examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json"
},
"CreateOrUpdate datastore (Azure Data Lake Gen2 w/ Service Principal).": {
"$ref": "./examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json"
},
"CreateOrUpdate datastore (Azure File store w/ AccountKey).": {
"$ref": "./examples/Datastore/AzureFileWAccountKey/createOrUpdate.json"
},
"CreateOrUpdate datastore (AzureBlob w/ AccountKey).": {
"$ref": "./examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "Datastores_Delete",
"tags": [
"Datastores"
],
"summary": "Delete datastore.",
"description": "Delete datastore.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Datastore name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete datastore.": {
"$ref": "./examples/Datastore/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets": {
"post": {
"operationId": "Datastores_ListSecrets",
"tags": [
"Datastores"
],
"summary": "Get datastore secrets.",
"description": "Get datastore secrets.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Datastore name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Secret expiry information.",
"required": false,
"schema": {
"$ref": "#/definitions/SecretExpiry"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatastoreSecrets"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get datastore secrets.": {
"$ref": "./examples/Datastore/listSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": {
"post": {
"operationId": "Workspaces_Diagnose",
"tags": [
"Workspaces"
],
"summary": "Diagnose workspace setup issue.",
"description": "Diagnose workspace setup issue.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "The parameter of diagnosing workspace health",
"required": false,
"schema": {
"$ref": "#/definitions/DiagnoseWorkspaceParameters"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnoseResponseResult"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Diagnose Workspace": {
"$ref": "./examples/Workspace/diagnose.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/DiagnoseResponseResult"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments": {
"get": {
"operationId": "EnvironmentContainers_List",
"tags": [
"EnvironmentContainerOperationGroup"
],
"summary": "List environment containers.",
"description": "List environment containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Environment Container.": {
"$ref": "./examples/Workspace/EnvironmentContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}": {
"get": {
"operationId": "EnvironmentContainers_Get",
"tags": [
"EnvironmentContainerOperationGroup"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Environment Container.": {
"$ref": "./examples/Workspace/EnvironmentContainer/get.json"
}
}
},
"put": {
"operationId": "EnvironmentContainers_CreateOrUpdate",
"tags": [
"EnvironmentContainerOperationGroup"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'EnvironmentContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
}
},
"201": {
"description": "Resource 'EnvironmentContainer' create operation succeeded",
"schema": {
"$ref": "#/definitions/EnvironmentContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Environment Container.": {
"$ref": "./examples/Workspace/EnvironmentContainer/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "EnvironmentContainers_Delete",
"tags": [
"EnvironmentContainerOperationGroup"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Environment Container.": {
"$ref": "./examples/Workspace/EnvironmentContainer/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions": {
"get": {
"operationId": "EnvironmentVersions_List",
"tags": [
"EnvironmentVersionOperationGroup"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Environment Version.": {
"$ref": "./examples/Workspace/EnvironmentVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}": {
"get": {
"operationId": "EnvironmentVersions_Get",
"tags": [
"EnvironmentVersionOperationGroup"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Environment Version.": {
"$ref": "./examples/Workspace/EnvironmentVersion/get.json"
}
}
},
"put": {
"operationId": "EnvironmentVersions_CreateOrUpdate",
"tags": [
"EnvironmentVersionOperationGroup"
],
"summary": "Creates or updates an EnvironmentVersion.",
"description": "Creates or updates an EnvironmentVersion.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Definition of EnvironmentVersion.",
"required": true,
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'EnvironmentVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
}
},
"201": {
"description": "Resource 'EnvironmentVersion' create operation succeeded",
"schema": {
"$ref": "#/definitions/EnvironmentVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Environment Version.": {
"$ref": "./examples/Workspace/EnvironmentVersion/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "EnvironmentVersions_Delete",
"tags": [
"EnvironmentVersionOperationGroup"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Environment Version.": {
"$ref": "./examples/Workspace/EnvironmentVersion/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish": {
"post": {
"operationId": "EnvironmentVersions_Publish",
"tags": [
"EnvironmentVersionOperationGroup"
],
"summary": "Publish version asset into registry.",
"description": "Publish version asset into registry.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Destination registry info",
"required": true,
"schema": {
"$ref": "#/definitions/DestinationAsset"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Publish Workspace Environment Version.": {
"$ref": "./examples/Workspace/EnvironmentVersion/publish.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features": {
"get": {
"operationId": "WorkspaceFeatures_List",
"tags": [
"Workspaces"
],
"description": "Lists all enabled features for a workspace",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ListAmlUserFeatureResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace features": {
"$ref": "./examples/WorkspaceFeature/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets": {
"get": {
"operationId": "FeaturesetContainers_List",
"tags": [
"FeaturesetContainers"
],
"summary": "List featurestore entity containers.",
"description": "List featurestore entity containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
},
{
"name": "pageSize",
"in": "query",
"description": "page size",
"required": false,
"type": "integer",
"format": "int32",
"default": 20
},
{
"name": "name",
"in": "query",
"description": "name for the featureset",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "description for the feature set",
"required": false,
"type": "string"
},
{
"name": "createdBy",
"in": "query",
"description": "createdBy user name",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturesetContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Featureset Container.": {
"$ref": "./examples/Workspace/FeaturesetContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}": {
"get": {
"operationId": "FeaturesetContainers_GetEntity",
"tags": [
"FeaturesetContainers"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturesetContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"GetEntity Workspace Featureset Container.": {
"$ref": "./examples/Workspace/FeaturesetContainer/getEntity.json"
}
}
},
"put": {
"operationId": "FeaturesetContainers_CreateOrUpdate",
"tags": [
"FeaturesetContainers"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/FeaturesetContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'FeaturesetContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/FeaturesetContainer"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/FeaturesetContainer"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Featureset Container.": {
"$ref": "./examples/Workspace/FeaturesetContainer/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/FeaturesetContainer"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "FeaturesetContainers_Delete",
"tags": [
"FeaturesetContainers"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Featureset Container.": {
"$ref": "./examples/Workspace/FeaturesetContainer/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions": {
"get": {
"operationId": "FeaturesetVersions_List",
"tags": [
"FeaturesetVersions"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
},
{
"name": "pageSize",
"in": "query",
"description": "page size",
"required": false,
"type": "integer",
"format": "int32",
"default": 20
},
{
"name": "versionName",
"in": "query",
"description": "name for the featureset version",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"description": "featureset version",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "description for the feature set version",
"required": false,
"type": "string"
},
{
"name": "createdBy",
"in": "query",
"description": "createdBy user name",
"required": false,
"type": "string"
},
{
"name": "stage",
"in": "query",
"description": "Specifies the featurestore stage",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturesetVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Featureset Version.": {
"$ref": "./examples/Workspace/FeaturesetVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}": {
"get": {
"operationId": "FeaturesetVersions_Get",
"tags": [
"FeaturesetVersions"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturesetVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Featureset Version.": {
"$ref": "./examples/Workspace/FeaturesetVersion/get.json"
}
}
},
"put": {
"operationId": "FeaturesetVersions_CreateOrUpdate",
"tags": [
"FeaturesetVersions"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/FeaturesetVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'FeaturesetVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/FeaturesetVersion"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/FeaturesetVersion"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Featureset Version.": {
"$ref": "./examples/Workspace/FeaturesetVersion/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/FeaturesetVersion"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "FeaturesetVersions_Delete",
"tags": [
"FeaturesetVersions"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Featureset Version.": {
"$ref": "./examples/Workspace/FeaturesetVersion/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill": {
"post": {
"operationId": "FeaturesetVersions_Backfill",
"tags": [
"FeaturesetVersions"
],
"summary": "Backfill.",
"description": "Backfill.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Feature set version backfill request entity.",
"required": true,
"schema": {
"$ref": "#/definitions/FeaturesetVersionBackfillRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturesetVersionBackfillResponse"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Backfill Workspace Featureset Version.": {
"$ref": "./examples/Workspace/FeaturesetVersion/backfill.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/FeaturesetVersionBackfillResponse"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features": {
"get": {
"operationId": "Features_List",
"tags": [
"Features"
],
"summary": "List Features.",
"description": "List Features.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "featuresetName",
"in": "path",
"description": "Name of Azure Machine Learning featuresets.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "featuresetVersion",
"in": "path",
"description": "Inference Version name.",
"required": true,
"type": "string"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "featureName",
"in": "query",
"description": "feature name.",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "Description of the featureset.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
},
{
"name": "pageSize",
"in": "query",
"description": "Page size.",
"required": false,
"type": "integer",
"format": "int32",
"default": 1000
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeatureResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Feature.": {
"$ref": "./examples/Feature/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}": {
"get": {
"operationId": "Features_Get",
"tags": [
"Features"
],
"summary": "Get feature.",
"description": "Get feature.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "featuresetName",
"in": "path",
"description": "Name of Azure Machine Learning featuresets.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
},
{
"name": "featuresetVersion",
"in": "path",
"description": "Inference Version name.",
"required": true,
"type": "string"
},
{
"name": "featureName",
"in": "path",
"description": "Inference FeatureName name.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,254}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Feature"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Feature.": {
"$ref": "./examples/Feature/get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities": {
"get": {
"operationId": "FeaturestoreEntityContainers_List",
"tags": [
"FeaturestoreEntityContainers"
],
"summary": "List featurestore entity containers.",
"description": "List featurestore entity containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
},
{
"name": "pageSize",
"in": "query",
"description": "page size",
"required": false,
"type": "integer",
"format": "int32",
"default": 20
},
{
"name": "name",
"in": "query",
"description": "name for the featurestore entity",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "description for the featurestore entity",
"required": false,
"type": "string"
},
{
"name": "createdBy",
"in": "query",
"description": "createdBy user name",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Featurestore Entity Container.": {
"$ref": "./examples/Workspace/FeaturestoreEntityContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}": {
"get": {
"operationId": "FeaturestoreEntityContainers_GetEntity",
"tags": [
"FeaturestoreEntityContainers"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"GetEntity Workspace Featurestore Entity Container.": {
"$ref": "./examples/Workspace/FeaturestoreEntityContainer/getEntity.json"
}
}
},
"put": {
"operationId": "FeaturestoreEntityContainers_CreateOrUpdate",
"tags": [
"FeaturestoreEntityContainers"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/FeaturestoreEntityContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'FeaturestoreEntityContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityContainer"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityContainer"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Featurestore Entity Container.": {
"$ref": "./examples/Workspace/FeaturestoreEntityContainer/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/FeaturestoreEntityContainer"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "FeaturestoreEntityContainers_Delete",
"tags": [
"FeaturestoreEntityContainers"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Featurestore Entity Container.": {
"$ref": "./examples/Workspace/FeaturestoreEntityContainer/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions": {
"get": {
"operationId": "FeaturestoreEntityVersions_List",
"tags": [
"FeaturestoreEntityVersions"
],
"summary": "List versions.",
"description": "List versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "[ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
},
{
"name": "pageSize",
"in": "query",
"description": "page size",
"required": false,
"type": "integer",
"format": "int32",
"default": 20
},
{
"name": "versionName",
"in": "query",
"description": "name for the featurestore entity version",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"description": "featurestore entity version",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "description for the feature entity version",
"required": false,
"type": "string"
},
{
"name": "createdBy",
"in": "query",
"description": "createdBy user name",
"required": false,
"type": "string"
},
{
"name": "stage",
"in": "query",
"description": "Specifies the featurestore stage",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Featurestore Entity Version.": {
"$ref": "./examples/Workspace/FeaturestoreEntityVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}/versions/{version}": {
"get": {
"operationId": "FeaturestoreEntityVersions_Get",
"tags": [
"FeaturestoreEntityVersions"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Featurestore Entity Version.": {
"$ref": "./examples/Workspace/FeaturestoreEntityVersion/get.json"
}
}
},
"put": {
"operationId": "FeaturestoreEntityVersions_CreateOrUpdate",
"tags": [
"FeaturestoreEntityVersions"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/FeaturestoreEntityVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'FeaturestoreEntityVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityVersion"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/FeaturestoreEntityVersion"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Featurestore Entity Version.": {
"$ref": "./examples/Workspace/FeaturestoreEntityVersion/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/FeaturestoreEntityVersion"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "FeaturestoreEntityVersions_Delete",
"tags": [
"FeaturestoreEntityVersions"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Featurestore Entity Version.": {
"$ref": "./examples/Workspace/FeaturestoreEntityVersion/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs": {
"get": {
"operationId": "Jobs_List",
"tags": [
"JobBases"
],
"summary": "Lists Jobs in the workspace.",
"description": "Lists Jobs in the workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "jobType",
"in": "query",
"description": "Type of job to be returned.",
"required": false,
"type": "string"
},
{
"name": "tag",
"in": "query",
"description": "Jobs returned will have this tag key.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
},
{
"name": "properties",
"in": "query",
"description": "Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JobBaseResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List AutoML Job.": {
"$ref": "./examples/Job/AutoMLJob/list.json"
},
"List Command Job.": {
"$ref": "./examples/Job/CommandJob/list.json"
},
"List Pipeline Job.": {
"$ref": "./examples/Job/PipelineJob/list.json"
},
"List Sweep Job.": {
"$ref": "./examples/Job/SweepJob/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}": {
"get": {
"operationId": "Jobs_Get",
"tags": [
"JobBases"
],
"summary": "Gets a Job by name/id.",
"description": "Gets a Job by name/id.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "id",
"in": "path",
"description": "The name and identifier for the Job. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JobBase"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get AutoML Job.": {
"$ref": "./examples/Job/AutoMLJob/get.json"
},
"Get Command Job.": {
"$ref": "./examples/Job/CommandJob/get.json"
},
"Get Pipeline Job.": {
"$ref": "./examples/Job/PipelineJob/get.json"
},
"Get Sweep Job.": {
"$ref": "./examples/Job/SweepJob/get.json"
}
}
},
"put": {
"operationId": "Jobs_CreateOrUpdate",
"tags": [
"JobBases"
],
"summary": "Creates and executes a Job.\r\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.",
"description": "Creates and executes a Job.\nFor update case, the Tags in the definition passed in will replace Tags in the existing job.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "id",
"in": "path",
"description": "The name and identifier for the Job. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Job definition object.",
"required": true,
"schema": {
"$ref": "#/definitions/JobBase"
}
}
],
"responses": {
"200": {
"description": "Resource 'JobBase' update operation succeeded",
"schema": {
"$ref": "#/definitions/JobBase"
}
},
"201": {
"description": "Resource 'JobBase' create operation succeeded",
"schema": {
"$ref": "#/definitions/JobBase"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate AutoML Job.": {
"$ref": "./examples/Job/AutoMLJob/createOrUpdate.json"
},
"CreateOrUpdate Command Job.": {
"$ref": "./examples/Job/CommandJob/createOrUpdate.json"
},
"CreateOrUpdate Pipeline Job.": {
"$ref": "./examples/Job/PipelineJob/createOrUpdate.json"
},
"CreateOrUpdate Sweep Job.": {
"$ref": "./examples/Job/SweepJob/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "Jobs_Delete",
"tags": [
"JobBases"
],
"summary": "Deletes a Job (asynchronous).",
"description": "Deletes a Job (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "id",
"in": "path",
"description": "The name and identifier for the Job. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Job.": {
"$ref": "./examples/Job/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel": {
"post": {
"operationId": "Jobs_Cancel",
"tags": [
"JobBases"
],
"summary": "Cancels a Job (asynchronous).",
"description": "Cancels a Job (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "id",
"in": "path",
"description": "The name and identifier for the Job. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Cancel Job.": {
"$ref": "./examples/Job/cancel.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": {
"post": {
"operationId": "Workspaces_ListKeys",
"tags": [
"Workspaces"
],
"summary": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.",
"description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ListWorkspaceKeysResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Keys": {
"$ref": "./examples/Workspace/listKeys.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": {
"post": {
"operationId": "Workspaces_ListNotebookAccessToken",
"tags": [
"Workspaces"
],
"summary": "Get Azure Machine Learning Workspace notebook access token",
"description": "Get Azure Machine Learning Workspace notebook access token",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/NotebookAccessTokenResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Keys": {
"$ref": "./examples/Workspace/listNotebookAccessToken.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": {
"post": {
"operationId": "Workspaces_ListNotebookKeys",
"tags": [
"Workspaces"
],
"summary": "Lists keys of Azure Machine Learning Workspaces notebook.",
"description": "Lists keys of Azure Machine Learning Workspaces notebook.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ListNotebookKeysResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Keys": {
"$ref": "./examples/Notebook/listKeys.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": {
"post": {
"operationId": "Workspaces_ListStorageAccountKeys",
"tags": [
"Workspaces"
],
"summary": "Lists keys of Azure Machine Learning Workspace's storage account.",
"description": "Lists keys of Azure Machine Learning Workspace's storage account.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ListStorageAccountKeysResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Keys": {
"$ref": "./examples/Workspace/listStorageAccountKeys.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions": {
"get": {
"operationId": "MarketplaceSubscriptions_List",
"tags": [
"MarketplaceSubscriptions"
],
"summary": "List containers.",
"description": "List containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MarketplaceSubscriptionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Marketplace Subscription.": {
"$ref": "./examples/Workspace/MarketplaceSubscription/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}": {
"get": {
"operationId": "MarketplaceSubscriptions_Get",
"tags": [
"MarketplaceSubscriptions"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MarketplaceSubscription"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Marketplace Subscription.": {
"$ref": "./examples/Workspace/MarketplaceSubscription/get.json"
}
}
},
"put": {
"operationId": "MarketplaceSubscriptions_CreateOrUpdate",
"tags": [
"MarketplaceSubscriptions"
],
"summary": "Create or update Marketplace Subscription (asynchronous).",
"description": "Create or update Marketplace Subscription (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Marketplace Subscription entity to apply during operation.",
"required": true,
"schema": {
"$ref": "#/definitions/MarketplaceSubscription"
}
}
],
"responses": {
"200": {
"description": "Resource 'MarketplaceSubscription' update operation succeeded",
"schema": {
"$ref": "#/definitions/MarketplaceSubscription"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/MarketplaceSubscription"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Marketplace Subscription.": {
"$ref": "./examples/Workspace/MarketplaceSubscription/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/MarketplaceSubscription"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "MarketplaceSubscriptions_Delete",
"tags": [
"MarketplaceSubscriptions"
],
"summary": "Delete Marketplace Subscription (asynchronous).",
"description": "Delete Marketplace Subscription (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Marketplace Subscription.": {
"$ref": "./examples/Workspace/MarketplaceSubscription/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models": {
"get": {
"operationId": "ModelContainers_List",
"tags": [
"ModelContainerOperationGroup"
],
"summary": "List model containers.",
"description": "List model containers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "count",
"in": "query",
"description": "Maximum number of results to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelContainerResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Model Container.": {
"$ref": "./examples/Workspace/ModelContainer/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}": {
"get": {
"operationId": "ModelContainers_Get",
"tags": [
"ModelContainerOperationGroup"
],
"summary": "Get container.",
"description": "Get container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Model Container.": {
"$ref": "./examples/Workspace/ModelContainer/get.json"
}
}
},
"put": {
"operationId": "ModelContainers_CreateOrUpdate",
"tags": [
"ModelContainerOperationGroup"
],
"summary": "Create or update container.",
"description": "Create or update container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Container entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ModelContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'ModelContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/ModelContainer"
}
},
"201": {
"description": "Resource 'ModelContainer' create operation succeeded",
"schema": {
"$ref": "#/definitions/ModelContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Model Container.": {
"$ref": "./examples/Workspace/ModelContainer/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "ModelContainers_Delete",
"tags": [
"ModelContainerOperationGroup"
],
"summary": "Delete container.",
"description": "Delete container.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Model Container.": {
"$ref": "./examples/Workspace/ModelContainer/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions": {
"get": {
"operationId": "ModelVersions_List",
"tags": [
"ModelVersionOperationGroup"
],
"summary": "List model versions.",
"description": "List model versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Maximum number of records to return.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "version",
"in": "query",
"description": "Model version.",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "Model description.",
"required": false,
"type": "string"
},
{
"name": "offset",
"in": "query",
"description": "Number of initial results to skip.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2",
"required": false,
"type": "string"
},
{
"name": "properties",
"in": "query",
"description": "Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2",
"required": false,
"type": "string"
},
{
"name": "feed",
"in": "query",
"description": "Name of the feed.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "View type for including/excluding (for example) archived entities.",
"required": false,
"type": "string",
"default": "ActiveOnly",
"enum": [
"ActiveOnly",
"ArchivedOnly",
"All"
],
"x-ms-enum": {
"name": "ListViewType",
"modelAsString": true,
"values": [
{
"name": "ActiveOnly",
"value": "ActiveOnly"
},
{
"name": "ArchivedOnly",
"value": "ArchivedOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelVersionResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Model Version.": {
"$ref": "./examples/Workspace/ModelVersion/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}": {
"get": {
"operationId": "ModelVersions_Get",
"tags": [
"ModelVersionOperationGroup"
],
"summary": "Get version.",
"description": "Get version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ModelVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Model Version.": {
"$ref": "./examples/Workspace/ModelVersion/get.json"
}
}
},
"put": {
"operationId": "ModelVersions_CreateOrUpdate",
"tags": [
"ModelVersionOperationGroup"
],
"summary": "Create or update version.",
"description": "Create or update version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Version entity to create or update.",
"required": true,
"schema": {
"$ref": "#/definitions/ModelVersion"
}
}
],
"responses": {
"200": {
"description": "Resource 'ModelVersion' update operation succeeded",
"schema": {
"$ref": "#/definitions/ModelVersion"
}
},
"201": {
"description": "Resource 'ModelVersion' create operation succeeded",
"schema": {
"$ref": "#/definitions/ModelVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Model Version.": {
"$ref": "./examples/Workspace/ModelVersion/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "ModelVersions_Delete",
"tags": [
"ModelVersionOperationGroup"
],
"summary": "Delete version.",
"description": "Delete version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Model Version.": {
"$ref": "./examples/Workspace/ModelVersion/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{name}/versions/{version}/publish": {
"post": {
"operationId": "ModelVersions_Publish",
"tags": [
"ModelVersionOperationGroup"
],
"summary": "Publish version asset into registry.",
"description": "Publish version asset into registry.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Name of Azure Machine Learning workspace.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Container name. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"description": "Version identifier. This is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Destination registry info",
"required": true,
"schema": {
"$ref": "#/definitions/DestinationAsset"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Publish Workspace Model Version.": {
"$ref": "./examples/Workspace/ModelVersion/publish.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints": {
"get": {
"operationId": "OnlineEndpoints_List",
"tags": [
"OnlineEndpoints"
],
"summary": "List Online Endpoints.",
"description": "List Online Endpoints.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "query",
"description": "Name of the endpoint.",
"required": false,
"type": "string"
},
{
"name": "count",
"in": "query",
"description": "Number of endpoints to be retrieved in a page of results.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "computeType",
"in": "query",
"description": "EndpointComputeType to be filtered by.",
"required": false,
"type": "string",
"enum": [
"Managed",
"Kubernetes",
"AzureMLCompute"
],
"x-ms-enum": {
"name": "EndpointComputeType",
"modelAsString": true,
"values": [
{
"name": "Managed",
"value": "Managed"
},
{
"name": "Kubernetes",
"value": "Kubernetes"
},
{
"name": "AzureMLCompute",
"value": "AzureMLCompute"
}
]
}
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"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 .",
"required": false,
"type": "string"
},
{
"name": "properties",
"in": "query",
"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 .",
"required": false,
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"description": "The option to order the response.",
"required": false,
"type": "string",
"enum": [
"CreatedAtDesc",
"CreatedAtAsc",
"UpdatedAtDesc",
"UpdatedAtAsc"
],
"x-ms-enum": {
"name": "OrderString",
"modelAsString": true,
"values": [
{
"name": "CreatedAtDesc",
"value": "CreatedAtDesc"
},
{
"name": "CreatedAtAsc",
"value": "CreatedAtAsc"
},
{
"name": "UpdatedAtDesc",
"value": "UpdatedAtDesc"
},
{
"name": "UpdatedAtAsc",
"value": "UpdatedAtAsc"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/OnlineEndpointTrackedResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}": {
"get": {
"operationId": "OnlineEndpoints_Get",
"tags": [
"OnlineEndpoints"
],
"summary": "Get Online Endpoint.",
"description": "Get Online Endpoint.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/OnlineEndpoint"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/get.json"
}
}
},
"put": {
"operationId": "OnlineEndpoints_CreateOrUpdate",
"tags": [
"OnlineEndpoints"
],
"summary": "Create or update Online Endpoint (asynchronous).",
"description": "Create or update Online Endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Online Endpoint entity to apply during operation.",
"required": true,
"schema": {
"$ref": "#/definitions/OnlineEndpoint"
}
}
],
"responses": {
"200": {
"description": "Resource 'OnlineEndpoint' update operation succeeded",
"schema": {
"$ref": "#/definitions/OnlineEndpoint"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/OnlineEndpoint"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/OnlineEndpoint"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "OnlineEndpoints_Update",
"tags": [
"OnlineEndpoints"
],
"summary": "Update Online Endpoint (asynchronous).",
"description": "Update Online Endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Online Endpoint entity to apply during operation.",
"required": true,
"schema": {
"$ref": "#/definitions/PartialMinimalTrackedResourceWithIdentity"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/OnlineEndpoint"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/update.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/OnlineEndpoint"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "OnlineEndpoints_Delete",
"tags": [
"OnlineEndpoints"
],
"summary": "Delete Online Endpoint (asynchronous).",
"description": "Delete Online Endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments": {
"get": {
"operationId": "OnlineDeployments_List",
"tags": [
"OnlineDeployments"
],
"summary": "List Inference Endpoint Deployments.",
"description": "List Inference Endpoint Deployments.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "$orderBy",
"in": "query",
"description": "Ordering of list.",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "Top of list.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/OnlineDeploymentTrackedResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Online Deployments.": {
"$ref": "./examples/OnlineDeployment/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}": {
"get": {
"operationId": "OnlineDeployments_Get",
"tags": [
"OnlineDeployments"
],
"summary": "Get Inference Deployment Deployment.",
"description": "Get Inference Deployment Deployment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/OnlineDeployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Kubernetes Online Deployment.": {
"$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/get.json"
},
"Get Managed Online Deployment.": {
"$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/get.json"
}
}
},
"put": {
"operationId": "OnlineDeployments_CreateOrUpdate",
"tags": [
"OnlineDeployments"
],
"summary": "Create or update Inference Endpoint Deployment (asynchronous).",
"description": "Create or update Inference Endpoint Deployment (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Inference Endpoint entity to apply during operation.",
"required": true,
"schema": {
"$ref": "#/definitions/OnlineDeployment"
}
}
],
"responses": {
"200": {
"description": "Resource 'OnlineDeployment' update operation succeeded",
"schema": {
"$ref": "#/definitions/OnlineDeployment"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/OnlineDeployment"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Kubernetes Online Deployment.": {
"$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json"
},
"CreateOrUpdate Managed Online Deployment.": {
"$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/OnlineDeployment"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "OnlineDeployments_Update",
"tags": [
"OnlineDeployments"
],
"summary": "Update Online Deployment (asynchronous).",
"description": "Update Online Deployment (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Online Endpoint entity to apply during operation.",
"required": true,
"schema": {
"$ref": "#/definitions/PartialMinimalTrackedResourceWithSku"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/OnlineDeployment"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Kubernetes Online Deployment.": {
"$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/update.json"
},
"Update Managed Online Deployment.": {
"$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/update.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/OnlineDeployment"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "OnlineDeployments_Delete",
"tags": [
"OnlineDeployments"
],
"summary": "Delete Inference Endpoint Deployment (asynchronous).",
"description": "Delete Inference Endpoint Deployment (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Online Deployment.": {
"$ref": "./examples/Workspace/OnlineDeployment/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs": {
"post": {
"operationId": "OnlineDeployments_GetLogs",
"tags": [
"OnlineDeployments"
],
"summary": "Polls an Endpoint operation.",
"description": "Polls an Endpoint operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "The request containing parameters for retrieving logs.",
"required": true,
"schema": {
"$ref": "#/definitions/DeploymentLogsRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DeploymentLogs"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Online Deployment Logs.": {
"$ref": "./examples/OnlineDeployment/getLogs.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/skus": {
"get": {
"operationId": "OnlineDeployments_ListSkus",
"tags": [
"OnlineDeployments"
],
"summary": "List Inference Endpoint Deployment Skus.",
"description": "List Inference Endpoint Deployment Skus.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"description": "Inference Endpoint Deployment name.",
"required": true,
"type": "string"
},
{
"name": "count",
"in": "query",
"description": "Number of Skus to be retrieved in a page of results.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SkuResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Kubernetes Online Deployment Skus.": {
"$ref": "./examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json"
},
"List Managed Online Deployment Skus.": {
"$ref": "./examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/listKeys": {
"post": {
"operationId": "OnlineEndpoints_ListKeys",
"tags": [
"OnlineEndpoints"
],
"summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.",
"description": "List EndpointAuthKeys for an Endpoint using Key-based authentication.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EndpointAuthKeys"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ListKeys Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/listKeys.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys": {
"post": {
"operationId": "OnlineEndpoints_RegenerateKeys",
"tags": [
"OnlineEndpoints"
],
"summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).",
"description": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "RegenerateKeys request .",
"required": true,
"schema": {
"$ref": "#/definitions/RegenerateEndpointKeysRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"RegenerateKeys Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/regenerateKeys.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/token": {
"post": {
"operationId": "OnlineEndpoints_GetToken",
"tags": [
"OnlineEndpoints"
],
"summary": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.",
"description": "Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "endpointName",
"in": "path",
"description": "Online Endpoint name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EndpointAuthToken"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"GetToken Workspace Online Endpoint.": {
"$ref": "./examples/Workspace/OnlineEndpoint/getToken.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": {
"get": {
"operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints",
"tags": [
"Workspaces"
],
"summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.",
"description": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ExternalFQDNResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ListOutboundNetworkDependenciesEndpoints": {
"$ref": "./examples/ExternalFQDN/get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules": {
"get": {
"operationId": "ManagedNetworkSettingsRule_List",
"tags": [
"OutboundRuleBasicResources"
],
"summary": "Lists the managed network outbound rules for a machine learning workspace.",
"description": "Lists the managed network outbound rules for a machine learning workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/OutboundRuleListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List ManagedNetworkSettingsRule": {
"$ref": "./examples/ManagedNetwork/listRule.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}": {
"get": {
"operationId": "ManagedNetworkSettingsRule_Get",
"tags": [
"OutboundRuleBasicResources"
],
"summary": "Gets an outbound rule from the managed network of a machine learning workspace.",
"description": "Gets an outbound rule from the managed network of a machine learning workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "ruleName",
"in": "path",
"description": "Name of the workspace managed network outbound rule",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/OutboundRuleBasicResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get ManagedNetworkSettingsRule": {
"$ref": "./examples/ManagedNetwork/getRule.json"
}
}
},
"put": {
"operationId": "ManagedNetworkSettingsRule_CreateOrUpdate",
"tags": [
"OutboundRuleBasicResources"
],
"summary": "Creates or updates an outbound rule in the managed network of a machine learning workspace.",
"description": "Creates or updates an outbound rule in the managed network of a machine learning workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "ruleName",
"in": "path",
"description": "Name of the workspace managed network outbound rule",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "Outbound Rule to be created or updated in the managed network of a machine learning workspace.",
"required": true,
"schema": {
"$ref": "#/definitions/OutboundRuleBasicResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'OutboundRuleBasicResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/OutboundRuleBasicResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate ManagedNetworkSettingsRule": {
"$ref": "./examples/ManagedNetwork/createOrUpdateRule.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/OutboundRuleBasicResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ManagedNetworkSettingsRule_Delete",
"tags": [
"OutboundRuleBasicResources"
],
"summary": "Deletes an outbound rule from the managed network of a machine learning workspace.",
"description": "Deletes an outbound rule from the managed network of a machine learning workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "ruleName",
"in": "path",
"description": "Name of the workspace managed network outbound rule",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete ManagedNetworkSettingsRule": {
"$ref": "./examples/ManagedNetwork/deleteRule.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": {
"post": {
"operationId": "Workspaces_PrepareNotebook",
"tags": [
"Workspaces"
],
"summary": "Prepare Azure Machine Learning Workspace's notebook resource",
"description": "Prepare Azure Machine Learning Workspace's notebook resource",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/NotebookResourceInfo"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Prepare Notebook": {
"$ref": "./examples/Notebook/prepare.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/NotebookResourceInfo"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": {
"get": {
"operationId": "PrivateEndpointConnections_List",
"tags": [
"PrivateEndpointConnections"
],
"summary": "Called by end-users to get all PE connections.",
"description": "Called by end-users to get all PE connections.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"StorageAccountListPrivateEndpointConnections": {
"$ref": "./examples/PrivateEndpointConnection/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": {
"get": {
"operationId": "PrivateEndpointConnections_Get",
"tags": [
"PrivateEndpointConnections"
],
"summary": "Called by end-users to get a PE connection.",
"description": "Called by end-users to get a PE connection.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "NRP Private Endpoint Connection Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"WorkspaceGetPrivateEndpointConnection": {
"$ref": "./examples/PrivateEndpointConnection/get.json"
}
}
},
"put": {
"operationId": "PrivateEndpointConnections_CreateOrUpdate",
"tags": [
"PrivateEndpointConnections"
],
"summary": "Called by end-users to approve or reject a PE connection.\r\nThis method must validate and forward the call to NRP.",
"description": "Called by end-users to approve or reject a PE connection.\nThis method must validate and forward the call to NRP.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "NRP Private Endpoint Connection Name",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "PrivateEndpointConnection object",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
}
],
"responses": {
"200": {
"description": "Resource 'PrivateEndpointConnection' update operation succeeded",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"WorkspacePutPrivateEndpointConnection": {
"$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json"
}
}
},
"delete": {
"operationId": "PrivateEndpointConnections_Delete",
"tags": [
"PrivateEndpointConnections"
],
"summary": "Called by end-users to delete a PE connection.",
"description": "Called by end-users to delete a PE connection.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "NRP Private Endpoint Connection Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"WorkspacePutPrivateEndpointConnection": {
"$ref": "./examples/PrivateEndpointConnection/delete.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": {
"get": {
"operationId": "PrivateLinkResources_List",
"tags": [
"Workspaces"
],
"summary": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\r\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\r\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\r\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\r\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".",
"description": "Called by Client (Portal, CLI, etc) to get available \"private link resources\" for the workspace.\nEach \"private link resource\" is a connection endpoint (IP address) to the resource.\nPre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution.\nOther RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc.\nDefined in the \"[NRP] Private Endpoint Design\" doc, topic \"GET API for GroupIds\".",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateLinkResourceListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"WorkspaceListPrivateLinkResources": {
"$ref": "./examples/PrivateLinkResource/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork": {
"post": {
"operationId": "ManagedNetworkProvisions_ProvisionManagedNetwork",
"tags": [
"Workspaces"
],
"summary": "Provisions the managed network of a machine learning workspace.",
"description": "Provisions the managed network of a machine learning workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "body",
"in": "body",
"description": "Managed Network Provisioning Options for a machine learning workspace.",
"required": false,
"schema": {
"$ref": "#/definitions/ManagedNetworkProvisionOptions"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ManagedNetworkProvisionStatus"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Provision ManagedNetwork": {
"$ref": "./examples/ManagedNetwork/provision.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ManagedNetworkProvisionStatus"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": {
"post": {
"operationId": "Workspaces_ResyncKeys",
"tags": [
"Workspaces"
],
"summary": "Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry",
"description": "Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Resync Workspace Keys": {
"$ref": "./examples/Workspace/resyncKeys.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules": {
"get": {
"operationId": "Schedules_List",
"tags": [
"Schedules"
],
"summary": "List schedules in specified workspace.",
"description": "List schedules in specified workspace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
},
{
"name": "listViewType",
"in": "query",
"description": "Status filter for schedule.",
"required": false,
"type": "string",
"default": "EnabledOnly",
"enum": [
"EnabledOnly",
"DisabledOnly",
"All"
],
"x-ms-enum": {
"name": "ScheduleListViewType",
"modelAsString": true,
"values": [
{
"name": "EnabledOnly",
"value": "EnabledOnly"
},
{
"name": "DisabledOnly",
"value": "DisabledOnly"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ScheduleResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Schedules.": {
"$ref": "./examples/Schedule/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{name}": {
"get": {
"operationId": "Schedules_Get",
"tags": [
"Schedules"
],
"summary": "Get schedule.",
"description": "Get schedule.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Schedule name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Schedule"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Schedule.": {
"$ref": "./examples/Schedule/get.json"
}
}
},
"put": {
"operationId": "Schedules_CreateOrUpdate",
"tags": [
"Schedules"
],
"summary": "Create or update schedule.",
"description": "Create or update schedule.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Schedule name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Schedule definition.",
"required": true,
"schema": {
"$ref": "#/definitions/Schedule"
}
}
],
"responses": {
"200": {
"description": "Resource 'Schedule' update operation succeeded",
"schema": {
"$ref": "#/definitions/Schedule"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/Schedule"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Schedule.": {
"$ref": "./examples/Schedule/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/Schedule"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "Schedules_Delete",
"tags": [
"Schedules"
],
"summary": "Delete schedule.",
"description": "Delete schedule.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Schedule name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Schedule.": {
"$ref": "./examples/Schedule/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints": {
"get": {
"operationId": "ServerlessEndpoints_List",
"tags": [
"ServerlessEndpoints"
],
"summary": "List Serverless Endpoints.",
"description": "List Serverless Endpoints.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "$skip",
"in": "query",
"description": "Continuation token for pagination.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ServerlessEndpointTrackedResourceArmPaginatedResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List Workspace Serverless Endpoint.": {
"$ref": "./examples/Workspace/ServerlessEndpoint/list.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}": {
"get": {
"operationId": "ServerlessEndpoints_Get",
"tags": [
"ServerlessEndpoints"
],
"summary": "Get Serverless Endpoint.",
"description": "Get Serverless Endpoint.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Serverless Endpoint name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ServerlessEndpoint"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Workspace Serverless Endpoint.": {
"$ref": "./examples/Workspace/ServerlessEndpoint/get.json"
}
}
},
"put": {
"operationId": "ServerlessEndpoints_CreateOrUpdate",
"tags": [
"ServerlessEndpoints"
],
"summary": "Create or update Serverless Endpoint (asynchronous).",
"description": "Create or update Serverless Endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Serverless Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Serverless Endpoint entity to apply during operation.",
"required": true,
"schema": {
"$ref": "#/definitions/ServerlessEndpoint"
}
}
],
"responses": {
"200": {
"description": "Resource 'ServerlessEndpoint' update operation succeeded",
"schema": {
"$ref": "#/definitions/ServerlessEndpoint"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/ServerlessEndpoint"
},
"headers": {
"Azure-AsyncOperation": {
"type": "string",
"description": "A link to the status monitor"
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"CreateOrUpdate Workspace Serverless Endpoint.": {
"$ref": "./examples/Workspace/ServerlessEndpoint/createOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "original-uri",
"final-state-schema": "#/definitions/ServerlessEndpoint"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "ServerlessEndpoints_Update",
"tags": [
"ServerlessEndpoints"
],
"summary": "Update Serverless Endpoint (asynchronous).",
"description": "Update Serverless Endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Serverless Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "Serverless Endpoint entity to apply during operation.",
"required": true,
"schema": {
"$ref": "#/definitions/PartialMinimalTrackedResourceWithSkuAndIdentity"
}
}
],
"responses": {
"200": {
"description": "Resource 'ServerlessEndpoint' update operation succeeded",
"schema": {
"$ref": "#/definitions/ServerlessEndpoint"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Workspace Serverless Endpoint.": {
"$ref": "./examples/Workspace/ServerlessEndpoint/update.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/ServerlessEndpoint"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ServerlessEndpoints_Delete",
"tags": [
"ServerlessEndpoints"
],
"summary": "Delete Serverless Endpoint (asynchronous).",
"description": "Delete Serverless Endpoint (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Serverless Endpoint name.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
},
"x-ms-async-operation-timeout": {
"type": "string",
"format": "duration",
"description": "Timeout for the client to use when polling the asynchronous operation."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Workspace Serverless Endpoint.": {
"$ref": "./examples/Workspace/ServerlessEndpoint/delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/listKeys": {
"post": {
"operationId": "ServerlessEndpoints_ListKeys",
"tags": [
"ServerlessEndpoints"
],
"summary": "List EndpointAuthKeys for an Endpoint using Key-based authentication.",
"description": "List EndpointAuthKeys for an Endpoint using Key-based authentication.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Serverless Endpoint name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EndpointAuthKeys"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"ListKeys Workspace Serverless Endpoint.": {
"$ref": "./examples/Workspace/ServerlessEndpoint/listKeys.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/regenerateKeys": {
"post": {
"operationId": "ServerlessEndpoints_RegenerateKeys",
"tags": [
"ServerlessEndpoints"
],
"summary": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).",
"description": "Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "workspaceName",
"in": "path",
"description": "Azure Machine Learning Workspace Name",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$"
},
{
"name": "name",
"in": "path",
"description": "Serverless Endpoint name.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "RegenerateKeys request .",
"required": true,
"schema": {
"$ref": "#/definitions/RegenerateEndpointKeysRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/EndpointAuthKeys"
}
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"RegenerateKeys Workspace Serverless Endpoint.": {
"$ref": "./examples/Workspace/ServerlessEndpoint/regenerateKeys.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/EndpointAuthKeys"
},
"x-ms-long-running-operation": true
}
}
},
"definitions": {
"AADAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"description": "This connection type covers the AAD auth for any applicable Azure service",
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "AAD"
},
"AKS": {
"type": "object",
"description": "A Machine Learning compute based on AKS.",
"properties": {
"properties": {
"$ref": "#/definitions/AKSSchemaProperties",
"description": "AKS properties"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "AKS"
},
"AKSSchemaProperties": {
"type": "object",
"description": "AKS properties",
"properties": {
"clusterFqdn": {
"type": "string",
"description": "Cluster full qualified domain name",
"x-nullable": true
},
"systemServices": {
"type": "array",
"description": "System services",
"x-nullable": true,
"items": {
"$ref": "#/definitions/SystemService"
},
"readOnly": true
},
"agentCount": {
"type": "integer",
"format": "int32",
"description": "Number of agents",
"minimum": 0,
"x-nullable": true
},
"agentVmSize": {
"type": "string",
"description": "Agent virtual machine size",
"x-nullable": true
},
"clusterPurpose": {
"type": "string",
"description": "Intended usage of the cluster",
"default": "FastProd",
"enum": [
"FastProd",
"DenseProd",
"DevTest"
],
"x-ms-enum": {
"name": "ClusterPurpose",
"modelAsString": true,
"values": [
{
"name": "FastProd",
"value": "FastProd"
},
{
"name": "DenseProd",
"value": "DenseProd"
},
{
"name": "DevTest",
"value": "DevTest"
}
]
}
},
"sslConfiguration": {
"$ref": "#/definitions/SslConfiguration",
"description": "SSL configuration",
"x-nullable": true
},
"aksNetworkingConfiguration": {
"$ref": "#/definitions/AksNetworkingConfiguration",
"description": "AKS networking configuration for vnet",
"x-nullable": true
},
"loadBalancerType": {
"type": "string",
"description": "Load Balancer Type",
"default": "PublicIp",
"enum": [
"PublicIp",
"InternalLoadBalancer"
],
"x-ms-enum": {
"name": "LoadBalancerType",
"modelAsString": true,
"values": [
{
"name": "PublicIp",
"value": "PublicIp"
},
{
"name": "InternalLoadBalancer",
"value": "InternalLoadBalancer"
}
]
}
},
"loadBalancerSubnet": {
"type": "string",
"description": "Load Balancer Subnet",
"x-nullable": true
}
}
},
"AccessKeyAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionAccessKey"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "AccessKey"
},
"AccountKeyAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"description": "This connection type covers the account key connection for Azure storage",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionAccountKey",
"description": "Account key object for workspace connection credential."
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "AccountKey"
},
"AccountKeyDatastoreCredentials": {
"type": "object",
"description": "Account key datastore credentials configuration.",
"properties": {
"secrets": {
"$ref": "#/definitions/AccountKeyDatastoreSecrets",
"format": "password",
"description": "[Required] Storage account secrets.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
},
"required": [
"secrets"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreCredentials"
}
],
"x-ms-discriminator-value": "AccountKey"
},
"AccountKeyDatastoreSecrets": {
"type": "object",
"description": "Datastore account key secrets.",
"properties": {
"key": {
"type": "string",
"description": "Storage account key.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DatastoreSecrets"
}
],
"x-ms-discriminator-value": "AccountKey"
},
"AcrDetails": {
"type": "object",
"description": "Details of ACR account to be used for the Registry",
"properties": {
"systemCreatedAcrAccount": {
"$ref": "#/definitions/SystemCreatedAcrAccount",
"description": "Details of system created ACR account to be used for the Registry",
"x-nullable": true
}
}
},
"AksComputeSecrets": {
"type": "object",
"description": "Secrets related to a Machine Learning compute based on AKS.",
"properties": {
"userKubeConfig": {
"type": "string",
"description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster."
},
"adminKubeConfig": {
"type": "string",
"description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster."
},
"imagePullSecretName": {
"type": "string",
"description": "Image registry pull secret.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/ComputeSecrets"
}
],
"x-ms-discriminator-value": "AKS"
},
"AksNetworkingConfiguration": {
"type": "object",
"description": "Advance configuration for AKS networking",
"properties": {
"subnetId": {
"type": "string",
"description": "Virtual network subnet resource ID the compute nodes belong to"
},
"serviceCidr": {
"type": "string",
"description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.",
"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$"
},
"dnsServiceIP": {
"type": "string",
"description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.",
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
},
"dockerBridgeCidr": {
"type": "string",
"description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.",
"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$"
}
}
},
"AllFeatures": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/MonitoringFeatureFilterBase"
}
],
"x-ms-discriminator-value": "AllFeatures"
},
"AllNodes": {
"type": "object",
"description": "All nodes means the service will be running on all of the nodes of the job",
"allOf": [
{
"$ref": "#/definitions/Nodes"
}
],
"x-ms-discriminator-value": "All"
},
"AllocationState": {
"type": "string",
"description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.",
"enum": [
"Steady",
"Resizing"
],
"x-ms-enum": {
"name": "AllocationState",
"modelAsString": true,
"values": [
{
"name": "Steady",
"value": "Steady"
},
{
"name": "Resizing",
"value": "Resizing"
}
]
}
},
"AmlCompute": {
"type": "object",
"description": "An Azure Machine Learning compute.",
"properties": {
"properties": {
"$ref": "#/definitions/AmlComputeProperties",
"description": "Properties of AmlCompute"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "AmlCompute"
},
"AmlComputeNodeInformation": {
"type": "object",
"description": "Compute node information related to a AmlCompute.",
"properties": {
"nodeId": {
"type": "string",
"title": "Node ID.",
"description": "ID of the compute node.",
"readOnly": true
},
"privateIpAddress": {
"type": "string",
"title": "Private IP address.",
"description": "Private IP address of the compute node.",
"x-nullable": true,
"readOnly": true
},
"publicIpAddress": {
"type": "string",
"title": "Public IP address.",
"description": "Public IP address of the compute node.",
"x-nullable": true,
"readOnly": true
},
"port": {
"type": "integer",
"format": "int32",
"title": "Port.",
"description": "SSH port number of the node.",
"readOnly": true
},
"nodeState": {
"$ref": "#/definitions/NodeState",
"description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.",
"readOnly": true
},
"runId": {
"type": "string",
"title": "Run ID.",
"description": "ID of the Experiment running on the node, if any else null.",
"x-nullable": true,
"readOnly": true
}
}
},
"AmlComputeNodesInformation": {
"type": "object",
"description": "Result of AmlCompute Nodes",
"properties": {
"nodes": {
"type": "array",
"description": "The collection of returned AmlCompute nodes details.",
"items": {
"$ref": "#/definitions/AmlComputeNodeInformation"
},
"readOnly": true,
"x-ms-identifiers": [
"nodeId"
]
},
"nextLink": {
"type": "string",
"description": "The continuation token.",
"readOnly": true
}
}
},
"AmlComputeProperties": {
"type": "object",
"description": "AML Compute properties",
"properties": {
"osType": {
"type": "string",
"description": "Compute OS Type",
"default": "Linux",
"enum": [
"Linux",
"Windows"
],
"x-ms-enum": {
"name": "OsType",
"modelAsString": true,
"values": [
{
"name": "Linux",
"value": "Linux"
},
{
"name": "Windows",
"value": "Windows"
}
]
}
},
"vmSize": {
"type": "string",
"description": "Virtual Machine Size"
},
"vmPriority": {
"$ref": "#/definitions/VmPriority",
"description": "Virtual Machine priority"
},
"virtualMachineImage": {
"$ref": "#/definitions/VirtualMachineImage",
"description": "Virtual Machine image for AML Compute - windows only",
"x-nullable": true
},
"isolatedNetwork": {
"type": "boolean",
"description": "Network is isolated or not"
},
"scaleSettings": {
"$ref": "#/definitions/ScaleSettings",
"description": "Scale settings for AML Compute"
},
"userAccountCredentials": {
"$ref": "#/definitions/UserAccountCredentials",
"title": "User account credentials.",
"description": "Credentials for an administrator user account that will be created on each compute node.",
"x-nullable": true
},
"subnet": {
"$ref": "#/definitions/ResourceId",
"title": "Subnet.",
"description": "Virtual network subnet resource ID the compute nodes belong to.",
"x-nullable": true
},
"remoteLoginPortPublicAccess": {
"type": "string",
"title": "Close remote Login Access Port",
"description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.",
"default": "NotSpecified",
"enum": [
"Enabled",
"Disabled",
"NotSpecified"
],
"x-ms-enum": {
"name": "RemoteLoginPortPublicAccess",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
},
{
"name": "NotSpecified",
"value": "NotSpecified"
}
]
}
},
"allocationState": {
"$ref": "#/definitions/AllocationState",
"title": "Allocation state.",
"description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.",
"readOnly": true
},
"allocationStateTransitionTime": {
"type": "string",
"format": "date-time",
"title": "Allocation state transition time.",
"description": "The time at which the compute entered its current allocation state.",
"readOnly": true
},
"errors": {
"type": "array",
"title": "Errors.",
"description": "Collection of errors encountered by various compute nodes during node setup.",
"x-nullable": true,
"items": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
},
"readOnly": true
},
"currentNodeCount": {
"type": "integer",
"format": "int32",
"title": "Current node count.",
"description": "The number of compute nodes currently assigned to the compute.",
"x-nullable": true,
"readOnly": true
},
"targetNodeCount": {
"type": "integer",
"format": "int32",
"title": "Target node count.",
"description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.",
"x-nullable": true,
"readOnly": true
},
"nodeStateCounts": {
"$ref": "#/definitions/NodeStateCounts",
"title": "Node state counts.",
"description": "Counts of various node states on the compute.",
"x-nullable": true,
"readOnly": true
},
"enableNodePublicIp": {
"type": "boolean",
"title": "Enable node public IP.",
"description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.",
"default": true,
"x-nullable": true
},
"propertyBag": {
"description": "A property bag containing additional properties.",
"x-nullable": true
}
}
},
"AmlToken": {
"type": "object",
"description": "AML Token identity configuration.",
"allOf": [
{
"$ref": "#/definitions/IdentityConfiguration"
}
],
"x-ms-discriminator-value": "AMLToken"
},
"AmlTokenComputeIdentity": {
"type": "object",
"description": "AML token compute identity definition.",
"allOf": [
{
"$ref": "#/definitions/MonitorComputeIdentityBase"
}
],
"x-ms-discriminator-value": "AmlToken"
},
"AmlUserFeature": {
"type": "object",
"description": "Features enabled for a workspace",
"properties": {
"id": {
"type": "string",
"description": "Specifies the feature ID"
},
"displayName": {
"type": "string",
"description": "Specifies the feature name"
},
"description": {
"type": "string",
"description": "Describes the feature for user experience"
}
}
},
"AnonymousAccessCredential": {
"type": "object",
"description": "Access credential with no credentials",
"allOf": [
{
"$ref": "#/definitions/DataReferenceCredential"
}
],
"x-ms-discriminator-value": "NoCredentials"
},
"ApiKeyAuthWorkspaceConnectionProperties": {
"type": "object",
"description": "This connection type covers the generic ApiKey auth connection categories, for examples:\nAzureOpenAI:\nCategory:= AzureOpenAI\nAuthType:= ApiKey (as type discriminator)\nCredentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\nTarget:= {ApiBase}\n\nCognitiveService:\nCategory:= CognitiveService\nAuthType:= ApiKey (as type discriminator)\nCredentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\nTarget:= ServiceRegion={serviceRegion}\n\nCognitiveSearch:\nCategory:= CognitiveSearch\nAuthType:= ApiKey (as type discriminator)\nCredentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey\nTarget:= {Endpoint}\n\nUse Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionApiKey"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "ApiKey"
},
"ArmResourceId": {
"type": "object",
"description": "ARM ResourceId of a resource",
"properties": {
"resourceId": {
"type": "string",
"description": "Arm ResourceId is in the format \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}\"\nor \"/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}\"",
"x-nullable": true
}
}
},
"AssetBase": {
"type": "object",
"properties": {
"isAnonymous": {
"type": "boolean",
"description": "If the name version are system generated (anonymous registration).",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"isArchived": {
"type": "boolean",
"description": "Is the asset archived?",
"default": false,
"x-ms-mutability": [
"read",
"update",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/ResourceBase"
}
]
},
"AssetContainer": {
"type": "object",
"properties": {
"isArchived": {
"type": "boolean",
"description": "Is the asset archived?",
"default": false,
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"latestVersion": {
"type": "string",
"description": "The latest version inside this container.",
"x-nullable": true,
"readOnly": true
},
"nextVersion": {
"type": "string",
"description": "The next auto incremental version",
"x-nullable": true,
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/ResourceBase"
}
]
},
"AssetProvisioningState": {
"type": "string",
"description": "Provisioning state of registry asset.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Creating",
"Updating",
"Deleting"
],
"x-ms-enum": {
"name": "AssetProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Canceled",
"value": "Canceled"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Deleting",
"value": "Deleting"
}
]
},
"readOnly": true
},
"AssetReferenceBase": {
"type": "object",
"description": "Base definition for asset references.",
"properties": {
"referenceType": {
"$ref": "#/definitions/ReferenceType",
"description": "[Required] Specifies the type of asset reference."
}
},
"discriminator": "referenceType",
"required": [
"referenceType"
]
},
"AssignedUser": {
"type": "object",
"description": "A user that can be assigned to a compute instance.",
"properties": {
"objectId": {
"type": "string",
"description": "User’s AAD Object Id."
},
"tenantId": {
"type": "string",
"description": "User’s AAD Tenant Id."
}
},
"required": [
"objectId",
"tenantId"
]
},
"AutoForecastHorizon": {
"type": "object",
"description": "Forecast horizon determined automatically by system.",
"allOf": [
{
"$ref": "#/definitions/ForecastHorizon"
}
],
"x-ms-discriminator-value": "Auto"
},
"AutoMLJob": {
"type": "object",
"description": "AutoMLJob class.\nUse this class for executing AutoML tasks like Classification/Regression etc.\nSee TaskType enum for all the tasks supported.",
"properties": {
"environmentId": {
"type": "string",
"description": "The ARM resource ID of the Environment specification for the job.\nThis is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"environmentVariables": {
"type": "object",
"description": "Environment variables included in the job.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"outputs": {
"type": "object",
"description": "Mapping of output data bindings used in the job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobOutput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"queueSettings": {
"$ref": "#/definitions/QueueSettings",
"description": "Queue settings for the job",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"resources": {
"$ref": "#/definitions/JobResourceConfiguration",
"description": "Compute Resource configuration for the job.",
"x-ms-mutability": [
"read",
"create"
]
},
"taskDetails": {
"$ref": "#/definitions/AutoMLVertical",
"description": "[Required] This represents scenario which can be one of Tables/NLP/Image"
}
},
"required": [
"taskDetails"
],
"allOf": [
{
"$ref": "#/definitions/JobBaseProperties"
}
],
"x-ms-discriminator-value": "AutoML"
},
"AutoMLVertical": {
"type": "object",
"description": "AutoML vertical class.\nBase class for AutoML verticals - TableVertical/ImageVertical/NLPVertical",
"properties": {
"logVerbosity": {
"type": "string",
"description": "Enum for setting log verbosity.",
"default": "Info",
"enum": [
"NotSet",
"Debug",
"Info",
"Warning",
"Error",
"Critical"
],
"x-ms-enum": {
"name": "LogVerbosity",
"modelAsString": true,
"values": [
{
"name": "NotSet",
"value": "NotSet",
"description": "No logs emitted."
},
{
"name": "Debug",
"value": "Debug",
"description": "Debug and above log statements logged."
},
{
"name": "Info",
"value": "Info",
"description": "Info and above log statements logged."
},
{
"name": "Warning",
"value": "Warning",
"description": "Warning and above log statements logged."
},
{
"name": "Error",
"value": "Error",
"description": "Error and above log statements logged."
},
{
"name": "Critical",
"value": "Critical",
"description": "Only critical statements logged."
}
]
}
},
"targetColumnName": {
"type": "string",
"description": "Target column name: This is prediction values column.\nAlso known as label column name in context of classification tasks.",
"x-nullable": true
},
"taskType": {
"$ref": "#/definitions/TaskType",
"description": "[Required] Task type for AutoMLJob.",
"x-ms-mutability": [
"read",
"create"
]
},
"trainingData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "[Required] Training data input."
}
},
"discriminator": "taskType",
"required": [
"taskType",
"trainingData"
]
},
"AutoNCrossValidations": {
"type": "object",
"description": "N-Cross validations determined automatically.",
"allOf": [
{
"$ref": "#/definitions/NCrossValidations"
}
],
"x-ms-discriminator-value": "Auto"
},
"AutoPauseProperties": {
"type": "object",
"description": "Auto pause properties",
"properties": {
"delayInMinutes": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"AutoScaleProperties": {
"type": "object",
"description": "Auto scale properties",
"properties": {
"minNodeCount": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
},
"maxNodeCount": {
"type": "integer",
"format": "int32"
}
}
},
"AutoSeasonality": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Seasonality"
}
],
"x-ms-discriminator-value": "Auto"
},
"AutoTargetLags": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/TargetLags"
}
],
"x-ms-discriminator-value": "Auto"
},
"AutoTargetRollingWindowSize": {
"type": "object",
"description": "Target lags rolling window determined automatically.",
"allOf": [
{
"$ref": "#/definitions/TargetRollingWindowSize"
}
],
"x-ms-discriminator-value": "Auto"
},
"Autosave": {
"type": "string",
"description": "Auto save settings.",
"enum": [
"None",
"Local",
"Remote"
],
"x-ms-enum": {
"name": "Autosave",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "Local",
"value": "Local"
},
{
"name": "Remote",
"value": "Remote"
}
]
}
},
"Azure.Core.uuid": {
"type": "string",
"format": "uuid",
"description": "Universally Unique Identifier"
},
"AzureBlobDatastore": {
"type": "object",
"description": "Azure Blob datastore configuration.",
"properties": {
"resourceGroup": {
"type": "string",
"description": "Azure Resource Group name",
"x-nullable": true
},
"subscriptionId": {
"type": "string",
"description": "Azure Subscription Id",
"x-nullable": true
},
"accountName": {
"type": "string",
"description": "Storage account name.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"containerName": {
"type": "string",
"description": "Storage account container name.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"endpoint": {
"type": "string",
"description": "Azure cloud endpoint for the storage account.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"protocol": {
"type": "string",
"description": "Protocol used to communicate with the storage account.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"serviceDataAccessAuthIdentity": {
"type": "string",
"description": "Indicates which identity to use to authenticate service data access to customer's storage.",
"default": "None",
"enum": [
"None",
"WorkspaceSystemAssignedIdentity",
"WorkspaceUserAssignedIdentity"
],
"x-ms-enum": {
"name": "ServiceDataAccessAuthIdentity",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Do not use any identity for service data access."
},
{
"name": "WorkspaceSystemAssignedIdentity",
"value": "WorkspaceSystemAssignedIdentity",
"description": "Use the system assigned managed identity of the Workspace to authenticate service data access."
},
{
"name": "WorkspaceUserAssignedIdentity",
"value": "WorkspaceUserAssignedIdentity",
"description": "Use the user assigned managed identity of the Workspace to authenticate service data access."
}
]
},
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/DatastoreProperties"
}
],
"x-ms-discriminator-value": "AzureBlob"
},
"AzureDataLakeGen1Datastore": {
"type": "object",
"description": "Azure Data Lake Gen1 datastore configuration.",
"properties": {
"resourceGroup": {
"type": "string",
"description": "Azure Resource Group name",
"x-nullable": true
},
"subscriptionId": {
"type": "string",
"description": "Azure Subscription Id",
"x-nullable": true
},
"serviceDataAccessAuthIdentity": {
"type": "string",
"description": "Indicates which identity to use to authenticate service data access to customer's storage.",
"default": "None",
"enum": [
"None",
"WorkspaceSystemAssignedIdentity",
"WorkspaceUserAssignedIdentity"
],
"x-ms-enum": {
"name": "ServiceDataAccessAuthIdentity",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Do not use any identity for service data access."
},
{
"name": "WorkspaceSystemAssignedIdentity",
"value": "WorkspaceSystemAssignedIdentity",
"description": "Use the system assigned managed identity of the Workspace to authenticate service data access."
},
{
"name": "WorkspaceUserAssignedIdentity",
"value": "WorkspaceUserAssignedIdentity",
"description": "Use the user assigned managed identity of the Workspace to authenticate service data access."
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"storeName": {
"type": "string",
"description": "[Required] Azure Data Lake store name.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"storeName"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreProperties"
}
],
"x-ms-discriminator-value": "AzureDataLakeGen1"
},
"AzureDataLakeGen2Datastore": {
"type": "object",
"description": "Azure Data Lake Gen2 datastore configuration.",
"properties": {
"resourceGroup": {
"type": "string",
"description": "Azure Resource Group name",
"x-nullable": true
},
"subscriptionId": {
"type": "string",
"description": "Azure Subscription Id",
"x-nullable": true
},
"accountName": {
"type": "string",
"description": "[Required] Storage account name.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"endpoint": {
"type": "string",
"description": "Azure cloud endpoint for the storage account.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"filesystem": {
"type": "string",
"description": "[Required] The name of the Data Lake Gen2 filesystem.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"protocol": {
"type": "string",
"description": "Protocol used to communicate with the storage account.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"serviceDataAccessAuthIdentity": {
"type": "string",
"description": "Indicates which identity to use to authenticate service data access to customer's storage.",
"default": "None",
"enum": [
"None",
"WorkspaceSystemAssignedIdentity",
"WorkspaceUserAssignedIdentity"
],
"x-ms-enum": {
"name": "ServiceDataAccessAuthIdentity",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Do not use any identity for service data access."
},
{
"name": "WorkspaceSystemAssignedIdentity",
"value": "WorkspaceSystemAssignedIdentity",
"description": "Use the system assigned managed identity of the Workspace to authenticate service data access."
},
{
"name": "WorkspaceUserAssignedIdentity",
"value": "WorkspaceUserAssignedIdentity",
"description": "Use the user assigned managed identity of the Workspace to authenticate service data access."
}
]
},
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"accountName",
"filesystem"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreProperties"
}
],
"x-ms-discriminator-value": "AzureDataLakeGen2"
},
"AzureDevOpsWebhook": {
"type": "object",
"description": "Webhook details specific for Azure DevOps",
"allOf": [
{
"$ref": "#/definitions/Webhook"
}
],
"x-ms-discriminator-value": "AzureDevOps"
},
"AzureFileDatastore": {
"type": "object",
"description": "Azure File datastore configuration.",
"properties": {
"resourceGroup": {
"type": "string",
"description": "Azure Resource Group name",
"x-nullable": true
},
"subscriptionId": {
"type": "string",
"description": "Azure Subscription Id",
"x-nullable": true
},
"accountName": {
"type": "string",
"description": "[Required] Storage account name.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"endpoint": {
"type": "string",
"description": "Azure cloud endpoint for the storage account.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"fileShareName": {
"type": "string",
"description": "[Required] The name of the Azure file share that the datastore points to.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"protocol": {
"type": "string",
"description": "Protocol used to communicate with the storage account.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"serviceDataAccessAuthIdentity": {
"type": "string",
"description": "Indicates which identity to use to authenticate service data access to customer's storage.",
"default": "None",
"enum": [
"None",
"WorkspaceSystemAssignedIdentity",
"WorkspaceUserAssignedIdentity"
],
"x-ms-enum": {
"name": "ServiceDataAccessAuthIdentity",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Do not use any identity for service data access."
},
{
"name": "WorkspaceSystemAssignedIdentity",
"value": "WorkspaceSystemAssignedIdentity",
"description": "Use the system assigned managed identity of the Workspace to authenticate service data access."
},
{
"name": "WorkspaceUserAssignedIdentity",
"value": "WorkspaceUserAssignedIdentity",
"description": "Use the user assigned managed identity of the Workspace to authenticate service data access."
}
]
},
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"accountName",
"fileShareName"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreProperties"
}
],
"x-ms-discriminator-value": "AzureFile"
},
"BanditPolicy": {
"type": "object",
"description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation",
"properties": {
"slackAmount": {
"type": "number",
"format": "float",
"description": "Absolute distance allowed from the best performing run.",
"default": 0
},
"slackFactor": {
"type": "number",
"format": "float",
"description": "Ratio of the allowed distance from the best performing run.",
"default": 0
}
},
"allOf": [
{
"$ref": "#/definitions/EarlyTerminationPolicy"
}
],
"x-ms-discriminator-value": "Bandit"
},
"BatchDeployment": {
"type": "object",
"description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/BatchDeploymentProperties",
"description": "[Required] Additional attributes of the entity."
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"kind": {
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
]
},
"BatchDeploymentConfiguration": {
"type": "object",
"description": "Properties relevant to different deployment types.",
"properties": {
"deploymentConfigurationType": {
"$ref": "#/definitions/BatchDeploymentConfigurationType",
"description": "[Required] The type of the deployment"
}
},
"discriminator": "deploymentConfigurationType",
"required": [
"deploymentConfigurationType"
]
},
"BatchDeploymentConfigurationType": {
"type": "string",
"description": "The enumerated property types for batch deployments.",
"enum": [
"Model",
"PipelineComponent"
],
"x-ms-enum": {
"name": "BatchDeploymentConfigurationType",
"modelAsString": true,
"values": [
{
"name": "Model",
"value": "Model"
},
{
"name": "PipelineComponent",
"value": "PipelineComponent"
}
]
}
},
"BatchDeploymentProperties": {
"type": "object",
"description": "Batch inference settings per deployment.",
"properties": {
"compute": {
"type": "string",
"description": "Compute target for batch inference operation.",
"x-nullable": true
},
"deploymentConfiguration": {
"$ref": "#/definitions/BatchDeploymentConfiguration",
"description": "Properties relevant to different deployment types.",
"x-nullable": true
},
"errorThreshold": {
"type": "integer",
"format": "int32",
"description": "Error threshold, if the error count for the entire input goes above this value,\nthe batch inference will be aborted. Range is [-1, int.MaxValue].\nFor FileDataset, this value is the count of file failures.\nFor TabularDataset, this value is the count of record failures.\nIf set to -1 (the lower bound), all failures during batch inference will be ignored.",
"default": -1
},
"loggingLevel": {
"type": "string",
"description": "Log verbosity for batch inferencing.\nIncreasing verbosity order for logging is : Warning, Info and Debug.\nThe default value is Info.",
"default": "Info",
"enum": [
"Info",
"Warning",
"Debug"
],
"x-ms-enum": {
"name": "BatchLoggingLevel",
"modelAsString": true,
"values": [
{
"name": "Info",
"value": "Info"
},
{
"name": "Warning",
"value": "Warning"
},
{
"name": "Debug",
"value": "Debug"
}
]
}
},
"maxConcurrencyPerInstance": {
"type": "integer",
"format": "int32",
"description": "Indicates maximum number of parallelism per instance.",
"default": 1
},
"miniBatchSize": {
"type": "integer",
"format": "int64",
"description": "Size of the mini-batch passed to each batch invocation.\nFor FileDataset, this is the number of files per mini-batch.\nFor TabularDataset, this is the size of the records in bytes, per mini-batch.",
"default": 10
},
"model": {
"$ref": "#/definitions/AssetReferenceBase",
"description": "Reference to the model asset for the endpoint deployment.",
"x-nullable": true
},
"outputAction": {
"type": "string",
"description": "Enum to determine how batch inferencing will handle output",
"default": "AppendRow",
"enum": [
"SummaryOnly",
"AppendRow"
],
"x-ms-enum": {
"name": "BatchOutputAction",
"modelAsString": true,
"values": [
{
"name": "SummaryOnly",
"value": "SummaryOnly"
},
{
"name": "AppendRow",
"value": "AppendRow"
}
]
}
},
"outputFileName": {
"type": "string",
"description": "Customized output file name for append_row output action.",
"default": "predictions.csv"
},
"provisioningState": {
"$ref": "#/definitions/DeploymentProvisioningState",
"description": "Provisioning state for the endpoint deployment.",
"readOnly": true
},
"resources": {
"$ref": "#/definitions/DeploymentResourceConfiguration",
"description": "Indicates compute configuration for the job.\nIf not provided, will default to the defaults defined in ResourceConfiguration.",
"x-nullable": true
},
"retrySettings": {
"$ref": "#/definitions/BatchRetrySettings",
"description": "Retry Settings for the batch inference operation.\nIf not provided, will default to the defaults defined in BatchRetrySettings.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/EndpointDeploymentPropertiesBase"
}
]
},
"BatchDeploymentTrackedResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of BatchDeployment entities.",
"properties": {
"value": {
"type": "array",
"description": "The BatchDeployment items on this page",
"items": {
"$ref": "#/definitions/BatchDeployment"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"BatchEndpoint": {
"type": "object",
"description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/BatchEndpointProperties",
"description": "[Required] Additional attributes of the entity."
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"kind": {
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
]
},
"BatchEndpointDefaults": {
"type": "object",
"description": "Batch endpoint default values",
"properties": {
"deploymentName": {
"type": "string",
"description": "Name of the deployment that will be default for the endpoint.\nThis deployment will end up getting 100% traffic when the endpoint scoring URL is invoked.",
"x-nullable": true
}
}
},
"BatchEndpointProperties": {
"type": "object",
"description": "Batch endpoint configuration.",
"properties": {
"defaults": {
"$ref": "#/definitions/BatchEndpointDefaults",
"description": "Default values for Batch Endpoint",
"x-nullable": true
},
"provisioningState": {
"$ref": "#/definitions/EndpointProvisioningState",
"description": "Provisioning state for the endpoint.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/EndpointPropertiesBase"
}
]
},
"BatchEndpointTrackedResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of BatchEndpoint entities.",
"properties": {
"value": {
"type": "array",
"description": "The BatchEndpoint items on this page",
"items": {
"$ref": "#/definitions/BatchEndpoint"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"BatchPipelineComponentDeploymentConfiguration": {
"type": "object",
"description": "Properties for a Batch Pipeline Component Deployment.",
"properties": {
"componentId": {
"$ref": "#/definitions/IdAssetReference",
"description": "The ARM id of the component to be run.",
"x-nullable": true
},
"description": {
"type": "string",
"description": "The description which will be applied to the job.",
"x-nullable": true
},
"settings": {
"type": "object",
"description": "Run-time settings for the pipeline job.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"tags": {
"type": "object",
"description": "The tags which will be applied to the job.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
},
"allOf": [
{
"$ref": "#/definitions/BatchDeploymentConfiguration"
}
],
"x-ms-discriminator-value": "PipelineComponent"
},
"BatchRetrySettings": {
"type": "object",
"description": "Retry settings for a batch inference operation.",
"properties": {
"maxRetries": {
"type": "integer",
"format": "int32",
"description": "Maximum retry count for a mini-batch",
"default": 3
},
"timeout": {
"type": "string",
"format": "duration",
"description": "Invocation timeout for a mini-batch, in ISO 8601 format.",
"default": "PT30S"
}
}
},
"BayesianSamplingAlgorithm": {
"type": "object",
"description": "Defines a Sampling Algorithm that generates values based on previous values",
"allOf": [
{
"$ref": "#/definitions/SamplingAlgorithm"
}
],
"x-ms-discriminator-value": "Bayesian"
},
"BillingCurrency": {
"type": "string",
"description": "Three lettered code specifying the currency of the VM price. Example: USD",
"enum": [
"USD"
],
"x-ms-enum": {
"name": "BillingCurrency",
"modelAsString": true,
"values": [
{
"name": "USD",
"value": "USD"
}
]
}
},
"BindOptions": {
"type": "object",
"properties": {
"propagation": {
"type": "string",
"description": "Type of Bind Option",
"x-nullable": true
},
"createHostPath": {
"type": "boolean",
"description": "Indicate whether to create host path.",
"x-nullable": true
},
"selinux": {
"type": "string",
"description": "Mention the selinux options.",
"x-nullable": true
}
}
},
"BlobReferenceForConsumptionDto": {
"type": "object",
"properties": {
"blobUri": {
"type": "string",
"format": "uri",
"description": "Blob URI path for client to upload data.\nExample: https://blob.windows.core.net/Container/Path",
"x-nullable": true
},
"credential": {
"$ref": "#/definitions/PendingUploadCredentialDto",
"description": "Credential info to access storage account",
"x-nullable": true
},
"storageAccountArmId": {
"type": "string",
"description": "Arm ID of the storage account to use",
"x-nullable": true
}
}
},
"BlockedTransformers": {
"type": "string",
"description": "Enum for all classification models supported by AutoML.",
"enum": [
"TextTargetEncoder",
"OneHotEncoder",
"CatTargetEncoder",
"TfIdf",
"WoETargetEncoder",
"LabelEncoder",
"WordEmbedding",
"NaiveBayes",
"CountVectorizer",
"HashOneHotEncoder"
],
"x-ms-enum": {
"name": "BlockedTransformers",
"modelAsString": true,
"values": [
{
"name": "TextTargetEncoder",
"value": "TextTargetEncoder",
"description": "Target encoding for text data."
},
{
"name": "OneHotEncoder",
"value": "OneHotEncoder",
"description": "Ohe hot encoding creates a binary feature transformation."
},
{
"name": "CatTargetEncoder",
"value": "CatTargetEncoder",
"description": "Target encoding for categorical data."
},
{
"name": "TfIdf",
"value": "TfIdf",
"description": "Tf-Idf stands for, term-frequency times inverse document-frequency. This is a common term weighting scheme for identifying information from documents."
},
{
"name": "WoETargetEncoder",
"value": "WoETargetEncoder",
"description": "Weight of Evidence encoding is a technique used to encode categorical variables. It uses the natural log of the P(1)/P(0) to create weights."
},
{
"name": "LabelEncoder",
"value": "LabelEncoder",
"description": "Label encoder converts labels/categorical variables in a numerical form."
},
{
"name": "WordEmbedding",
"value": "WordEmbedding",
"description": "Word embedding helps represents words or phrases as a vector, or a series of numbers."
},
{
"name": "NaiveBayes",
"value": "NaiveBayes",
"description": "Naive Bayes is a classified that is used for classification of discrete features that are categorically distributed."
},
{
"name": "CountVectorizer",
"value": "CountVectorizer",
"description": "Count Vectorizer converts a collection of text documents to a matrix of token counts."
},
{
"name": "HashOneHotEncoder",
"value": "HashOneHotEncoder",
"description": "Hashing One Hot Encoder can turn categorical variables into a limited number of new features. This is often used for high-cardinality categorical features."
}
]
}
},
"BuildContext": {
"type": "object",
"description": "Configuration settings for Docker build context",
"properties": {
"contextUri": {
"type": "string",
"description": "[Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs.\n",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"dockerfilePath": {
"type": "string",
"description": "Path to the Dockerfile in the build context.\n",
"default": "Dockerfile",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"contextUri"
]
},
"Caching": {
"type": "string",
"description": "Caching type of Data Disk.",
"enum": [
"None",
"ReadOnly",
"ReadWrite"
],
"x-ms-enum": {
"name": "Caching",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "ReadOnly",
"value": "ReadOnly"
},
{
"name": "ReadWrite",
"value": "ReadWrite"
}
]
}
},
"CapabilityHost": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/CapabilityHostProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"CapabilityHostListResult": {
"type": "object",
"description": "The response of a CapabilityHost list operation.",
"properties": {
"value": {
"type": "array",
"description": "The CapabilityHost items on this page",
"items": {
"$ref": "#/definitions/CapabilityHost"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"CapabilityHostProperties": {
"type": "object",
"properties": {
"acaEnvironmentConnections": {
"type": "array",
"description": "List of Aca Environment connections.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"aiServicesConnections": {
"type": "array",
"description": "List of AI services connections.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"capabilityHostKind": {
"type": "string",
"description": "Kind of this capability host.",
"default": "Agents",
"enum": [
"Agents"
],
"x-ms-enum": {
"name": "CapabilityHostKind",
"modelAsString": true,
"values": [
{
"name": "Agents",
"value": "Agents"
}
]
}
},
"customerSubnet": {
"type": "string",
"description": "Customer subnet info to help set up this capability host.",
"x-nullable": true
},
"provisioningState": {
"$ref": "#/definitions/CapabilityHostProvisioningState",
"description": "Provisioning state for the CapabilityHost.",
"readOnly": true
},
"storageConnections": {
"type": "array",
"description": "List of Storage connections.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"threadStorageConnections": {
"type": "array",
"description": "List of Thread storage connections.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"vectorStoreConnections": {
"type": "array",
"description": "List of VectorStore connections.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"messages": {
"type": "array",
"description": "List of messages containing errors.",
"x-nullable": true,
"items": {
"type": "string"
},
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/ResourceBase"
}
]
},
"CapabilityHostProvisioningState": {
"type": "string",
"description": "Provisioning state of capability host.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Creating",
"Updating",
"Deleting"
],
"x-ms-enum": {
"name": "CapabilityHostProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Canceled",
"value": "Canceled"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Deleting",
"value": "Deleting"
}
]
},
"readOnly": true
},
"CategoricalDataDriftMetric": {
"type": "string",
"enum": [
"JensenShannonDistance",
"PopulationStabilityIndex",
"PearsonsChiSquaredTest"
],
"x-ms-enum": {
"name": "CategoricalDataDriftMetric",
"modelAsString": true,
"values": [
{
"name": "JensenShannonDistance",
"value": "JensenShannonDistance",
"description": "The Jensen Shannon Distance (JSD) metric."
},
{
"name": "PopulationStabilityIndex",
"value": "PopulationStabilityIndex",
"description": "The Population Stability Index (PSI) metric."
},
{
"name": "PearsonsChiSquaredTest",
"value": "PearsonsChiSquaredTest",
"description": "The Pearsons Chi Squared Test metric."
}
]
}
},
"CategoricalDataDriftMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"$ref": "#/definitions/CategoricalDataDriftMetric",
"description": "[Required] The categorical data drift metric to calculate.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metric"
],
"allOf": [
{
"$ref": "#/definitions/DataDriftMetricThresholdBase"
}
],
"x-ms-discriminator-value": "Categorical"
},
"CategoricalDataQualityMetric": {
"type": "string",
"enum": [
"NullValueRate",
"DataTypeErrorRate",
"OutOfBoundsRate"
],
"x-ms-enum": {
"name": "CategoricalDataQualityMetric",
"modelAsString": true,
"values": [
{
"name": "NullValueRate",
"value": "NullValueRate",
"description": "Calculates the rate of null values."
},
{
"name": "DataTypeErrorRate",
"value": "DataTypeErrorRate",
"description": "Calculates the rate of data type errors."
},
{
"name": "OutOfBoundsRate",
"value": "OutOfBoundsRate",
"description": "Calculates the rate values are out of bounds."
}
]
}
},
"CategoricalDataQualityMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"$ref": "#/definitions/CategoricalDataQualityMetric",
"description": "[Required] The categorical data quality metric to calculate.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metric"
],
"allOf": [
{
"$ref": "#/definitions/DataQualityMetricThresholdBase"
}
],
"x-ms-discriminator-value": "Categorical"
},
"CategoricalPredictionDriftMetric": {
"type": "string",
"enum": [
"JensenShannonDistance",
"PopulationStabilityIndex",
"PearsonsChiSquaredTest"
],
"x-ms-enum": {
"name": "CategoricalPredictionDriftMetric",
"modelAsString": true,
"values": [
{
"name": "JensenShannonDistance",
"value": "JensenShannonDistance",
"description": "The Jensen Shannon Distance (JSD) metric."
},
{
"name": "PopulationStabilityIndex",
"value": "PopulationStabilityIndex",
"description": "The Population Stability Index (PSI) metric."
},
{
"name": "PearsonsChiSquaredTest",
"value": "PearsonsChiSquaredTest",
"description": "The Pearsons Chi Squared Test metric."
}
]
}
},
"CategoricalPredictionDriftMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"$ref": "#/definitions/CategoricalPredictionDriftMetric",
"description": "[Required] The categorical prediction drift metric to calculate.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metric"
],
"allOf": [
{
"$ref": "#/definitions/PredictionDriftMetricThresholdBase"
}
],
"x-ms-discriminator-value": "Categorical"
},
"CertificateDatastoreCredentials": {
"type": "object",
"description": "Certificate datastore credentials configuration.",
"properties": {
"authorityUrl": {
"type": "string",
"description": "Authority URL used for authentication.",
"x-nullable": true
},
"clientId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "[Required] Service principal client ID."
},
"resourceUrl": {
"type": "string",
"description": "Resource the service principal has access to.",
"x-nullable": true
},
"secrets": {
"$ref": "#/definitions/CertificateDatastoreSecrets",
"format": "password",
"description": "[Required] Service principal secrets.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
},
"tenantId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "[Required] ID of the tenant to which the service principal belongs."
},
"thumbprint": {
"type": "string",
"description": "[Required] Thumbprint of the certificate used for authentication.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"clientId",
"secrets",
"tenantId",
"thumbprint"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreCredentials"
}
],
"x-ms-discriminator-value": "Certificate"
},
"CertificateDatastoreSecrets": {
"type": "object",
"description": "Datastore certificate secrets.",
"properties": {
"certificate": {
"type": "string",
"description": "Service principal certificate.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DatastoreSecrets"
}
],
"x-ms-discriminator-value": "Certificate"
},
"Classification": {
"type": "object",
"description": "Classification task in AutoML Table vertical.",
"properties": {
"cvSplitColumnNames": {
"type": "array",
"description": "Columns to use for CVSplit data.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"featurizationSettings": {
"$ref": "#/definitions/TableVerticalFeaturizationSettings",
"description": "Featurization inputs needed for AutoML job.",
"x-nullable": true
},
"limitSettings": {
"$ref": "#/definitions/TableVerticalLimitSettings",
"description": "Execution constraints for AutoMLJob.",
"x-nullable": true
},
"nCrossValidations": {
"$ref": "#/definitions/NCrossValidations",
"description": "Number of cross validation folds to be applied on training dataset\nwhen validation dataset is not provided.",
"x-nullable": true
},
"testData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Test data input.",
"x-nullable": true
},
"testDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of test dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"validationDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of training dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"weightColumnName": {
"type": "string",
"description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.",
"x-nullable": true
},
"positiveLabel": {
"type": "string",
"description": "Positive label for binary metrics calculation.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for classification tasks.",
"default": "AUCWeighted",
"enum": [
"AUCWeighted",
"Accuracy",
"NormMacroRecall",
"AveragePrecisionScoreWeighted",
"PrecisionScoreWeighted"
],
"x-ms-enum": {
"name": "ClassificationPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "AUCWeighted",
"value": "AUCWeighted",
"description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class."
},
{
"name": "Accuracy",
"value": "Accuracy",
"description": "Accuracy is the ratio of predictions that exactly match the true class labels."
},
{
"name": "NormMacroRecall",
"value": "NormMacroRecall",
"description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1."
},
{
"name": "AveragePrecisionScoreWeighted",
"value": "AveragePrecisionScoreWeighted",
"description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class."
},
{
"name": "PrecisionScoreWeighted",
"value": "PrecisionScoreWeighted",
"description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class."
}
]
}
},
"trainingSettings": {
"$ref": "#/definitions/ClassificationTrainingSettings",
"description": "Inputs for training phase for an AutoML Job.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "Classification"
},
"ClassificationModels": {
"type": "string",
"description": "Enum for all classification models supported by AutoML.",
"enum": [
"LogisticRegression",
"SGD",
"MultinomialNaiveBayes",
"BernoulliNaiveBayes",
"SVM",
"LinearSVM",
"KNN",
"DecisionTree",
"RandomForest",
"ExtremeRandomTrees",
"LightGBM",
"GradientBoosting",
"XGBoostClassifier"
],
"x-ms-enum": {
"name": "ClassificationModels",
"modelAsString": true,
"values": [
{
"name": "LogisticRegression",
"value": "LogisticRegression",
"description": "Logistic regression is a fundamental classification technique.\nIt belongs to the group of linear classifiers and is somewhat similar to polynomial and linear regression.\nLogistic regression is fast and relatively uncomplicated, and it's convenient for you to interpret the results.\nAlthough it's essentially a method for binary classification, it can also be applied to multiclass problems."
},
{
"name": "SGD",
"value": "SGD",
"description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs."
},
{
"name": "MultinomialNaiveBayes",
"value": "MultinomialNaiveBayes",
"description": "The multinomial Naive Bayes classifier is suitable for classification with discrete features (e.g., word counts for text classification).\nThe multinomial distribution normally requires integer feature counts. However, in practice, fractional counts such as tf-idf may also work."
},
{
"name": "BernoulliNaiveBayes",
"value": "BernoulliNaiveBayes",
"description": "Naive Bayes classifier for multivariate Bernoulli models."
},
{
"name": "SVM",
"value": "SVM",
"description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text."
},
{
"name": "LinearSVM",
"value": "LinearSVM",
"description": "A support vector machine (SVM) is a supervised machine learning model that uses classification algorithms for two-group classification problems.\nAfter giving an SVM model sets of labeled training data for each category, they're able to categorize new text.\nLinear SVM performs best when input data is linear, i.e., data can be easily classified by drawing the straight line between classified values on a plotted graph."
},
{
"name": "KNN",
"value": "KNN",
"description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set."
},
{
"name": "DecisionTree",
"value": "DecisionTree",
"description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features."
},
{
"name": "RandomForest",
"value": "RandomForest",
"description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the \"bagging\" method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result."
},
{
"name": "ExtremeRandomTrees",
"value": "ExtremeRandomTrees",
"description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm."
},
{
"name": "LightGBM",
"value": "LightGBM",
"description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms."
},
{
"name": "GradientBoosting",
"value": "GradientBoosting",
"description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution."
},
{
"name": "XGBoostClassifier",
"value": "XGBoostClassifier",
"description": "XGBoost: Extreme Gradient Boosting Algorithm. This algorithm is used for structured data where target column values can be divided into distinct class values."
}
]
}
},
"ClassificationMultilabelPrimaryMetrics": {
"type": "string",
"description": "Primary metrics for classification multilabel tasks.",
"enum": [
"AUCWeighted",
"Accuracy",
"NormMacroRecall",
"AveragePrecisionScoreWeighted",
"PrecisionScoreWeighted",
"IOU"
],
"x-ms-enum": {
"name": "ClassificationMultilabelPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "AUCWeighted",
"value": "AUCWeighted",
"description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class."
},
{
"name": "Accuracy",
"value": "Accuracy",
"description": "Accuracy is the ratio of predictions that exactly match the true class labels."
},
{
"name": "NormMacroRecall",
"value": "NormMacroRecall",
"description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1."
},
{
"name": "AveragePrecisionScoreWeighted",
"value": "AveragePrecisionScoreWeighted",
"description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class."
},
{
"name": "PrecisionScoreWeighted",
"value": "PrecisionScoreWeighted",
"description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class."
},
{
"name": "IOU",
"value": "IOU",
"description": "Intersection Over Union. Intersection of predictions divided by union of predictions."
}
]
}
},
"ClassificationPrimaryMetrics": {
"type": "string",
"description": "Primary metrics for classification tasks.",
"enum": [
"AUCWeighted",
"Accuracy",
"NormMacroRecall",
"AveragePrecisionScoreWeighted",
"PrecisionScoreWeighted"
],
"x-ms-enum": {
"name": "ClassificationPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "AUCWeighted",
"value": "AUCWeighted",
"description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class."
},
{
"name": "Accuracy",
"value": "Accuracy",
"description": "Accuracy is the ratio of predictions that exactly match the true class labels."
},
{
"name": "NormMacroRecall",
"value": "NormMacroRecall",
"description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1."
},
{
"name": "AveragePrecisionScoreWeighted",
"value": "AveragePrecisionScoreWeighted",
"description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class."
},
{
"name": "PrecisionScoreWeighted",
"value": "PrecisionScoreWeighted",
"description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class."
}
]
}
},
"ClassificationTrainingSettings": {
"type": "object",
"description": "Classification Training related configuration.",
"properties": {
"allowedTrainingAlgorithms": {
"type": "array",
"description": "Allowed models for classification task.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ClassificationModels"
}
},
"blockedTrainingAlgorithms": {
"type": "array",
"description": "Blocked models for classification task.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ClassificationModels"
}
}
},
"allOf": [
{
"$ref": "#/definitions/TrainingSettings"
}
]
},
"ClusterUpdateParameters": {
"type": "object",
"description": "AmlCompute update parameters.",
"properties": {
"properties": {
"$ref": "#/definitions/ClusterUpdateProperties",
"description": "The properties of the amlCompute.",
"x-ms-client-flatten": true
}
}
},
"ClusterUpdateProperties": {
"type": "object",
"description": "The properties of a amlCompute that need to be updated.",
"properties": {
"properties": {
"$ref": "#/definitions/ScaleSettingsInformation",
"description": "Properties of ClusterUpdate"
}
}
},
"CodeConfiguration": {
"type": "object",
"description": "Configuration for a scoring code asset.",
"properties": {
"codeId": {
"type": "string",
"description": "ARM resource ID of the code asset.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"scoringScript": {
"type": "string",
"description": "[Required] The script to execute on startup. eg. \"score.py\"",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"scoringScript"
]
},
"CodeContainer": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/CodeContainerProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"CodeContainerProperties": {
"type": "object",
"description": "Container for code asset versions.",
"properties": {
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the code container.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetContainer"
}
]
},
"CodeContainerResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of CodeContainer entities.",
"properties": {
"value": {
"type": "array",
"description": "The CodeContainer items on this page",
"items": {
"$ref": "#/definitions/CodeContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"CodeVersion": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/CodeVersionProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"CodeVersionProperties": {
"type": "object",
"description": "Code asset version details.",
"properties": {
"codeUri": {
"type": "string",
"description": "Uri where code is located",
"x-nullable": true
},
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the code version.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetBase"
}
]
},
"CodeVersionResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of CodeVersion entities.",
"properties": {
"value": {
"type": "array",
"description": "The CodeVersion items on this page",
"items": {
"$ref": "#/definitions/CodeVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"Collection": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth.",
"x-nullable": true
},
"dataCollectionMode": {
"type": "string",
"description": "Enable or disable data collection.",
"default": "Disabled",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "DataCollectionMode",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"dataId": {
"type": "string",
"description": "The data asset arm resource id. Client side will ensure data asset is pointing to the blob storage, and backend will collect data to the blob storage.",
"x-nullable": true
},
"samplingRate": {
"type": "number",
"format": "double",
"description": "The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default.",
"default": 1
}
}
},
"ColumnTransformer": {
"type": "object",
"description": "Column transformer parameters.",
"properties": {
"fields": {
"type": "array",
"description": "Fields to apply transformer logic on.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"parameters": {
"description": "Different properties to be passed to transformer.\nInput expected is dictionary of key,value pairs in JSON format.",
"x-nullable": true
}
}
},
"CommandJob": {
"type": "object",
"description": "Command job definition.",
"properties": {
"codeId": {
"type": "string",
"description": "ARM resource ID of the code asset.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"command": {
"type": "string",
"description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"distribution": {
"$ref": "#/definitions/DistributionConfiguration",
"description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"environmentId": {
"type": "string",
"description": "[Required] The ARM resource ID of the Environment specification for the job.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"environmentVariables": {
"type": "object",
"description": "Environment variables included in the job.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"inputs": {
"type": "object",
"description": "Mapping of input data bindings used in the job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobInput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"limits": {
"$ref": "#/definitions/CommandJobLimits",
"description": "Command Job limit.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"outputs": {
"type": "object",
"description": "Mapping of output data bindings used in the job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobOutput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"parameters": {
"description": "Input parameters.",
"x-nullable": true,
"readOnly": true
},
"queueSettings": {
"$ref": "#/definitions/QueueSettings",
"description": "Queue settings for the job",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"resources": {
"$ref": "#/definitions/JobResourceConfiguration",
"description": "Compute Resource configuration for the job.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"command",
"environmentId"
],
"allOf": [
{
"$ref": "#/definitions/JobBaseProperties"
}
],
"x-ms-discriminator-value": "Command"
},
"CommandJobLimits": {
"type": "object",
"description": "Command Job limit class.",
"allOf": [
{
"$ref": "#/definitions/JobLimits"
}
],
"x-ms-discriminator-value": "Command"
},
"ComponentContainer": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/ComponentContainerProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"ComponentContainerProperties": {
"type": "object",
"description": "Component container definition.\n",
"properties": {
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the component container.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetContainer"
}
]
},
"ComponentContainerResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of ComponentContainer entities.",
"properties": {
"value": {
"type": "array",
"description": "The ComponentContainer items on this page",
"items": {
"$ref": "#/definitions/ComponentContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ComponentVersion": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/ComponentVersionProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"ComponentVersionProperties": {
"type": "object",
"description": "Definition of a component version: defines resources that span component types.",
"properties": {
"componentSpec": {
"description": "Defines Component definition details.\n",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the component version.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetBase"
}
]
},
"ComponentVersionResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of ComponentVersion entities.",
"properties": {
"value": {
"type": "array",
"description": "The ComponentVersion items on this page",
"items": {
"$ref": "#/definitions/ComponentVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"Compute": {
"type": "object",
"description": "Machine Learning compute object.",
"properties": {
"computeType": {
"$ref": "#/definitions/ComputeType",
"description": "The type of compute"
},
"computeLocation": {
"type": "string",
"description": "Location for the underlying compute",
"x-ms-mutability": [
"read",
"create"
]
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.",
"readOnly": true
},
"description": {
"type": "string",
"description": "The description of the Machine Learning compute.",
"x-nullable": true
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The time at which the compute was created.",
"readOnly": true
},
"modifiedOn": {
"type": "string",
"format": "date-time",
"description": "The time at which the compute was last modified.",
"readOnly": true
},
"resourceId": {
"type": "string",
"description": "ARM resource id of the underlying compute",
"x-nullable": true
},
"provisioningErrors": {
"type": "array",
"description": "Errors during provisioning",
"x-nullable": true,
"items": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
},
"readOnly": true
},
"isAttachedCompute": {
"type": "boolean",
"description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.",
"readOnly": true
},
"disableLocalAuth": {
"type": "boolean",
"description": "Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "computeType",
"required": [
"computeType"
]
},
"ComputeInstance": {
"type": "object",
"description": "An Azure Machine Learning compute instance.",
"properties": {
"properties": {
"$ref": "#/definitions/ComputeInstanceProperties",
"description": "Properties of ComputeInstance"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "ComputeInstance"
},
"ComputeInstanceApplication": {
"type": "object",
"description": "Defines an Aml Instance application and its connectivity endpoint URI.",
"properties": {
"displayName": {
"type": "string",
"description": "Name of the ComputeInstance application."
},
"endpointUri": {
"type": "string",
"description": "Application' endpoint URI."
}
}
},
"ComputeInstanceConnectivityEndpoints": {
"type": "object",
"description": "Defines all connectivity endpoints and properties for an ComputeInstance.",
"properties": {
"publicIpAddress": {
"type": "string",
"description": "Public IP Address of this ComputeInstance.",
"x-nullable": true,
"readOnly": true
},
"privateIpAddress": {
"type": "string",
"description": "Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).",
"x-nullable": true,
"readOnly": true
}
}
},
"ComputeInstanceContainer": {
"type": "object",
"description": "Defines an Aml Instance container.",
"properties": {
"name": {
"type": "string",
"description": "Name of the ComputeInstance container."
},
"autosave": {
"$ref": "#/definitions/Autosave",
"description": "Auto save settings."
},
"gpu": {
"type": "string",
"description": "Information of GPU."
},
"network": {
"$ref": "#/definitions/Network",
"description": "network of this container."
},
"environment": {
"$ref": "#/definitions/ComputeInstanceEnvironmentInfo",
"description": "Environment information of this container."
},
"services": {
"type": "array",
"description": "services of this containers.",
"items": {},
"readOnly": true
}
}
},
"ComputeInstanceCreatedBy": {
"type": "object",
"description": "Describes information on user who created this ComputeInstance.",
"properties": {
"userName": {
"type": "string",
"description": "Name of the user.",
"x-nullable": true,
"readOnly": true
},
"userOrgId": {
"type": "string",
"description": "Uniquely identifies user' Azure Active Directory organization.",
"readOnly": true
},
"userId": {
"type": "string",
"description": "Uniquely identifies the user within his/her organization.",
"x-nullable": true,
"readOnly": true
}
}
},
"ComputeInstanceDataDisk": {
"type": "object",
"description": "Defines an Aml Instance DataDisk.",
"properties": {
"caching": {
"$ref": "#/definitions/Caching",
"description": "Caching type of Data Disk."
},
"diskSizeGB": {
"type": "integer",
"format": "int32",
"title": "The initial disk size in gigabytes.",
"description": "The initial disk size in gigabytes."
},
"lun": {
"type": "integer",
"format": "int32",
"title": "The logical unit number.",
"description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun."
},
"storageAccountType": {
"type": "string",
"description": "type of this storage account.",
"default": "Standard_LRS",
"enum": [
"Standard_LRS",
"Premium_LRS"
],
"x-ms-enum": {
"name": "StorageAccountType",
"modelAsString": true,
"values": [
{
"name": "Standard_LRS",
"value": "Standard_LRS"
},
{
"name": "Premium_LRS",
"value": "Premium_LRS"
}
]
}
}
}
},
"ComputeInstanceDataMount": {
"type": "object",
"description": "Defines an Aml Instance DataMount.",
"properties": {
"source": {
"type": "string",
"description": "Source of the ComputeInstance data mount."
},
"sourceType": {
"$ref": "#/definitions/SourceType",
"description": "Data source type."
},
"mountName": {
"type": "string",
"description": "name of the ComputeInstance data mount."
},
"mountAction": {
"$ref": "#/definitions/MountAction",
"description": "Mount Action."
},
"mountMode": {
"$ref": "#/definitions/MountMode",
"description": "Mount Mode."
},
"createdBy": {
"type": "string",
"description": "who this data mount created by."
},
"mountPath": {
"type": "string",
"description": "Path of this data mount."
},
"mountState": {
"$ref": "#/definitions/MountState",
"description": "Mount state."
},
"mountedOn": {
"type": "string",
"format": "date-time",
"title": "Mounted time.",
"description": "The time when the disk mounted."
},
"error": {
"type": "string",
"description": "Error of this data mount."
}
}
},
"ComputeInstanceEnvironmentInfo": {
"type": "object",
"description": "Environment information",
"properties": {
"name": {
"type": "string",
"description": "name of environment."
},
"version": {
"type": "string",
"description": "version of environment."
}
}
},
"ComputeInstanceLastOperation": {
"type": "object",
"description": "The last operation on ComputeInstance.",
"properties": {
"operationName": {
"$ref": "#/definitions/OperationName",
"description": "Name of the last operation."
},
"operationTime": {
"type": "string",
"format": "date-time",
"description": "Time of the last operation."
},
"operationStatus": {
"$ref": "#/definitions/OperationStatus",
"description": "Operation status."
},
"operationTrigger": {
"$ref": "#/definitions/OperationTrigger",
"description": "Trigger of operation."
}
}
},
"ComputeInstanceProperties": {
"type": "object",
"description": "Compute Instance properties",
"properties": {
"vmSize": {
"type": "string",
"description": "Virtual Machine Size"
},
"subnet": {
"$ref": "#/definitions/ResourceId",
"title": "Subnet.",
"description": "Virtual network subnet resource ID the compute nodes belong to.",
"x-nullable": true
},
"applicationSharingPolicy": {
"type": "string",
"title": "Sharing policy for applications on this compute instance",
"description": "Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.",
"default": "Shared",
"enum": [
"Personal",
"Shared"
],
"x-ms-enum": {
"name": "ApplicationSharingPolicy",
"modelAsString": true,
"values": [
{
"name": "Personal",
"value": "Personal"
},
{
"name": "Shared",
"value": "Shared"
}
]
}
},
"sshSettings": {
"$ref": "#/definitions/ComputeInstanceSshSettings",
"description": "Specifies policy and settings for SSH access.",
"x-nullable": true
},
"customServices": {
"type": "array",
"description": "List of Custom Services added to the compute.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/CustomService"
}
},
"osImageMetadata": {
"$ref": "#/definitions/ImageMetadata",
"description": "Returns metadata about the operating system image for this compute instance.",
"readOnly": true
},
"connectivityEndpoints": {
"$ref": "#/definitions/ComputeInstanceConnectivityEndpoints",
"description": "Describes all connectivity endpoints available for this ComputeInstance.",
"readOnly": true
},
"applications": {
"type": "array",
"description": "Describes available applications and their endpoints on this ComputeInstance.",
"items": {
"$ref": "#/definitions/ComputeInstanceApplication"
},
"readOnly": true,
"x-ms-identifiers": [
"displayName"
]
},
"createdBy": {
"$ref": "#/definitions/ComputeInstanceCreatedBy",
"description": "Describes information on user who created this ComputeInstance.",
"readOnly": true
},
"errors": {
"type": "array",
"title": "Errors.",
"description": "Collection of errors encountered on this ComputeInstance.",
"items": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
},
"readOnly": true,
"x-ms-identifiers": [
"/error/code"
]
},
"state": {
"$ref": "#/definitions/ComputeInstanceState",
"description": "The current state of this ComputeInstance.",
"readOnly": true
},
"computeInstanceAuthorizationType": {
"type": "string",
"title": "Compute Instance Authorization type.",
"description": "The Compute Instance Authorization type. Available values are personal (default).",
"default": "personal",
"enum": [
"personal"
],
"x-ms-enum": {
"modelAsString": true,
"values": [
{
"name": "personal",
"value": "personal"
}
]
},
"x-nullable": true
},
"enableSSO": {
"type": "boolean",
"title": "Enable SSO (single sign on).",
"description": "Enable SSO (single sign on). Possible values are: true, false.",
"default": true,
"x-nullable": true
},
"personalComputeInstanceSettings": {
"$ref": "#/definitions/PersonalComputeInstanceSettings",
"title": "Personal Compute Instance settings.",
"description": "Settings for a personal compute instance.",
"x-nullable": true
},
"setupScripts": {
"$ref": "#/definitions/SetupScripts",
"description": "Details of customized scripts to execute for setting up the cluster.",
"x-nullable": true
},
"lastOperation": {
"$ref": "#/definitions/ComputeInstanceLastOperation",
"description": "The last operation on ComputeInstance.",
"x-nullable": true,
"readOnly": true
},
"schedules": {
"$ref": "#/definitions/ComputeSchedules",
"description": "The list of schedules to be applied on the computes.",
"x-nullable": true
},
"idleTimeBeforeShutdown": {
"type": "string",
"description": "Stops compute instance after user defined period of inactivity. Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days."
},
"enableNodePublicIp": {
"type": "boolean",
"title": "Enable node public IP.",
"description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.",
"x-nullable": true
},
"containers": {
"type": "array",
"description": "Describes informations of containers on this ComputeInstance.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ComputeInstanceContainer"
},
"readOnly": true
},
"dataDisks": {
"type": "array",
"description": "Describes informations of dataDisks on this ComputeInstance.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ComputeInstanceDataDisk"
},
"readOnly": true
},
"dataMounts": {
"type": "array",
"description": "Describes informations of dataMounts on this ComputeInstance.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ComputeInstanceDataMount"
},
"readOnly": true
},
"versions": {
"$ref": "#/definitions/ComputeInstanceVersion",
"description": "ComputeInstance version.",
"readOnly": true
}
}
},
"ComputeInstanceSshSettings": {
"type": "object",
"description": "Specifies policy and settings for SSH access.",
"properties": {
"sshPublicAccess": {
"type": "string",
"title": "Access policy for SSH",
"description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.",
"default": "Disabled",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "SshPublicAccess",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"adminUserName": {
"type": "string",
"description": "Describes the admin user name.",
"readOnly": true
},
"sshPort": {
"type": "integer",
"format": "int32",
"description": "Describes the port for connecting through SSH.",
"readOnly": true
},
"adminPublicKey": {
"type": "string",
"description": "Specifies the SSH rsa public key file as a string. Use \"ssh-keygen -t rsa -b 2048\" to generate your SSH key pairs."
}
}
},
"ComputeInstanceState": {
"type": "string",
"description": "Current state of an ComputeInstance.",
"enum": [
"Creating",
"CreateFailed",
"Deleting",
"Running",
"Restarting",
"Resizing",
"JobRunning",
"SettingUp",
"SetupFailed",
"Starting",
"Stopped",
"Stopping",
"UserSettingUp",
"UserSetupFailed",
"Unknown",
"Unusable"
],
"x-ms-enum": {
"name": "ComputeInstanceState",
"modelAsString": true,
"values": [
{
"name": "Creating",
"value": "Creating"
},
{
"name": "CreateFailed",
"value": "CreateFailed"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Running",
"value": "Running"
},
{
"name": "Restarting",
"value": "Restarting"
},
{
"name": "Resizing",
"value": "Resizing"
},
{
"name": "JobRunning",
"value": "JobRunning"
},
{
"name": "SettingUp",
"value": "SettingUp"
},
{
"name": "SetupFailed",
"value": "SetupFailed"
},
{
"name": "Starting",
"value": "Starting"
},
{
"name": "Stopped",
"value": "Stopped"
},
{
"name": "Stopping",
"value": "Stopping"
},
{
"name": "UserSettingUp",
"value": "UserSettingUp"
},
{
"name": "UserSetupFailed",
"value": "UserSetupFailed"
},
{
"name": "Unknown",
"value": "Unknown"
},
{
"name": "Unusable",
"value": "Unusable"
}
]
}
},
"ComputeInstanceVersion": {
"type": "object",
"description": "Version of computeInstance.",
"properties": {
"runtime": {
"type": "string",
"description": "Runtime of compute instance.",
"x-nullable": true
}
}
},
"ComputePowerAction": {
"type": "string",
"description": "[Required] The compute power action.",
"enum": [
"Start",
"Stop"
],
"x-ms-enum": {
"name": "ComputePowerAction",
"modelAsString": true,
"values": [
{
"name": "Start",
"value": "Start"
},
{
"name": "Stop",
"value": "Stop"
}
]
}
},
"ComputeRecurrenceFrequency": {
"type": "string",
"description": "Enum to describe the frequency of a compute recurrence schedule",
"enum": [
"Minute",
"Hour",
"Day",
"Week",
"Month"
],
"x-ms-enum": {
"name": "ComputeRecurrenceFrequency",
"modelAsString": true,
"values": [
{
"name": "Minute",
"value": "Minute",
"description": "Minute frequency"
},
{
"name": "Hour",
"value": "Hour",
"description": "Hour frequency"
},
{
"name": "Day",
"value": "Day",
"description": "Day frequency"
},
{
"name": "Week",
"value": "Week",
"description": "Week frequency"
},
{
"name": "Month",
"value": "Month",
"description": "Month frequency"
}
]
}
},
"ComputeRecurrenceSchedule": {
"type": "object",
"properties": {
"hours": {
"type": "array",
"description": "[Required] List of hours for the schedule.",
"items": {
"type": "integer",
"format": "int32"
}
},
"minutes": {
"type": "array",
"description": "[Required] List of minutes for the schedule.",
"items": {
"type": "integer",
"format": "int32"
}
},
"monthDays": {
"type": "array",
"description": "List of month days for the schedule",
"x-nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"weekDays": {
"type": "array",
"description": "List of days for the schedule.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ComputeWeekDay"
}
}
},
"required": [
"hours",
"minutes"
]
},
"ComputeResource": {
"type": "object",
"description": "Machine Learning compute object wrapped into ARM resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/Compute",
"description": "The resource-specific properties for this resource."
},
"location": {
"type": "string",
"description": "Specifies the location of the resource."
},
"tags": {
"type": "object",
"description": "Contains resource tags defined as key/value pairs.",
"x-nullable": true,
"additionalProperties": {
"type": "string"
}
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "The sku of the workspace.",
"x-nullable": true
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The identity of the resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"ComputeRuntimeDto": {
"type": "object",
"properties": {
"sparkRuntimeVersion": {
"type": "string"
}
}
},
"ComputeSchedules": {
"type": "object",
"description": "The list of schedules to be applied on the computes",
"properties": {
"computeStartStop": {
"type": "array",
"description": "The list of compute start stop schedules to be applied.",
"items": {
"$ref": "#/definitions/ComputeStartStopSchedule"
}
}
}
},
"ComputeSecrets": {
"type": "object",
"description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.",
"properties": {
"computeType": {
"$ref": "#/definitions/ComputeType",
"description": "The type of compute"
}
},
"discriminator": "computeType",
"required": [
"computeType"
]
},
"ComputeStartStopSchedule": {
"type": "object",
"description": "Compute start stop schedule properties",
"properties": {
"id": {
"type": "string",
"description": "A system assigned id for the schedule.",
"x-nullable": true,
"readOnly": true
},
"provisioningStatus": {
"$ref": "#/definitions/ProvisioningStatus",
"description": "The current deployment state of schedule.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/ScheduleStatus",
"description": "Is the schedule enabled or disabled?"
},
"action": {
"$ref": "#/definitions/ComputePowerAction",
"description": "[Required] The compute power action."
},
"triggerType": {
"$ref": "#/definitions/ComputeTriggerType",
"description": "[Required] The schedule trigger type."
},
"recurrence": {
"$ref": "#/definitions/Recurrence",
"description": "Required if triggerType is Recurrence."
},
"cron": {
"$ref": "#/definitions/Cron",
"description": "Required if triggerType is Cron."
},
"schedule": {
"$ref": "#/definitions/ScheduleBase",
"description": "[Deprecated] Not used any more."
}
}
},
"ComputeTriggerType": {
"type": "string",
"enum": [
"Recurrence",
"Cron"
],
"x-ms-enum": {
"name": "ComputeTriggerType",
"modelAsString": true,
"values": [
{
"name": "Recurrence",
"value": "Recurrence"
},
{
"name": "Cron",
"value": "Cron"
}
]
}
},
"ComputeType": {
"type": "string",
"description": "The type of compute",
"enum": [
"AKS",
"Kubernetes",
"AmlCompute",
"ComputeInstance",
"DataFactory",
"VirtualMachine",
"HDInsight",
"Databricks",
"DataLakeAnalytics",
"SynapseSpark"
],
"x-ms-enum": {
"name": "ComputeType",
"modelAsString": true,
"values": [
{
"name": "AKS",
"value": "AKS"
},
{
"name": "Kubernetes",
"value": "Kubernetes"
},
{
"name": "AmlCompute",
"value": "AmlCompute"
},
{
"name": "ComputeInstance",
"value": "ComputeInstance"
},
{
"name": "DataFactory",
"value": "DataFactory"
},
{
"name": "VirtualMachine",
"value": "VirtualMachine"
},
{
"name": "HDInsight",
"value": "HDInsight"
},
{
"name": "Databricks",
"value": "Databricks"
},
{
"name": "DataLakeAnalytics",
"value": "DataLakeAnalytics"
},
{
"name": "SynapseSpark",
"value": "SynapseSpark"
}
]
}
},
"ComputeWeekDay": {
"type": "string",
"description": "Enum of weekday",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"x-ms-enum": {
"name": "ComputeWeekDay",
"modelAsString": true,
"values": [
{
"name": "Monday",
"value": "Monday",
"description": "Monday weekday"
},
{
"name": "Tuesday",
"value": "Tuesday",
"description": "Tuesday weekday"
},
{
"name": "Wednesday",
"value": "Wednesday",
"description": "Wednesday weekday"
},
{
"name": "Thursday",
"value": "Thursday",
"description": "Thursday weekday"
},
{
"name": "Friday",
"value": "Friday",
"description": "Friday weekday"
},
{
"name": "Saturday",
"value": "Saturday",
"description": "Saturday weekday"
},
{
"name": "Sunday",
"value": "Sunday",
"description": "Sunday weekday"
}
]
}
},
"ConnectionAuthType": {
"type": "string",
"description": "Authentication type of the connection target",
"enum": [
"PAT",
"ManagedIdentity",
"UsernamePassword",
"None",
"SAS",
"AccountKey",
"ServicePrincipal",
"AccessKey",
"ApiKey",
"CustomKeys",
"OAuth2",
"AAD",
"DelegatedSAS",
"ProjectManagedIdentity",
"AccountManagedIdentity",
"UserEntraToken",
"AgentUserImpersonation",
"AgenticIdentityToken",
"AgenticUser"
],
"x-ms-enum": {
"name": "ConnectionAuthType",
"modelAsString": true,
"values": [
{
"name": "PAT",
"value": "PAT"
},
{
"name": "ManagedIdentity",
"value": "ManagedIdentity"
},
{
"name": "UsernamePassword",
"value": "UsernamePassword"
},
{
"name": "None",
"value": "None"
},
{
"name": "SAS",
"value": "SAS"
},
{
"name": "AccountKey",
"value": "AccountKey"
},
{
"name": "ServicePrincipal",
"value": "ServicePrincipal"
},
{
"name": "AccessKey",
"value": "AccessKey"
},
{
"name": "ApiKey",
"value": "ApiKey"
},
{
"name": "CustomKeys",
"value": "CustomKeys"
},
{
"name": "OAuth2",
"value": "OAuth2"
},
{
"name": "AAD",
"value": "AAD"
},
{
"name": "DelegatedSAS",
"value": "DelegatedSAS"
},
{
"name": "ProjectManagedIdentity",
"value": "ProjectManagedIdentity"
},
{
"name": "AccountManagedIdentity",
"value": "AccountManagedIdentity"
},
{
"name": "UserEntraToken",
"value": "UserEntraToken"
},
{
"name": "AgentUserImpersonation",
"value": "AgentUserImpersonation"
},
{
"name": "AgenticIdentityToken",
"value": "AgenticIdentityToken"
},
{
"name": "AgenticUser",
"value": "AgenticUser"
}
]
}
},
"ConnectionCategory": {
"type": "string",
"description": "Category of the connection",
"enum": [
"PythonFeed",
"ContainerRegistry",
"Git",
"S3",
"Snowflake",
"AzureKeyVault",
"AzureSqlDb",
"AzureSynapseAnalytics",
"AzureMySqlDb",
"AzurePostgresDb",
"ADLSGen2",
"AzureContainerAppEnvironment",
"Redis",
"ApiKey",
"AzureOpenAI",
"AIServices",
"CognitiveSearch",
"CognitiveService",
"CustomKeys",
"AzureBlob",
"AzureStorageAccount",
"AzureOneLake",
"CosmosDb",
"CosmosDbMongoDbApi",
"AzureDataExplorer",
"AzureMariaDb",
"AzureDatabricksDeltaLake",
"AzureSqlMi",
"AzureTableStorage",
"AmazonRdsForOracle",
"AmazonRdsForSqlServer",
"AmazonRedshift",
"Db2",
"Drill",
"GoogleBigQuery",
"Greenplum",
"Hbase",
"Hive",
"Impala",
"Informix",
"MariaDb",
"MicrosoftAccess",
"MySql",
"Netezza",
"Oracle",
"Phoenix",
"PostgreSql",
"Presto",
"SapOpenHub",
"SapBw",
"SapHana",
"SapTable",
"Spark",
"SqlServer",
"Sybase",
"Teradata",
"Vertica",
"Pinecone",
"Databricks",
"Cassandra",
"Couchbase",
"MongoDbV2",
"MongoDbAtlas",
"AmazonS3Compatible",
"FileServer",
"FtpServer",
"GoogleCloudStorage",
"Hdfs",
"OracleCloudStorage",
"Sftp",
"GenericHttp",
"ODataRest",
"Odbc",
"GenericRest",
"RemoteTool",
"AmazonMws",
"Concur",
"Dynamics",
"DynamicsAx",
"DynamicsCrm",
"GoogleAdWords",
"Hubspot",
"Jira",
"Magento",
"Marketo",
"Office365",
"Eloqua",
"Responsys",
"OracleServiceCloud",
"PayPal",
"QuickBooks",
"Salesforce",
"SalesforceServiceCloud",
"SalesforceMarketingCloud",
"SapCloudForCustomer",
"SapEcc",
"ServiceNow",
"SharePointOnlineList",
"Shopify",
"Square",
"WebTable",
"Xero",
"Zoho",
"GenericContainerRegistry",
"Elasticsearch",
"AppInsights",
"AppConfig",
"OpenAI",
"Serp",
"BingLLMSearch",
"Serverless",
"ManagedOnlineEndpoint",
"ApiManagement",
"ModelGateway",
"GroundingWithBingSearch",
"GroundingWithCustomSearch",
"Sharepoint",
"MicrosoftFabric",
"PowerPlatformEnvironment",
"RemoteA2A"
],
"x-ms-enum": {
"name": "ConnectionCategory",
"modelAsString": true,
"values": [
{
"name": "PythonFeed",
"value": "PythonFeed"
},
{
"name": "ContainerRegistry",
"value": "ContainerRegistry"
},
{
"name": "Git",
"value": "Git"
},
{
"name": "S3",
"value": "S3"
},
{
"name": "Snowflake",
"value": "Snowflake"
},
{
"name": "AzureKeyVault",
"value": "AzureKeyVault"
},
{
"name": "AzureSqlDb",
"value": "AzureSqlDb"
},
{
"name": "AzureSynapseAnalytics",
"value": "AzureSynapseAnalytics"
},
{
"name": "AzureMySqlDb",
"value": "AzureMySqlDb"
},
{
"name": "AzurePostgresDb",
"value": "AzurePostgresDb"
},
{
"name": "ADLSGen2",
"value": "ADLSGen2"
},
{
"name": "AzureContainerAppEnvironment",
"value": "AzureContainerAppEnvironment"
},
{
"name": "Redis",
"value": "Redis"
},
{
"name": "ApiKey",
"value": "ApiKey"
},
{
"name": "AzureOpenAI",
"value": "AzureOpenAI"
},
{
"name": "AIServices",
"value": "AIServices"
},
{
"name": "CognitiveSearch",
"value": "CognitiveSearch"
},
{
"name": "CognitiveService",
"value": "CognitiveService"
},
{
"name": "CustomKeys",
"value": "CustomKeys"
},
{
"name": "AzureBlob",
"value": "AzureBlob"
},
{
"name": "AzureStorageAccount",
"value": "AzureStorageAccount"
},
{
"name": "AzureOneLake",
"value": "AzureOneLake"
},
{
"name": "CosmosDb",
"value": "CosmosDb"
},
{
"name": "CosmosDbMongoDbApi",
"value": "CosmosDbMongoDbApi"
},
{
"name": "AzureDataExplorer",
"value": "AzureDataExplorer"
},
{
"name": "AzureMariaDb",
"value": "AzureMariaDb"
},
{
"name": "AzureDatabricksDeltaLake",
"value": "AzureDatabricksDeltaLake"
},
{
"name": "AzureSqlMi",
"value": "AzureSqlMi"
},
{
"name": "AzureTableStorage",
"value": "AzureTableStorage"
},
{
"name": "AmazonRdsForOracle",
"value": "AmazonRdsForOracle"
},
{
"name": "AmazonRdsForSqlServer",
"value": "AmazonRdsForSqlServer"
},
{
"name": "AmazonRedshift",
"value": "AmazonRedshift"
},
{
"name": "Db2",
"value": "Db2"
},
{
"name": "Drill",
"value": "Drill"
},
{
"name": "GoogleBigQuery",
"value": "GoogleBigQuery"
},
{
"name": "Greenplum",
"value": "Greenplum"
},
{
"name": "Hbase",
"value": "Hbase"
},
{
"name": "Hive",
"value": "Hive"
},
{
"name": "Impala",
"value": "Impala"
},
{
"name": "Informix",
"value": "Informix"
},
{
"name": "MariaDb",
"value": "MariaDb"
},
{
"name": "MicrosoftAccess",
"value": "MicrosoftAccess"
},
{
"name": "MySql",
"value": "MySql"
},
{
"name": "Netezza",
"value": "Netezza"
},
{
"name": "Oracle",
"value": "Oracle"
},
{
"name": "Phoenix",
"value": "Phoenix"
},
{
"name": "PostgreSql",
"value": "PostgreSql"
},
{
"name": "Presto",
"value": "Presto"
},
{
"name": "SapOpenHub",
"value": "SapOpenHub"
},
{
"name": "SapBw",
"value": "SapBw"
},
{
"name": "SapHana",
"value": "SapHana"
},
{
"name": "SapTable",
"value": "SapTable"
},
{
"name": "Spark",
"value": "Spark"
},
{
"name": "SqlServer",
"value": "SqlServer"
},
{
"name": "Sybase",
"value": "Sybase"
},
{
"name": "Teradata",
"value": "Teradata"
},
{
"name": "Vertica",
"value": "Vertica"
},
{
"name": "Pinecone",
"value": "Pinecone"
},
{
"name": "Databricks",
"value": "Databricks"
},
{
"name": "Cassandra",
"value": "Cassandra"
},
{
"name": "Couchbase",
"value": "Couchbase"
},
{
"name": "MongoDbV2",
"value": "MongoDbV2"
},
{
"name": "MongoDbAtlas",
"value": "MongoDbAtlas"
},
{
"name": "AmazonS3Compatible",
"value": "AmazonS3Compatible"
},
{
"name": "FileServer",
"value": "FileServer"
},
{
"name": "FtpServer",
"value": "FtpServer"
},
{
"name": "GoogleCloudStorage",
"value": "GoogleCloudStorage"
},
{
"name": "Hdfs",
"value": "Hdfs"
},
{
"name": "OracleCloudStorage",
"value": "OracleCloudStorage"
},
{
"name": "Sftp",
"value": "Sftp"
},
{
"name": "GenericHttp",
"value": "GenericHttp"
},
{
"name": "ODataRest",
"value": "ODataRest"
},
{
"name": "Odbc",
"value": "Odbc"
},
{
"name": "GenericRest",
"value": "GenericRest"
},
{
"name": "RemoteTool",
"value": "RemoteTool"
},
{
"name": "AmazonMws",
"value": "AmazonMws"
},
{
"name": "Concur",
"value": "Concur"
},
{
"name": "Dynamics",
"value": "Dynamics"
},
{
"name": "DynamicsAx",
"value": "DynamicsAx"
},
{
"name": "DynamicsCrm",
"value": "DynamicsCrm"
},
{
"name": "GoogleAdWords",
"value": "GoogleAdWords"
},
{
"name": "Hubspot",
"value": "Hubspot"
},
{
"name": "Jira",
"value": "Jira"
},
{
"name": "Magento",
"value": "Magento"
},
{
"name": "Marketo",
"value": "Marketo"
},
{
"name": "Office365",
"value": "Office365"
},
{
"name": "Eloqua",
"value": "Eloqua"
},
{
"name": "Responsys",
"value": "Responsys"
},
{
"name": "OracleServiceCloud",
"value": "OracleServiceCloud"
},
{
"name": "PayPal",
"value": "PayPal"
},
{
"name": "QuickBooks",
"value": "QuickBooks"
},
{
"name": "Salesforce",
"value": "Salesforce"
},
{
"name": "SalesforceServiceCloud",
"value": "SalesforceServiceCloud"
},
{
"name": "SalesforceMarketingCloud",
"value": "SalesforceMarketingCloud"
},
{
"name": "SapCloudForCustomer",
"value": "SapCloudForCustomer"
},
{
"name": "SapEcc",
"value": "SapEcc"
},
{
"name": "ServiceNow",
"value": "ServiceNow"
},
{
"name": "SharePointOnlineList",
"value": "SharePointOnlineList"
},
{
"name": "Shopify",
"value": "Shopify"
},
{
"name": "Square",
"value": "Square"
},
{
"name": "WebTable",
"value": "WebTable"
},
{
"name": "Xero",
"value": "Xero"
},
{
"name": "Zoho",
"value": "Zoho"
},
{
"name": "GenericContainerRegistry",
"value": "GenericContainerRegistry"
},
{
"name": "Elasticsearch",
"value": "Elasticsearch"
},
{
"name": "AppInsights",
"value": "AppInsights"
},
{
"name": "AppConfig",
"value": "AppConfig"
},
{
"name": "OpenAI",
"value": "OpenAI"
},
{
"name": "Serp",
"value": "Serp"
},
{
"name": "BingLLMSearch",
"value": "BingLLMSearch"
},
{
"name": "Serverless",
"value": "Serverless"
},
{
"name": "ManagedOnlineEndpoint",
"value": "ManagedOnlineEndpoint"
},
{
"name": "ApiManagement",
"value": "ApiManagement"
},
{
"name": "ModelGateway",
"value": "ModelGateway"
},
{
"name": "GroundingWithBingSearch",
"value": "GroundingWithBingSearch"
},
{
"name": "GroundingWithCustomSearch",
"value": "GroundingWithCustomSearch"
},
{
"name": "Sharepoint",
"value": "Sharepoint"
},
{
"name": "MicrosoftFabric",
"value": "MicrosoftFabric"
},
{
"name": "PowerPlatformEnvironment",
"value": "PowerPlatformEnvironment"
},
{
"name": "RemoteA2A",
"value": "RemoteA2A"
}
]
}
},
"ConnectionGroup": {
"type": "string",
"description": "Group based on connection category",
"enum": [
"Azure",
"AzureAI",
"Database",
"NoSQL",
"File",
"GenericProtocol",
"ServicesAndApps"
],
"x-ms-enum": {
"name": "ConnectionGroup",
"modelAsString": true,
"values": [
{
"name": "Azure",
"value": "Azure"
},
{
"name": "AzureAI",
"value": "AzureAI"
},
{
"name": "Database",
"value": "Database"
},
{
"name": "NoSQL",
"value": "NoSQL"
},
{
"name": "File",
"value": "File"
},
{
"name": "GenericProtocol",
"value": "GenericProtocol"
},
{
"name": "ServicesAndApps",
"value": "ServicesAndApps"
}
]
}
},
"ContainerResourceRequirements": {
"type": "object",
"description": "Resource requirements for each container instance within an online deployment.",
"properties": {
"containerResourceLimits": {
"$ref": "#/definitions/ContainerResourceSettings",
"description": "Container resource limit info:",
"x-nullable": true
},
"containerResourceRequests": {
"$ref": "#/definitions/ContainerResourceSettings",
"description": "Container resource request info:",
"x-nullable": true
}
}
},
"ContainerResourceSettings": {
"type": "object",
"properties": {
"cpu": {
"type": "string",
"description": "Number of vCPUs request/limit for container. More info:\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"x-nullable": true
},
"gpu": {
"type": "string",
"description": "Number of Nvidia GPU cards request/limit for container. More info:\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"x-nullable": true
},
"memory": {
"type": "string",
"description": "Memory size request/limit for container. More info:\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"x-nullable": true
}
}
},
"ContentSafety": {
"type": "object",
"properties": {
"contentSafetyStatus": {
"$ref": "#/definitions/ContentSafetyStatus",
"description": "[Required] Specifies the status of content safety."
}
},
"required": [
"contentSafetyStatus"
]
},
"ContentSafetyStatus": {
"type": "string",
"description": "Specifies the status of content safety.",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "ContentSafetyStatus",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"CosmosDbSettings": {
"type": "object",
"properties": {
"collectionsThroughput": {
"type": "integer",
"format": "int32"
}
}
},
"CreateMonitorAction": {
"type": "object",
"properties": {
"monitorDefinition": {
"$ref": "#/definitions/MonitorDefinition",
"description": "[Required] Defines the monitor.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"monitorDefinition"
],
"allOf": [
{
"$ref": "#/definitions/ScheduleActionBase"
}
],
"x-ms-discriminator-value": "CreateMonitor"
},
"CredentialsType": {
"type": "string",
"description": "Enum to determine the datastore credentials type.",
"enum": [
"AccountKey",
"Certificate",
"None",
"Sas",
"ServicePrincipal"
],
"x-ms-enum": {
"name": "CredentialsType",
"modelAsString": true,
"values": [
{
"name": "AccountKey",
"value": "AccountKey"
},
{
"name": "Certificate",
"value": "Certificate"
},
{
"name": "None",
"value": "None"
},
{
"name": "Sas",
"value": "Sas"
},
{
"name": "ServicePrincipal",
"value": "ServicePrincipal"
}
]
}
},
"Cron": {
"type": "object",
"description": "The workflow trigger cron for ComputeStartStop schedule type.",
"properties": {
"startTime": {
"type": "string",
"description": "The start time in yyyy-MM-ddTHH:mm:ss format.",
"x-nullable": true
},
"timeZone": {
"type": "string",
"description": "Specifies time zone in which the schedule runs.\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11",
"default": "UTC"
},
"expression": {
"type": "string",
"description": "[Required] Specifies cron expression of schedule.\nThe expression should follow NCronTab format."
}
}
},
"CronTrigger": {
"type": "object",
"properties": {
"expression": {
"type": "string",
"description": "[Required] Specifies cron expression of schedule.\nThe expression should follow NCronTab format.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"expression"
],
"allOf": [
{
"$ref": "#/definitions/TriggerBase"
}
],
"x-ms-discriminator-value": "Cron"
},
"CustomForecastHorizon": {
"type": "object",
"description": "The desired maximum forecast horizon in units of time-series frequency.",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"description": "[Required] Forecast horizon value."
}
},
"required": [
"value"
],
"allOf": [
{
"$ref": "#/definitions/ForecastHorizon"
}
],
"x-ms-discriminator-value": "Custom"
},
"CustomKeys": {
"type": "object",
"description": "Custom Keys credential object",
"properties": {
"keys": {
"type": "object",
"format": "password",
"additionalProperties": {
"type": "string"
},
"x-ms-secret": true
}
}
},
"CustomKeysWorkspaceConnectionProperties": {
"type": "object",
"description": "Category:= CustomKeys\nAuthType:= CustomKeys (as type discriminator)\nCredentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys\nTarget:= {any value}\nUse Metadata property bag for ApiVersion and other metadata fields",
"properties": {
"credentials": {
"$ref": "#/definitions/CustomKeys",
"description": "Custom Keys credential object"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "CustomKeys"
},
"CustomMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"type": "string",
"description": "[Required] The user-defined metric to calculate.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"threshold": {
"$ref": "#/definitions/MonitoringThreshold",
"description": "The threshold value. If null, a default value will be set depending on the selected metric.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metric"
]
},
"CustomModelJobInput": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Enum to determine the input data delivery mode.",
"default": "ReadOnlyMount",
"enum": [
"ReadOnlyMount",
"ReadWriteMount",
"Download",
"Direct",
"EvalMount",
"EvalDownload"
],
"x-ms-enum": {
"name": "InputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnlyMount",
"value": "ReadOnlyMount"
},
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Download",
"value": "Download"
},
{
"name": "Direct",
"value": "Direct"
},
{
"name": "EvalMount",
"value": "EvalMount"
},
{
"name": "EvalDownload",
"value": "EvalDownload"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "[Required] Input Asset URI.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"uri"
],
"allOf": [
{
"$ref": "#/definitions/JobInput"
}
],
"x-ms-discriminator-value": "custom_model"
},
"CustomModelJobOutput": {
"type": "object",
"properties": {
"assetName": {
"type": "string",
"description": "Output Asset Name.",
"x-nullable": true
},
"mode": {
"type": "string",
"description": "Output data delivery mode enums.",
"default": "ReadWriteMount",
"enum": [
"ReadWriteMount",
"Upload",
"Direct"
],
"x-ms-enum": {
"name": "OutputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Upload",
"value": "Upload"
},
{
"name": "Direct",
"value": "Direct"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "Output Asset URI.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/JobOutput"
}
],
"x-ms-discriminator-value": "custom_model"
},
"CustomMonitoringSignal": {
"type": "object",
"properties": {
"componentId": {
"type": "string",
"description": "[Required] Reference to the component asset used to calculate the custom metrics.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"inputAssets": {
"type": "object",
"description": "Monitoring assets to take as input. Key is the component input port name, value is the data asset.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/MonitoringInputDataBase",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"inputs": {
"type": "object",
"description": "Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobInput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"metricThresholds": {
"type": "array",
"description": "[Required] A list of metrics to calculate and their associated thresholds.",
"items": {
"$ref": "#/definitions/CustomMetricThreshold"
},
"x-ms-identifiers": [],
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"componentId",
"metricThresholds"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringSignalBase"
}
],
"x-ms-discriminator-value": "Custom"
},
"CustomNCrossValidations": {
"type": "object",
"description": "N-Cross validations are specified by user.",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"description": "[Required] N-Cross validations value."
}
},
"required": [
"value"
],
"allOf": [
{
"$ref": "#/definitions/NCrossValidations"
}
],
"x-ms-discriminator-value": "Custom"
},
"CustomSeasonality": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"description": "[Required] Seasonality value."
}
},
"required": [
"value"
],
"allOf": [
{
"$ref": "#/definitions/Seasonality"
}
],
"x-ms-discriminator-value": "Custom"
},
"CustomService": {
"type": "object",
"description": "Specifies the custom service configuration",
"properties": {
"name": {
"type": "string",
"description": "Name of the Custom Service"
},
"image": {
"$ref": "#/definitions/Image",
"description": "Describes the Image Specifications"
},
"environmentVariables": {
"type": "object",
"description": "Environment Variable for the container",
"additionalProperties": {
"$ref": "#/definitions/EnvironmentVariable"
}
},
"docker": {
"$ref": "#/definitions/Docker",
"description": "Describes the docker settings for the image",
"x-nullable": true
},
"endpoints": {
"type": "array",
"description": "Configuring the endpoints for the container",
"items": {
"$ref": "#/definitions/Endpoint"
},
"x-ms-identifiers": [
"name"
]
},
"volumes": {
"type": "array",
"description": "Configuring the volumes for the container",
"items": {
"$ref": "#/definitions/VolumeDefinition"
},
"x-ms-identifiers": [
"source",
"target"
]
},
"kernel": {
"$ref": "#/definitions/JupyterKernelConfig",
"description": "Describes the jupyter kernel settings for the image if its a custom environment"
}
},
"additionalProperties": {}
},
"CustomTargetLags": {
"type": "object",
"properties": {
"values": {
"type": "array",
"description": "[Required] Set target lags values.",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"required": [
"values"
],
"allOf": [
{
"$ref": "#/definitions/TargetLags"
}
],
"x-ms-discriminator-value": "Custom"
},
"CustomTargetRollingWindowSize": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"description": "[Required] TargetRollingWindowSize value."
}
},
"required": [
"value"
],
"allOf": [
{
"$ref": "#/definitions/TargetRollingWindowSize"
}
],
"x-ms-discriminator-value": "Custom"
},
"DataAvailabilityStatus": {
"type": "string",
"enum": [
"None",
"Pending",
"Incomplete",
"Complete"
],
"x-ms-enum": {
"name": "DataAvailabilityStatus",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "Pending",
"value": "Pending"
},
{
"name": "Incomplete",
"value": "Incomplete"
},
{
"name": "Complete",
"value": "Complete"
}
]
}
},
"DataCollector": {
"type": "object",
"properties": {
"collections": {
"type": "object",
"description": "[Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string.\nModel data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging.",
"additionalProperties": {
"$ref": "#/definitions/Collection",
"x-nullable": true
}
},
"requestLogging": {
"$ref": "#/definitions/RequestLogging",
"description": "The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional.",
"x-nullable": true
},
"rollingRate": {
"type": "string",
"description": "When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file.\nIf the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/.\nIf it's day, all data will be collected in blob path /yyyy/MM/dd/.\nThe other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly.",
"default": "Hour",
"enum": [
"Year",
"Month",
"Day",
"Hour",
"Minute"
],
"x-ms-enum": {
"name": "RollingRateType",
"modelAsString": true,
"values": [
{
"name": "Year",
"value": "Year"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "Day",
"value": "Day"
},
{
"name": "Hour",
"value": "Hour"
},
{
"name": "Minute",
"value": "Minute"
}
]
}
}
},
"required": [
"collections"
]
},
"DataContainer": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/DataContainerProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"DataContainerProperties": {
"type": "object",
"description": "Container for data asset versions.",
"properties": {
"dataType": {
"$ref": "#/definitions/DataType",
"description": "[Required] Specifies the type of data.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"dataType"
],
"allOf": [
{
"$ref": "#/definitions/AssetContainer"
}
]
},
"DataContainerResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of DataContainer entities.",
"properties": {
"value": {
"type": "array",
"description": "The DataContainer items on this page",
"items": {
"$ref": "#/definitions/DataContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DataDriftMetricThresholdBase": {
"type": "object",
"properties": {
"dataType": {
"$ref": "#/definitions/MonitoringFeatureDataType",
"description": "[Required] Specifies the data type of the metric threshold.",
"x-ms-mutability": [
"read",
"create"
]
},
"threshold": {
"$ref": "#/definitions/MonitoringThreshold",
"description": "The threshold value. If null, a default value will be set depending on the selected metric.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "dataType",
"required": [
"dataType"
]
},
"DataDriftMonitoringSignal": {
"type": "object",
"properties": {
"featureDataTypeOverride": {
"type": "object",
"description": "A dictionary that maps feature names to their respective data types.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/MonitoringFeatureDataType"
},
"x-ms-mutability": [
"read",
"create"
]
},
"featureImportanceSettings": {
"$ref": "#/definitions/FeatureImportanceSettings",
"description": "The settings for computing feature importance.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"features": {
"$ref": "#/definitions/MonitoringFeatureFilterBase",
"description": "The feature filter which identifies which feature to calculate drift over.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"metricThresholds": {
"type": "array",
"description": "[Required] A list of metrics to calculate and their associated thresholds.",
"items": {
"$ref": "#/definitions/DataDriftMetricThresholdBase"
},
"x-ms-identifiers": [],
"x-ms-mutability": [
"read",
"create"
]
},
"productionData": {
"$ref": "#/definitions/MonitoringInputDataBase",
"description": "[Required] The data which drift will be calculated for.",
"x-ms-mutability": [
"read",
"create"
]
},
"referenceData": {
"$ref": "#/definitions/MonitoringInputDataBase",
"description": "[Required] The data to calculate drift against.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metricThresholds",
"productionData",
"referenceData"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringSignalBase"
}
],
"x-ms-discriminator-value": "DataDrift"
},
"DataFactory": {
"type": "object",
"description": "A DataFactory compute.",
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "DataFactory"
},
"DataLakeAnalytics": {
"type": "object",
"description": "A DataLakeAnalytics compute.",
"properties": {
"properties": {
"$ref": "#/definitions/DataLakeAnalyticsSchemaProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "DataLakeAnalytics"
},
"DataLakeAnalyticsSchemaProperties": {
"type": "object",
"properties": {
"dataLakeStoreAccountName": {
"type": "string",
"description": "DataLake Store Account Name"
}
}
},
"DataPathAssetReference": {
"type": "object",
"description": "Reference to an asset via its path in a datastore.",
"properties": {
"datastoreId": {
"type": "string",
"description": "ARM resource ID of the datastore where the asset is located.",
"x-nullable": true
},
"path": {
"type": "string",
"description": "The path of the file/directory in the datastore.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetReferenceBase"
}
],
"x-ms-discriminator-value": "DataPath"
},
"DataQualityMetricThresholdBase": {
"type": "object",
"properties": {
"dataType": {
"$ref": "#/definitions/MonitoringFeatureDataType",
"description": "[Required] Specifies the data type of the metric threshold.",
"x-ms-mutability": [
"read",
"create"
]
},
"threshold": {
"$ref": "#/definitions/MonitoringThreshold",
"description": "The threshold value. If null, a default value will be set depending on the selected metric.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "dataType",
"required": [
"dataType"
]
},
"DataQualityMonitoringSignal": {
"type": "object",
"properties": {
"featureDataTypeOverride": {
"type": "object",
"description": "A dictionary that maps feature names to their respective data types.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/MonitoringFeatureDataType"
},
"x-ms-mutability": [
"read",
"create"
]
},
"featureImportanceSettings": {
"$ref": "#/definitions/FeatureImportanceSettings",
"description": "The settings for computing feature importance.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"features": {
"$ref": "#/definitions/MonitoringFeatureFilterBase",
"description": "The features to calculate drift over.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"metricThresholds": {
"type": "array",
"description": "[Required] A list of metrics to calculate and their associated thresholds.",
"items": {
"$ref": "#/definitions/DataQualityMetricThresholdBase"
},
"x-ms-identifiers": [],
"x-ms-mutability": [
"read",
"create"
]
},
"productionData": {
"$ref": "#/definitions/MonitoringInputDataBase",
"description": "[Required] The data produced by the production service which drift will be calculated for.",
"x-ms-mutability": [
"read",
"create"
]
},
"referenceData": {
"$ref": "#/definitions/MonitoringInputDataBase",
"description": "[Required] The data to calculate drift against.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metricThresholds",
"productionData",
"referenceData"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringSignalBase"
}
],
"x-ms-discriminator-value": "DataQuality"
},
"DataReferenceCredential": {
"type": "object",
"description": "DataReferenceCredential base class",
"properties": {
"credentialType": {
"$ref": "#/definitions/DataReferenceCredentialType",
"description": "[Required] Credential type used to authentication with storage."
}
},
"discriminator": "credentialType",
"required": [
"credentialType"
]
},
"DataReferenceCredentialType": {
"type": "string",
"description": "Enum to determine the DataReference credentials type.",
"enum": [
"SAS",
"DockerCredentials",
"ManagedIdentity",
"NoCredentials"
],
"x-ms-enum": {
"name": "DataReferenceCredentialType",
"modelAsString": true,
"values": [
{
"name": "SAS",
"value": "SAS"
},
{
"name": "DockerCredentials",
"value": "DockerCredentials"
},
{
"name": "ManagedIdentity",
"value": "ManagedIdentity"
},
{
"name": "NoCredentials",
"value": "NoCredentials"
}
]
}
},
"DataType": {
"type": "string",
"description": "Enum to determine the type of data.",
"enum": [
"uri_file",
"uri_folder",
"mltable"
],
"x-ms-enum": {
"name": "DataType",
"modelAsString": true,
"values": [
{
"name": "uri_file",
"value": "uri_file"
},
{
"name": "uri_folder",
"value": "uri_folder"
},
{
"name": "mltable",
"value": "mltable"
}
]
}
},
"DataVersionBase": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/DataVersionBaseProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"DataVersionBaseProperties": {
"type": "object",
"description": "Data version base definition",
"properties": {
"dataType": {
"$ref": "#/definitions/DataType",
"description": "[Required] Specifies the type of data.",
"x-ms-mutability": [
"read",
"create"
]
},
"dataUri": {
"type": "string",
"description": "[Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "dataType",
"required": [
"dataType",
"dataUri"
],
"allOf": [
{
"$ref": "#/definitions/AssetBase"
}
]
},
"DataVersionBaseResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of DataVersionBase entities.",
"properties": {
"value": {
"type": "array",
"description": "The DataVersionBase items on this page",
"items": {
"$ref": "#/definitions/DataVersionBase"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"Databricks": {
"type": "object",
"description": "A DataFactory compute.",
"properties": {
"properties": {
"$ref": "#/definitions/DatabricksProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "Databricks"
},
"DatabricksComputeSecrets": {
"type": "object",
"description": "Secrets related to a Machine Learning compute based on Databricks.",
"properties": {
"databricksAccessToken": {
"type": "string",
"format": "password",
"description": "access token for databricks account.",
"x-ms-secret": true
}
},
"allOf": [
{
"$ref": "#/definitions/ComputeSecrets"
}
],
"x-ms-discriminator-value": "Databricks"
},
"DatabricksProperties": {
"type": "object",
"description": "Properties of Databricks",
"properties": {
"databricksAccessToken": {
"type": "string",
"format": "password",
"description": "Databricks access token",
"x-ms-secret": true
},
"workspaceUrl": {
"type": "string",
"description": "Workspace Url"
}
}
},
"DatasetReference": {
"type": "object",
"description": "Dataset reference object.",
"properties": {
"name": {
"type": "string",
"description": "The name of the dataset reference.",
"x-nullable": true
},
"id": {
"type": "string",
"description": "The fully qualified ARM id of the dataset reference.",
"x-nullable": true
}
}
},
"Datastore": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/DatastoreProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"DatastoreCredentials": {
"type": "object",
"description": "Base definition for datastore credentials.",
"properties": {
"credentialsType": {
"$ref": "#/definitions/CredentialsType",
"description": "[Required] Credential type used to authentication with storage."
}
},
"discriminator": "credentialsType",
"required": [
"credentialsType"
]
},
"DatastoreProperties": {
"type": "object",
"description": "Base definition for datastore contents configuration.",
"properties": {
"credentials": {
"$ref": "#/definitions/DatastoreCredentials",
"description": "[Required] Account credentials."
},
"datastoreType": {
"$ref": "#/definitions/DatastoreType",
"description": "Enum to determine the datastore contents type."
},
"isDefault": {
"type": "boolean",
"description": "Readonly property to indicate if datastore is the workspace default datastore",
"readOnly": true
}
},
"discriminator": "datastoreType",
"required": [
"credentials",
"datastoreType"
],
"allOf": [
{
"$ref": "#/definitions/ResourceBase"
}
]
},
"DatastoreResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of Datastore entities.",
"properties": {
"value": {
"type": "array",
"description": "The Datastore items on this page",
"items": {
"$ref": "#/definitions/Datastore"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DatastoreSecrets": {
"type": "object",
"description": "Base definition for datastore secrets.",
"properties": {
"secretsType": {
"$ref": "#/definitions/SecretsType",
"description": "[Required] Credential type used to authentication with storage."
}
},
"discriminator": "secretsType",
"required": [
"secretsType"
]
},
"DatastoreType": {
"type": "string",
"description": "Enum to determine the datastore contents type.",
"enum": [
"AzureBlob",
"AzureDataLakeGen1",
"AzureDataLakeGen2",
"AzureFile",
"OneLake"
],
"x-ms-enum": {
"name": "DatastoreType",
"modelAsString": true,
"values": [
{
"name": "AzureBlob",
"value": "AzureBlob"
},
{
"name": "AzureDataLakeGen1",
"value": "AzureDataLakeGen1"
},
{
"name": "AzureDataLakeGen2",
"value": "AzureDataLakeGen2"
},
{
"name": "AzureFile",
"value": "AzureFile"
},
{
"name": "OneLake",
"value": "OneLake"
}
]
}
},
"DefaultScaleSettings": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/OnlineScaleSettings"
}
],
"x-ms-discriminator-value": "Default"
},
"DeploymentLogs": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The retrieved online deployment logs.",
"x-nullable": true
}
}
},
"DeploymentLogsRequest": {
"type": "object",
"properties": {
"containerType": {
"type": "string",
"description": "The type of container to retrieve logs from.",
"default": "InferenceServer",
"enum": [
"StorageInitializer",
"InferenceServer"
],
"x-ms-enum": {
"name": "ContainerType",
"modelAsString": true,
"values": [
{
"name": "StorageInitializer",
"value": "StorageInitializer"
},
{
"name": "InferenceServer",
"value": "InferenceServer"
}
]
}
},
"tail": {
"type": "integer",
"format": "int32",
"description": "The maximum number of lines to tail.",
"x-nullable": true
}
}
},
"DeploymentProvisioningState": {
"type": "string",
"description": "Possible values for DeploymentProvisioningState.",
"enum": [
"Creating",
"Deleting",
"Scaling",
"Updating",
"Succeeded",
"Failed",
"Canceled"
],
"x-ms-enum": {
"name": "DeploymentProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Scaling",
"value": "Scaling"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Canceled",
"value": "Canceled"
}
]
},
"readOnly": true
},
"DeploymentResourceConfiguration": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/ResourceConfiguration"
}
]
},
"DestinationAsset": {
"type": "object",
"description": "Publishing destination registry asset information",
"properties": {
"destinationName": {
"type": "string",
"description": "Destination asset name",
"x-nullable": true
},
"destinationVersion": {
"type": "string",
"description": "Destination asset version",
"x-nullable": true
},
"registryName": {
"type": "string",
"description": "Destination registry name",
"x-nullable": true
}
}
},
"DiagnoseRequestProperties": {
"type": "object",
"properties": {
"applicationInsights": {
"type": "object",
"description": "Setting for diagnosing dependent application insights",
"additionalProperties": {}
},
"containerRegistry": {
"type": "object",
"description": "Setting for diagnosing dependent container registry",
"additionalProperties": {}
},
"dnsResolution": {
"type": "object",
"description": "Setting for diagnosing dns resolution",
"additionalProperties": {}
},
"keyVault": {
"type": "object",
"description": "Setting for diagnosing dependent key vault",
"additionalProperties": {}
},
"nsg": {
"type": "object",
"description": "Setting for diagnosing network security group",
"additionalProperties": {}
},
"others": {
"type": "object",
"description": "Setting for diagnosing unclassified category of problems",
"additionalProperties": {}
},
"requiredResourceProviders": {
"type": "object",
"description": "Setting for diagnosing the presence of required resource providers in the workspace.",
"additionalProperties": {}
},
"resourceLock": {
"type": "object",
"description": "Setting for diagnosing resource lock",
"additionalProperties": {}
},
"storageAccount": {
"type": "object",
"description": "Setting for diagnosing dependent storage account",
"additionalProperties": {}
},
"udr": {
"type": "object",
"description": "Setting for diagnosing user defined routing",
"additionalProperties": {}
}
}
},
"DiagnoseResponseResult": {
"type": "object",
"properties": {
"value": {
"$ref": "#/definitions/DiagnoseResponseResultValue"
}
}
},
"DiagnoseResponseResultValue": {
"type": "object",
"properties": {
"userDefinedRouteResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"networkSecurityRuleResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"resourceLockResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"dnsResolutionResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"storageAccountResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"keyVaultResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"containerRegistryResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"applicationInsightsResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
},
"otherResults": {
"type": "array",
"items": {
"$ref": "#/definitions/DiagnoseResult"
},
"x-ms-identifiers": [
"message"
]
}
}
},
"DiagnoseResult": {
"type": "object",
"description": "Result of Diagnose",
"properties": {
"code": {
"type": "string",
"description": "Code for workspace setup error",
"readOnly": true
},
"level": {
"$ref": "#/definitions/DiagnoseResultLevel",
"description": "Level of workspace setup error",
"readOnly": true
},
"message": {
"type": "string",
"description": "Message of workspace setup error",
"readOnly": true
}
}
},
"DiagnoseResultLevel": {
"type": "string",
"description": "Level of workspace setup error",
"enum": [
"Warning",
"Error",
"Information"
],
"x-ms-enum": {
"name": "DiagnoseResultLevel",
"modelAsString": true,
"values": [
{
"name": "Warning",
"value": "Warning"
},
{
"name": "Error",
"value": "Error"
},
{
"name": "Information",
"value": "Information"
}
]
}
},
"DiagnoseWorkspaceParameters": {
"type": "object",
"description": "Parameters to diagnose a workspace",
"properties": {
"value": {
"$ref": "#/definitions/DiagnoseRequestProperties"
}
}
},
"DistributionConfiguration": {
"type": "object",
"description": "Base definition for job distribution configuration.",
"properties": {
"distributionType": {
"$ref": "#/definitions/DistributionType",
"description": "[Required] Specifies the type of distribution framework.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "distributionType",
"required": [
"distributionType"
]
},
"DistributionType": {
"type": "string",
"description": "Enum to determine the job distribution type.",
"enum": [
"PyTorch",
"TensorFlow",
"Mpi"
],
"x-ms-enum": {
"name": "DistributionType",
"modelAsString": true,
"values": [
{
"name": "PyTorch",
"value": "PyTorch"
},
{
"name": "TensorFlow",
"value": "TensorFlow"
},
{
"name": "Mpi",
"value": "Mpi"
}
]
}
},
"Docker": {
"type": "object",
"properties": {
"privileged": {
"type": "boolean",
"description": "Indicate whether container shall run in privileged or non-privileged mode.",
"x-nullable": true
}
},
"additionalProperties": {}
},
"DockerCredential": {
"type": "object",
"description": "Credential for docker with username and password",
"properties": {
"password": {
"type": "string",
"format": "password",
"description": "DockerCredential user password",
"x-nullable": true,
"x-ms-secret": true
},
"userName": {
"type": "string",
"description": "DockerCredential user name",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DataReferenceCredential"
}
],
"x-ms-discriminator-value": "DockerCredentials"
},
"EarlyTerminationPolicy": {
"type": "object",
"description": "Early termination policies enable canceling poor-performing runs before they complete",
"properties": {
"delayEvaluation": {
"type": "integer",
"format": "int32",
"description": "Number of intervals by which to delay the first evaluation.",
"default": 0
},
"evaluationInterval": {
"type": "integer",
"format": "int32",
"description": "Interval (number of runs) between policy evaluations.",
"default": 0
},
"policyType": {
"$ref": "#/definitions/EarlyTerminationPolicyType",
"description": "[Required] Name of policy configuration"
}
},
"discriminator": "policyType",
"required": [
"policyType"
]
},
"EarlyTerminationPolicyType": {
"type": "string",
"enum": [
"Bandit",
"MedianStopping",
"TruncationSelection"
],
"x-ms-enum": {
"name": "EarlyTerminationPolicyType",
"modelAsString": true,
"values": [
{
"name": "Bandit",
"value": "Bandit"
},
{
"name": "MedianStopping",
"value": "MedianStopping"
},
{
"name": "TruncationSelection",
"value": "TruncationSelection"
}
]
}
},
"EmailNotificationEnableType": {
"type": "string",
"description": "Enum to determine the email notification type.",
"enum": [
"JobCompleted",
"JobFailed",
"JobCancelled"
],
"x-ms-enum": {
"name": "EmailNotificationEnableType",
"modelAsString": true,
"values": [
{
"name": "JobCompleted",
"value": "JobCompleted"
},
{
"name": "JobFailed",
"value": "JobFailed"
},
{
"name": "JobCancelled",
"value": "JobCancelled"
}
]
}
},
"EncryptionKeyVaultUpdateProperties": {
"type": "object",
"properties": {
"keyIdentifier": {
"type": "string",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"keyIdentifier"
]
},
"EncryptionProperty": {
"type": "object",
"properties": {
"cosmosDbResourceId": {
"type": "string",
"description": "The byok cosmosdb account that customer brings to store customer's data\nwith encryption"
},
"identity": {
"$ref": "#/definitions/IdentityForCmk",
"description": "Identity to be used with the keyVault"
},
"keyVaultProperties": {
"$ref": "#/definitions/KeyVaultProperties",
"description": "KeyVault details to do the encryption"
},
"searchAccountResourceId": {
"type": "string",
"description": "The byok search account that customer brings to store customer's data\nwith encryption"
},
"status": {
"$ref": "#/definitions/EncryptionStatus",
"description": "Indicates whether or not the encryption is enabled for the workspace."
},
"storageAccountResourceId": {
"type": "string",
"description": "The byok storage account that customer brings to store customer's data\nwith encryption"
}
},
"required": [
"keyVaultProperties",
"status"
]
},
"EncryptionStatus": {
"type": "string",
"description": "Indicates whether or not the encryption is enabled for the workspace.",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "EncryptionStatus",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"EncryptionUpdateProperties": {
"type": "object",
"properties": {
"keyVaultProperties": {
"$ref": "#/definitions/EncryptionKeyVaultUpdateProperties"
}
},
"required": [
"keyVaultProperties"
]
},
"Endpoint": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"title": "Endpoint Communication Protocol",
"description": "Protocol over which communication will happen over this endpoint",
"default": "tcp",
"enum": [
"tcp",
"udp",
"http"
],
"x-ms-enum": {
"name": "Protocol",
"modelAsString": true,
"values": [
{
"name": "tcp",
"value": "tcp"
},
{
"name": "udp",
"value": "udp"
},
{
"name": "http",
"value": "http"
}
]
}
},
"name": {
"type": "string",
"description": "Name of the Endpoint"
},
"target": {
"type": "integer",
"format": "int32",
"description": "Application port inside the container."
},
"published": {
"type": "integer",
"format": "int32",
"description": "Port over which the application is exposed from container.",
"x-nullable": true
},
"hostIp": {
"type": "string",
"description": "Host IP over which the application is exposed from the container",
"x-nullable": true
}
}
},
"EndpointAuthKeys": {
"type": "object",
"description": "Keys for endpoint authentication.",
"properties": {
"primaryKey": {
"type": "string",
"format": "password",
"description": "The primary key.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
],
"x-ms-secret": true
},
"secondaryKey": {
"type": "string",
"format": "password",
"description": "The secondary key.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
],
"x-ms-secret": true
}
}
},
"EndpointAuthMode": {
"type": "string",
"description": "Enum to determine endpoint authentication mode.",
"enum": [
"AMLToken",
"Key",
"AADToken"
],
"x-ms-enum": {
"name": "EndpointAuthMode",
"modelAsString": true,
"values": [
{
"name": "AMLToken",
"value": "AMLToken"
},
{
"name": "Key",
"value": "Key"
},
{
"name": "AADToken",
"value": "AADToken"
}
]
}
},
"EndpointAuthToken": {
"type": "object",
"description": "Service Token",
"properties": {
"accessToken": {
"type": "string",
"format": "password",
"description": "Access token for endpoint authentication.",
"x-nullable": true,
"x-ms-secret": true
},
"expiryTimeUtc": {
"type": "integer",
"format": "int64",
"description": "Access token expiry time (UTC).",
"default": 0
},
"refreshAfterTimeUtc": {
"type": "integer",
"format": "int64",
"description": "Refresh access token after time (UTC).",
"default": 0
},
"tokenType": {
"type": "string",
"description": "Access token type.",
"x-nullable": true
}
}
},
"EndpointComputeType": {
"type": "string",
"description": "Enum to determine endpoint compute type.",
"enum": [
"Managed",
"Kubernetes",
"AzureMLCompute"
],
"x-ms-enum": {
"name": "EndpointComputeType",
"modelAsString": true,
"values": [
{
"name": "Managed",
"value": "Managed"
},
{
"name": "Kubernetes",
"value": "Kubernetes"
},
{
"name": "AzureMLCompute",
"value": "AzureMLCompute"
}
]
}
},
"EndpointDeploymentPropertiesBase": {
"type": "object",
"description": "Base definition for endpoint deployment.",
"properties": {
"codeConfiguration": {
"$ref": "#/definitions/CodeConfiguration",
"description": "Code configuration for the endpoint deployment.",
"x-nullable": true
},
"description": {
"type": "string",
"description": "Description of the endpoint deployment.",
"x-nullable": true
},
"environmentId": {
"type": "string",
"description": "ARM resource ID or AssetId of the environment specification for the endpoint deployment.",
"x-nullable": true
},
"environmentVariables": {
"type": "object",
"description": "Environment variables configuration for the deployment.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"properties": {
"type": "object",
"description": "Property dictionary. Properties can be added, but not removed or altered.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
}
},
"EndpointPropertiesBase": {
"type": "object",
"description": "Inference Endpoint base definition",
"properties": {
"authMode": {
"$ref": "#/definitions/EndpointAuthMode",
"description": "[Required] The authentication method for invoking the endpoint (data plane operation). Use 'Key' for key-based authentication. Use 'AMLToken' for Azure Machine Learning token-based authentication. Use 'AADToken' for Microsoft Entra token-based authentication."
},
"description": {
"type": "string",
"description": "Description of the inference endpoint.",
"x-nullable": true
},
"keys": {
"$ref": "#/definitions/EndpointAuthKeys",
"format": "password",
"description": "EndpointAuthKeys to set initially on an Endpoint.\nThis property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.",
"x-nullable": true,
"x-ms-mutability": [
"create"
],
"x-ms-secret": true
},
"properties": {
"type": "object",
"description": "Property dictionary. Properties can be added, but not removed or altered.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"scoringUri": {
"type": "string",
"format": "uri",
"description": "Endpoint URI.",
"x-nullable": true,
"readOnly": true
},
"swaggerUri": {
"type": "string",
"format": "uri",
"description": "Endpoint Swagger URI.",
"x-nullable": true,
"readOnly": true
}
},
"required": [
"authMode"
]
},
"EndpointProvisioningState": {
"type": "string",
"description": "State of endpoint provisioning.",
"enum": [
"Creating",
"Deleting",
"Succeeded",
"Failed",
"Updating",
"Canceled"
],
"x-ms-enum": {
"name": "EndpointProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Canceled",
"value": "Canceled"
}
]
},
"readOnly": true
},
"EndpointScheduleAction": {
"type": "object",
"properties": {
"endpointInvocationDefinition": {
"type": "object",
"description": "[Required] Defines Schedule action definition details.\n",
"additionalProperties": {},
"x-ms-mutability": [
"read",
"update",
"create"
]
}
},
"required": [
"endpointInvocationDefinition"
],
"allOf": [
{
"$ref": "#/definitions/ScheduleActionBase"
}
],
"x-ms-discriminator-value": "InvokeBatchEndpoint"
},
"EndpointServiceConnectionStatus": {
"type": "string",
"description": "Connection status of the service consumer with the service provider",
"enum": [
"Approved",
"Pending",
"Rejected",
"Disconnected",
"Timeout"
],
"x-ms-enum": {
"name": "EndpointServiceConnectionStatus",
"modelAsString": true,
"values": [
{
"name": "Approved",
"value": "Approved"
},
{
"name": "Pending",
"value": "Pending"
},
{
"name": "Rejected",
"value": "Rejected"
},
{
"name": "Disconnected",
"value": "Disconnected"
},
{
"name": "Timeout",
"value": "Timeout"
}
]
}
},
"EnvironmentContainer": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/EnvironmentContainerProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"EnvironmentContainerProperties": {
"type": "object",
"description": "Container for environment specification versions.",
"properties": {
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the environment container.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetContainer"
}
]
},
"EnvironmentContainerResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of EnvironmentContainer entities.",
"properties": {
"value": {
"type": "array",
"description": "The EnvironmentContainer items on this page",
"items": {
"$ref": "#/definitions/EnvironmentContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"EnvironmentType": {
"type": "string",
"description": "Environment type is either user created or curated by Azure ML service",
"enum": [
"Curated",
"UserCreated"
],
"x-ms-enum": {
"name": "EnvironmentType",
"modelAsString": true,
"values": [
{
"name": "Curated",
"value": "Curated"
},
{
"name": "UserCreated",
"value": "UserCreated"
}
]
}
},
"EnvironmentVariable": {
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Type of Environment Variable",
"description": "Type of the Environment Variable. Possible values are: local - For local variable",
"default": "local",
"enum": [
"local"
],
"x-ms-enum": {
"name": "EnvironmentVariableType",
"modelAsString": true,
"values": [
{
"name": "local",
"value": "local"
}
]
}
},
"value": {
"type": "string",
"description": "Value of the Environment variable"
}
},
"additionalProperties": {}
},
"EnvironmentVersion": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/EnvironmentVersionProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"EnvironmentVersionProperties": {
"type": "object",
"description": "Environment version details.",
"properties": {
"autoRebuild": {
"type": "string",
"description": "AutoRebuild setting for the derived image",
"default": "Disabled",
"enum": [
"Disabled",
"OnBaseImageUpdate"
],
"x-ms-enum": {
"name": "AutoRebuildSetting",
"modelAsString": true,
"values": [
{
"name": "Disabled",
"value": "Disabled"
},
{
"name": "OnBaseImageUpdate",
"value": "OnBaseImageUpdate"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"build": {
"$ref": "#/definitions/BuildContext",
"description": "Configuration settings for Docker build context.",
"x-ms-mutability": [
"read",
"create"
]
},
"condaFile": {
"type": "string",
"description": "Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.\n",
"x-ms-mutability": [
"read",
"create"
]
},
"environmentType": {
"$ref": "#/definitions/EnvironmentType",
"description": "Environment type is either user managed or curated by the Azure ML service\n",
"readOnly": true
},
"image": {
"type": "string",
"description": "Name of the image that will be used for the environment.\n",
"x-ms-mutability": [
"read",
"create"
]
},
"inferenceConfig": {
"$ref": "#/definitions/InferenceContainerProperties",
"description": "Defines configuration specific to inference.",
"x-ms-mutability": [
"read",
"create"
]
},
"osType": {
"type": "string",
"description": "The type of operating system.",
"default": "Linux",
"enum": [
"Linux",
"Windows"
],
"x-ms-enum": {
"name": "OperatingSystemType",
"modelAsString": true,
"values": [
{
"name": "Linux",
"value": "Linux"
},
{
"name": "Windows",
"value": "Windows"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the environment version.",
"readOnly": true
},
"stage": {
"type": "string",
"description": "Stage in the environment lifecycle assigned to this environment",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetBase"
}
]
},
"EnvironmentVersionResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of EnvironmentVersion entities.",
"properties": {
"value": {
"type": "array",
"description": "The EnvironmentVersion items on this page",
"items": {
"$ref": "#/definitions/EnvironmentVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"EstimatedVMPrice": {
"type": "object",
"description": "The estimated price info for using a VM of a particular OS type, tier, etc.",
"properties": {
"retailPrice": {
"type": "number",
"format": "double",
"title": "Retail price",
"description": "The price charged for using the VM."
},
"osType": {
"$ref": "#/definitions/VMPriceOSType",
"title": "OS type",
"description": "Operating system type used by the VM."
},
"vmTier": {
"$ref": "#/definitions/VMTier",
"title": "VM tier",
"description": "The type of the VM."
}
},
"required": [
"retailPrice",
"osType",
"vmTier"
]
},
"EstimatedVMPrices": {
"type": "object",
"description": "The estimated price info for using a VM.",
"properties": {
"billingCurrency": {
"$ref": "#/definitions/BillingCurrency",
"title": "Billing currency",
"description": "Three lettered code specifying the currency of the VM price. Example: USD"
},
"unitOfMeasure": {
"$ref": "#/definitions/UnitOfMeasure",
"title": "Unit of time measure",
"description": "The unit of time measurement for the specified VM price. Example: OneHour"
},
"values": {
"type": "array",
"title": "List of estimated VM prices.",
"description": "The list of estimated prices for using a VM of a particular OS type, tier, etc.",
"items": {
"$ref": "#/definitions/EstimatedVMPrice"
},
"x-ms-identifiers": []
}
},
"required": [
"billingCurrency",
"unitOfMeasure",
"values"
]
},
"ExternalFQDNResponse": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/FQDNEndpointsPropertyBag"
},
"x-ms-identifiers": [
"/properties/category"
]
}
}
},
"FQDNEndpoint": {
"type": "object",
"properties": {
"domainName": {
"type": "string"
},
"endpointDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/FQDNEndpointDetail"
},
"x-ms-identifiers": [
"port"
]
}
}
},
"FQDNEndpointDetail": {
"type": "object",
"properties": {
"port": {
"type": "integer",
"format": "int32"
}
}
},
"FQDNEndpoints": {
"type": "object",
"properties": {
"category": {
"type": "string"
},
"endpoints": {
"type": "array",
"items": {
"$ref": "#/definitions/FQDNEndpoint"
},
"x-ms-identifiers": [
"domainName"
]
}
}
},
"FQDNEndpointsPropertyBag": {
"type": "object",
"description": "Property bag for FQDN endpoints result",
"properties": {
"properties": {
"$ref": "#/definitions/FQDNEndpoints"
}
}
},
"Feature": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/FeatureProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"FeatureAttributionDriftMonitoringSignal": {
"type": "object",
"properties": {
"featureDataTypeOverride": {
"type": "object",
"description": "A dictionary that maps feature names to their respective data types.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/MonitoringFeatureDataType"
},
"x-ms-mutability": [
"read",
"create"
]
},
"featureImportanceSettings": {
"$ref": "#/definitions/FeatureImportanceSettings",
"description": "[Required] The settings for computing feature importance.",
"x-ms-mutability": [
"read",
"create"
]
},
"metricThreshold": {
"$ref": "#/definitions/FeatureAttributionMetricThreshold",
"description": "[Required] A list of metrics to calculate and their associated thresholds.",
"x-ms-mutability": [
"read",
"create"
]
},
"productionData": {
"type": "array",
"description": "[Required] The data which drift will be calculated for.",
"items": {
"$ref": "#/definitions/MonitoringInputDataBase"
},
"x-ms-identifiers": [],
"x-ms-mutability": [
"read",
"create"
]
},
"referenceData": {
"$ref": "#/definitions/MonitoringInputDataBase",
"description": "[Required] The data to calculate drift against.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"featureImportanceSettings",
"metricThreshold",
"productionData",
"referenceData"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringSignalBase"
}
],
"x-ms-discriminator-value": "FeatureAttributionDrift"
},
"FeatureAttributionMetric": {
"type": "string",
"enum": [
"NormalizedDiscountedCumulativeGain"
],
"x-ms-enum": {
"name": "FeatureAttributionMetric",
"modelAsString": true,
"values": [
{
"name": "NormalizedDiscountedCumulativeGain",
"value": "NormalizedDiscountedCumulativeGain",
"description": "The Normalized Discounted Cumulative Gain metric."
}
]
}
},
"FeatureAttributionMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"$ref": "#/definitions/FeatureAttributionMetric",
"description": "[Required] The feature attribution metric to calculate.",
"x-ms-mutability": [
"read",
"create"
]
},
"threshold": {
"$ref": "#/definitions/MonitoringThreshold",
"description": "The threshold value. If null, a default value will be set depending on the selected metric.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metric"
]
},
"FeatureImportanceSettings": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "The mode of operation for computing feature importance.",
"default": "Disabled",
"enum": [
"Disabled",
"Enabled"
],
"x-ms-enum": {
"name": "FeatureImportanceMode",
"modelAsString": true,
"values": [
{
"name": "Disabled",
"value": "Disabled",
"description": "Disables computing feature importance within a signal."
},
{
"name": "Enabled",
"value": "Enabled",
"description": "Enables computing feature importance within a signal."
}
]
}
},
"targetColumn": {
"type": "string",
"description": "The name of the target column within the input data asset.",
"x-nullable": true
}
}
},
"FeatureProperties": {
"type": "object",
"description": "DTO object representing feature",
"properties": {
"dataType": {
"type": "string",
"description": "Specifies type",
"default": "String",
"enum": [
"String",
"Integer",
"Long",
"Float",
"Double",
"Binary",
"Datetime",
"Boolean"
],
"x-ms-enum": {
"name": "FeatureDataType",
"modelAsString": true,
"values": [
{
"name": "String",
"value": "String"
},
{
"name": "Integer",
"value": "Integer"
},
{
"name": "Long",
"value": "Long"
},
{
"name": "Float",
"value": "Float"
},
{
"name": "Double",
"value": "Double"
},
{
"name": "Binary",
"value": "Binary"
},
{
"name": "Datetime",
"value": "Datetime"
},
{
"name": "Boolean",
"value": "Boolean"
}
]
}
},
"featureName": {
"type": "string",
"description": "Specifies name",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/ResourceBase"
}
]
},
"FeatureResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of Feature entities.",
"properties": {
"value": {
"type": "array",
"description": "The Feature items on this page",
"items": {
"$ref": "#/definitions/Feature"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"FeatureStoreSettings": {
"type": "object",
"properties": {
"computeRuntime": {
"$ref": "#/definitions/ComputeRuntimeDto"
},
"offlineStoreConnectionName": {
"type": "string"
},
"onlineStoreConnectionName": {
"type": "string"
}
}
},
"FeatureSubset": {
"type": "object",
"properties": {
"features": {
"type": "array",
"description": "[Required] The list of features to include.",
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"features"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringFeatureFilterBase"
}
],
"x-ms-discriminator-value": "FeatureSubset"
},
"FeatureWindow": {
"type": "object",
"description": "Specifies the feature window",
"properties": {
"featureWindowEnd": {
"type": "string",
"format": "date-time",
"description": "Specifies the feature window end time",
"x-nullable": true
},
"featureWindowStart": {
"type": "string",
"format": "date-time",
"description": "Specifies the feature window start time",
"x-nullable": true
}
}
},
"FeaturesetContainer": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/FeaturesetContainerProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"FeaturesetContainerProperties": {
"type": "object",
"description": "DTO object representing feature set",
"properties": {
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the featureset container.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetContainer"
}
]
},
"FeaturesetContainerResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of FeaturesetContainer entities.",
"properties": {
"value": {
"type": "array",
"description": "The FeaturesetContainer items on this page",
"items": {
"$ref": "#/definitions/FeaturesetContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"FeaturesetSpecification": {
"type": "object",
"description": "DTO object representing specification",
"properties": {
"path": {
"type": "string",
"description": "Specifies the spec path",
"x-nullable": true
}
}
},
"FeaturesetVersion": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/FeaturesetVersionProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"FeaturesetVersionBackfillRequest": {
"type": "object",
"description": "Request payload for creating a backfill request for a given feature set version",
"properties": {
"dataAvailabilityStatus": {
"type": "array",
"description": "Specified the data availability status that you want to backfill",
"items": {
"$ref": "#/definitions/DataAvailabilityStatus"
}
},
"description": {
"type": "string",
"description": "Specifies description"
},
"displayName": {
"type": "string",
"description": "Specifies description"
},
"featureWindow": {
"$ref": "#/definitions/FeatureWindow",
"description": "Specifies the backfill feature window to be materialized",
"x-nullable": true
},
"jobId": {
"type": "string",
"description": "Specify the jobId to retry the failed materialization"
},
"properties": {
"type": "object",
"description": "Specifies the properties",
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"resource": {
"$ref": "#/definitions/MaterializationComputeResource",
"description": "Specifies the compute resource settings"
},
"sparkConfiguration": {
"type": "object",
"description": "Specifies the spark compute settings",
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"tags": {
"type": "object",
"description": "Specifies the tags",
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
}
},
"FeaturesetVersionBackfillResponse": {
"type": "object",
"description": "Response payload for creating a backfill request for a given feature set version",
"properties": {
"jobIds": {
"type": "array",
"description": "List of jobs submitted as part of the backfill request.",
"x-nullable": true,
"items": {
"type": "string"
}
}
}
},
"FeaturesetVersionProperties": {
"type": "object",
"description": "DTO object representing feature set version",
"properties": {
"entities": {
"type": "array",
"description": "Specifies list of entities",
"x-nullable": true,
"items": {
"type": "string"
}
},
"materializationSettings": {
"$ref": "#/definitions/MaterializationSettings",
"description": "Specifies the materialization settings",
"x-nullable": true
},
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the featureset version container.",
"readOnly": true
},
"specification": {
"$ref": "#/definitions/FeaturesetSpecification",
"description": "Specifies the feature spec details",
"x-nullable": true
},
"stage": {
"type": "string",
"description": "Specifies the asset stage",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetBase"
}
]
},
"FeaturesetVersionResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of FeaturesetVersion entities.",
"properties": {
"value": {
"type": "array",
"description": "The FeaturesetVersion items on this page",
"items": {
"$ref": "#/definitions/FeaturesetVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"FeaturestoreEntityContainer": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/FeaturestoreEntityContainerProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"FeaturestoreEntityContainerProperties": {
"type": "object",
"description": "DTO object representing feature entity",
"properties": {
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the featurestore entity container.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetContainer"
}
]
},
"FeaturestoreEntityContainerResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of FeaturestoreEntityContainer entities.",
"properties": {
"value": {
"type": "array",
"description": "The FeaturestoreEntityContainer items on this page",
"items": {
"$ref": "#/definitions/FeaturestoreEntityContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"FeaturestoreEntityVersion": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/FeaturestoreEntityVersionProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"FeaturestoreEntityVersionProperties": {
"type": "object",
"description": "DTO object representing feature entity version",
"properties": {
"indexColumns": {
"type": "array",
"description": "Specifies index columns",
"x-nullable": true,
"items": {
"$ref": "#/definitions/IndexColumn"
}
},
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the featurestore entity version.",
"readOnly": true
},
"stage": {
"type": "string",
"description": "Specifies the asset stage",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetBase"
}
]
},
"FeaturestoreEntityVersionResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of FeaturestoreEntityVersion entities.",
"properties": {
"value": {
"type": "array",
"description": "The FeaturestoreEntityVersion items on this page",
"items": {
"$ref": "#/definitions/FeaturestoreEntityVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"FeaturizationSettings": {
"type": "object",
"description": "Featurization Configuration.",
"properties": {
"datasetLanguage": {
"type": "string",
"description": "Dataset language, useful for the text data.",
"x-nullable": true
}
}
},
"FirewallSku": {
"type": "string",
"description": "Firewall Sku used for FQDN Rules",
"enum": [
"Standard",
"Basic"
],
"x-ms-enum": {
"name": "FirewallSku",
"modelAsString": true,
"values": [
{
"name": "Standard",
"value": "Standard"
},
{
"name": "Basic",
"value": "Basic"
}
]
}
},
"FixedInputData": {
"type": "object",
"description": "Fixed input data definition.",
"allOf": [
{
"$ref": "#/definitions/MonitoringInputDataBase"
}
],
"x-ms-discriminator-value": "Fixed"
},
"FlavorData": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Model flavor-specific data.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
}
},
"ForecastHorizon": {
"type": "object",
"description": "The desired maximum forecast horizon in units of time-series frequency.",
"properties": {
"mode": {
"$ref": "#/definitions/ForecastHorizonMode",
"description": "[Required] Set forecast horizon value selection mode.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "mode",
"required": [
"mode"
]
},
"ForecastHorizonMode": {
"type": "string",
"description": "Enum to determine forecast horizon selection mode.",
"enum": [
"Auto",
"Custom"
],
"x-ms-enum": {
"name": "ForecastHorizonMode",
"modelAsString": true,
"values": [
{
"name": "Auto",
"value": "Auto",
"description": "Forecast horizon to be determined automatically."
},
{
"name": "Custom",
"value": "Custom",
"description": "Use the custom forecast horizon."
}
]
}
},
"Forecasting": {
"type": "object",
"description": "Forecasting task in AutoML Table vertical.",
"properties": {
"cvSplitColumnNames": {
"type": "array",
"description": "Columns to use for CVSplit data.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"featurizationSettings": {
"$ref": "#/definitions/TableVerticalFeaturizationSettings",
"description": "Featurization inputs needed for AutoML job.",
"x-nullable": true
},
"limitSettings": {
"$ref": "#/definitions/TableVerticalLimitSettings",
"description": "Execution constraints for AutoMLJob.",
"x-nullable": true
},
"nCrossValidations": {
"$ref": "#/definitions/NCrossValidations",
"description": "Number of cross validation folds to be applied on training dataset\nwhen validation dataset is not provided.",
"x-nullable": true
},
"testData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Test data input.",
"x-nullable": true
},
"testDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of test dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"validationDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of training dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"weightColumnName": {
"type": "string",
"description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.",
"x-nullable": true
},
"forecastingSettings": {
"$ref": "#/definitions/ForecastingSettings",
"description": "Forecasting task specific inputs.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for Forecasting task.",
"default": "NormalizedRootMeanSquaredError",
"enum": [
"SpearmanCorrelation",
"NormalizedRootMeanSquaredError",
"R2Score",
"NormalizedMeanAbsoluteError"
],
"x-ms-enum": {
"name": "ForecastingPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "SpearmanCorrelation",
"value": "SpearmanCorrelation",
"description": "The Spearman's rank coefficient of correlation is a non-parametric measure of rank correlation."
},
{
"name": "NormalizedRootMeanSquaredError",
"value": "NormalizedRootMeanSquaredError",
"description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales."
},
{
"name": "R2Score",
"value": "R2Score",
"description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models."
},
{
"name": "NormalizedMeanAbsoluteError",
"value": "NormalizedMeanAbsoluteError",
"description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales."
}
]
}
},
"trainingSettings": {
"$ref": "#/definitions/ForecastingTrainingSettings",
"description": "Inputs for training phase for an AutoML Job.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "Forecasting"
},
"ForecastingModels": {
"type": "string",
"description": "Enum for all forecasting models supported by AutoML.",
"enum": [
"AutoArima",
"Prophet",
"Naive",
"SeasonalNaive",
"Average",
"SeasonalAverage",
"ExponentialSmoothing",
"Arimax",
"TCNForecaster",
"ElasticNet",
"GradientBoosting",
"DecisionTree",
"KNN",
"LassoLars",
"SGD",
"RandomForest",
"ExtremeRandomTrees",
"LightGBM",
"XGBoostRegressor"
],
"x-ms-enum": {
"name": "ForecastingModels",
"modelAsString": true,
"values": [
{
"name": "AutoArima",
"value": "AutoArima",
"description": "Auto-Autoregressive Integrated Moving Average (ARIMA) model uses time-series data and statistical analysis to interpret the data and make future predictions.\nThis model aims to explain data by using time series data on its past values and uses linear regression to make predictions."
},
{
"name": "Prophet",
"value": "Prophet",
"description": "Prophet is a procedure for forecasting time series data based on an additive model where non-linear trends are fit with yearly, weekly, and daily seasonality, plus holiday effects.\nIt works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust to missing data and shifts in the trend, and typically handles outliers well."
},
{
"name": "Naive",
"value": "Naive",
"description": "The Naive forecasting model makes predictions by carrying forward the latest target value for each time-series in the training data."
},
{
"name": "SeasonalNaive",
"value": "SeasonalNaive",
"description": "The Seasonal Naive forecasting model makes predictions by carrying forward the latest season of target values for each time-series in the training data."
},
{
"name": "Average",
"value": "Average",
"description": "The Average forecasting model makes predictions by carrying forward the average of the target values for each time-series in the training data."
},
{
"name": "SeasonalAverage",
"value": "SeasonalAverage",
"description": "The Seasonal Average forecasting model makes predictions by carrying forward the average value of the latest season of data for each time-series in the training data."
},
{
"name": "ExponentialSmoothing",
"value": "ExponentialSmoothing",
"description": "Exponential smoothing is a time series forecasting method for univariate data that can be extended to support data with a systematic trend or seasonal component."
},
{
"name": "Arimax",
"value": "Arimax",
"description": "An Autoregressive Integrated Moving Average with Explanatory Variable (ARIMAX) model can be viewed as a multiple regression model with one or more autoregressive (AR) terms and/or one or more moving average (MA) terms.\nThis method is suitable for forecasting when data is stationary/non stationary, and multivariate with any type of data pattern, i.e., level/trend /seasonality/cyclicity."
},
{
"name": "TCNForecaster",
"value": "TCNForecaster",
"description": "TCNForecaster: Temporal Convolutional Networks Forecaster. //TODO: Ask forecasting team for brief intro."
},
{
"name": "ElasticNet",
"value": "ElasticNet",
"description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions."
},
{
"name": "GradientBoosting",
"value": "GradientBoosting",
"description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution."
},
{
"name": "DecisionTree",
"value": "DecisionTree",
"description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features."
},
{
"name": "KNN",
"value": "KNN",
"description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set."
},
{
"name": "LassoLars",
"value": "LassoLars",
"description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer."
},
{
"name": "SGD",
"value": "SGD",
"description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique."
},
{
"name": "RandomForest",
"value": "RandomForest",
"description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the \"bagging\" method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result."
},
{
"name": "ExtremeRandomTrees",
"value": "ExtremeRandomTrees",
"description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm."
},
{
"name": "LightGBM",
"value": "LightGBM",
"description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms."
},
{
"name": "XGBoostRegressor",
"value": "XGBoostRegressor",
"description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners."
}
]
}
},
"ForecastingSettings": {
"type": "object",
"description": "Forecasting specific parameters.",
"properties": {
"countryOrRegionForHolidays": {
"type": "string",
"description": "Country or region for holidays for forecasting tasks.\nThese should be ISO 3166 two-letter country/region codes, for example 'US' or 'GB'.",
"x-nullable": true
},
"cvStepSize": {
"type": "integer",
"format": "int32",
"description": "Number of periods between the origin time of one CV fold and the next fold. For\nexample, if `CVStepSize` = 3 for daily data, the origin time for each fold will be\nthree days apart.",
"x-nullable": true
},
"featureLags": {
"type": "string",
"description": "Flag for generating lags for the numeric features.",
"default": "None",
"enum": [
"None",
"Auto"
],
"x-ms-enum": {
"name": "FeatureLags",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No feature lags generated."
},
{
"name": "Auto",
"value": "Auto",
"description": "System auto-generates feature lags."
}
]
}
},
"forecastHorizon": {
"$ref": "#/definitions/ForecastHorizon",
"description": "The desired maximum forecast horizon in units of time-series frequency."
},
"frequency": {
"type": "string",
"description": "When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.",
"x-nullable": true
},
"seasonality": {
"$ref": "#/definitions/Seasonality",
"description": "Set time series seasonality as an integer multiple of the series frequency.\nIf seasonality is set to 'auto', it will be inferred."
},
"shortSeriesHandlingConfig": {
"type": "string",
"description": "The parameter defining how if AutoML should handle short time series.",
"default": "Auto",
"enum": [
"None",
"Auto",
"Pad",
"Drop"
],
"x-ms-enum": {
"name": "ShortSeriesHandlingConfiguration",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Represents no/null value."
},
{
"name": "Auto",
"value": "Auto",
"description": "Short series will be padded if there are no long series, otherwise short series will be dropped."
},
{
"name": "Pad",
"value": "Pad",
"description": "All the short series will be padded."
},
{
"name": "Drop",
"value": "Drop",
"description": "All the short series will be dropped."
}
]
}
},
"targetAggregateFunction": {
"type": "string",
"description": "Target aggregate function.",
"default": "None",
"enum": [
"None",
"Sum",
"Max",
"Min",
"Mean"
],
"x-ms-enum": {
"name": "TargetAggregationFunction",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Represent no value set."
},
{
"name": "Sum",
"value": "Sum"
},
{
"name": "Max",
"value": "Max"
},
{
"name": "Min",
"value": "Min"
},
{
"name": "Mean",
"value": "Mean"
}
]
}
},
"targetLags": {
"$ref": "#/definitions/TargetLags",
"description": "The number of past periods to lag from the target column.",
"x-nullable": true
},
"targetRollingWindowSize": {
"$ref": "#/definitions/TargetRollingWindowSize",
"description": "The number of past periods used to create a rolling window average of the target column.",
"x-nullable": true
},
"timeColumnName": {
"type": "string",
"description": "The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.",
"x-nullable": true
},
"timeSeriesIdColumnNames": {
"type": "array",
"description": "The names of columns used to group a timeseries. It can be used to create multiple series.\nIf grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"useStl": {
"type": "string",
"description": "Configure STL Decomposition of the time-series target column.",
"default": "None",
"enum": [
"None",
"Season",
"SeasonTrend"
],
"x-ms-enum": {
"name": "UseStl",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No stl decomposition."
},
{
"name": "Season",
"value": "Season"
},
{
"name": "SeasonTrend",
"value": "SeasonTrend"
}
]
}
}
}
},
"ForecastingTrainingSettings": {
"type": "object",
"description": "Forecasting Training related configuration.",
"properties": {
"allowedTrainingAlgorithms": {
"type": "array",
"description": "Allowed models for forecasting task.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ForecastingModels"
}
},
"blockedTrainingAlgorithms": {
"type": "array",
"description": "Blocked models for forecasting task.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ForecastingModels"
}
}
},
"allOf": [
{
"$ref": "#/definitions/TrainingSettings"
}
]
},
"FqdnOutboundRule": {
"type": "object",
"description": "FQDN Outbound Rule for the managed network of a machine learning workspace.",
"properties": {
"destination": {
"type": "string"
}
},
"allOf": [
{
"$ref": "#/definitions/OutboundRule"
}
],
"x-ms-discriminator-value": "FQDN"
},
"GetBlobReferenceForConsumptionDto": {
"type": "object",
"properties": {
"blobUri": {
"type": "string",
"format": "uri",
"description": "Blob uri, example: https://blob.windows.core.net/Container/Path",
"x-nullable": true
},
"credential": {
"$ref": "#/definitions/DataReferenceCredential",
"description": "Credential info to access storage account",
"x-nullable": true
},
"storageAccountArmId": {
"type": "string",
"description": "The ARM id of the storage account",
"x-nullable": true
}
}
},
"GetBlobReferenceSASRequestDto": {
"type": "object",
"description": "BlobReferenceSASRequest for getBlobReferenceSAS API",
"properties": {
"assetId": {
"type": "string",
"description": "Id of the asset to be accessed",
"x-nullable": true
},
"blobUri": {
"type": "string",
"format": "uri",
"description": "Blob uri of the asset to be accessed",
"x-nullable": true
}
}
},
"GetBlobReferenceSASResponseDto": {
"type": "object",
"description": "BlobReferenceSASResponse for getBlobReferenceSAS API",
"properties": {
"blobReferenceForConsumption": {
"$ref": "#/definitions/GetBlobReferenceForConsumptionDto",
"description": "Blob reference for consumption details",
"x-nullable": true
}
}
},
"Goal": {
"type": "string",
"description": "Defines supported metric goals for hyperparameter tuning",
"enum": [
"Minimize",
"Maximize"
],
"x-ms-enum": {
"name": "Goal",
"modelAsString": true,
"values": [
{
"name": "Minimize",
"value": "Minimize"
},
{
"name": "Maximize",
"value": "Maximize"
}
]
}
},
"GridSamplingAlgorithm": {
"type": "object",
"description": "Defines a Sampling Algorithm that exhaustively generates every value combination in the space",
"allOf": [
{
"$ref": "#/definitions/SamplingAlgorithm"
}
],
"x-ms-discriminator-value": "Grid"
},
"HDInsight": {
"type": "object",
"description": "A HDInsight compute.",
"properties": {
"properties": {
"$ref": "#/definitions/HDInsightProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "HDInsight"
},
"HDInsightProperties": {
"type": "object",
"description": "HDInsight compute properties",
"properties": {
"sshPort": {
"type": "integer",
"format": "int32",
"description": "Port open for ssh connections on the master node of the cluster."
},
"address": {
"type": "string",
"description": "Public IP address of the master node of the cluster."
},
"administratorAccount": {
"$ref": "#/definitions/VirtualMachineSshCredentials",
"description": "Admin credentials for master node of the cluster"
}
}
},
"IdAssetReference": {
"type": "object",
"description": "Reference to an asset via its ARM resource ID.",
"properties": {
"assetId": {
"type": "string",
"description": "[Required] ARM resource ID of the asset.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"assetId"
],
"allOf": [
{
"$ref": "#/definitions/AssetReferenceBase"
}
],
"x-ms-discriminator-value": "Id"
},
"IdentityConfiguration": {
"type": "object",
"description": "Base definition for identity configuration.",
"properties": {
"identityType": {
"$ref": "#/definitions/IdentityConfigurationType",
"description": "[Required] Specifies the type of identity framework.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "identityType",
"required": [
"identityType"
]
},
"IdentityConfigurationType": {
"type": "string",
"description": "Enum to determine identity framework.",
"enum": [
"Managed",
"AMLToken",
"UserIdentity"
],
"x-ms-enum": {
"name": "IdentityConfigurationType",
"modelAsString": true,
"values": [
{
"name": "Managed",
"value": "Managed"
},
{
"name": "AMLToken",
"value": "AMLToken"
},
{
"name": "UserIdentity",
"value": "UserIdentity"
}
]
}
},
"IdentityForCmk": {
"type": "object",
"description": "Identity object used for encryption.",
"properties": {
"userAssignedIdentity": {
"type": "string",
"description": "UserAssignedIdentity to be used to fetch the encryption key from keyVault"
}
}
},
"Image": {
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Type of the image",
"description": "Type of the image. Possible values are: docker - For docker images. azureml - For AzureML Environment images (custom and curated)",
"default": "docker",
"enum": [
"docker",
"azureml"
],
"x-ms-enum": {
"name": "ImageType",
"modelAsString": true,
"values": [
{
"name": "docker",
"value": "docker"
},
{
"name": "azureml",
"value": "azureml"
}
]
}
},
"reference": {
"type": "string",
"description": "Image reference URL if type is docker. Environment name if type is azureml"
},
"version": {
"type": "string",
"description": "Version of image being used. If latest then skip this field"
}
},
"additionalProperties": {}
},
"ImageClassification": {
"type": "object",
"description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'.",
"properties": {
"modelSettings": {
"$ref": "#/definitions/ImageModelSettingsClassification",
"description": "Settings used for training the model.",
"x-nullable": true
},
"searchSpace": {
"type": "array",
"description": "Search space for sampling different combinations of models and their hyperparameters.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ImageModelDistributionSettingsClassification"
}
},
"limitSettings": {
"$ref": "#/definitions/ImageLimitSettings",
"description": "[Required] Limit settings for the AutoML job."
},
"sweepSettings": {
"$ref": "#/definitions/ImageSweepSettings",
"description": "Model sweeping and hyperparameter sweeping related settings.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"validationDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of training dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for classification tasks.",
"default": "Accuracy",
"enum": [
"AUCWeighted",
"Accuracy",
"NormMacroRecall",
"AveragePrecisionScoreWeighted",
"PrecisionScoreWeighted"
],
"x-ms-enum": {
"name": "ClassificationPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "AUCWeighted",
"value": "AUCWeighted",
"description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class."
},
{
"name": "Accuracy",
"value": "Accuracy",
"description": "Accuracy is the ratio of predictions that exactly match the true class labels."
},
{
"name": "NormMacroRecall",
"value": "NormMacroRecall",
"description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1."
},
{
"name": "AveragePrecisionScoreWeighted",
"value": "AveragePrecisionScoreWeighted",
"description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class."
},
{
"name": "PrecisionScoreWeighted",
"value": "PrecisionScoreWeighted",
"description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class."
}
]
}
}
},
"required": [
"limitSettings"
],
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "ImageClassification"
},
"ImageClassificationMultilabel": {
"type": "object",
"description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'.",
"properties": {
"modelSettings": {
"$ref": "#/definitions/ImageModelSettingsClassification",
"description": "Settings used for training the model.",
"x-nullable": true
},
"searchSpace": {
"type": "array",
"description": "Search space for sampling different combinations of models and their hyperparameters.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ImageModelDistributionSettingsClassification"
}
},
"limitSettings": {
"$ref": "#/definitions/ImageLimitSettings",
"description": "[Required] Limit settings for the AutoML job."
},
"sweepSettings": {
"$ref": "#/definitions/ImageSweepSettings",
"description": "Model sweeping and hyperparameter sweeping related settings.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"validationDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of training dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for classification multilabel tasks.",
"default": "IOU",
"enum": [
"AUCWeighted",
"Accuracy",
"NormMacroRecall",
"AveragePrecisionScoreWeighted",
"PrecisionScoreWeighted",
"IOU"
],
"x-ms-enum": {
"name": "ClassificationMultilabelPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "AUCWeighted",
"value": "AUCWeighted",
"description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class."
},
{
"name": "Accuracy",
"value": "Accuracy",
"description": "Accuracy is the ratio of predictions that exactly match the true class labels."
},
{
"name": "NormMacroRecall",
"value": "NormMacroRecall",
"description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1."
},
{
"name": "AveragePrecisionScoreWeighted",
"value": "AveragePrecisionScoreWeighted",
"description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class."
},
{
"name": "PrecisionScoreWeighted",
"value": "PrecisionScoreWeighted",
"description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class."
},
{
"name": "IOU",
"value": "IOU",
"description": "Intersection Over Union. Intersection of predictions divided by union of predictions."
}
]
}
}
},
"required": [
"limitSettings"
],
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "ImageClassificationMultilabel"
},
"ImageInstanceSegmentation": {
"type": "object",
"description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\ndrawing a polygon around each object in the image.",
"properties": {
"modelSettings": {
"$ref": "#/definitions/ImageModelSettingsObjectDetection",
"description": "Settings used for training the model.",
"x-nullable": true
},
"searchSpace": {
"type": "array",
"description": "Search space for sampling different combinations of models and their hyperparameters.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ImageModelDistributionSettingsObjectDetection"
}
},
"limitSettings": {
"$ref": "#/definitions/ImageLimitSettings",
"description": "[Required] Limit settings for the AutoML job."
},
"sweepSettings": {
"$ref": "#/definitions/ImageSweepSettings",
"description": "Model sweeping and hyperparameter sweeping related settings.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"validationDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of training dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for InstanceSegmentation tasks.",
"default": "MeanAveragePrecision",
"enum": [
"MeanAveragePrecision"
],
"x-ms-enum": {
"name": "InstanceSegmentationPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "MeanAveragePrecision",
"value": "MeanAveragePrecision",
"description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP."
}
]
}
}
},
"required": [
"limitSettings"
],
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "ImageInstanceSegmentation"
},
"ImageLimitSettings": {
"type": "object",
"description": "Limit settings for the AutoML job.",
"properties": {
"maxConcurrentTrials": {
"type": "integer",
"format": "int32",
"description": "Maximum number of concurrent AutoML iterations.",
"default": 1
},
"maxTrials": {
"type": "integer",
"format": "int32",
"description": "Maximum number of AutoML iterations.",
"default": 1
},
"timeout": {
"type": "string",
"format": "duration",
"description": "AutoML job timeout.",
"default": "P7D"
}
}
},
"ImageMetadata": {
"type": "object",
"description": "Returns metadata about the operating system image for this compute instance.",
"properties": {
"currentImageVersion": {
"type": "string",
"description": "Specifies the current operating system image version this compute instance is running on."
},
"latestImageVersion": {
"type": "string",
"description": "Specifies the latest available operating system image version."
},
"isLatestOsImageVersion": {
"type": "boolean",
"description": "Specifies whether this compute instance is running on the latest operating system image."
},
"osPatchingStatus": {
"$ref": "#/definitions/OsPatchingStatus",
"description": "Metadata about the os patching.",
"readOnly": true
}
}
},
"ImageModelDistributionSettings": {
"type": "object",
"description": "Distribution expressions to sweep over values of model settings.\n\nSome examples are:\n```\nModelName = \"choice('seresnext', 'resnest50')\";\nLearningRate = \"uniform(0.001, 0.01)\";\nLayersToFreeze = \"choice(0, 2)\";\n```\nAll distributions can be specified as distribution_name(min, max) or choice(val1, val2, ..., valn)\nwhere distribution name can be: uniform, quniform, loguniform, etc\nFor more details on how to compose distribution expressions please check the documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\nFor more information on the available settings please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"properties": {
"amsGradient": {
"type": "string",
"description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.",
"x-nullable": true
},
"augmentations": {
"type": "string",
"description": "Settings for using Augmentations.",
"x-nullable": true
},
"beta1": {
"type": "string",
"description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"beta2": {
"type": "string",
"description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"distributed": {
"type": "string",
"description": "Whether to use distributer training.",
"x-nullable": true
},
"earlyStopping": {
"type": "string",
"description": "Enable early stopping logic during training.",
"x-nullable": true
},
"earlyStoppingDelay": {
"type": "string",
"description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\nis tracked for early stopping. Must be a positive integer.",
"x-nullable": true
},
"earlyStoppingPatience": {
"type": "string",
"description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\nthe run is stopped. Must be a positive integer.",
"x-nullable": true
},
"enableOnnxNormalization": {
"type": "string",
"description": "Enable normalization when exporting ONNX model.",
"x-nullable": true
},
"evaluationFrequency": {
"type": "string",
"description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.",
"x-nullable": true
},
"gradientAccumulationStep": {
"type": "string",
"description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\nupdating the model weights while accumulating the gradients of those steps, and then using\nthe accumulated gradients to compute the weight updates. Must be a positive integer.",
"x-nullable": true
},
"layersToFreeze": {
"type": "string",
"description": "Number of layers to freeze for the model. Must be a positive integer.\nFor instance, passing 2 as value for 'seresnext' means\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"x-nullable": true
},
"learningRate": {
"type": "string",
"description": "Initial learning rate. Must be a float in the range [0, 1].",
"x-nullable": true
},
"learningRateScheduler": {
"type": "string",
"description": "Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.",
"x-nullable": true
},
"modelName": {
"type": "string",
"description": "Name of the model to use for training.\nFor more information on the available models please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"x-nullable": true
},
"momentum": {
"type": "string",
"description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"nesterov": {
"type": "string",
"description": "Enable nesterov when optimizer is 'sgd'.",
"x-nullable": true
},
"numberOfEpochs": {
"type": "string",
"description": "Number of training epochs. Must be a positive integer.",
"x-nullable": true
},
"numberOfWorkers": {
"type": "string",
"description": "Number of data loader workers. Must be a non-negative integer.",
"x-nullable": true
},
"optimizer": {
"type": "string",
"description": "Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.",
"x-nullable": true
},
"randomSeed": {
"type": "string",
"description": "Random seed to be used when using deterministic training.",
"x-nullable": true
},
"stepLRGamma": {
"type": "string",
"description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"stepLRStepSize": {
"type": "string",
"description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.",
"x-nullable": true
},
"trainingBatchSize": {
"type": "string",
"description": "Training batch size. Must be a positive integer.",
"x-nullable": true
},
"validationBatchSize": {
"type": "string",
"description": "Validation batch size. Must be a positive integer.",
"x-nullable": true
},
"warmupCosineLRCycles": {
"type": "string",
"description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"warmupCosineLRWarmupEpochs": {
"type": "string",
"description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.",
"x-nullable": true
},
"weightDecay": {
"type": "string",
"description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].",
"x-nullable": true
}
}
},
"ImageModelDistributionSettingsClassification": {
"type": "object",
"description": "Distribution expressions to sweep over values of model settings.\n\nSome examples are:\n```\nModelName = \"choice('seresnext', 'resnest50')\";\nLearningRate = \"uniform(0.001, 0.01)\";\nLayersToFreeze = \"choice(0, 2)\";\n```\nFor more details on how to compose distribution expressions please check the documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\nFor more information on the available settings please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"properties": {
"trainingCropSize": {
"type": "string",
"description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.",
"x-nullable": true
},
"validationCropSize": {
"type": "string",
"description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.",
"x-nullable": true
},
"validationResizeSize": {
"type": "string",
"description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.",
"x-nullable": true
},
"weightedLoss": {
"type": "string",
"description": "Weighted loss. The accepted values are 0 for no weighted loss.\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/ImageModelDistributionSettings"
}
]
},
"ImageModelDistributionSettingsObjectDetection": {
"type": "object",
"description": "Distribution expressions to sweep over values of model settings.\n\nSome examples are:\n```\nModelName = \"choice('seresnext', 'resnest50')\";\nLearningRate = \"uniform(0.001, 0.01)\";\nLayersToFreeze = \"choice(0, 2)\";\n```\nFor more details on how to compose distribution expressions please check the documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters\nFor more information on the available settings please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"properties": {
"boxDetectionsPerImage": {
"type": "string",
"description": "Maximum number of detections per image, for all classes. Must be a positive integer.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"boxScoreThreshold": {
"type": "string",
"description": "During inference, only return proposals with a classification score greater than\nBoxScoreThreshold. Must be a float in the range[0, 1].",
"x-nullable": true
},
"imageSize": {
"type": "string",
"description": "Image size for train and validation. Must be a positive integer.\nNote: The training run may get into CUDA OOM if the size is too big.\nNote: This settings is only supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"maxSize": {
"type": "string",
"description": "Maximum size of the image to be rescaled before feeding it to the backbone.\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"minSize": {
"type": "string",
"description": "Minimum size of the image to be rescaled before feeding it to the backbone.\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"modelSize": {
"type": "string",
"description": "Model size. Must be 'small', 'medium', 'large', or 'xlarge'.\nNote: training run may get into CUDA OOM if the model size is too big.\nNote: This settings is only supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"multiScale": {
"type": "string",
"description": "Enable multi-scale image by varying image size by +/- 50%.\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\nNote: This settings is only supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"nmsIouThreshold": {
"type": "string",
"description": "IOU threshold used during inference in NMS post processing. Must be float in the range [0, 1].",
"x-nullable": true
},
"tileGridSize": {
"type": "string",
"description": "The grid size to use for tiling each image. Note: TileGridSize must not be\nNone to enable small object detection logic. A string containing two integers in mxn format.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"tileOverlapRatio": {
"type": "string",
"description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"tilePredictionsNmsThreshold": {
"type": "string",
"description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\nUsed in validation/ inference. Must be float in the range [0, 1].\nNote: This settings is not supported for the 'yolov5' algorithm.\nNMS: Non-maximum suppression",
"x-nullable": true
},
"validationIouThreshold": {
"type": "string",
"description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].",
"x-nullable": true
},
"validationMetricType": {
"type": "string",
"description": "Metric computation method to use for validation metrics. Must be 'none', 'coco', 'voc', or 'coco_voc'.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/ImageModelDistributionSettings"
}
]
},
"ImageModelSettings": {
"type": "object",
"description": "Settings used for training the model.\nFor more information on the available settings please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"properties": {
"advancedSettings": {
"type": "string",
"description": "Settings for advanced scenarios.",
"x-nullable": true
},
"amsGradient": {
"type": "boolean",
"description": "Enable AMSGrad when optimizer is 'adam' or 'adamw'.",
"x-nullable": true
},
"augmentations": {
"type": "string",
"description": "Settings for using Augmentations.",
"x-nullable": true
},
"beta1": {
"type": "number",
"format": "float",
"description": "Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"beta2": {
"type": "number",
"format": "float",
"description": "Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"checkpointFrequency": {
"type": "integer",
"format": "int32",
"description": "Frequency to store model checkpoints. Must be a positive integer.",
"x-nullable": true
},
"checkpointModel": {
"$ref": "#/definitions/MLFlowModelJobInput",
"description": "The pretrained checkpoint model for incremental training.",
"x-nullable": true
},
"checkpointRunId": {
"type": "string",
"description": "The id of a previous run that has a pretrained checkpoint for incremental training.",
"x-nullable": true
},
"distributed": {
"type": "boolean",
"description": "Whether to use distributed training.",
"x-nullable": true
},
"earlyStopping": {
"type": "boolean",
"description": "Enable early stopping logic during training.",
"x-nullable": true
},
"earlyStoppingDelay": {
"type": "integer",
"format": "int32",
"description": "Minimum number of epochs or validation evaluations to wait before primary metric improvement\nis tracked for early stopping. Must be a positive integer.",
"x-nullable": true
},
"earlyStoppingPatience": {
"type": "integer",
"format": "int32",
"description": "Minimum number of epochs or validation evaluations with no primary metric improvement before\nthe run is stopped. Must be a positive integer.",
"x-nullable": true
},
"enableOnnxNormalization": {
"type": "boolean",
"description": "Enable normalization when exporting ONNX model.",
"x-nullable": true
},
"evaluationFrequency": {
"type": "integer",
"format": "int32",
"description": "Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.",
"x-nullable": true
},
"gradientAccumulationStep": {
"type": "integer",
"format": "int32",
"description": "Gradient accumulation means running a configured number of \"GradAccumulationStep\" steps without\nupdating the model weights while accumulating the gradients of those steps, and then using\nthe accumulated gradients to compute the weight updates. Must be a positive integer.",
"x-nullable": true
},
"layersToFreeze": {
"type": "integer",
"format": "int32",
"description": "Number of layers to freeze for the model. Must be a positive integer.\nFor instance, passing 2 as value for 'seresnext' means\nfreezing layer0 and layer1. For a full list of models supported and details on layer freeze, please\nsee: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"x-nullable": true
},
"learningRate": {
"type": "number",
"format": "float",
"description": "Initial learning rate. Must be a float in the range [0, 1].",
"x-nullable": true
},
"learningRateScheduler": {
"type": "string",
"description": "Learning rate scheduler enum.",
"default": "None",
"enum": [
"None",
"WarmupCosine",
"Step"
],
"x-ms-enum": {
"name": "LearningRateScheduler",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No learning rate scheduler selected."
},
{
"name": "WarmupCosine",
"value": "WarmupCosine",
"description": "Cosine Annealing With Warmup."
},
{
"name": "Step",
"value": "Step",
"description": "Step learning rate scheduler."
}
]
}
},
"modelName": {
"type": "string",
"description": "Name of the model to use for training.\nFor more information on the available models please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"x-nullable": true
},
"momentum": {
"type": "number",
"format": "float",
"description": "Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"nesterov": {
"type": "boolean",
"description": "Enable nesterov when optimizer is 'sgd'.",
"x-nullable": true
},
"numberOfEpochs": {
"type": "integer",
"format": "int32",
"description": "Number of training epochs. Must be a positive integer.",
"x-nullable": true
},
"numberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "Number of data loader workers. Must be a non-negative integer.",
"x-nullable": true
},
"optimizer": {
"type": "string",
"description": "Stochastic optimizer for image models.",
"default": "None",
"enum": [
"None",
"Sgd",
"Adam",
"Adamw"
],
"x-ms-enum": {
"name": "StochasticOptimizer",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No optimizer selected."
},
{
"name": "Sgd",
"value": "Sgd",
"description": "Stochastic Gradient Descent optimizer."
},
{
"name": "Adam",
"value": "Adam",
"description": "Adam is algorithm the optimizes stochastic objective functions based on adaptive estimates of moments"
},
{
"name": "Adamw",
"value": "Adamw",
"description": "AdamW is a variant of the optimizer Adam that has an improved implementation of weight decay."
}
]
}
},
"randomSeed": {
"type": "integer",
"format": "int32",
"description": "Random seed to be used when using deterministic training.",
"x-nullable": true
},
"stepLRGamma": {
"type": "number",
"format": "float",
"description": "Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"stepLRStepSize": {
"type": "integer",
"format": "int32",
"description": "Value of step size when learning rate scheduler is 'step'. Must be a positive integer.",
"x-nullable": true
},
"trainingBatchSize": {
"type": "integer",
"format": "int32",
"description": "Training batch size. Must be a positive integer.",
"x-nullable": true
},
"validationBatchSize": {
"type": "integer",
"format": "int32",
"description": "Validation batch size. Must be a positive integer.",
"x-nullable": true
},
"warmupCosineLRCycles": {
"type": "number",
"format": "float",
"description": "Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].",
"x-nullable": true
},
"warmupCosineLRWarmupEpochs": {
"type": "integer",
"format": "int32",
"description": "Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.",
"x-nullable": true
},
"weightDecay": {
"type": "number",
"format": "float",
"description": "Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].",
"x-nullable": true
}
}
},
"ImageModelSettingsClassification": {
"type": "object",
"description": "Settings used for training the model.\nFor more information on the available settings please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"properties": {
"trainingCropSize": {
"type": "integer",
"format": "int32",
"description": "Image crop size that is input to the neural network for the training dataset. Must be a positive integer.",
"x-nullable": true
},
"validationCropSize": {
"type": "integer",
"format": "int32",
"description": "Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.",
"x-nullable": true
},
"validationResizeSize": {
"type": "integer",
"format": "int32",
"description": "Image size to which to resize before cropping for validation dataset. Must be a positive integer.",
"x-nullable": true
},
"weightedLoss": {
"type": "integer",
"format": "int32",
"description": "Weighted loss. The accepted values are 0 for no weighted loss.\n1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/ImageModelSettings"
}
]
},
"ImageModelSettingsObjectDetection": {
"type": "object",
"description": "Settings used for training the model.\nFor more information on the available settings please visit the official documentation:\nhttps://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.",
"properties": {
"boxDetectionsPerImage": {
"type": "integer",
"format": "int32",
"description": "Maximum number of detections per image, for all classes. Must be a positive integer.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"boxScoreThreshold": {
"type": "number",
"format": "float",
"description": "During inference, only return proposals with a classification score greater than\nBoxScoreThreshold. Must be a float in the range[0, 1].",
"x-nullable": true
},
"imageSize": {
"type": "integer",
"format": "int32",
"description": "Image size for train and validation. Must be a positive integer.\nNote: The training run may get into CUDA OOM if the size is too big.\nNote: This settings is only supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"maxSize": {
"type": "integer",
"format": "int32",
"description": "Maximum size of the image to be rescaled before feeding it to the backbone.\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"minSize": {
"type": "integer",
"format": "int32",
"description": "Minimum size of the image to be rescaled before feeding it to the backbone.\nMust be a positive integer. Note: training run may get into CUDA OOM if the size is too big.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"modelSize": {
"type": "string",
"description": "Image model size.",
"default": "None",
"enum": [
"None",
"Small",
"Medium",
"Large",
"ExtraLarge"
],
"x-ms-enum": {
"name": "ModelSize",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No value selected."
},
{
"name": "Small",
"value": "Small",
"description": "Small size."
},
{
"name": "Medium",
"value": "Medium",
"description": "Medium size."
},
{
"name": "Large",
"value": "Large",
"description": "Large size."
},
{
"name": "ExtraLarge",
"value": "ExtraLarge",
"description": "Extra large size."
}
]
}
},
"multiScale": {
"type": "boolean",
"description": "Enable multi-scale image by varying image size by +/- 50%.\nNote: training run may get into CUDA OOM if no sufficient GPU memory.\nNote: This settings is only supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"nmsIouThreshold": {
"type": "number",
"format": "float",
"description": "IOU threshold used during inference in NMS post processing. Must be a float in the range [0, 1].",
"x-nullable": true
},
"tileGridSize": {
"type": "string",
"description": "The grid size to use for tiling each image. Note: TileGridSize must not be\nNone to enable small object detection logic. A string containing two integers in mxn format.\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"tileOverlapRatio": {
"type": "number",
"format": "float",
"description": "Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1).\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"tilePredictionsNmsThreshold": {
"type": "number",
"format": "float",
"description": "The IOU threshold to use to perform NMS while merging predictions from tiles and image.\nUsed in validation/ inference. Must be float in the range [0, 1].\nNote: This settings is not supported for the 'yolov5' algorithm.",
"x-nullable": true
},
"validationIouThreshold": {
"type": "number",
"format": "float",
"description": "IOU threshold to use when computing validation metric. Must be float in the range [0, 1].",
"x-nullable": true
},
"validationMetricType": {
"type": "string",
"description": "Metric computation method to use for validation metrics in image tasks.",
"default": "None",
"enum": [
"None",
"Coco",
"Voc",
"CocoVoc"
],
"x-ms-enum": {
"name": "ValidationMetricType",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No metric."
},
{
"name": "Coco",
"value": "Coco",
"description": "Coco metric."
},
{
"name": "Voc",
"value": "Voc",
"description": "Voc metric."
},
{
"name": "CocoVoc",
"value": "CocoVoc",
"description": "CocoVoc metric."
}
]
}
}
},
"allOf": [
{
"$ref": "#/definitions/ImageModelSettings"
}
]
},
"ImageObjectDetection": {
"type": "object",
"description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.",
"properties": {
"modelSettings": {
"$ref": "#/definitions/ImageModelSettingsObjectDetection",
"description": "Settings used for training the model.",
"x-nullable": true
},
"searchSpace": {
"type": "array",
"description": "Search space for sampling different combinations of models and their hyperparameters.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ImageModelDistributionSettingsObjectDetection"
}
},
"limitSettings": {
"$ref": "#/definitions/ImageLimitSettings",
"description": "[Required] Limit settings for the AutoML job."
},
"sweepSettings": {
"$ref": "#/definitions/ImageSweepSettings",
"description": "Model sweeping and hyperparameter sweeping related settings.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"validationDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of training dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for Image ObjectDetection task.",
"default": "MeanAveragePrecision",
"enum": [
"MeanAveragePrecision"
],
"x-ms-enum": {
"name": "ObjectDetectionPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "MeanAveragePrecision",
"value": "MeanAveragePrecision",
"description": "Mean Average Precision (MAP) is the average of AP (Average Precision).\nAP is calculated for each class and averaged to get the MAP."
}
]
}
}
},
"required": [
"limitSettings"
],
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "ImageObjectDetection"
},
"ImageSweepSettings": {
"type": "object",
"description": "Model sweeping and hyperparameter sweeping related settings.",
"properties": {
"earlyTermination": {
"$ref": "#/definitions/EarlyTerminationPolicy",
"description": "Type of early termination policy.",
"x-nullable": true
},
"samplingAlgorithm": {
"$ref": "#/definitions/SamplingAlgorithmType",
"description": "[Required] Type of the hyperparameter sampling algorithms."
}
},
"required": [
"samplingAlgorithm"
]
},
"IndexColumn": {
"type": "object",
"description": "DTO object representing index column",
"properties": {
"columnName": {
"type": "string",
"description": "Specifies the column name",
"x-nullable": true
},
"dataType": {
"type": "string",
"description": "Specifies the data type",
"default": "String",
"enum": [
"String",
"Integer",
"Long",
"Float",
"Double",
"Binary",
"Datetime",
"Boolean"
],
"x-ms-enum": {
"name": "FeatureDataType",
"modelAsString": true,
"values": [
{
"name": "String",
"value": "String"
},
{
"name": "Integer",
"value": "Integer"
},
{
"name": "Long",
"value": "Long"
},
{
"name": "Float",
"value": "Float"
},
{
"name": "Double",
"value": "Double"
},
{
"name": "Binary",
"value": "Binary"
},
{
"name": "Datetime",
"value": "Datetime"
},
{
"name": "Boolean",
"value": "Boolean"
}
]
}
}
}
},
"InferenceContainerProperties": {
"type": "object",
"properties": {
"livenessRoute": {
"$ref": "#/definitions/Route",
"description": "The route to check the liveness of the inference server container."
},
"readinessRoute": {
"$ref": "#/definitions/Route",
"description": "The route to check the readiness of the inference server container."
},
"scoringRoute": {
"$ref": "#/definitions/Route",
"description": "The port to send the scoring requests to, within the inference server container."
},
"startupRoute": {
"$ref": "#/definitions/Route",
"description": "The route to check the startup of the application in the container.",
"x-nullable": true
}
}
},
"InstanceTypeSchema": {
"type": "object",
"description": "Instance type schema.",
"properties": {
"nodeSelector": {
"type": "object",
"description": "Node Selector",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"resources": {
"$ref": "#/definitions/InstanceTypeSchemaResources",
"description": "Resource requests/limits for this instance type"
}
}
},
"InstanceTypeSchemaResources": {
"type": "object",
"description": "Resource requests/limits for this instance type",
"properties": {
"requests": {
"type": "object",
"description": "Resource requests for this instance type",
"additionalProperties": {
"type": "string"
}
},
"limits": {
"type": "object",
"description": "Resource limits for this instance type",
"additionalProperties": {
"type": "string"
}
}
}
},
"IsolationMode": {
"type": "string",
"description": "Isolation mode for the managed network of a machine learning workspace.",
"enum": [
"Disabled",
"AllowInternetOutbound",
"AllowOnlyApprovedOutbound"
],
"x-ms-enum": {
"name": "IsolationMode",
"modelAsString": true,
"values": [
{
"name": "Disabled",
"value": "Disabled"
},
{
"name": "AllowInternetOutbound",
"value": "AllowInternetOutbound"
},
{
"name": "AllowOnlyApprovedOutbound",
"value": "AllowOnlyApprovedOutbound"
}
]
}
},
"JobBase": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/JobBaseProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"JobBaseProperties": {
"type": "object",
"description": "Base definition for a job.",
"properties": {
"componentId": {
"type": "string",
"description": "ARM resource ID of the component resource.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"computeId": {
"type": "string",
"description": "ARM resource ID of the compute resource.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"displayName": {
"type": "string",
"description": "Display name of job.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"experimentName": {
"type": "string",
"description": "The name of the experiment the job belongs to. If not set, the job is placed in the \"Default\" experiment.",
"default": "Default",
"x-ms-mutability": [
"read",
"create"
]
},
"identity": {
"$ref": "#/definitions/IdentityConfiguration",
"description": "Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null.\nDefaults to AmlToken if null.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"isArchived": {
"type": "boolean",
"description": "Is the asset archived?",
"default": false,
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"jobType": {
"$ref": "#/definitions/JobType",
"description": "[Required] Specifies the type of job.",
"x-ms-mutability": [
"read",
"create"
]
},
"notificationSetting": {
"$ref": "#/definitions/NotificationSetting",
"description": "Notification setting for the job",
"x-nullable": true,
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"services": {
"type": "object",
"description": "List of JobEndpoints.\nFor local jobs, a job endpoint will have an endpoint value of FileStreamObject.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobService",
"x-nullable": true
}
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "Status of the job.",
"readOnly": true
}
},
"discriminator": "jobType",
"required": [
"jobType"
],
"allOf": [
{
"$ref": "#/definitions/ResourceBase"
}
]
},
"JobBaseResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of JobBase entities.",
"properties": {
"value": {
"type": "array",
"description": "The JobBase items on this page",
"items": {
"$ref": "#/definitions/JobBase"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"JobInput": {
"type": "object",
"description": "Command job definition.",
"properties": {
"description": {
"type": "string",
"description": "Description for the input.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"jobInputType": {
"$ref": "#/definitions/JobInputType",
"description": "[Required] Specifies the type of job.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "jobInputType",
"required": [
"jobInputType"
]
},
"JobInputType": {
"type": "string",
"description": "Enum to determine the Job Input Type.",
"enum": [
"literal",
"uri_file",
"uri_folder",
"mltable",
"custom_model",
"mlflow_model",
"triton_model"
],
"x-ms-enum": {
"name": "JobInputType",
"modelAsString": true,
"values": [
{
"name": "literal",
"value": "literal"
},
{
"name": "uri_file",
"value": "uri_file"
},
{
"name": "uri_folder",
"value": "uri_folder"
},
{
"name": "mltable",
"value": "mltable"
},
{
"name": "custom_model",
"value": "custom_model"
},
{
"name": "mlflow_model",
"value": "mlflow_model"
},
{
"name": "triton_model",
"value": "triton_model"
}
]
}
},
"JobLimits": {
"type": "object",
"properties": {
"jobLimitsType": {
"$ref": "#/definitions/JobLimitsType",
"description": "[Required] JobLimit type."
},
"timeout": {
"type": "string",
"format": "duration",
"description": "The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.",
"x-nullable": true
}
},
"discriminator": "jobLimitsType",
"required": [
"jobLimitsType"
]
},
"JobLimitsType": {
"type": "string",
"enum": [
"Command",
"Sweep"
],
"x-ms-enum": {
"name": "JobLimitsType",
"modelAsString": true,
"values": [
{
"name": "Command",
"value": "Command"
},
{
"name": "Sweep",
"value": "Sweep"
}
]
}
},
"JobOutput": {
"type": "object",
"description": "Job output definition container information on where to find job output/logs.",
"properties": {
"description": {
"type": "string",
"description": "Description for the output.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"jobOutputType": {
"$ref": "#/definitions/JobOutputType",
"description": "[Required] Specifies the type of job.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "jobOutputType",
"required": [
"jobOutputType"
]
},
"JobOutputType": {
"type": "string",
"description": "Enum to determine the Job Output Type.",
"enum": [
"uri_file",
"uri_folder",
"mltable",
"custom_model",
"mlflow_model",
"triton_model"
],
"x-ms-enum": {
"name": "JobOutputType",
"modelAsString": true,
"values": [
{
"name": "uri_file",
"value": "uri_file"
},
{
"name": "uri_folder",
"value": "uri_folder"
},
{
"name": "mltable",
"value": "mltable"
},
{
"name": "custom_model",
"value": "custom_model"
},
{
"name": "mlflow_model",
"value": "mlflow_model"
},
{
"name": "triton_model",
"value": "triton_model"
}
]
}
},
"JobResourceConfiguration": {
"type": "object",
"properties": {
"dockerArgs": {
"type": "string",
"description": "Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"dockerArgsList": {
"type": "array",
"description": "Extra arguments to pass to the Docker run command, as a collection. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types.",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
},
"shmSize": {
"type": "string",
"description": "Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes).",
"default": "2g",
"pattern": "\\d+[bBkKmMgG]",
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/ResourceConfiguration"
}
]
},
"JobScheduleAction": {
"type": "object",
"properties": {
"jobDefinition": {
"$ref": "#/definitions/JobBaseProperties",
"description": "[Required] Defines Schedule action definition details.",
"x-ms-mutability": [
"read",
"update",
"create"
]
}
},
"required": [
"jobDefinition"
],
"allOf": [
{
"$ref": "#/definitions/ScheduleActionBase"
}
],
"x-ms-discriminator-value": "CreateJob"
},
"JobService": {
"type": "object",
"description": "Job endpoint definition",
"properties": {
"endpoint": {
"type": "string",
"description": "Url for endpoint.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"errorMessage": {
"type": "string",
"description": "Any error in the service.",
"x-nullable": true,
"readOnly": true
},
"jobServiceType": {
"type": "string",
"description": "Endpoint type.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"nodes": {
"$ref": "#/definitions/Nodes",
"description": "Nodes that user would like to start the service on.\nIf Nodes is not set or set to null, the service will only be started on leader node.",
"x-nullable": true
},
"port": {
"type": "integer",
"format": "int32",
"description": "Port for endpoint.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"properties": {
"type": "object",
"description": "Additional properties to set on the endpoint.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"status": {
"type": "string",
"description": "Status of endpoint.",
"x-nullable": true,
"readOnly": true
}
}
},
"JobStatus": {
"type": "string",
"description": "The status of a job.",
"enum": [
"NotStarted",
"Starting",
"Provisioning",
"Preparing",
"Queued",
"Running",
"Finalizing",
"CancelRequested",
"Completed",
"Failed",
"Canceled",
"NotResponding",
"Paused",
"Unknown"
],
"x-ms-enum": {
"name": "JobStatus",
"modelAsString": true,
"values": [
{
"name": "NotStarted",
"value": "NotStarted",
"description": "Run hasn't started yet."
},
{
"name": "Starting",
"value": "Starting",
"description": "Run has started. The user has a run ID."
},
{
"name": "Provisioning",
"value": "Provisioning",
"description": "(Not used currently) It will be used if ES is creating the compute target."
},
{
"name": "Preparing",
"value": "Preparing",
"description": "The run environment is being prepared."
},
{
"name": "Queued",
"value": "Queued",
"description": "The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready."
},
{
"name": "Running",
"value": "Running",
"description": "The job started to run in the compute target."
},
{
"name": "Finalizing",
"value": "Finalizing",
"description": "Job is completed in the target. It is in output collection state now."
},
{
"name": "CancelRequested",
"value": "CancelRequested",
"description": "Cancellation has been requested for the job."
},
{
"name": "Completed",
"value": "Completed",
"description": "Job completed successfully. This reflects that both the job itself and output collection states completed successfully"
},
{
"name": "Failed",
"value": "Failed",
"description": "Job failed."
},
{
"name": "Canceled",
"value": "Canceled",
"description": "Following cancellation request, the job is now successfully canceled."
},
{
"name": "NotResponding",
"value": "NotResponding",
"description": "When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state.\nNotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states."
},
{
"name": "Paused",
"value": "Paused",
"description": "The job is paused by users. Some adjustment to labeling jobs can be made only in paused state."
},
{
"name": "Unknown",
"value": "Unknown",
"description": "Default job status if not mapped to all other statuses"
}
]
}
},
"JobType": {
"type": "string",
"description": "Enum to determine the type of job.",
"enum": [
"AutoML",
"Command",
"Sweep",
"Pipeline",
"Spark"
],
"x-ms-enum": {
"name": "JobType",
"modelAsString": true,
"values": [
{
"name": "AutoML",
"value": "AutoML"
},
{
"name": "Command",
"value": "Command"
},
{
"name": "Sweep",
"value": "Sweep"
},
{
"name": "Pipeline",
"value": "Pipeline"
},
{
"name": "Spark",
"value": "Spark"
}
]
}
},
"JupyterKernelConfig": {
"type": "object",
"description": "Jupyter kernel configuration.",
"properties": {
"argv": {
"type": "array",
"description": "Argument to the the runtime",
"items": {
"type": "string"
}
},
"displayName": {
"type": "string",
"description": "Display name of the kernel"
},
"language": {
"type": "string",
"description": "Language of the kernel [Example value: python]"
}
}
},
"KeyType": {
"type": "string",
"enum": [
"Primary",
"Secondary"
],
"x-ms-enum": {
"name": "KeyType",
"modelAsString": true,
"values": [
{
"name": "Primary",
"value": "Primary"
},
{
"name": "Secondary",
"value": "Secondary"
}
]
}
},
"KeyVaultProperties": {
"type": "object",
"description": "Customer Key vault properties.",
"properties": {
"identityClientId": {
"type": "string",
"description": "Currently, we support only SystemAssigned MSI.\nWe need this when we support UserAssignedIdentities"
},
"keyIdentifier": {
"type": "string",
"description": "KeyVault key identifier to encrypt the data",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
},
"keyVaultArmId": {
"type": "string",
"description": "KeyVault Arm Id that contains the data encryption key",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"keyIdentifier",
"keyVaultArmId"
]
},
"Kubernetes": {
"type": "object",
"description": "A Machine Learning compute based on Kubernetes Compute.",
"properties": {
"properties": {
"$ref": "#/definitions/KubernetesProperties",
"description": "Properties of Kubernetes"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "Kubernetes"
},
"KubernetesOnlineDeployment": {
"type": "object",
"description": "Properties specific to a KubernetesOnlineDeployment.",
"properties": {
"containerResourceRequirements": {
"$ref": "#/definitions/ContainerResourceRequirements",
"description": "The resource requirements for the container (cpu and memory).",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/OnlineDeploymentProperties"
}
],
"x-ms-discriminator-value": "Kubernetes"
},
"KubernetesProperties": {
"type": "object",
"description": "Kubernetes properties",
"properties": {
"relayConnectionString": {
"type": "string",
"format": "password",
"description": "Relay connection string.",
"x-nullable": true,
"x-ms-secret": true
},
"serviceBusConnectionString": {
"type": "string",
"format": "password",
"description": "ServiceBus connection string.",
"x-nullable": true,
"x-ms-secret": true
},
"extensionPrincipalId": {
"type": "string",
"description": "Extension principal-id.",
"x-nullable": true
},
"extensionInstanceReleaseTrain": {
"type": "string",
"description": "Extension instance release train."
},
"vcName": {
"type": "string",
"description": "VC name."
},
"namespace": {
"type": "string",
"description": "Compute namespace",
"default": "default"
},
"defaultInstanceType": {
"type": "string",
"description": "Default instance type"
},
"instanceTypes": {
"type": "object",
"description": "Instance Type Schema",
"additionalProperties": {
"$ref": "#/definitions/InstanceTypeSchema"
}
}
}
},
"LakeHouseArtifact": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/OneLakeArtifact"
}
],
"x-ms-discriminator-value": "LakeHouse"
},
"ListAmlUserFeatureResult": {
"type": "object",
"description": "The List Aml user feature operation response.",
"properties": {
"value": {
"type": "array",
"description": "The AmlUserFeature items on this page",
"items": {
"$ref": "#/definitions/AmlUserFeature"
},
"readOnly": true
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ListNotebookKeysResult": {
"type": "object",
"properties": {
"primaryAccessKey": {
"type": "string",
"format": "password",
"description": "The primary access key of the Notebook",
"readOnly": true,
"x-ms-secret": true
},
"secondaryAccessKey": {
"type": "string",
"format": "password",
"description": "The secondary access key of the Notebook",
"readOnly": true,
"x-ms-secret": true
}
}
},
"ListStorageAccountKeysResult": {
"type": "object",
"properties": {
"userStorageKey": {
"type": "string",
"format": "password",
"description": "The access key of the storage",
"readOnly": true,
"x-ms-secret": true
}
}
},
"ListUsagesResult": {
"type": "object",
"description": "The List Usages operation response.",
"properties": {
"value": {
"type": "array",
"description": "The Usage items on this page",
"items": {
"$ref": "#/definitions/Usage"
},
"readOnly": true
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ListWorkspaceKeysResult": {
"type": "object",
"properties": {
"appInsightsInstrumentationKey": {
"type": "string",
"format": "password",
"description": "The access key of the workspace app insights",
"readOnly": true,
"x-ms-secret": true
},
"containerRegistryCredentials": {
"$ref": "#/definitions/RegistryListCredentialsResult"
},
"notebookAccessKeys": {
"$ref": "#/definitions/ListNotebookKeysResult"
},
"userStorageArmId": {
"type": "string",
"description": "The arm Id key of the workspace storage",
"readOnly": true
},
"userStorageKey": {
"type": "string",
"format": "password",
"description": "The access key of the workspace storage",
"readOnly": true,
"x-ms-secret": true
}
}
},
"ListWorkspaceQuotas": {
"type": "object",
"description": "The List WorkspaceQuotasByVMFamily operation response.",
"properties": {
"value": {
"type": "array",
"description": "The ResourceQuota items on this page",
"items": {
"$ref": "#/definitions/ResourceQuota"
},
"readOnly": true
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"LiteralJobInput": {
"type": "object",
"description": "Literal input type.",
"properties": {
"value": {
"type": "string",
"description": "[Required] Literal value for the input.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"value"
],
"allOf": [
{
"$ref": "#/definitions/JobInput"
}
],
"x-ms-discriminator-value": "literal"
},
"MLFlowModelJobInput": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Enum to determine the input data delivery mode.",
"default": "ReadOnlyMount",
"enum": [
"ReadOnlyMount",
"ReadWriteMount",
"Download",
"Direct",
"EvalMount",
"EvalDownload"
],
"x-ms-enum": {
"name": "InputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnlyMount",
"value": "ReadOnlyMount"
},
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Download",
"value": "Download"
},
{
"name": "Direct",
"value": "Direct"
},
{
"name": "EvalMount",
"value": "EvalMount"
},
{
"name": "EvalDownload",
"value": "EvalDownload"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "[Required] Input Asset URI.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"uri"
],
"allOf": [
{
"$ref": "#/definitions/JobInput"
}
],
"x-ms-discriminator-value": "mlflow_model"
},
"MLFlowModelJobOutput": {
"type": "object",
"properties": {
"assetName": {
"type": "string",
"description": "Output Asset Name.",
"x-nullable": true
},
"mode": {
"type": "string",
"description": "Output data delivery mode enums.",
"default": "ReadWriteMount",
"enum": [
"ReadWriteMount",
"Upload",
"Direct"
],
"x-ms-enum": {
"name": "OutputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Upload",
"value": "Upload"
},
{
"name": "Direct",
"value": "Direct"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "Output Asset URI.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/JobOutput"
}
],
"x-ms-discriminator-value": "mlflow_model"
},
"MLTableData": {
"type": "object",
"description": "MLTable data definition",
"properties": {
"referencedUris": {
"type": "array",
"description": "Uris referenced in the MLTable definition (required for lineage)",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/DataVersionBaseProperties"
}
],
"x-ms-discriminator-value": "mltable"
},
"MLTableJobInput": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Enum to determine the input data delivery mode.",
"default": "ReadOnlyMount",
"enum": [
"ReadOnlyMount",
"ReadWriteMount",
"Download",
"Direct",
"EvalMount",
"EvalDownload"
],
"x-ms-enum": {
"name": "InputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnlyMount",
"value": "ReadOnlyMount"
},
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Download",
"value": "Download"
},
{
"name": "Direct",
"value": "Direct"
},
{
"name": "EvalMount",
"value": "EvalMount"
},
{
"name": "EvalDownload",
"value": "EvalDownload"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "[Required] Input Asset URI.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"uri"
],
"allOf": [
{
"$ref": "#/definitions/JobInput"
}
],
"x-ms-discriminator-value": "mltable"
},
"MLTableJobOutput": {
"type": "object",
"properties": {
"assetName": {
"type": "string",
"description": "Output Asset Name.",
"x-nullable": true
},
"mode": {
"type": "string",
"description": "Output data delivery mode enums.",
"default": "ReadWriteMount",
"enum": [
"ReadWriteMount",
"Upload",
"Direct"
],
"x-ms-enum": {
"name": "OutputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Upload",
"value": "Upload"
},
{
"name": "Direct",
"value": "Direct"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "Output Asset URI.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/JobOutput"
}
],
"x-ms-discriminator-value": "mltable"
},
"ManagedComputeIdentity": {
"type": "object",
"description": "Managed compute identity definition.",
"properties": {
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The identity which will be leveraged by the monitoring jobs.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/MonitorComputeIdentityBase"
}
],
"x-ms-discriminator-value": "ManagedIdentity"
},
"ManagedIdentity": {
"type": "object",
"description": "Managed identity configuration.",
"properties": {
"clientId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"objectId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"resourceId": {
"type": "string",
"description": "Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/IdentityConfiguration"
}
],
"x-ms-discriminator-value": "Managed"
},
"ManagedIdentityAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionManagedIdentity"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "ManagedIdentity"
},
"ManagedIdentityCredential": {
"type": "object",
"description": "Credential for user managed identity",
"properties": {
"managedIdentityType": {
"type": "string",
"description": "ManagedIdentityCredential identity type",
"x-nullable": true
},
"userManagedIdentityClientId": {
"type": "string",
"description": "ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.",
"x-nullable": true
},
"userManagedIdentityPrincipalId": {
"type": "string",
"description": "PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.",
"x-nullable": true
},
"userManagedIdentityResourceId": {
"type": "string",
"description": "Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.",
"x-nullable": true
},
"userManagedIdentityTenantId": {
"type": "string",
"description": "TenantId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DataReferenceCredential"
}
],
"x-ms-discriminator-value": "ManagedIdentity"
},
"ManagedNetworkKind": {
"type": "string",
"description": "The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled.",
"enum": [
"V1",
"V2"
],
"x-ms-enum": {
"name": "ManagedNetworkKind",
"modelAsString": true,
"values": [
{
"name": "V1",
"value": "V1"
},
{
"name": "V2",
"value": "V2"
}
]
}
},
"ManagedNetworkProvisionOptions": {
"type": "object",
"description": "Managed Network Provisioning options for managed network of a machine learning workspace.",
"properties": {
"includeSpark": {
"type": "boolean"
}
}
},
"ManagedNetworkProvisionStatus": {
"type": "object",
"description": "Status of the Provisioning for the managed network of a machine learning workspace.",
"properties": {
"sparkReady": {
"type": "boolean"
},
"status": {
"$ref": "#/definitions/ManagedNetworkStatus",
"description": "Status for the managed network of a machine learning workspace."
}
}
},
"ManagedNetworkSettings": {
"type": "object",
"description": "Managed Network settings for a machine learning workspace.",
"properties": {
"enableNetworkMonitor": {
"type": "boolean",
"description": "A flag to indicate if monitoring needs to be enabled for the managed network.",
"default": false
},
"isolationMode": {
"$ref": "#/definitions/IsolationMode",
"description": "Isolation mode for the managed network of a machine learning workspace."
},
"networkId": {
"type": "string",
"readOnly": true
},
"outboundRules": {
"type": "object",
"description": "Dictionary of ",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/OutboundRule"
}
},
"status": {
"$ref": "#/definitions/ManagedNetworkProvisionStatus",
"description": "Status of the Provisioning for the managed network of a machine learning workspace."
},
"firewallSku": {
"$ref": "#/definitions/FirewallSku",
"description": "Firewall Sku used for FQDN Rules"
},
"managedNetworkKind": {
"$ref": "#/definitions/ManagedNetworkKind",
"description": "The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled."
},
"firewallPublicIpAddress": {
"type": "string",
"description": "Public IP address assigned to the Azure Firewall.",
"x-nullable": true,
"readOnly": true
}
}
},
"ManagedNetworkSettingsEx": {
"type": "object",
"properties": {
"changeableIsolationModes": {
"type": "array",
"items": {
"$ref": "#/definitions/IsolationMode"
},
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/ManagedNetworkSettings"
}
]
},
"ManagedNetworkStatus": {
"type": "string",
"description": "Status for the managed network of a machine learning workspace.",
"enum": [
"Inactive",
"Active"
],
"x-ms-enum": {
"name": "ManagedNetworkStatus",
"modelAsString": true,
"values": [
{
"name": "Inactive",
"value": "Inactive"
},
{
"name": "Active",
"value": "Active"
}
]
}
},
"ManagedOnlineDeployment": {
"type": "object",
"description": "Properties specific to a ManagedOnlineDeployment.",
"allOf": [
{
"$ref": "#/definitions/OnlineDeploymentProperties"
}
],
"x-ms-discriminator-value": "Managed"
},
"ManagedPERequirement": {
"type": "string",
"enum": [
"Required",
"NotRequired",
"NotApplicable"
],
"x-ms-enum": {
"name": "ManagedPERequirement",
"modelAsString": true,
"values": [
{
"name": "Required",
"value": "Required"
},
{
"name": "NotRequired",
"value": "NotRequired"
},
{
"name": "NotApplicable",
"value": "NotApplicable"
}
]
}
},
"ManagedPEStatus": {
"type": "string",
"enum": [
"Inactive",
"Active",
"NotApplicable"
],
"x-ms-enum": {
"name": "ManagedPEStatus",
"modelAsString": true,
"values": [
{
"name": "Inactive",
"value": "Inactive"
},
{
"name": "Active",
"value": "Active"
},
{
"name": "NotApplicable",
"value": "NotApplicable"
}
]
}
},
"ManagedResourceGroupAssignedIdentities": {
"type": "object",
"description": "Details for managed resource group assigned identities.",
"properties": {
"principalId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "Identity principal Id"
}
}
},
"ManagedResourceGroupSettings": {
"type": "object",
"description": "Managed resource group settings",
"properties": {
"assignedIdentities": {
"type": "array",
"description": "List of assigned identities for the managed resource group",
"x-nullable": true,
"items": {
"$ref": "#/definitions/ManagedResourceGroupAssignedIdentities"
}
}
}
},
"MarketplacePlan": {
"type": "object",
"properties": {
"offerId": {
"type": "string",
"description": "The identifying name of the Offer of the Marketplace Plan.",
"x-nullable": true,
"readOnly": true
},
"planId": {
"type": "string",
"description": "The identifying name of the Plan of the Marketplace Plan.",
"x-nullable": true,
"readOnly": true
},
"publisherId": {
"type": "string",
"description": "The identifying name of the Publisher of the Marketplace Plan.",
"x-nullable": true,
"readOnly": true
}
}
},
"MarketplaceSubscription": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/MarketplaceSubscriptionProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"MarketplaceSubscriptionProperties": {
"type": "object",
"properties": {
"marketplacePlan": {
"$ref": "#/definitions/MarketplacePlan",
"description": "Marketplace Plan associated with the Marketplace Subscription.",
"x-nullable": true,
"readOnly": true
},
"marketplaceSubscriptionStatus": {
"$ref": "#/definitions/MarketplaceSubscriptionStatus",
"description": "Current status of the Marketplace Subscription.",
"readOnly": true
},
"modelId": {
"type": "string",
"description": "[Required] Target Marketplace Model ID to create a Marketplace Subscription for.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
},
"provisioningState": {
"$ref": "#/definitions/MarketplaceSubscriptionProvisioningState",
"description": "Provisioning State of the Marketplace Subscription.",
"readOnly": true
}
},
"required": [
"modelId"
]
},
"MarketplaceSubscriptionProvisioningState": {
"type": "string",
"enum": [
"Creating",
"Deleting",
"Succeeded",
"Failed",
"Updating",
"Canceled"
],
"x-ms-enum": {
"name": "MarketplaceSubscriptionProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Creating",
"value": "Creating",
"description": "MarketplaceSubscription is being created."
},
{
"name": "Deleting",
"value": "Deleting",
"description": "MarketplaceSubscription is being deleted."
},
{
"name": "Succeeded",
"value": "Succeeded",
"description": "MarketplaceSubscription is successfully provisioned."
},
{
"name": "Failed",
"value": "Failed",
"description": "MarketplaceSubscription provisioning failed."
},
{
"name": "Updating",
"value": "Updating",
"description": "MarketplaceSubscription is being updated."
},
{
"name": "Canceled",
"value": "Canceled"
}
]
},
"readOnly": true
},
"MarketplaceSubscriptionResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of MarketplaceSubscription entities.",
"properties": {
"value": {
"type": "array",
"description": "The MarketplaceSubscription items on this page",
"items": {
"$ref": "#/definitions/MarketplaceSubscription"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"MarketplaceSubscriptionStatus": {
"type": "string",
"enum": [
"Subscribed",
"Suspended",
"Unsubscribed"
],
"x-ms-enum": {
"name": "MarketplaceSubscriptionStatus",
"modelAsString": true,
"values": [
{
"name": "Subscribed",
"value": "Subscribed",
"description": "The customer can now use the Marketplace Subscription's\nmodel and will be billed."
},
{
"name": "Suspended",
"value": "Suspended",
"description": "The customer could not be billed for the Marketplace Subscription.\nThe customer will not be able to access the model."
},
{
"name": "Unsubscribed",
"value": "Unsubscribed",
"description": "Marketplace Subscriptions reach this state in response to an explicit customer or CSP action.\nA Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues,\nafter being in the Suspended state for some time."
}
]
}
},
"MaterializationComputeResource": {
"type": "object",
"description": "DTO object representing compute resource",
"properties": {
"instanceType": {
"type": "string",
"description": "Specifies the instance type",
"x-nullable": true
}
}
},
"MaterializationSettings": {
"type": "object",
"properties": {
"notification": {
"$ref": "#/definitions/NotificationSetting",
"description": "Specifies the notification details",
"x-nullable": true
},
"resource": {
"$ref": "#/definitions/MaterializationComputeResource",
"description": "Specifies the compute resource settings",
"x-nullable": true
},
"schedule": {
"$ref": "#/definitions/RecurrenceTrigger",
"description": "Specifies the schedule details",
"x-nullable": true
},
"sparkConfiguration": {
"type": "object",
"description": "Specifies the spark compute settings",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"storeType": {
"type": "string",
"description": "Specifies the stores to which materialization should happen",
"default": "None",
"enum": [
"None",
"Online",
"Offline",
"OnlineAndOffline"
],
"x-ms-enum": {
"name": "MaterializationStoreType",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "Online",
"value": "Online"
},
{
"name": "Offline",
"value": "Offline"
},
{
"name": "OnlineAndOffline",
"value": "OnlineAndOffline"
}
]
}
}
}
},
"MedianStoppingPolicy": {
"type": "object",
"description": "Defines an early termination policy based on running averages of the primary metric of all runs",
"allOf": [
{
"$ref": "#/definitions/EarlyTerminationPolicy"
}
],
"x-ms-discriminator-value": "MedianStopping"
},
"ModelContainer": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/ModelContainerProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"ModelContainerProperties": {
"type": "object",
"properties": {
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the model container.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetContainer"
}
]
},
"ModelContainerResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of ModelContainer entities.",
"properties": {
"value": {
"type": "array",
"description": "The ModelContainer items on this page",
"items": {
"$ref": "#/definitions/ModelContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ModelSettings": {
"type": "object",
"properties": {
"modelId": {
"type": "string",
"description": "The unique model identifier that this ServerlessEndpoint should provision.",
"x-nullable": true
}
}
},
"ModelTaskType": {
"type": "string",
"description": "Model task type enum.",
"enum": [
"Classification",
"Regression"
],
"x-ms-enum": {
"name": "ModelTaskType",
"modelAsString": true,
"values": [
{
"name": "Classification",
"value": "Classification"
},
{
"name": "Regression",
"value": "Regression"
}
]
}
},
"ModelVersion": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/ModelVersionProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"ModelVersionProperties": {
"type": "object",
"description": "Model asset version details.",
"properties": {
"flavors": {
"type": "object",
"description": "Mapping of model flavors to their properties.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/FlavorData",
"x-nullable": true
}
},
"jobName": {
"type": "string",
"description": "Name of the training job which produced this model",
"x-nullable": true
},
"modelType": {
"type": "string",
"description": "The storage format for this entity. Used for NCD.",
"x-nullable": true
},
"modelUri": {
"type": "string",
"description": "The URI path to the model contents.",
"x-nullable": true
},
"provisioningState": {
"$ref": "#/definitions/AssetProvisioningState",
"description": "Provisioning state for the model version.",
"readOnly": true
},
"stage": {
"type": "string",
"description": "Stage in the model lifecycle assigned to this model",
"x-nullable": true
},
"datasets": {
"type": "array",
"description": "Array of dataset references",
"x-nullable": true,
"items": {
"$ref": "#/definitions/DatasetReference"
}
}
},
"allOf": [
{
"$ref": "#/definitions/AssetBase"
}
]
},
"ModelVersionResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of ModelVersion entities.",
"properties": {
"value": {
"type": "array",
"description": "The ModelVersion items on this page",
"items": {
"$ref": "#/definitions/ModelVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"MonitorComputeConfigurationBase": {
"type": "object",
"description": "Monitor compute configuration base definition.",
"properties": {
"computeType": {
"$ref": "#/definitions/MonitorComputeType",
"description": "[Required] Specifies the type of signal to monitor.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "computeType",
"required": [
"computeType"
]
},
"MonitorComputeIdentityBase": {
"type": "object",
"description": "Monitor compute identity base definition.",
"properties": {
"computeIdentityType": {
"$ref": "#/definitions/MonitorComputeIdentityType",
"description": "[Required] Specifies the type of identity to use within the monitoring jobs.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "computeIdentityType",
"required": [
"computeIdentityType"
]
},
"MonitorComputeIdentityType": {
"type": "string",
"description": "Monitor compute identity type enum.",
"enum": [
"AmlToken",
"ManagedIdentity"
],
"x-ms-enum": {
"name": "MonitorComputeIdentityType",
"modelAsString": true,
"values": [
{
"name": "AmlToken",
"value": "AmlToken",
"description": "Authenticates through user's AML token."
},
{
"name": "ManagedIdentity",
"value": "ManagedIdentity",
"description": "Authenticates through a user-provided managed identity."
}
]
}
},
"MonitorComputeType": {
"type": "string",
"description": "Monitor compute type enum.",
"enum": [
"ServerlessSpark"
],
"x-ms-enum": {
"name": "MonitorComputeType",
"modelAsString": true,
"values": [
{
"name": "ServerlessSpark",
"value": "ServerlessSpark",
"description": "Serverless Spark compute."
}
]
}
},
"MonitorDefinition": {
"type": "object",
"properties": {
"alertNotificationSettings": {
"$ref": "#/definitions/MonitorNotificationSettings",
"description": "The monitor's notification settings.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"computeConfiguration": {
"$ref": "#/definitions/MonitorComputeConfigurationBase",
"description": "[Required] The ARM resource ID of the compute resource to run the monitoring job on.",
"x-ms-mutability": [
"read",
"create"
]
},
"monitoringTarget": {
"$ref": "#/definitions/MonitoringTarget",
"description": "The entities targeted by the monitor.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"signals": {
"type": "object",
"description": "[Required] The signals to monitor.",
"additionalProperties": {
"$ref": "#/definitions/MonitoringSignalBase",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"computeConfiguration",
"signals"
]
},
"MonitorEmailNotificationSettings": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "The email recipient list which has a limitation of 499 characters in total.",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"MonitorNotificationSettings": {
"type": "object",
"properties": {
"emailNotificationSettings": {
"$ref": "#/definitions/MonitorEmailNotificationSettings",
"description": "The AML notification email settings.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"MonitorServerlessSparkCompute": {
"type": "object",
"description": "Monitor serverless spark compute definition.",
"properties": {
"computeIdentity": {
"$ref": "#/definitions/MonitorComputeIdentityBase",
"description": "[Required] The identity scheme leveraged to by the spark jobs running on serverless Spark.",
"x-ms-mutability": [
"read",
"create"
]
},
"instanceType": {
"type": "string",
"description": "[Required] The instance type running the Spark job.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"runtimeVersion": {
"type": "string",
"description": "[Required] The Spark runtime version.",
"minLength": 1,
"pattern": "^[0-9]+\\.[0-9]+$",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"computeIdentity",
"instanceType",
"runtimeVersion"
],
"allOf": [
{
"$ref": "#/definitions/MonitorComputeConfigurationBase"
}
],
"x-ms-discriminator-value": "ServerlessSpark"
},
"MonitoringFeatureDataType": {
"type": "string",
"enum": [
"Numerical",
"Categorical"
],
"x-ms-enum": {
"name": "MonitoringFeatureDataType",
"modelAsString": true,
"values": [
{
"name": "Numerical",
"value": "Numerical",
"description": "Used for features of numerical data type."
},
{
"name": "Categorical",
"value": "Categorical",
"description": "Used for features of categorical data type."
}
]
}
},
"MonitoringFeatureFilterBase": {
"type": "object",
"properties": {
"filterType": {
"$ref": "#/definitions/MonitoringFeatureFilterType",
"description": "[Required] Specifies the feature filter to leverage when selecting features to calculate metrics over.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "filterType",
"required": [
"filterType"
]
},
"MonitoringFeatureFilterType": {
"type": "string",
"enum": [
"AllFeatures",
"TopNByAttribution",
"FeatureSubset"
],
"x-ms-enum": {
"name": "MonitoringFeatureFilterType",
"modelAsString": true,
"values": [
{
"name": "AllFeatures",
"value": "AllFeatures",
"description": "Includes all features."
},
{
"name": "TopNByAttribution",
"value": "TopNByAttribution",
"description": "Only includes the top contributing features, measured by feature attribution."
},
{
"name": "FeatureSubset",
"value": "FeatureSubset",
"description": "Includes a user-defined subset of features."
}
]
}
},
"MonitoringInputDataBase": {
"type": "object",
"description": "Monitoring input data base definition.",
"properties": {
"columns": {
"type": "object",
"description": "Mapping of column names to special uses.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"dataContext": {
"type": "string",
"description": "The context metadata of the data source.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"inputDataType": {
"$ref": "#/definitions/MonitoringInputDataType",
"description": "[Required] Specifies the type of signal to monitor.",
"x-ms-mutability": [
"read",
"create"
]
},
"jobInputType": {
"$ref": "#/definitions/JobInputType",
"description": "[Required] Specifies the type of job.",
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "[Required] Input Asset URI.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "inputDataType",
"required": [
"inputDataType",
"jobInputType",
"uri"
]
},
"MonitoringInputDataType": {
"type": "string",
"description": "Monitoring input data type enum.",
"enum": [
"Static",
"Rolling",
"Fixed"
],
"x-ms-enum": {
"name": "MonitoringInputDataType",
"modelAsString": true,
"values": [
{
"name": "Static",
"value": "Static",
"description": "An input data with a fixed window size."
},
{
"name": "Rolling",
"value": "Rolling",
"description": "An input data which rolls relatively to the monitor's current run time."
},
{
"name": "Fixed",
"value": "Fixed",
"description": "An input data with tabular format which doesn't require preprocessing."
}
]
}
},
"MonitoringNotificationType": {
"type": "string",
"enum": [
"AmlNotification"
],
"x-ms-enum": {
"name": "MonitoringNotificationType",
"modelAsString": true,
"values": [
{
"name": "AmlNotification",
"value": "AmlNotification",
"description": "Enables email notifications through AML notifications."
}
]
}
},
"MonitoringSignalBase": {
"type": "object",
"properties": {
"notificationTypes": {
"type": "array",
"description": "The current notification mode for this signal.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/MonitoringNotificationType"
},
"x-ms-mutability": [
"read",
"create"
]
},
"properties": {
"type": "object",
"description": "Property dictionary. Properties can be added, but not removed or altered.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"signalType": {
"$ref": "#/definitions/MonitoringSignalType",
"description": "[Required] Specifies the type of signal to monitor.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "signalType",
"required": [
"signalType"
]
},
"MonitoringSignalType": {
"type": "string",
"enum": [
"DataDrift",
"PredictionDrift",
"DataQuality",
"FeatureAttributionDrift",
"Custom"
],
"x-ms-enum": {
"name": "MonitoringSignalType",
"modelAsString": true,
"values": [
{
"name": "DataDrift",
"value": "DataDrift",
"description": "Tracks model input data distribution change, comparing against training data or past production data."
},
{
"name": "PredictionDrift",
"value": "PredictionDrift",
"description": "Tracks prediction result data distribution change, comparing against validation/test label data or past production data."
},
{
"name": "DataQuality",
"value": "DataQuality",
"description": "Tracks model input data integrity."
},
{
"name": "FeatureAttributionDrift",
"value": "FeatureAttributionDrift",
"description": "Tracks feature importance change in production, comparing against feature importance at training time."
},
{
"name": "Custom",
"value": "Custom",
"description": "Tracks a custom signal provided by users."
}
]
}
},
"MonitoringTarget": {
"type": "object",
"description": "Monitoring target definition.",
"properties": {
"deploymentId": {
"type": "string",
"description": "Reference to the deployment asset targeted by this monitor.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"modelId": {
"type": "string",
"description": "Reference to the model asset targeted by this monitor.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"taskType": {
"$ref": "#/definitions/ModelTaskType",
"description": "[Required] The machine learning task type of the monitored model.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"taskType"
]
},
"MonitoringThreshold": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double",
"description": "The threshold value. If null, the set default is dependent on the metric type.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"MountAction": {
"type": "string",
"description": "Mount Action.",
"enum": [
"Mount",
"Unmount"
],
"x-ms-enum": {
"name": "MountAction",
"modelAsString": true,
"values": [
{
"name": "Mount",
"value": "Mount"
},
{
"name": "Unmount",
"value": "Unmount"
}
]
}
},
"MountMode": {
"type": "string",
"description": "Mount Mode.",
"enum": [
"ReadOnly",
"ReadWrite"
],
"x-ms-enum": {
"name": "MountMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnly",
"value": "ReadOnly"
},
{
"name": "ReadWrite",
"value": "ReadWrite"
}
]
}
},
"MountState": {
"type": "string",
"description": "Mount state.",
"enum": [
"MountRequested",
"Mounted",
"MountFailed",
"UnmountRequested",
"UnmountFailed",
"Unmounted"
],
"x-ms-enum": {
"name": "MountState",
"modelAsString": true,
"values": [
{
"name": "MountRequested",
"value": "MountRequested"
},
{
"name": "Mounted",
"value": "Mounted"
},
{
"name": "MountFailed",
"value": "MountFailed"
},
{
"name": "UnmountRequested",
"value": "UnmountRequested"
},
{
"name": "UnmountFailed",
"value": "UnmountFailed"
},
{
"name": "Unmounted",
"value": "Unmounted"
}
]
}
},
"Mpi": {
"type": "object",
"description": "MPI distribution configuration.",
"properties": {
"processCountPerInstance": {
"type": "integer",
"format": "int32",
"description": "Number of processes per MPI node.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/DistributionConfiguration"
}
],
"x-ms-discriminator-value": "Mpi"
},
"NCrossValidations": {
"type": "object",
"description": "N-Cross validations value.",
"properties": {
"mode": {
"$ref": "#/definitions/NCrossValidationsMode",
"description": "[Required] Mode for determining N-Cross validations.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "mode",
"required": [
"mode"
]
},
"NCrossValidationsMode": {
"type": "string",
"description": "Determines how N-Cross validations value is determined.",
"enum": [
"Auto",
"Custom"
],
"x-ms-enum": {
"name": "NCrossValidationsMode",
"modelAsString": true,
"values": [
{
"name": "Auto",
"value": "Auto",
"description": "Determine N-Cross validations value automatically. Supported only for 'Forecasting' AutoML task."
},
{
"name": "Custom",
"value": "Custom",
"description": "Use custom N-Cross validations value."
}
]
}
},
"Network": {
"type": "string",
"description": "network of this container.",
"enum": [
"Bridge",
"Host"
],
"x-ms-enum": {
"name": "Network",
"modelAsString": true,
"values": [
{
"name": "Bridge",
"value": "Bridge"
},
{
"name": "Host",
"value": "Host"
}
]
}
},
"NlpVerticalFeaturizationSettings": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/FeaturizationSettings"
}
]
},
"NlpVerticalLimitSettings": {
"type": "object",
"description": "Job execution constraints.",
"properties": {
"maxConcurrentTrials": {
"type": "integer",
"format": "int32",
"description": "Maximum Concurrent AutoML iterations.",
"default": 1
},
"maxTrials": {
"type": "integer",
"format": "int32",
"description": "Number of AutoML iterations.",
"default": 1
},
"timeout": {
"type": "string",
"format": "duration",
"description": "AutoML job timeout.",
"default": "P7D"
}
}
},
"NodeState": {
"type": "string",
"description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.",
"enum": [
"idle",
"running",
"preparing",
"unusable",
"leaving",
"preempted"
],
"x-ms-enum": {
"name": "NodeState",
"modelAsString": true,
"values": [
{
"name": "idle",
"value": "idle"
},
{
"name": "running",
"value": "running"
},
{
"name": "preparing",
"value": "preparing"
},
{
"name": "unusable",
"value": "unusable"
},
{
"name": "leaving",
"value": "leaving"
},
{
"name": "preempted",
"value": "preempted"
}
]
}
},
"NodeStateCounts": {
"type": "object",
"description": "Counts of various compute node states on the amlCompute.",
"properties": {
"idleNodeCount": {
"type": "integer",
"format": "int32",
"title": "Idle node count.",
"description": "Number of compute nodes in idle state.",
"readOnly": true
},
"runningNodeCount": {
"type": "integer",
"format": "int32",
"title": "Running node count.",
"description": "Number of compute nodes which are running jobs.",
"readOnly": true
},
"preparingNodeCount": {
"type": "integer",
"format": "int32",
"title": "Preparing node count.",
"description": "Number of compute nodes which are being prepared.",
"readOnly": true
},
"unusableNodeCount": {
"type": "integer",
"format": "int32",
"title": "Unusable node count.",
"description": "Number of compute nodes which are in unusable state.",
"readOnly": true
},
"leavingNodeCount": {
"type": "integer",
"format": "int32",
"title": "Leaving node count.",
"description": "Number of compute nodes which are leaving the amlCompute.",
"readOnly": true
},
"preemptedNodeCount": {
"type": "integer",
"format": "int32",
"title": "Preempted node count.",
"description": "Number of compute nodes which are in preempted state.",
"readOnly": true
}
}
},
"Nodes": {
"type": "object",
"description": "Abstract Nodes definition",
"properties": {
"nodesValueType": {
"$ref": "#/definitions/NodesValueType",
"description": "[Required] Type of the Nodes value",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "nodesValueType",
"required": [
"nodesValueType"
]
},
"NodesValueType": {
"type": "string",
"description": "The enumerated types for the nodes value",
"enum": [
"All"
],
"x-ms-enum": {
"name": "NodesValueType",
"modelAsString": true,
"values": [
{
"name": "All",
"value": "All"
}
]
}
},
"NoneAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "None"
},
"NoneDatastoreCredentials": {
"type": "object",
"description": "Empty/none datastore credentials.",
"allOf": [
{
"$ref": "#/definitions/DatastoreCredentials"
}
],
"x-ms-discriminator-value": "None"
},
"NotebookAccessTokenResult": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"format": "password",
"readOnly": true,
"x-ms-secret": true
},
"expiresIn": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"hostName": {
"type": "string",
"readOnly": true
},
"notebookResourceId": {
"type": "string",
"readOnly": true
},
"publicDns": {
"type": "string",
"readOnly": true
},
"refreshToken": {
"type": "string",
"format": "password",
"readOnly": true,
"x-ms-secret": true
},
"scope": {
"type": "string",
"readOnly": true
},
"tokenType": {
"type": "string",
"readOnly": true
}
}
},
"NotebookPreparationError": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer",
"format": "int32"
}
}
},
"NotebookResourceInfo": {
"type": "object",
"properties": {
"fqdn": {
"type": "string"
},
"isPrivateLinkEnabled": {
"type": "boolean"
},
"notebookPreparationError": {
"$ref": "#/definitions/NotebookPreparationError",
"description": "The error that occurs when preparing notebook."
},
"resourceId": {
"type": "string",
"description": "the data plane resourceId that used to initialize notebook component"
}
}
},
"NotificationSetting": {
"type": "object",
"description": "Configuration for notification.",
"properties": {
"emailOn": {
"type": "array",
"description": "Send email notification to user on specified notification type",
"x-nullable": true,
"items": {
"$ref": "#/definitions/EmailNotificationEnableType"
},
"x-ms-mutability": [
"read",
"create"
]
},
"emails": {
"type": "array",
"description": "This is the email recipient list which has a limitation of 499 characters in total concat with comma separator",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
},
"webhooks": {
"type": "object",
"description": "Send webhook callback to a service. Key is a user-provided name for the webhook.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/Webhook",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"update",
"create"
]
}
}
},
"NumericalDataDriftMetric": {
"type": "string",
"enum": [
"JensenShannonDistance",
"PopulationStabilityIndex",
"NormalizedWassersteinDistance",
"TwoSampleKolmogorovSmirnovTest"
],
"x-ms-enum": {
"name": "NumericalDataDriftMetric",
"modelAsString": true,
"values": [
{
"name": "JensenShannonDistance",
"value": "JensenShannonDistance",
"description": "The Jensen Shannon Distance (JSD) metric."
},
{
"name": "PopulationStabilityIndex",
"value": "PopulationStabilityIndex",
"description": "The Population Stability Index (PSI) metric."
},
{
"name": "NormalizedWassersteinDistance",
"value": "NormalizedWassersteinDistance",
"description": "The Normalized Wasserstein Distance metric."
},
{
"name": "TwoSampleKolmogorovSmirnovTest",
"value": "TwoSampleKolmogorovSmirnovTest",
"description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric."
}
]
}
},
"NumericalDataDriftMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"$ref": "#/definitions/NumericalDataDriftMetric",
"description": "[Required] The numerical data drift metric to calculate."
}
},
"required": [
"metric"
],
"allOf": [
{
"$ref": "#/definitions/DataDriftMetricThresholdBase"
}
],
"x-ms-discriminator-value": "Numerical"
},
"NumericalDataQualityMetric": {
"type": "string",
"enum": [
"NullValueRate",
"DataTypeErrorRate",
"OutOfBoundsRate"
],
"x-ms-enum": {
"name": "NumericalDataQualityMetric",
"modelAsString": true,
"values": [
{
"name": "NullValueRate",
"value": "NullValueRate",
"description": "Calculates the rate of null values."
},
{
"name": "DataTypeErrorRate",
"value": "DataTypeErrorRate",
"description": "Calculates the rate of data type errors."
},
{
"name": "OutOfBoundsRate",
"value": "OutOfBoundsRate",
"description": "Calculates the rate values are out of bounds."
}
]
}
},
"NumericalDataQualityMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"$ref": "#/definitions/NumericalDataQualityMetric",
"description": "[Required] The numerical data quality metric to calculate.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metric"
],
"allOf": [
{
"$ref": "#/definitions/DataQualityMetricThresholdBase"
}
],
"x-ms-discriminator-value": "Numerical"
},
"NumericalPredictionDriftMetric": {
"type": "string",
"enum": [
"JensenShannonDistance",
"PopulationStabilityIndex",
"NormalizedWassersteinDistance",
"TwoSampleKolmogorovSmirnovTest"
],
"x-ms-enum": {
"name": "NumericalPredictionDriftMetric",
"modelAsString": true,
"values": [
{
"name": "JensenShannonDistance",
"value": "JensenShannonDistance",
"description": "The Jensen Shannon Distance (JSD) metric."
},
{
"name": "PopulationStabilityIndex",
"value": "PopulationStabilityIndex",
"description": "The Population Stability Index (PSI) metric."
},
{
"name": "NormalizedWassersteinDistance",
"value": "NormalizedWassersteinDistance",
"description": "The Normalized Wasserstein Distance metric."
},
{
"name": "TwoSampleKolmogorovSmirnovTest",
"value": "TwoSampleKolmogorovSmirnovTest",
"description": "The Two Sample Kolmogorov-Smirnov Test (two-sample K–S) metric."
}
]
}
},
"NumericalPredictionDriftMetricThreshold": {
"type": "object",
"properties": {
"metric": {
"$ref": "#/definitions/NumericalPredictionDriftMetric",
"description": "[Required] The numerical prediction drift metric to calculate.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metric"
],
"allOf": [
{
"$ref": "#/definitions/PredictionDriftMetricThresholdBase"
}
],
"x-ms-discriminator-value": "Numerical"
},
"OAuth2AuthTypeWorkspaceConnectionProperties": {
"type": "object",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionOAuth2"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "OAuth2"
},
"Objective": {
"type": "object",
"description": "Optimization objective.",
"properties": {
"goal": {
"$ref": "#/definitions/Goal",
"description": "[Required] Defines supported metric goals for hyperparameter tuning"
},
"primaryMetric": {
"type": "string",
"description": "[Required] Name of the metric to optimize.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"goal",
"primaryMetric"
]
},
"OneLakeArtifact": {
"type": "object",
"description": "OneLake artifact (data source) configuration.",
"properties": {
"artifactName": {
"type": "string",
"description": "[Required] OneLake artifact name",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"artifactType": {
"$ref": "#/definitions/OneLakeArtifactType",
"description": "[Required] OneLake artifact type"
}
},
"discriminator": "artifactType",
"required": [
"artifactName",
"artifactType"
]
},
"OneLakeArtifactType": {
"type": "string",
"description": "Enum to determine OneLake artifact type.",
"enum": [
"LakeHouse"
],
"x-ms-enum": {
"name": "OneLakeArtifactType",
"modelAsString": true,
"values": [
{
"name": "LakeHouse",
"value": "LakeHouse"
}
]
}
},
"OneLakeDatastore": {
"type": "object",
"description": "OneLake (Trident) datastore configuration.",
"properties": {
"artifact": {
"$ref": "#/definitions/OneLakeArtifact",
"description": "[Required] OneLake artifact backing the datastore.",
"x-ms-mutability": [
"read",
"create"
]
},
"endpoint": {
"type": "string",
"description": "OneLake endpoint to use for the datastore.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"oneLakeWorkspaceName": {
"type": "string",
"description": "[Required] OneLake workspace name.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"serviceDataAccessAuthIdentity": {
"type": "string",
"description": "Indicates which identity to use to authenticate service data access to customer's storage.",
"default": "None",
"enum": [
"None",
"WorkspaceSystemAssignedIdentity",
"WorkspaceUserAssignedIdentity"
],
"x-ms-enum": {
"name": "ServiceDataAccessAuthIdentity",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "Do not use any identity for service data access."
},
{
"name": "WorkspaceSystemAssignedIdentity",
"value": "WorkspaceSystemAssignedIdentity",
"description": "Use the system assigned managed identity of the Workspace to authenticate service data access."
},
{
"name": "WorkspaceUserAssignedIdentity",
"value": "WorkspaceUserAssignedIdentity",
"description": "Use the user assigned managed identity of the Workspace to authenticate service data access."
}
]
},
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"artifact",
"oneLakeWorkspaceName"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreProperties"
}
],
"x-ms-discriminator-value": "OneLake"
},
"OnlineDeployment": {
"type": "object",
"description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/OnlineDeploymentProperties",
"description": "[Required] Additional attributes of the entity."
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"kind": {
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
]
},
"OnlineDeploymentProperties": {
"type": "object",
"properties": {
"appInsightsEnabled": {
"type": "boolean",
"description": "If true, enables Application Insights logging.",
"default": false
},
"dataCollector": {
"$ref": "#/definitions/DataCollector",
"description": "The mdc configuration, we disable mdc when it's null.",
"x-nullable": true
},
"egressPublicNetworkAccess": {
"type": "string",
"description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.",
"default": "Enabled",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "EgressPublicNetworkAccessType",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"endpointComputeType": {
"$ref": "#/definitions/EndpointComputeType",
"description": "[Required] The compute type of the endpoint."
},
"instanceType": {
"type": "string",
"description": "Compute instance type. Default: Standard_F4s_v2.",
"default": "Standard_F4s_v2",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"livenessProbe": {
"$ref": "#/definitions/ProbeSettings",
"description": "Liveness probe monitors the health of the container regularly.",
"x-nullable": true
},
"model": {
"type": "string",
"description": "The URI path to the model.",
"x-nullable": true
},
"modelMountPath": {
"type": "string",
"description": "The path to mount the model in custom container.",
"x-nullable": true
},
"provisioningState": {
"$ref": "#/definitions/DeploymentProvisioningState",
"description": "Provisioning state for the endpoint deployment.",
"readOnly": true
},
"readinessProbe": {
"$ref": "#/definitions/ProbeSettings",
"description": "Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.",
"x-nullable": true
},
"requestSettings": {
"$ref": "#/definitions/OnlineRequestSettings",
"description": "Request settings for the deployment.",
"x-nullable": true
},
"scaleSettings": {
"$ref": "#/definitions/OnlineScaleSettings",
"description": "Scale settings for the deployment.\nIf it is null or not provided,\nit defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment\nand to DefaultScaleSettings for ManagedOnlineDeployment.",
"x-nullable": true
},
"startupProbe": {
"$ref": "#/definitions/ProbeSettings",
"description": "Startup probe verify whether an application within a container has started successfully.",
"x-nullable": true
}
},
"discriminator": "endpointComputeType",
"required": [
"endpointComputeType"
],
"allOf": [
{
"$ref": "#/definitions/EndpointDeploymentPropertiesBase"
}
]
},
"OnlineDeploymentTrackedResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of OnlineDeployment entities.",
"properties": {
"value": {
"type": "array",
"description": "The OnlineDeployment items on this page",
"items": {
"$ref": "#/definitions/OnlineDeployment"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"OnlineEndpoint": {
"type": "object",
"description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/OnlineEndpointProperties",
"description": "[Required] Additional attributes of the entity."
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"kind": {
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
]
},
"OnlineEndpointProperties": {
"type": "object",
"description": "Online endpoint configuration",
"properties": {
"compute": {
"type": "string",
"description": "ARM resource ID of the compute if it exists.\noptional",
"x-nullable": true
},
"mirrorTraffic": {
"type": "object",
"description": "Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.",
"x-nullable": true,
"additionalProperties": {
"format": "int32",
"type": "integer"
}
},
"provisioningState": {
"$ref": "#/definitions/EndpointProvisioningState",
"description": "Provisioning state for the endpoint.",
"readOnly": true
},
"publicNetworkAccess": {
"type": "string",
"description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled.",
"default": "Enabled",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "PublicNetworkAccessType",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"traffic": {
"type": "object",
"description": "Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.",
"x-nullable": true,
"additionalProperties": {
"format": "int32",
"type": "integer"
}
}
},
"allOf": [
{
"$ref": "#/definitions/EndpointPropertiesBase"
}
]
},
"OnlineEndpointTrackedResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of OnlineEndpoint entities.",
"properties": {
"value": {
"type": "array",
"description": "The OnlineEndpoint items on this page",
"items": {
"$ref": "#/definitions/OnlineEndpoint"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"OnlineRequestSettings": {
"type": "object",
"description": "Online deployment scoring requests configuration.",
"properties": {
"maxConcurrentRequestsPerInstance": {
"type": "integer",
"format": "int32",
"description": "The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.",
"default": 1
},
"maxQueueWait": {
"type": "string",
"format": "duration",
"description": "(Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format.\nDefaults to 500ms.\n(Now increase `request_timeout_ms` to account for any networking/queue delays)",
"default": "PT0.5S"
},
"requestTimeout": {
"type": "string",
"format": "duration",
"description": "The scoring timeout in ISO 8601 format.\nDefaults to 5000ms.",
"default": "PT5S"
}
}
},
"OnlineScaleSettings": {
"type": "object",
"description": "Online deployment scaling configuration.",
"properties": {
"scaleType": {
"$ref": "#/definitions/ScaleType",
"description": "[Required] Type of deployment scaling algorithm"
}
},
"discriminator": "scaleType",
"required": [
"scaleType"
]
},
"OperationName": {
"type": "string",
"description": "Name of the last operation.",
"enum": [
"Create",
"Start",
"Stop",
"Restart",
"Resize",
"Reimage",
"Delete"
],
"x-ms-enum": {
"name": "OperationName",
"modelAsString": true,
"values": [
{
"name": "Create",
"value": "Create"
},
{
"name": "Start",
"value": "Start"
},
{
"name": "Stop",
"value": "Stop"
},
{
"name": "Restart",
"value": "Restart"
},
{
"name": "Resize",
"value": "Resize"
},
{
"name": "Reimage",
"value": "Reimage"
},
{
"name": "Delete",
"value": "Delete"
}
]
}
},
"OperationStatus": {
"type": "string",
"description": "Operation status.",
"enum": [
"InProgress",
"Succeeded",
"CreateFailed",
"StartFailed",
"StopFailed",
"RestartFailed",
"ResizeFailed",
"ReimageFailed",
"DeleteFailed"
],
"x-ms-enum": {
"name": "OperationStatus",
"modelAsString": true,
"values": [
{
"name": "InProgress",
"value": "InProgress"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "CreateFailed",
"value": "CreateFailed"
},
{
"name": "StartFailed",
"value": "StartFailed"
},
{
"name": "StopFailed",
"value": "StopFailed"
},
{
"name": "RestartFailed",
"value": "RestartFailed"
},
{
"name": "ResizeFailed",
"value": "ResizeFailed"
},
{
"name": "ReimageFailed",
"value": "ReimageFailed"
},
{
"name": "DeleteFailed",
"value": "DeleteFailed"
}
]
}
},
"OperationTrigger": {
"type": "string",
"description": "Trigger of operation.",
"enum": [
"User",
"Schedule",
"IdleShutdown"
],
"x-ms-enum": {
"name": "OperationTrigger",
"modelAsString": true,
"values": [
{
"name": "User",
"value": "User"
},
{
"name": "Schedule",
"value": "Schedule"
},
{
"name": "IdleShutdown",
"value": "IdleShutdown"
}
]
}
},
"OsPatchingStatus": {
"type": "object",
"description": "Returns metadata about the os patching.",
"properties": {
"patchStatus": {
"$ref": "#/definitions/PatchStatus",
"description": "The os patching status."
},
"latestPatchTime": {
"type": "string",
"description": "Time of the latest os patching."
},
"rebootPending": {
"type": "boolean",
"description": "Specifies whether this compute instance is pending for reboot to finish os patching."
},
"scheduledRebootTime": {
"type": "string",
"description": "Time of scheduled reboot."
},
"osPatchingErrors": {
"type": "array",
"description": "Collection of errors encountered when doing os patching.",
"x-nullable": true,
"items": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"OutboundRule": {
"type": "object",
"description": "Outbound Rule for the managed network of a machine learning workspace.",
"properties": {
"category": {
"$ref": "#/definitions/RuleCategory",
"description": "Category of a managed network Outbound Rule of a machine learning workspace."
},
"status": {
"$ref": "#/definitions/RuleStatus",
"description": "Type of a managed network Outbound Rule of a machine learning workspace."
},
"type": {
"$ref": "#/definitions/RuleType",
"description": "Type of a managed network Outbound Rule of a machine learning workspace."
},
"errorInformation": {
"type": "string",
"description": "Error information about an outbound rule of a machine learning workspace if RuleStatus is failed.",
"readOnly": true
},
"parentRuleNames": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
},
"discriminator": "type",
"required": [
"type"
]
},
"OutboundRuleBasicResource": {
"type": "object",
"description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/OutboundRule",
"description": "Outbound Rule for the managed network of a machine learning workspace."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"OutboundRuleListResult": {
"type": "object",
"description": "Paged collection of OutboundRuleBasicResource items",
"properties": {
"value": {
"type": "array",
"description": "The OutboundRuleBasicResource items on this page",
"items": {
"$ref": "#/definitions/OutboundRuleBasicResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"OutputPathAssetReference": {
"type": "object",
"description": "Reference to an asset via its path in a job output.",
"properties": {
"jobId": {
"type": "string",
"description": "ARM resource ID of the job.",
"x-nullable": true
},
"path": {
"type": "string",
"description": "The path of the file/directory in the job output.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AssetReferenceBase"
}
],
"x-ms-discriminator-value": "OutputPath"
},
"PATAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionPersonalAccessToken"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "PAT"
},
"PaginatedComputeResourcesList": {
"type": "object",
"description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.",
"properties": {
"value": {
"type": "array",
"description": "The ComputeResource items on this page",
"items": {
"$ref": "#/definitions/ComputeResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PartialBatchDeployment": {
"type": "object",
"description": "Mutable batch inference settings per deployment.",
"properties": {
"description": {
"type": "string",
"description": "Description of the endpoint deployment.",
"x-nullable": true
}
}
},
"PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties": {
"type": "object",
"description": "Strictly used in update requests.",
"properties": {
"properties": {
"$ref": "#/definitions/PartialBatchDeployment",
"description": "Additional attributes of the entity."
},
"tags": {
"type": "object",
"description": "Resource tags.",
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
}
},
"PartialManagedServiceIdentity": {
"type": "object",
"description": "Managed service identity (system assigned and/or user assigned identities)",
"properties": {
"type": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentityType",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"userAssignedIdentities": {
"type": "object",
"description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
"additionalProperties": {}
}
}
},
"PartialMinimalTrackedResource": {
"type": "object",
"description": "Strictly used in update requests.",
"properties": {
"tags": {
"type": "object",
"description": "Resource tags.",
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
}
},
"PartialMinimalTrackedResourceWithIdentity": {
"type": "object",
"description": "Strictly used in update requests.",
"properties": {
"identity": {
"$ref": "#/definitions/PartialManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
}
},
"allOf": [
{
"$ref": "#/definitions/PartialMinimalTrackedResource"
}
]
},
"PartialMinimalTrackedResourceWithSku": {
"type": "object",
"description": "Strictly used in update requests.",
"properties": {
"sku": {
"$ref": "#/definitions/PartialSku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"allOf": [
{
"$ref": "#/definitions/PartialMinimalTrackedResource"
}
]
},
"PartialMinimalTrackedResourceWithSkuAndIdentity": {
"type": "object",
"description": "Strictly used in update requests.",
"properties": {
"identity": {
"$ref": "#/definitions/PartialManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"sku": {
"$ref": "#/definitions/PartialSku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"allOf": [
{
"$ref": "#/definitions/PartialMinimalTrackedResource"
}
]
},
"PartialRegistryPartialTrackedResource": {
"type": "object",
"description": "Strictly used in update requests.",
"properties": {
"identity": {
"$ref": "#/definitions/RegistryPartialManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"sku": {
"$ref": "#/definitions/PartialSku",
"description": "Sku details required for ARM contract for Autoscaling."
},
"tags": {
"type": "object",
"description": "Resource tags.",
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
}
},
"PartialSku": {
"type": "object",
"description": "Common SKU definition.",
"properties": {
"capacity": {
"type": "integer",
"format": "int32",
"description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
},
"family": {
"type": "string",
"description": "If the service has different generations of hardware, for the same SKU, then that can be captured here."
},
"name": {
"type": "string",
"description": "The name of the SKU. Ex - P3. It is typically a letter+number code."
},
"size": {
"type": "string",
"description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
},
"tier": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/SkuTier",
"description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
}
}
},
"Password": {
"type": "object",
"properties": {
"name": {
"type": "string",
"format": "password",
"readOnly": true,
"x-ms-secret": true
},
"value": {
"type": "string",
"format": "password",
"readOnly": true,
"x-ms-secret": true
}
}
},
"PatchStatus": {
"type": "string",
"description": "The os patching status.",
"enum": [
"CompletedWithWarnings",
"Failed",
"InProgress",
"Succeeded",
"Unknown"
],
"x-ms-enum": {
"name": "PatchStatus",
"modelAsString": true,
"values": [
{
"name": "CompletedWithWarnings",
"value": "CompletedWithWarnings"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "InProgress",
"value": "InProgress"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Unknown",
"value": "Unknown"
}
]
},
"readOnly": true
},
"PendingUploadCredentialDto": {
"type": "object",
"properties": {
"credentialType": {
"$ref": "#/definitions/PendingUploadCredentialType",
"description": "[Required] Credential type used to authentication with storage."
}
},
"discriminator": "credentialType",
"required": [
"credentialType"
]
},
"PendingUploadCredentialType": {
"type": "string",
"description": "Enum to determine the PendingUpload credentials type.",
"enum": [
"SAS"
],
"x-ms-enum": {
"name": "PendingUploadCredentialType",
"modelAsString": true,
"values": [
{
"name": "SAS",
"value": "SAS"
}
]
}
},
"PendingUploadRequestDto": {
"type": "object",
"properties": {
"pendingUploadId": {
"type": "string",
"description": "If PendingUploadId = null then random guid will be used.",
"x-nullable": true
},
"pendingUploadType": {
"type": "string",
"description": "Type of storage to use for the pending upload location",
"default": "TemporaryBlobReference",
"enum": [
"None",
"TemporaryBlobReference"
],
"x-ms-enum": {
"name": "PendingUploadType",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "TemporaryBlobReference",
"value": "TemporaryBlobReference"
}
]
}
}
}
},
"PendingUploadResponseDto": {
"type": "object",
"properties": {
"blobReferenceForConsumption": {
"$ref": "#/definitions/BlobReferenceForConsumptionDto",
"description": "Container level read, write, list SAS",
"x-nullable": true
},
"pendingUploadId": {
"type": "string",
"description": "ID for this upload request",
"x-nullable": true
},
"pendingUploadType": {
"type": "string",
"description": "Type of storage to use for the pending upload location",
"default": "TemporaryBlobReference",
"enum": [
"None",
"TemporaryBlobReference"
],
"x-ms-enum": {
"name": "PendingUploadType",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "TemporaryBlobReference",
"value": "TemporaryBlobReference"
}
]
}
}
}
},
"PersonalComputeInstanceSettings": {
"type": "object",
"description": "Settings for a personal compute instance.",
"properties": {
"assignedUser": {
"$ref": "#/definitions/AssignedUser",
"title": "Assigned User.",
"description": "A user explicitly assigned to a personal compute instance."
}
}
},
"PipelineJob": {
"type": "object",
"description": "Pipeline Job definition: defines generic to MFE attributes.",
"properties": {
"inputs": {
"type": "object",
"description": "Inputs for the pipeline job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobInput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"jobs": {
"type": "object",
"description": "Jobs construct the Pipeline Job.",
"x-nullable": true,
"additionalProperties": {
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"outputs": {
"type": "object",
"description": "Outputs for the pipeline job",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobOutput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"settings": {
"description": "Pipeline settings, for things like ContinueRunOnStepFailure etc.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"sourceJobId": {
"type": "string",
"description": "ARM resource ID of source job.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/JobBaseProperties"
}
],
"x-ms-discriminator-value": "Pipeline"
},
"PredictionDriftMetricThresholdBase": {
"type": "object",
"properties": {
"dataType": {
"$ref": "#/definitions/MonitoringFeatureDataType",
"description": "[Required] Specifies the data type of the metric threshold.",
"x-ms-mutability": [
"read",
"create"
]
},
"threshold": {
"$ref": "#/definitions/MonitoringThreshold",
"description": "The threshold value. If null, a default value will be set depending on the selected metric.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "dataType",
"required": [
"dataType"
]
},
"PredictionDriftMonitoringSignal": {
"type": "object",
"properties": {
"featureDataTypeOverride": {
"type": "object",
"description": "A dictionary that maps feature names to their respective data types.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/MonitoringFeatureDataType"
},
"x-ms-mutability": [
"read",
"create"
]
},
"metricThresholds": {
"type": "array",
"description": "[Required] A list of metrics to calculate and their associated thresholds.",
"items": {
"$ref": "#/definitions/PredictionDriftMetricThresholdBase"
},
"x-ms-identifiers": [],
"x-ms-mutability": [
"read",
"create"
]
},
"productionData": {
"$ref": "#/definitions/MonitoringInputDataBase",
"description": "[Required] The data which drift will be calculated for.",
"x-ms-mutability": [
"read",
"create"
]
},
"referenceData": {
"$ref": "#/definitions/MonitoringInputDataBase",
"description": "[Required] The data to calculate drift against.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"metricThresholds",
"productionData",
"referenceData"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringSignalBase"
}
],
"x-ms-discriminator-value": "PredictionDrift"
},
"PrivateEndpointConnection": {
"type": "object",
"description": "The Private Endpoint Connection resource.",
"properties": {
"properties": {
"$ref": "#/definitions/PrivateEndpointConnectionProperties",
"description": "Private endpoint connection properties.",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The managed service identities assigned to this resource."
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier"
},
"location": {
"type": "string",
"description": "*Same as workspace location."
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"PrivateEndpointConnectionListResult": {
"type": "object",
"description": "List of private endpoint connection associated with the specified workspace",
"properties": {
"value": {
"type": "array",
"description": "Array of private endpoint connections",
"items": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
},
"nextLink": {
"type": "string"
}
}
},
"PrivateEndpointConnectionProperties": {
"type": "object",
"description": "Private endpoint connection properties.",
"properties": {
"privateEndpoint": {
"$ref": "#/definitions/WorkspacePrivateEndpointResource"
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkServiceConnectionState",
"description": "The connection state."
},
"provisioningState": {
"$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
"description": "The current provisioning state.",
"readOnly": true
}
}
},
"PrivateEndpointConnectionProvisioningState": {
"type": "string",
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Failed"
],
"x-ms-enum": {
"name": "PrivateEndpointConnectionProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Failed",
"value": "Failed"
}
]
},
"readOnly": true
},
"PrivateEndpointDestination": {
"type": "object",
"description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.",
"properties": {
"serviceResourceId": {
"type": "string",
"format": "arm-id",
"description": "A type definition that refers the id to an Azure Resource Manager resource."
},
"sparkEnabled": {
"type": "boolean"
},
"sparkStatus": {
"$ref": "#/definitions/RuleStatus",
"description": "Type of a managed network Outbound Rule of a machine learning workspace."
},
"subresourceTarget": {
"type": "string"
}
}
},
"PrivateEndpointOutboundRule": {
"type": "object",
"description": "Private Endpoint Outbound Rule for the managed network of a machine learning workspace.",
"properties": {
"destination": {
"$ref": "#/definitions/PrivateEndpointDestination",
"description": "Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace."
},
"fqdns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"allOf": [
{
"$ref": "#/definitions/OutboundRule"
}
],
"x-ms-discriminator-value": "PrivateEndpoint"
},
"PrivateEndpointResource": {
"type": "object",
"description": "The PE network resource that is linked to this PE connection.",
"properties": {
"subnetArmId": {
"type": "string",
"description": "The subnetId that the private endpoint is connected to.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpoint"
}
]
},
"PrivateLinkResource": {
"type": "object",
"description": "A private link resource",
"properties": {
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity"
},
"location": {
"type": "string",
"description": "Same as workspace location."
},
"properties": {
"$ref": "#/definitions/PrivateLinkResourceProperties",
"description": "Properties of a private link resource.",
"x-ms-client-flatten": true
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Resource"
}
]
},
"PrivateLinkResourceListResult": {
"type": "object",
"description": "A list of private link resources",
"properties": {
"value": {
"type": "array",
"description": "A list of private link resources",
"items": {
"$ref": "#/definitions/PrivateLinkResource"
}
},
"nextLink": {
"type": "string"
}
}
},
"PrivateLinkResourceProperties": {
"type": "object",
"description": "Properties of a private link resource.",
"properties": {
"groupId": {
"type": "string",
"description": "The private link resource group id."
},
"requiredMembers": {
"type": "array",
"description": "The private link resource required member names.",
"items": {
"type": "string"
}
},
"requiredZoneNames": {
"type": "array",
"description": "The private link resource Private link DNS zone name.",
"items": {
"type": "string"
}
}
}
},
"PrivateLinkServiceConnectionState": {
"type": "object",
"description": "A collection of information about the state of the connection between service consumer and provider.",
"properties": {
"actionsRequired": {
"type": "string",
"description": "Some RP chose \"None\". Other RPs use this for region expansion."
},
"description": {
"type": "string",
"description": "User-defined message that, per NRP doc, may be used for approval-related message."
},
"status": {
"$ref": "#/definitions/EndpointServiceConnectionStatus",
"description": "Connection status of the service consumer with the service provider\\r\\nPossible state transitions\\r\\nPending -> Approved (Service provider approves the connection request)\\r\\nPending -> Rejected (Service provider rejects the connection request)\\r\\nPending -> Disconnected (Service provider deletes the connection)\\r\\nApproved -> Rejected (Service provider rejects the approved connection)\\r\\nApproved -> Disconnected (Service provider deletes the connection)\\r\\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\\r\\nRejected -> Disconnected (Service provider deletes the connection)"
}
}
},
"ProbeSettings": {
"type": "object",
"description": "Deployment container liveness/readiness probe configuration.",
"properties": {
"failureThreshold": {
"type": "integer",
"format": "int32",
"description": "The number of failures to allow before returning an unhealthy status.",
"default": 30
},
"initialDelay": {
"type": "string",
"format": "duration",
"description": "The delay before the first probe in ISO 8601 format.",
"x-nullable": true
},
"period": {
"type": "string",
"format": "duration",
"description": "The length of time between probes in ISO 8601 format.",
"default": "PT10S"
},
"successThreshold": {
"type": "integer",
"format": "int32",
"description": "The number of successful probes before returning a healthy status.",
"default": 1
},
"timeout": {
"type": "string",
"format": "duration",
"description": "The probe timeout in ISO 8601 format.",
"default": "PT2S"
}
}
},
"ProvisioningState": {
"type": "string",
"description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.",
"enum": [
"Unknown",
"Updating",
"Creating",
"Deleting",
"Succeeded",
"Failed",
"Canceled"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Unknown",
"value": "Unknown"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Canceled",
"value": "Canceled"
}
]
},
"readOnly": true
},
"ProvisioningStatus": {
"type": "string",
"description": "The current deployment state of schedule.",
"enum": [
"Completed",
"Provisioning",
"Failed"
],
"x-ms-enum": {
"name": "ProvisioningStatus",
"modelAsString": true,
"values": [
{
"name": "Completed",
"value": "Completed"
},
{
"name": "Provisioning",
"value": "Provisioning"
},
{
"name": "Failed",
"value": "Failed"
}
]
}
},
"PublicNetworkAccessType": {
"type": "string",
"description": "Enum to determine whether PublicNetworkAccess is Enabled or Disabled.",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "PublicNetworkAccessType",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"PyTorch": {
"type": "object",
"description": "PyTorch distribution configuration.",
"properties": {
"processCountPerInstance": {
"type": "integer",
"format": "int32",
"description": "Number of processes per node.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DistributionConfiguration"
}
],
"x-ms-discriminator-value": "PyTorch"
},
"QueueSettings": {
"type": "object",
"properties": {
"jobTier": {
"type": "string",
"description": "Enum to determine the job tier.",
"default": "Null",
"enum": [
"Null",
"Spot",
"Basic",
"Standard",
"Premium"
],
"x-ms-enum": {
"name": "JobTier",
"modelAsString": true,
"values": [
{
"name": "Null",
"value": "Null"
},
{
"name": "Spot",
"value": "Spot"
},
{
"name": "Basic",
"value": "Basic"
},
{
"name": "Standard",
"value": "Standard"
},
{
"name": "Premium",
"value": "Premium"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"QuotaBaseProperties": {
"type": "object",
"description": "The properties for Quota update or retrieval.",
"properties": {
"id": {
"type": "string",
"description": "Specifies the resource ID."
},
"type": {
"type": "string",
"description": "Specifies the resource type."
},
"limit": {
"type": "integer",
"format": "int64",
"title": "Limit.",
"description": "The maximum permitted quota of the resource."
},
"unit": {
"$ref": "#/definitions/QuotaUnit",
"description": "An enum describing the unit of quota measurement."
}
}
},
"QuotaUnit": {
"type": "string",
"description": "An enum describing the unit of quota measurement.",
"enum": [
"Count"
],
"x-ms-enum": {
"name": "QuotaUnit",
"modelAsString": true,
"values": [
{
"name": "Count",
"value": "Count"
}
]
}
},
"QuotaUpdateParameters": {
"type": "object",
"description": "Quota update parameters.",
"properties": {
"value": {
"type": "array",
"description": "The list for update quota.",
"items": {
"$ref": "#/definitions/QuotaBaseProperties"
}
},
"location": {
"type": "string",
"description": "Region of workspace quota to be updated."
}
}
},
"RandomSamplingAlgorithm": {
"type": "object",
"description": "Defines a Sampling Algorithm that generates values randomly",
"properties": {
"rule": {
"type": "string",
"description": "The specific type of random algorithm",
"default": "Random",
"enum": [
"Random",
"Sobol"
],
"x-ms-enum": {
"name": "RandomSamplingAlgorithmRule",
"modelAsString": true,
"values": [
{
"name": "Random",
"value": "Random"
},
{
"name": "Sobol",
"value": "Sobol"
}
]
}
},
"seed": {
"type": "integer",
"format": "int32",
"description": "An optional integer to use as the seed for random number generation",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/SamplingAlgorithm"
}
],
"x-ms-discriminator-value": "Random"
},
"Recurrence": {
"type": "object",
"description": "The workflow trigger recurrence for ComputeStartStop schedule type.",
"properties": {
"frequency": {
"$ref": "#/definitions/ComputeRecurrenceFrequency",
"description": "[Required] The frequency to trigger schedule."
},
"interval": {
"type": "integer",
"format": "int32",
"description": "[Required] Specifies schedule interval in conjunction with frequency"
},
"startTime": {
"type": "string",
"description": "The start time in yyyy-MM-ddTHH:mm:ss format.",
"x-nullable": true
},
"timeZone": {
"type": "string",
"description": "Specifies time zone in which the schedule runs.\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11",
"default": "UTC"
},
"schedule": {
"$ref": "#/definitions/ComputeRecurrenceSchedule",
"description": "[Required] The recurrence schedule."
}
}
},
"RecurrenceFrequency": {
"type": "string",
"description": "Enum to describe the frequency of a recurrence schedule",
"enum": [
"Minute",
"Hour",
"Day",
"Week",
"Month"
],
"x-ms-enum": {
"name": "RecurrenceFrequency",
"modelAsString": true,
"values": [
{
"name": "Minute",
"value": "Minute",
"description": "Minute frequency"
},
{
"name": "Hour",
"value": "Hour",
"description": "Hour frequency"
},
{
"name": "Day",
"value": "Day",
"description": "Day frequency"
},
{
"name": "Week",
"value": "Week",
"description": "Week frequency"
},
{
"name": "Month",
"value": "Month",
"description": "Month frequency"
}
]
}
},
"RecurrenceSchedule": {
"type": "object",
"properties": {
"hours": {
"type": "array",
"description": "[Required] List of hours for the schedule.",
"items": {
"type": "integer",
"format": "int32"
}
},
"minutes": {
"type": "array",
"description": "[Required] List of minutes for the schedule.",
"items": {
"type": "integer",
"format": "int32"
}
},
"monthDays": {
"type": "array",
"description": "List of month days for the schedule",
"x-nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"weekDays": {
"type": "array",
"description": "List of days for the schedule.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/WeekDay"
}
}
},
"required": [
"hours",
"minutes"
]
},
"RecurrenceTrigger": {
"type": "object",
"properties": {
"frequency": {
"$ref": "#/definitions/RecurrenceFrequency",
"description": "[Required] The frequency to trigger schedule."
},
"interval": {
"type": "integer",
"format": "int32",
"description": "[Required] Specifies schedule interval in conjunction with frequency"
},
"schedule": {
"$ref": "#/definitions/RecurrenceSchedule",
"description": "The recurrence schedule.",
"x-nullable": true
}
},
"required": [
"frequency",
"interval"
],
"allOf": [
{
"$ref": "#/definitions/TriggerBase"
}
],
"x-ms-discriminator-value": "Recurrence"
},
"ReferenceType": {
"type": "string",
"description": "Enum to determine which reference method to use for an asset.",
"enum": [
"Id",
"DataPath",
"OutputPath"
],
"x-ms-enum": {
"name": "ReferenceType",
"modelAsString": true,
"values": [
{
"name": "Id",
"value": "Id"
},
{
"name": "DataPath",
"value": "DataPath"
},
{
"name": "OutputPath",
"value": "OutputPath"
}
]
}
},
"RegenerateEndpointKeysRequest": {
"type": "object",
"properties": {
"keyType": {
"$ref": "#/definitions/KeyType",
"description": "[Required] Specification for which type of key to generate. Primary or Secondary."
},
"keyValue": {
"type": "string",
"description": "The value the key is set to.",
"x-nullable": true
}
},
"required": [
"keyType"
]
},
"Registry": {
"type": "object",
"description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/RegistryProperties",
"description": "[Required] Additional attributes of the entity.",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"kind": {
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
]
},
"RegistryListCredentialsResult": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The location of the workspace ACR",
"readOnly": true
},
"passwords": {
"type": "array",
"items": {
"$ref": "#/definitions/Password"
},
"x-ms-identifiers": [
"name"
]
},
"username": {
"type": "string",
"description": "The username of the workspace ACR",
"readOnly": true
}
}
},
"RegistryPartialManagedServiceIdentity": {
"type": "object",
"description": "Managed service identity (system assigned and/or user assigned identities)",
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity"
}
]
},
"RegistryPrivateEndpointConnection": {
"type": "object",
"description": "Private endpoint connection definition.",
"properties": {
"id": {
"type": "string",
"description": "This is the private endpoint connection name created on SRP\nFull resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName}",
"x-nullable": true
},
"location": {
"type": "string",
"description": "Same as workspace location.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"properties": {
"$ref": "#/definitions/RegistryPrivateEndpointConnectionProperties",
"description": "Properties of the Private Endpoint Connection",
"x-nullable": true,
"x-ms-client-flatten": true
}
}
},
"RegistryPrivateEndpointConnectionProperties": {
"type": "object",
"description": "Properties of the Private Endpoint Connection",
"properties": {
"groupIds": {
"type": "array",
"description": "The group ids",
"x-nullable": true,
"items": {
"type": "string"
}
},
"privateEndpoint": {
"$ref": "#/definitions/PrivateEndpointResource",
"description": "The PE network resource that is linked to this PE connection.",
"x-nullable": true
},
"registryPrivateLinkServiceConnectionState": {
"$ref": "#/definitions/RegistryPrivateLinkServiceConnectionState",
"description": "The connection state.",
"x-nullable": true
},
"provisioningState": {
"type": "string",
"description": "One of null, \"Succeeded\", \"Provisioning\", \"Failed\". While not approved, it's null.",
"x-nullable": true
}
}
},
"RegistryPrivateLinkServiceConnectionState": {
"type": "object",
"description": "The connection state.",
"properties": {
"actionsRequired": {
"type": "string",
"description": "Some RP chose \"None\". Other RPs use this for region expansion.",
"x-nullable": true
},
"description": {
"type": "string",
"description": "User-defined message that, per NRP doc, may be used for approval-related message.",
"x-nullable": true
},
"status": {
"$ref": "#/definitions/EndpointServiceConnectionStatus",
"description": "Connection status of the service consumer with the service provider"
}
}
},
"RegistryProperties": {
"type": "object",
"description": "Details of the Registry",
"properties": {
"discoveryUrl": {
"type": "string",
"description": "Discovery URL for the Registry",
"x-nullable": true
},
"intellectualPropertyPublisher": {
"type": "string",
"description": "IntellectualPropertyPublisher for the registry",
"x-nullable": true
},
"managedResourceGroup": {
"$ref": "#/definitions/ArmResourceId",
"description": "ResourceId of the managed RG if the registry has system created resources",
"x-nullable": true
},
"managedResourceGroupSettings": {
"$ref": "#/definitions/ManagedResourceGroupSettings",
"description": "Managed resource group specific settings",
"x-nullable": true
},
"mlFlowRegistryUri": {
"type": "string",
"description": "MLFlow Registry URI for the Registry",
"x-nullable": true
},
"registryPrivateEndpointConnections": {
"type": "array",
"description": "Private endpoint connections info used for pending connections in private link portal",
"x-nullable": true,
"items": {
"$ref": "#/definitions/RegistryPrivateEndpointConnection"
}
},
"publicNetworkAccess": {
"type": "string",
"description": "Is the Registry accessible from the internet?\nPossible values: \"Enabled\" or \"Disabled\"",
"x-nullable": true
},
"regionDetails": {
"type": "array",
"description": "Details of each region the registry is in",
"x-nullable": true,
"items": {
"$ref": "#/definitions/RegistryRegionArmDetails"
}
}
}
},
"RegistryRegionArmDetails": {
"type": "object",
"description": "Details for each region the registry is in",
"properties": {
"acrDetails": {
"type": "array",
"description": "List of ACR accounts",
"x-nullable": true,
"items": {
"$ref": "#/definitions/AcrDetails"
}
},
"location": {
"type": "string",
"description": "The location where the registry exists",
"x-nullable": true
},
"storageAccountDetails": {
"type": "array",
"description": "List of storage accounts",
"x-nullable": true,
"items": {
"$ref": "#/definitions/StorageAccountDetails"
}
}
}
},
"RegistryTrackedResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of Registry entities.",
"properties": {
"value": {
"type": "array",
"description": "The Registry items on this page",
"items": {
"$ref": "#/definitions/Registry"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"Regression": {
"type": "object",
"description": "Regression task in AutoML Table vertical.",
"properties": {
"cvSplitColumnNames": {
"type": "array",
"description": "Columns to use for CVSplit data.",
"x-nullable": true,
"items": {
"type": "string"
}
},
"featurizationSettings": {
"$ref": "#/definitions/TableVerticalFeaturizationSettings",
"description": "Featurization inputs needed for AutoML job.",
"x-nullable": true
},
"limitSettings": {
"$ref": "#/definitions/TableVerticalLimitSettings",
"description": "Execution constraints for AutoMLJob.",
"x-nullable": true
},
"nCrossValidations": {
"$ref": "#/definitions/NCrossValidations",
"description": "Number of cross validation folds to be applied on training dataset\nwhen validation dataset is not provided.",
"x-nullable": true
},
"testData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Test data input.",
"x-nullable": true
},
"testDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of test dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"validationDataSize": {
"type": "number",
"format": "double",
"description": "The fraction of training dataset that needs to be set aside for validation purpose.\nValues between (0.0 , 1.0)\nApplied when validation dataset is not provided.",
"x-nullable": true
},
"weightColumnName": {
"type": "string",
"description": "The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for Regression task.",
"default": "NormalizedRootMeanSquaredError",
"enum": [
"SpearmanCorrelation",
"NormalizedRootMeanSquaredError",
"R2Score",
"NormalizedMeanAbsoluteError"
],
"x-ms-enum": {
"name": "RegressionPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "SpearmanCorrelation",
"value": "SpearmanCorrelation",
"description": "The Spearman's rank coefficient of correlation is a nonparametric measure of rank correlation."
},
{
"name": "NormalizedRootMeanSquaredError",
"value": "NormalizedRootMeanSquaredError",
"description": "The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates the comparison between models with different scales."
},
{
"name": "R2Score",
"value": "R2Score",
"description": "The R2 score is one of the performance evaluation measures for forecasting-based machine learning models."
},
{
"name": "NormalizedMeanAbsoluteError",
"value": "NormalizedMeanAbsoluteError",
"description": "The Normalized Mean Absolute Error (NMAE) is a validation metric to compare the Mean Absolute Error (MAE) of (time) series with different scales."
}
]
}
},
"trainingSettings": {
"$ref": "#/definitions/RegressionTrainingSettings",
"description": "Inputs for training phase for an AutoML Job.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "Regression"
},
"RegressionModels": {
"type": "string",
"description": "Enum for all Regression models supported by AutoML.",
"enum": [
"ElasticNet",
"GradientBoosting",
"DecisionTree",
"KNN",
"LassoLars",
"SGD",
"RandomForest",
"ExtremeRandomTrees",
"LightGBM",
"XGBoostRegressor"
],
"x-ms-enum": {
"name": "RegressionModels",
"modelAsString": true,
"values": [
{
"name": "ElasticNet",
"value": "ElasticNet",
"description": "Elastic net is a popular type of regularized linear regression that combines two popular penalties, specifically the L1 and L2 penalty functions."
},
{
"name": "GradientBoosting",
"value": "GradientBoosting",
"description": "The technique of transiting week learners into a strong learner is called Boosting. The gradient boosting algorithm process works on this theory of execution."
},
{
"name": "DecisionTree",
"value": "DecisionTree",
"description": "Decision Trees are a non-parametric supervised learning method used for both classification and regression tasks.\nThe goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from the data features."
},
{
"name": "KNN",
"value": "KNN",
"description": "K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints\nwhich further means that the new data point will be assigned a value based on how closely it matches the points in the training set."
},
{
"name": "LassoLars",
"value": "LassoLars",
"description": "Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with an L1 prior as regularizer."
},
{
"name": "SGD",
"value": "SGD",
"description": "SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications\nto find the model parameters that correspond to the best fit between predicted and actual outputs.\nIt's an inexact but powerful technique."
},
{
"name": "RandomForest",
"value": "RandomForest",
"description": "Random forest is a supervised learning algorithm.\nThe \"forest\" it builds, is an ensemble of decision trees, usually trained with the \"bagging\" method.\nThe general idea of the bagging method is that a combination of learning models increases the overall result."
},
{
"name": "ExtremeRandomTrees",
"value": "ExtremeRandomTrees",
"description": "Extreme Trees is an ensemble machine learning algorithm that combines the predictions from many decision trees. It is related to the widely used random forest algorithm."
},
{
"name": "LightGBM",
"value": "LightGBM",
"description": "LightGBM is a gradient boosting framework that uses tree based learning algorithms."
},
{
"name": "XGBoostRegressor",
"value": "XGBoostRegressor",
"description": "XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning model using ensemble of base learners."
}
]
}
},
"RegressionTrainingSettings": {
"type": "object",
"description": "Regression Training related configuration.",
"properties": {
"allowedTrainingAlgorithms": {
"type": "array",
"description": "Allowed models for regression task.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/RegressionModels"
}
},
"blockedTrainingAlgorithms": {
"type": "array",
"description": "Blocked models for regression task.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/RegressionModels"
}
}
},
"allOf": [
{
"$ref": "#/definitions/TrainingSettings"
}
]
},
"RequestLogging": {
"type": "object",
"properties": {
"captureHeaders": {
"type": "array",
"description": "For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload.",
"x-nullable": true,
"items": {
"type": "string"
}
}
}
},
"ResourceBase": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The asset description text.",
"x-nullable": true
},
"properties": {
"type": "object",
"description": "The asset property dictionary.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"tags": {
"type": "object",
"description": "Tag dictionary. Tags can be added, removed, and updated.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
}
}
},
"ResourceConfiguration": {
"type": "object",
"properties": {
"instanceCount": {
"type": "integer",
"format": "int32",
"description": "Optional number of instances or nodes used by the compute target.",
"default": 1,
"x-ms-mutability": [
"read",
"create"
]
},
"instanceType": {
"type": "string",
"description": "Optional type of VM used as supported by the compute target.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"properties": {
"type": "object",
"description": "Additional properties bag.",
"x-nullable": true,
"additionalProperties": {
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"ResourceId": {
"type": "object",
"description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the resource"
}
},
"required": [
"id"
]
},
"ResourceName": {
"type": "object",
"description": "The Resource Name.",
"properties": {
"value": {
"type": "string",
"description": "The name of the resource.",
"readOnly": true
},
"localizedValue": {
"type": "string",
"description": "The localized name of the resource.",
"readOnly": true
}
}
},
"ResourceQuota": {
"type": "object",
"description": "The quota assigned to a resource.",
"properties": {
"id": {
"type": "string",
"description": "Specifies the resource ID.",
"readOnly": true
},
"amlWorkspaceLocation": {
"type": "string",
"description": "Region of the AML workspace in the id.",
"readOnly": true
},
"type": {
"type": "string",
"description": "Specifies the resource type.",
"readOnly": true
},
"name": {
"$ref": "#/definitions/ResourceName",
"description": "Name of the resource.",
"readOnly": true
},
"limit": {
"type": "integer",
"format": "int64",
"title": "Limit.",
"description": "The maximum permitted quota of the resource.",
"readOnly": true
},
"unit": {
"$ref": "#/definitions/QuotaUnit",
"description": "An enum describing the unit of quota measurement.",
"readOnly": true
}
}
},
"RollingInputData": {
"type": "object",
"description": "Rolling input data definition.",
"properties": {
"preprocessingComponentId": {
"type": "string",
"description": "Reference to the component asset used to preprocess the data.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"windowOffset": {
"type": "string",
"format": "duration",
"description": "[Required] The time offset between the end of the data window and the monitor's current run time.",
"x-ms-mutability": [
"read",
"create"
]
},
"windowSize": {
"type": "string",
"format": "duration",
"description": "[Required] The size of the rolling data window.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"windowOffset",
"windowSize"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringInputDataBase"
}
],
"x-ms-discriminator-value": "Rolling"
},
"Route": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "[Required] The path for the route.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
},
"port": {
"type": "integer",
"format": "int32",
"description": "[Required] The port for the route."
}
},
"required": [
"path",
"port"
]
},
"RuleAction": {
"type": "string",
"description": "The action enum for networking rule.",
"enum": [
"Allow",
"Deny"
],
"x-ms-enum": {
"name": "RuleAction",
"modelAsString": true,
"values": [
{
"name": "Allow",
"value": "Allow"
},
{
"name": "Deny",
"value": "Deny"
}
]
}
},
"RuleCategory": {
"type": "string",
"description": "Category of a managed network Outbound Rule of a machine learning workspace.",
"enum": [
"Required",
"Recommended",
"UserDefined",
"Dependency"
],
"x-ms-enum": {
"name": "RuleCategory",
"modelAsString": true,
"values": [
{
"name": "Required",
"value": "Required"
},
{
"name": "Recommended",
"value": "Recommended"
},
{
"name": "UserDefined",
"value": "UserDefined"
},
{
"name": "Dependency",
"value": "Dependency"
}
]
}
},
"RuleStatus": {
"type": "string",
"description": "Type of a managed network Outbound Rule of a machine learning workspace.",
"enum": [
"Inactive",
"Active",
"Provisioning",
"Deleting",
"Failed"
],
"x-ms-enum": {
"name": "RuleStatus",
"modelAsString": true,
"values": [
{
"name": "Inactive",
"value": "Inactive"
},
{
"name": "Active",
"value": "Active"
},
{
"name": "Provisioning",
"value": "Provisioning"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Failed",
"value": "Failed"
}
]
}
},
"RuleType": {
"type": "string",
"description": "Type of a managed network Outbound Rule of a machine learning workspace.",
"enum": [
"FQDN",
"PrivateEndpoint",
"ServiceTag"
],
"x-ms-enum": {
"name": "RuleType",
"modelAsString": true,
"values": [
{
"name": "FQDN",
"value": "FQDN"
},
{
"name": "PrivateEndpoint",
"value": "PrivateEndpoint"
},
{
"name": "ServiceTag",
"value": "ServiceTag"
}
]
}
},
"SASAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionSharedAccessSignature"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "SAS"
},
"SASCredential": {
"type": "object",
"description": "Access with full SAS uri",
"properties": {
"sasUri": {
"type": "string",
"format": "uri",
"description": "Full SAS Uri, including the storage, container/blob path and SAS token",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DataReferenceCredential"
}
],
"x-ms-discriminator-value": "SAS"
},
"SASCredentialDto": {
"type": "object",
"properties": {
"sasUri": {
"type": "string",
"format": "password",
"description": "Full SAS Uri, including the storage, container/blob path and SAS token",
"x-nullable": true,
"x-ms-secret": true
}
},
"allOf": [
{
"$ref": "#/definitions/PendingUploadCredentialDto"
}
],
"x-ms-discriminator-value": "SAS"
},
"SamplingAlgorithm": {
"type": "object",
"description": "The Sampling Algorithm used to generate hyperparameter values, along with properties to\nconfigure the algorithm",
"properties": {
"samplingAlgorithmType": {
"$ref": "#/definitions/SamplingAlgorithmType",
"description": "[Required] The algorithm used for generating hyperparameter values, along with configuration properties"
}
},
"discriminator": "samplingAlgorithmType",
"required": [
"samplingAlgorithmType"
]
},
"SamplingAlgorithmType": {
"type": "string",
"enum": [
"Grid",
"Random",
"Bayesian"
],
"x-ms-enum": {
"name": "SamplingAlgorithmType",
"modelAsString": true,
"values": [
{
"name": "Grid",
"value": "Grid"
},
{
"name": "Random",
"value": "Random"
},
{
"name": "Bayesian",
"value": "Bayesian"
}
]
}
},
"SasDatastoreCredentials": {
"type": "object",
"description": "SAS datastore credentials configuration.",
"properties": {
"secrets": {
"$ref": "#/definitions/SasDatastoreSecrets",
"format": "password",
"description": "[Required] Storage container secrets.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
},
"required": [
"secrets"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreCredentials"
}
],
"x-ms-discriminator-value": "Sas"
},
"SasDatastoreSecrets": {
"type": "object",
"description": "Datastore SAS secrets.",
"properties": {
"sasToken": {
"type": "string",
"description": "Storage container SAS token.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DatastoreSecrets"
}
],
"x-ms-discriminator-value": "Sas"
},
"ScaleSettings": {
"type": "object",
"description": "scale settings for AML Compute",
"properties": {
"maxNodeCount": {
"type": "integer",
"format": "int32",
"description": "Max number of nodes to use"
},
"minNodeCount": {
"type": "integer",
"format": "int32",
"description": "Min number of nodes to use",
"default": 0
},
"nodeIdleTimeBeforeScaleDown": {
"type": "string",
"format": "duration",
"description": "Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format."
}
},
"required": [
"maxNodeCount"
]
},
"ScaleSettingsInformation": {
"type": "object",
"description": "Desired scale settings for the amlCompute.",
"properties": {
"scaleSettings": {
"$ref": "#/definitions/ScaleSettings",
"title": "Scale settings."
}
}
},
"ScaleType": {
"type": "string",
"enum": [
"Default",
"TargetUtilization"
],
"x-ms-enum": {
"name": "ScaleType",
"modelAsString": true,
"values": [
{
"name": "Default",
"value": "Default"
},
{
"name": "TargetUtilization",
"value": "TargetUtilization"
}
]
}
},
"Schedule": {
"type": "object",
"description": "Azure Resource Manager resource envelope.",
"properties": {
"properties": {
"$ref": "#/definitions/ScheduleProperties",
"description": "[Required] Additional attributes of the entity."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"ScheduleActionBase": {
"type": "object",
"properties": {
"actionType": {
"$ref": "#/definitions/ScheduleActionType",
"description": "[Required] Specifies the action type of the schedule",
"x-ms-mutability": [
"read",
"update",
"create"
]
}
},
"discriminator": "actionType",
"required": [
"actionType"
]
},
"ScheduleActionType": {
"type": "string",
"enum": [
"CreateJob",
"InvokeBatchEndpoint",
"CreateMonitor"
],
"x-ms-enum": {
"name": "ScheduleActionType",
"modelAsString": true,
"values": [
{
"name": "CreateJob",
"value": "CreateJob"
},
{
"name": "InvokeBatchEndpoint",
"value": "InvokeBatchEndpoint"
},
{
"name": "CreateMonitor",
"value": "CreateMonitor"
}
]
}
},
"ScheduleBase": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A system assigned id for the schedule.",
"x-nullable": true
},
"provisioningStatus": {
"$ref": "#/definitions/ScheduleProvisioningState",
"description": "The current deployment state of schedule."
},
"status": {
"$ref": "#/definitions/ScheduleStatus",
"description": "Is the schedule enabled or disabled?"
}
}
},
"ScheduleProperties": {
"type": "object",
"description": "Base definition of a schedule",
"properties": {
"action": {
"$ref": "#/definitions/ScheduleActionBase",
"description": "[Required] Specifies the action of the schedule",
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"displayName": {
"type": "string",
"description": "Display name of schedule.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"isEnabled": {
"type": "boolean",
"description": "Is the schedule enabled?",
"default": true,
"x-ms-mutability": [
"read",
"update",
"create"
]
},
"provisioningState": {
"$ref": "#/definitions/ScheduleProvisioningStatus",
"description": "Provisioning state for the schedule.",
"readOnly": true
},
"trigger": {
"$ref": "#/definitions/TriggerBase",
"description": "[Required] Specifies the trigger details",
"x-ms-mutability": [
"read",
"update",
"create"
]
}
},
"required": [
"action",
"trigger"
],
"allOf": [
{
"$ref": "#/definitions/ResourceBase"
}
]
},
"ScheduleProvisioningState": {
"type": "string",
"description": "The current deployment state of schedule.",
"enum": [
"Completed",
"Provisioning",
"Failed"
],
"x-ms-enum": {
"name": "ScheduleProvisioningState",
"modelAsString": true,
"values": [
{
"name": "Completed",
"value": "Completed"
},
{
"name": "Provisioning",
"value": "Provisioning"
},
{
"name": "Failed",
"value": "Failed"
}
]
}
},
"ScheduleProvisioningStatus": {
"type": "string",
"enum": [
"Creating",
"Updating",
"Deleting",
"Succeeded",
"Failed",
"Canceled"
],
"x-ms-enum": {
"name": "ScheduleProvisioningStatus",
"modelAsString": true,
"values": [
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Canceled",
"value": "Canceled"
}
]
},
"readOnly": true
},
"ScheduleResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of Schedule entities.",
"properties": {
"value": {
"type": "array",
"description": "The Schedule items on this page",
"items": {
"$ref": "#/definitions/Schedule"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ScheduleStatus": {
"type": "string",
"description": "Is the schedule enabled or disabled?",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "ScheduleStatus",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"ScriptReference": {
"type": "object",
"description": "Script reference",
"properties": {
"scriptSource": {
"type": "string",
"description": "The storage source of the script: inline, workspace."
},
"scriptData": {
"type": "string",
"description": "The location of scripts in the mounted volume."
},
"scriptArguments": {
"type": "string",
"description": "Optional command line arguments passed to the script to run."
},
"timeout": {
"type": "string",
"description": "Optional time period passed to timeout command."
}
}
},
"ScriptsToExecute": {
"type": "object",
"description": "Customized setup scripts",
"properties": {
"startupScript": {
"$ref": "#/definitions/ScriptReference",
"description": "Script that's run every time the machine starts."
},
"creationScript": {
"$ref": "#/definitions/ScriptReference",
"description": "Script that's run only once during provision of the compute."
}
}
},
"Seasonality": {
"type": "object",
"description": "Forecasting seasonality.",
"properties": {
"mode": {
"$ref": "#/definitions/SeasonalityMode",
"description": "[Required] Seasonality mode.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "mode",
"required": [
"mode"
]
},
"SeasonalityMode": {
"type": "string",
"description": "Forecasting seasonality mode.",
"enum": [
"Auto",
"Custom"
],
"x-ms-enum": {
"name": "SeasonalityMode",
"modelAsString": true,
"values": [
{
"name": "Auto",
"value": "Auto",
"description": "Seasonality to be determined automatically."
},
{
"name": "Custom",
"value": "Custom",
"description": "Use the custom seasonality value."
}
]
}
},
"SecretExpiry": {
"type": "object",
"description": "Secret expiration configuration.",
"properties": {
"expirableSecret": {
"type": "boolean",
"description": "Indicates if the secret is expirable.",
"default": false
},
"expireAfterHours": {
"type": "integer",
"format": "int32",
"description": "Number of hours after which the secret will expire.",
"default": 1
}
}
},
"SecretsType": {
"type": "string",
"description": "Enum to determine the datastore secrets type.",
"enum": [
"AccountKey",
"Certificate",
"Sas",
"ServicePrincipal"
],
"x-ms-enum": {
"name": "SecretsType",
"modelAsString": true,
"values": [
{
"name": "AccountKey",
"value": "AccountKey"
},
{
"name": "Certificate",
"value": "Certificate"
},
{
"name": "Sas",
"value": "Sas"
},
{
"name": "ServicePrincipal",
"value": "ServicePrincipal"
}
]
}
},
"ServerlessComputeSettings": {
"type": "object",
"properties": {
"serverlessComputeCustomSubnet": {
"type": "string",
"format": "arm-id",
"description": "The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed"
},
"serverlessComputeNoPublicIP": {
"type": "boolean",
"description": "The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint"
}
}
},
"ServerlessEndpoint": {
"type": "object",
"description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/ServerlessEndpointProperties",
"description": "[Required] Additional attributes of the entity."
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "Managed service identity (system assigned and/or user assigned identities)"
},
"kind": {
"type": "string",
"description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type."
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Sku details required for ARM contract for Autoscaling."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
]
},
"ServerlessEndpointProperties": {
"type": "object",
"properties": {
"authMode": {
"$ref": "#/definitions/ServerlessInferenceEndpointAuthMode",
"description": "[Required] Specifies the authentication mode for the Serverless endpoint."
},
"contentSafety": {
"$ref": "#/definitions/ContentSafety",
"description": "Specifies the content safety options. If omitted, the default content safety settings will be configured",
"x-nullable": true
},
"endpointState": {
"$ref": "#/definitions/ServerlessEndpointState",
"description": "The current state of the ServerlessEndpoint.",
"readOnly": true
},
"inferenceEndpoint": {
"$ref": "#/definitions/ServerlessInferenceEndpoint",
"description": "The inference uri to target when making requests against the serverless endpoint",
"x-nullable": true,
"readOnly": true
},
"marketplaceSubscriptionId": {
"type": "string",
"description": "The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint.",
"x-nullable": true,
"readOnly": true
},
"modelSettings": {
"$ref": "#/definitions/ModelSettings",
"description": "The model settings (model id) for the model being serviced on the ServerlessEndpoint.",
"x-nullable": true
},
"provisioningState": {
"$ref": "#/definitions/EndpointProvisioningState",
"description": "State of endpoint provisioning.",
"readOnly": true
}
},
"required": [
"authMode"
]
},
"ServerlessEndpointState": {
"type": "string",
"description": "State of the Serverless Endpoint.",
"enum": [
"Unknown",
"Creating",
"Deleting",
"Suspending",
"Reinstating",
"Online",
"Suspended",
"CreationFailed",
"DeletionFailed"
],
"x-ms-enum": {
"name": "ServerlessEndpointState",
"modelAsString": true,
"values": [
{
"name": "Unknown",
"value": "Unknown"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Suspending",
"value": "Suspending"
},
{
"name": "Reinstating",
"value": "Reinstating"
},
{
"name": "Online",
"value": "Online"
},
{
"name": "Suspended",
"value": "Suspended"
},
{
"name": "CreationFailed",
"value": "CreationFailed"
},
{
"name": "DeletionFailed",
"value": "DeletionFailed"
}
]
}
},
"ServerlessEndpointTrackedResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of ServerlessEndpoint entities.",
"properties": {
"value": {
"type": "array",
"description": "The ServerlessEndpoint items on this page",
"items": {
"$ref": "#/definitions/ServerlessEndpoint"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ServerlessInferenceEndpoint": {
"type": "object",
"properties": {
"headers": {
"type": "object",
"description": "Specifies any required headers to target this serverless endpoint.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"readOnly": true
},
"uri": {
"type": "string",
"format": "uri",
"description": "[Required] The inference uri to target when making requests against the Serverless Endpoint.",
"readOnly": true
}
},
"required": [
"uri"
]
},
"ServerlessInferenceEndpointAuthMode": {
"type": "string",
"enum": [
"Key",
"AAD",
"KeyAndAAD"
],
"x-ms-enum": {
"name": "ServerlessInferenceEndpointAuthMode",
"modelAsString": true,
"values": [
{
"name": "Key",
"value": "Key"
},
{
"name": "AAD",
"value": "AAD"
},
{
"name": "KeyAndAAD",
"value": "KeyAndAAD"
}
]
}
},
"ServiceManagedResourcesSettings": {
"type": "object",
"properties": {
"cosmosDb": {
"$ref": "#/definitions/CosmosDbSettings"
}
}
},
"ServicePrincipalAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionServicePrincipal"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "ServicePrincipal"
},
"ServicePrincipalDatastoreCredentials": {
"type": "object",
"description": "Service Principal datastore credentials configuration.",
"properties": {
"authorityUrl": {
"type": "string",
"description": "Authority URL used for authentication.",
"x-nullable": true
},
"clientId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "[Required] Service principal client ID."
},
"resourceUrl": {
"type": "string",
"description": "Resource the service principal has access to.",
"x-nullable": true
},
"secrets": {
"$ref": "#/definitions/ServicePrincipalDatastoreSecrets",
"format": "password",
"description": "[Required] Service principal secrets.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
},
"tenantId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "[Required] ID of the tenant to which the service principal belongs."
}
},
"required": [
"clientId",
"secrets",
"tenantId"
],
"allOf": [
{
"$ref": "#/definitions/DatastoreCredentials"
}
],
"x-ms-discriminator-value": "ServicePrincipal"
},
"ServicePrincipalDatastoreSecrets": {
"type": "object",
"description": "Datastore Service Principal secrets.",
"properties": {
"clientSecret": {
"type": "string",
"description": "Service principal secret.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/DatastoreSecrets"
}
],
"x-ms-discriminator-value": "ServicePrincipal"
},
"ServiceTagDestination": {
"type": "object",
"description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.",
"properties": {
"action": {
"$ref": "#/definitions/RuleAction",
"description": "The action enum for networking rule."
},
"addressPrefixes": {
"type": "array",
"description": "Optional, if provided, the ServiceTag property will be ignored.",
"items": {
"type": "string"
}
},
"portRanges": {
"type": "string"
},
"protocol": {
"type": "string"
},
"serviceTag": {
"type": "string"
}
}
},
"ServiceTagOutboundRule": {
"type": "object",
"description": "Service Tag Outbound Rule for the managed network of a machine learning workspace.",
"properties": {
"destination": {
"$ref": "#/definitions/ServiceTagDestination",
"description": "Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace."
}
},
"allOf": [
{
"$ref": "#/definitions/OutboundRule"
}
],
"x-ms-discriminator-value": "ServiceTag"
},
"SetupScripts": {
"type": "object",
"description": "Details of customized scripts to execute for setting up the cluster.",
"properties": {
"scripts": {
"$ref": "#/definitions/ScriptsToExecute",
"description": "Customized setup scripts"
}
}
},
"SharedPrivateLinkResource": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Unique name of the private link"
},
"properties": {
"$ref": "#/definitions/SharedPrivateLinkResourceProperty",
"description": "Properties of a shared private link resource.",
"x-ms-client-flatten": true
}
}
},
"SharedPrivateLinkResourceProperty": {
"type": "object",
"description": "Properties of a shared private link resource.",
"properties": {
"groupId": {
"type": "string",
"description": "group id of the private link"
},
"privateLinkResourceId": {
"type": "string",
"description": "the resource id that private link links to"
},
"requestMessage": {
"type": "string",
"description": "Request message"
},
"status": {
"$ref": "#/definitions/EndpointServiceConnectionStatus",
"description": "Connection status of the service consumer with the service provider\\r\\nPossible state transitions\\r\\nPending -> Approved (Service provider approves the connection request)\\r\\nPending -> Rejected (Service provider rejects the connection request)\\r\\nPending -> Disconnected (Service provider deletes the connection)\\r\\nApproved -> Rejected (Service provider rejects the approved connection)\\r\\nApproved -> Disconnected (Service provider deletes the connection)\\r\\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\\r\\nRejected -> Disconnected (Service provider deletes the connection)"
}
}
},
"SkuCapacity": {
"type": "object",
"description": "SKU capacity information",
"properties": {
"default": {
"type": "integer",
"format": "int32",
"description": "Gets or sets the default capacity.",
"default": 0
},
"maximum": {
"type": "integer",
"format": "int32",
"description": "Gets or sets the maximum.",
"default": 0
},
"minimum": {
"type": "integer",
"format": "int32",
"description": "Gets or sets the minimum.",
"default": 0
},
"scaleType": {
"type": "string",
"description": "Node scaling setting for the compute sku.",
"default": "Automatic",
"enum": [
"Automatic",
"Manual",
"None"
],
"x-ms-enum": {
"name": "SkuScaleType",
"modelAsString": true,
"values": [
{
"name": "Automatic",
"value": "Automatic",
"description": "Automatically scales node count."
},
{
"name": "Manual",
"value": "Manual",
"description": "Node count scaled upon user request."
},
{
"name": "None",
"value": "None",
"description": "Fixed set of nodes."
}
]
}
}
}
},
"SkuResource": {
"type": "object",
"description": "Fulfills ARM Contract requirement to list all available SKUS for a resource.",
"properties": {
"capacity": {
"$ref": "#/definitions/SkuCapacity",
"description": "Gets or sets the Sku Capacity.",
"x-nullable": true
},
"resourceType": {
"type": "string",
"description": "The resource type name.",
"x-nullable": true,
"readOnly": true
},
"sku": {
"$ref": "#/definitions/SkuSetting",
"description": "Gets or sets the Sku.",
"x-nullable": true
}
}
},
"SkuResourceArmPaginatedResult": {
"type": "object",
"description": "A paginated list of SkuResource entities.",
"properties": {
"value": {
"type": "array",
"description": "The SkuResource items on this page",
"items": {
"$ref": "#/definitions/SkuResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SkuSetting": {
"type": "object",
"description": "SkuSetting fulfills the need for stripped down SKU info in ARM contract.",
"properties": {
"name": {
"type": "string",
"description": "[Required] The name of the SKU. Ex - P3. It is typically a letter+number code.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
},
"tier": {
"type": "string",
"description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
"default": "Basic",
"enum": [
"Free",
"Basic",
"Standard",
"Premium"
],
"x-ms-enum": {
"name": "SkuTier",
"modelAsString": false,
"values": [
{
"name": "Free",
"value": "Free",
"description": "The Free service tier."
},
{
"name": "Basic",
"value": "Basic",
"description": "The Basic service tier."
},
{
"name": "Standard",
"value": "Standard",
"description": "The Standard service tier."
},
{
"name": "Premium",
"value": "Premium",
"description": "The Premium service tier."
}
]
}
}
},
"required": [
"name"
]
},
"SourceType": {
"type": "string",
"description": "Data source type.",
"enum": [
"Dataset",
"Datastore",
"URI"
],
"x-ms-enum": {
"name": "SourceType",
"modelAsString": true,
"values": [
{
"name": "Dataset",
"value": "Dataset"
},
{
"name": "Datastore",
"value": "Datastore"
},
{
"name": "URI",
"value": "URI"
}
]
}
},
"SparkJob": {
"type": "object",
"description": "Spark job definition.",
"properties": {
"archives": {
"type": "array",
"description": "Archive files used in the job.",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
},
"args": {
"type": "string",
"description": "Arguments for the job.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"codeId": {
"type": "string",
"format": "arm-id",
"description": "[Required] arm-id of the code asset.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"conf": {
"type": "object",
"description": "Spark configured properties.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"entry": {
"$ref": "#/definitions/SparkJobEntry",
"description": "[Required] The entry to execute on startup of the job.",
"x-ms-mutability": [
"read",
"create"
]
},
"environmentId": {
"type": "string",
"format": "arm-id",
"description": "The ARM resource ID of the Environment specification for the job.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"environmentVariables": {
"type": "object",
"description": "Environment variables included in the job.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"files": {
"type": "array",
"description": "Files used in the job.",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
},
"inputs": {
"type": "object",
"description": "Mapping of input data bindings used in the job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobInput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"jars": {
"type": "array",
"description": "Jar files used in the job.",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
},
"outputs": {
"type": "object",
"description": "Mapping of output data bindings used in the job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobOutput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"pyFiles": {
"type": "array",
"description": "Python files used in the job.",
"x-nullable": true,
"items": {
"type": "string"
},
"x-ms-mutability": [
"read",
"create"
]
},
"queueSettings": {
"$ref": "#/definitions/QueueSettings",
"description": "Queue settings for the job",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"resources": {
"$ref": "#/definitions/SparkResourceConfiguration",
"description": "Compute Resource configuration for the job.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"codeId",
"entry"
],
"allOf": [
{
"$ref": "#/definitions/JobBaseProperties"
}
],
"x-ms-discriminator-value": "Spark"
},
"SparkJobEntry": {
"type": "object",
"description": "Spark job entry point definition.",
"properties": {
"sparkJobEntryType": {
"$ref": "#/definitions/SparkJobEntryType",
"description": "[Required] Type of the job's entry point.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "sparkJobEntryType",
"required": [
"sparkJobEntryType"
]
},
"SparkJobEntryType": {
"type": "string",
"enum": [
"SparkJobPythonEntry",
"SparkJobScalaEntry"
],
"x-ms-enum": {
"name": "SparkJobEntryType",
"modelAsString": true,
"values": [
{
"name": "SparkJobPythonEntry",
"value": "SparkJobPythonEntry"
},
{
"name": "SparkJobScalaEntry",
"value": "SparkJobScalaEntry"
}
]
}
},
"SparkJobPythonEntry": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "[Required] Relative python file path for job entry point.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"file"
],
"allOf": [
{
"$ref": "#/definitions/SparkJobEntry"
}
],
"x-ms-discriminator-value": "SparkJobPythonEntry"
},
"SparkJobScalaEntry": {
"type": "object",
"properties": {
"className": {
"type": "string",
"description": "[Required] Scala class name used as entry point.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"className"
],
"allOf": [
{
"$ref": "#/definitions/SparkJobEntry"
}
],
"x-ms-discriminator-value": "SparkJobScalaEntry"
},
"SparkResourceConfiguration": {
"type": "object",
"properties": {
"instanceType": {
"type": "string",
"description": "Optional type of VM used as supported by the compute target.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"runtimeVersion": {
"type": "string",
"description": "Version of spark runtime used for the job.",
"default": "3.1",
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"SslConfigStatus": {
"type": "string",
"description": "Enable or disable ssl for scoring",
"enum": [
"Disabled",
"Enabled",
"Auto"
],
"x-ms-enum": {
"name": "SslConfigStatus",
"modelAsString": true,
"values": [
{
"name": "Disabled",
"value": "Disabled"
},
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Auto",
"value": "Auto"
}
]
}
},
"SslConfiguration": {
"type": "object",
"description": "The ssl configuration for scoring",
"properties": {
"status": {
"$ref": "#/definitions/SslConfigStatus",
"description": "Enable or disable ssl for scoring"
},
"cert": {
"type": "string",
"format": "password",
"description": "Cert data",
"x-nullable": true,
"x-ms-secret": true
},
"key": {
"type": "string",
"format": "password",
"description": "Key data",
"x-nullable": true,
"x-ms-secret": true
},
"cname": {
"type": "string",
"description": "CNAME of the cert",
"x-nullable": true
},
"leafDomainLabel": {
"type": "string",
"description": "Leaf domain label of public endpoint",
"x-nullable": true
},
"overwriteExistingDomain": {
"type": "boolean",
"description": "Indicates whether to overwrite existing domain label."
}
}
},
"StackEnsembleSettings": {
"type": "object",
"description": "Advances setting to customize StackEnsemble run.",
"properties": {
"stackMetaLearnerKWargs": {
"description": "Optional parameters to pass to the initializer of the meta-learner.",
"x-nullable": true
},
"stackMetaLearnerTrainPercentage": {
"type": "number",
"format": "double",
"description": "Specifies the proportion of the training set (when choosing train and validation type of training) to be reserved for training the meta-learner. Default value is 0.2.",
"default": 0.2
},
"stackMetaLearnerType": {
"type": "string",
"description": "The meta-learner is a model trained on the output of the individual heterogeneous models.\\r\\nDefault meta-learners are LogisticRegression for classification tasks (or LogisticRegressionCV if cross-validation is enabled) and ElasticNet for regression/forecasting tasks (or ElasticNetCV if cross-validation is enabled).\\r\\nThis parameter can be one of the following strings: LogisticRegression, LogisticRegressionCV, LightGBMClassifier, ElasticNet, ElasticNetCV, LightGBMRegressor, or LinearRegression",
"default": "None",
"enum": [
"None",
"LogisticRegression",
"LogisticRegressionCV",
"LightGBMClassifier",
"ElasticNet",
"ElasticNetCV",
"LightGBMRegressor",
"LinearRegression"
],
"x-ms-enum": {
"name": "StackMetaLearnerType",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "LogisticRegression",
"value": "LogisticRegression",
"description": "Default meta-learners are LogisticRegression for classification tasks."
},
{
"name": "LogisticRegressionCV",
"value": "LogisticRegressionCV",
"description": "Default meta-learners are LogisticRegression for classification task when CV is on."
},
{
"name": "LightGBMClassifier",
"value": "LightGBMClassifier"
},
{
"name": "ElasticNet",
"value": "ElasticNet",
"description": "Default meta-learners are LogisticRegression for regression task."
},
{
"name": "ElasticNetCV",
"value": "ElasticNetCV",
"description": "Default meta-learners are LogisticRegression for regression task when CV is on."
},
{
"name": "LightGBMRegressor",
"value": "LightGBMRegressor"
},
{
"name": "LinearRegression",
"value": "LinearRegression"
}
]
}
}
}
},
"StaticInputData": {
"type": "object",
"description": "Static input data definition.",
"properties": {
"preprocessingComponentId": {
"type": "string",
"description": "Reference to the component asset used to preprocess the data.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"windowEnd": {
"type": "string",
"format": "date-time",
"description": "[Required] The end date of the data window.",
"x-ms-mutability": [
"read",
"create"
]
},
"windowStart": {
"type": "string",
"format": "date-time",
"description": "[Required] The start date of the data window.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"windowEnd",
"windowStart"
],
"allOf": [
{
"$ref": "#/definitions/MonitoringInputDataBase"
}
],
"x-ms-discriminator-value": "Static"
},
"Status": {
"type": "string",
"description": "Status of update workspace quota.",
"enum": [
"Undefined",
"Success",
"Failure",
"InvalidQuotaBelowClusterMinimum",
"InvalidQuotaExceedsSubscriptionLimit",
"InvalidVMFamilyName",
"OperationNotSupportedForSku",
"OperationNotEnabledForRegion"
],
"x-ms-enum": {
"name": "Status",
"modelAsString": true,
"values": [
{
"name": "Undefined",
"value": "Undefined"
},
{
"name": "Success",
"value": "Success"
},
{
"name": "Failure",
"value": "Failure"
},
{
"name": "InvalidQuotaBelowClusterMinimum",
"value": "InvalidQuotaBelowClusterMinimum"
},
{
"name": "InvalidQuotaExceedsSubscriptionLimit",
"value": "InvalidQuotaExceedsSubscriptionLimit"
},
{
"name": "InvalidVMFamilyName",
"value": "InvalidVMFamilyName"
},
{
"name": "OperationNotSupportedForSku",
"value": "OperationNotSupportedForSku"
},
{
"name": "OperationNotEnabledForRegion",
"value": "OperationNotEnabledForRegion"
}
]
}
},
"StorageAccountDetails": {
"type": "object",
"description": "Details of storage account to be used for the Registry",
"properties": {
"systemCreatedStorageAccount": {
"$ref": "#/definitions/SystemCreatedStorageAccount",
"description": "Details of system created storage account to be used for the registry",
"x-nullable": true
}
}
},
"SweepJob": {
"type": "object",
"description": "Sweep job definition.",
"properties": {
"earlyTermination": {
"$ref": "#/definitions/EarlyTerminationPolicy",
"description": "Early termination policies enable canceling poor-performing runs before they complete",
"x-nullable": true
},
"inputs": {
"type": "object",
"description": "Mapping of input data bindings used in the job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobInput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"limits": {
"$ref": "#/definitions/SweepJobLimits",
"description": "Sweep Job limit.",
"x-ms-mutability": [
"read",
"create"
]
},
"objective": {
"$ref": "#/definitions/Objective",
"description": "[Required] Optimization objective."
},
"outputs": {
"type": "object",
"description": "Mapping of output data bindings used in the job.",
"x-nullable": true,
"additionalProperties": {
"$ref": "#/definitions/JobOutput",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"queueSettings": {
"$ref": "#/definitions/QueueSettings",
"description": "Queue settings for the job",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"samplingAlgorithm": {
"$ref": "#/definitions/SamplingAlgorithm",
"description": "[Required] The hyperparameter sampling algorithm"
},
"searchSpace": {
"description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter"
},
"trial": {
"$ref": "#/definitions/TrialComponent",
"description": "[Required] Trial component definition."
}
},
"required": [
"objective",
"samplingAlgorithm",
"searchSpace",
"trial"
],
"allOf": [
{
"$ref": "#/definitions/JobBaseProperties"
}
],
"x-ms-discriminator-value": "Sweep"
},
"SweepJobLimits": {
"type": "object",
"description": "Sweep Job limit class.",
"properties": {
"maxConcurrentTrials": {
"type": "integer",
"format": "int32",
"description": "Sweep Job max concurrent trials.",
"x-nullable": true
},
"maxTotalTrials": {
"type": "integer",
"format": "int32",
"description": "Sweep Job max total trials.",
"x-nullable": true
},
"trialTimeout": {
"type": "string",
"format": "duration",
"description": "Sweep Job Trial timeout value.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/JobLimits"
}
],
"x-ms-discriminator-value": "Sweep"
},
"SynapseSpark": {
"type": "object",
"description": "A SynapseSpark compute.",
"properties": {
"properties": {
"$ref": "#/definitions/SynapseSparkProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "SynapseSpark"
},
"SynapseSparkProperties": {
"type": "object",
"properties": {
"autoScaleProperties": {
"$ref": "#/definitions/AutoScaleProperties",
"description": "Auto scale properties."
},
"autoPauseProperties": {
"$ref": "#/definitions/AutoPauseProperties",
"description": "Auto pause properties."
},
"sparkVersion": {
"type": "string",
"description": "Spark version."
},
"nodeCount": {
"type": "integer",
"format": "int32",
"description": "The number of compute nodes currently assigned to the compute."
},
"nodeSize": {
"type": "string",
"description": "Node size."
},
"nodeSizeFamily": {
"type": "string",
"description": "Node size family."
},
"subscriptionId": {
"type": "string",
"description": "Azure subscription identifier."
},
"resourceGroup": {
"type": "string",
"description": "Name of the resource group in which workspace is located."
},
"workspaceName": {
"type": "string",
"description": "Name of Azure Machine Learning workspace."
},
"poolName": {
"type": "string",
"description": "Pool name."
}
}
},
"SystemCreatedAcrAccount": {
"type": "object",
"properties": {
"acrAccountName": {
"type": "string",
"description": "Name of the ACR account",
"x-nullable": true
},
"acrAccountSku": {
"type": "string",
"description": "SKU of the ACR account",
"x-nullable": true
},
"armResourceId": {
"$ref": "#/definitions/ArmResourceId",
"description": "This is populated once the ACR account is created.",
"x-nullable": true
}
}
},
"SystemCreatedStorageAccount": {
"type": "object",
"properties": {
"allowBlobPublicAccess": {
"type": "boolean",
"description": "Public blob access allowed"
},
"armResourceId": {
"$ref": "#/definitions/ArmResourceId",
"description": "This is populated once the storage account is created.",
"x-nullable": true
},
"storageAccountHnsEnabled": {
"type": "boolean",
"description": "HNS enabled for storage account"
},
"storageAccountName": {
"type": "string",
"description": "Name of the storage account",
"x-nullable": true
},
"storageAccountType": {
"type": "string",
"description": "Allowed values:\n\"Standard_LRS\",\n\"Standard_GRS\",\n\"Standard_RAGRS\",\n\"Standard_ZRS\",\n\"Standard_GZRS\",\n\"Standard_RAGZRS\",\n\"Premium_LRS\",\n\"Premium_ZRS\"",
"x-nullable": true
}
}
},
"SystemDatastoresAuthMode": {
"type": "string",
"description": "The auth mode used for accessing the system datastores of the workspace.",
"enum": [
"AccessKey",
"Identity",
"UserDelegationSAS"
],
"x-ms-enum": {
"name": "SystemDatastoresAuthMode",
"modelAsString": true,
"values": [
{
"name": "AccessKey",
"value": "AccessKey"
},
{
"name": "Identity",
"value": "Identity"
},
{
"name": "UserDelegationSAS",
"value": "UserDelegationSAS"
}
]
}
},
"SystemService": {
"type": "object",
"description": "A system service running on a compute.",
"properties": {
"systemServiceType": {
"type": "string",
"description": "The type of this system service.",
"readOnly": true
},
"publicIpAddress": {
"type": "string",
"description": "Public IP address",
"readOnly": true
},
"version": {
"type": "string",
"description": "The version for this type.",
"readOnly": true
}
}
},
"TableVerticalFeaturizationSettings": {
"type": "object",
"description": "Featurization Configuration.",
"properties": {
"blockedTransformers": {
"type": "array",
"description": "These transformers shall not be used in featurization.",
"x-nullable": true,
"items": {
"$ref": "#/definitions/BlockedTransformers"
}
},
"columnNameAndTypes": {
"type": "object",
"description": "Dictionary of column name and its type (int, float, string, datetime etc).",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
}
},
"enableDnnFeaturization": {
"type": "boolean",
"description": "Determines whether to use Dnn based featurizers for data featurization.",
"default": false
},
"mode": {
"type": "string",
"description": "Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase.\nIf 'Off' is selected then no featurization is done.\nIf 'Custom' is selected then user can specify additional inputs to customize how featurization is done.",
"default": "Auto",
"enum": [
"Auto",
"Custom",
"Off"
],
"x-ms-enum": {
"name": "FeaturizationMode",
"modelAsString": true,
"values": [
{
"name": "Auto",
"value": "Auto",
"description": "Auto mode, system performs featurization without any custom featurization inputs."
},
{
"name": "Custom",
"value": "Custom",
"description": "Custom featurization."
},
{
"name": "Off",
"value": "Off",
"description": "Featurization off. 'Forecasting' task cannot use this value."
}
]
}
},
"transformerParams": {
"type": "object",
"description": "User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor.",
"x-nullable": true,
"additionalProperties": {
"items": {
"$ref": "#/definitions/ColumnTransformer"
},
"type": "array",
"x-nullable": true
}
}
},
"allOf": [
{
"$ref": "#/definitions/FeaturizationSettings"
}
]
},
"TableVerticalLimitSettings": {
"type": "object",
"description": "Job execution constraints.",
"properties": {
"enableEarlyTermination": {
"type": "boolean",
"description": "Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations.",
"default": true
},
"exitScore": {
"type": "number",
"format": "double",
"description": "Exit score for the AutoML job.",
"x-nullable": true
},
"maxConcurrentTrials": {
"type": "integer",
"format": "int32",
"description": "Maximum Concurrent iterations.",
"default": 1
},
"maxCoresPerTrial": {
"type": "integer",
"format": "int32",
"description": "Max cores per iteration.",
"default": -1
},
"maxTrials": {
"type": "integer",
"format": "int32",
"description": "Number of iterations.",
"default": 1000
},
"timeout": {
"type": "string",
"format": "duration",
"description": "AutoML job timeout.",
"default": "PT6H"
},
"trialTimeout": {
"type": "string",
"format": "duration",
"description": "Iteration timeout.",
"default": "PT30M"
}
}
},
"TargetLags": {
"type": "object",
"description": "The number of past periods to lag from the target column.",
"properties": {
"mode": {
"$ref": "#/definitions/TargetLagsMode",
"description": "[Required] Set target lags mode - Auto/Custom",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "mode",
"required": [
"mode"
]
},
"TargetLagsMode": {
"type": "string",
"description": "Target lags selection modes.",
"enum": [
"Auto",
"Custom"
],
"x-ms-enum": {
"name": "TargetLagsMode",
"modelAsString": true,
"values": [
{
"name": "Auto",
"value": "Auto",
"description": "Target lags to be determined automatically."
},
{
"name": "Custom",
"value": "Custom",
"description": "Use the custom target lags."
}
]
}
},
"TargetRollingWindowSize": {
"type": "object",
"description": "Forecasting target rolling window size.",
"properties": {
"mode": {
"$ref": "#/definitions/TargetRollingWindowSizeMode",
"description": "[Required] TargetRollingWindowSiz detection mode.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "mode",
"required": [
"mode"
]
},
"TargetRollingWindowSizeMode": {
"type": "string",
"description": "Target rolling windows size mode.",
"enum": [
"Auto",
"Custom"
],
"x-ms-enum": {
"name": "TargetRollingWindowSizeMode",
"modelAsString": true,
"values": [
{
"name": "Auto",
"value": "Auto",
"description": "Determine rolling windows size automatically."
},
{
"name": "Custom",
"value": "Custom",
"description": "Use the specified rolling window size."
}
]
}
},
"TargetUtilizationScaleSettings": {
"type": "object",
"properties": {
"maxInstances": {
"type": "integer",
"format": "int32",
"description": "The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.",
"default": 1
},
"minInstances": {
"type": "integer",
"format": "int32",
"description": "The minimum number of instances to always be present.",
"default": 1
},
"pollingInterval": {
"type": "string",
"format": "duration",
"description": "The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.",
"default": "PT1S"
},
"targetUtilizationPercentage": {
"type": "integer",
"format": "int32",
"description": "Target CPU usage for the autoscaler.",
"default": 70
}
},
"allOf": [
{
"$ref": "#/definitions/OnlineScaleSettings"
}
],
"x-ms-discriminator-value": "TargetUtilization"
},
"TaskType": {
"type": "string",
"description": "AutoMLJob Task type.",
"enum": [
"Classification",
"Regression",
"Forecasting",
"ImageClassification",
"ImageClassificationMultilabel",
"ImageObjectDetection",
"ImageInstanceSegmentation",
"TextClassification",
"TextClassificationMultilabel",
"TextNER"
],
"x-ms-enum": {
"name": "TaskType",
"modelAsString": true,
"values": [
{
"name": "Classification",
"value": "Classification",
"description": "Classification in machine learning and statistics is a supervised learning approach in which\nthe computer program learns from the data given to it and make new observations or classifications."
},
{
"name": "Regression",
"value": "Regression",
"description": "Regression means to predict the value using the input data. Regression models are used to predict a continuous value."
},
{
"name": "Forecasting",
"value": "Forecasting",
"description": "Forecasting is a special kind of regression task that deals with time-series data and creates forecasting model\nthat can be used to predict the near future values based on the inputs."
},
{
"name": "ImageClassification",
"value": "ImageClassification",
"description": "Image Classification. Multi-class image classification is used when an image is classified with only a single label\nfrom a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'."
},
{
"name": "ImageClassificationMultilabel",
"value": "ImageClassificationMultilabel",
"description": "Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels\nfrom a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'."
},
{
"name": "ImageObjectDetection",
"value": "ImageObjectDetection",
"description": "Image Object Detection. Object detection is used to identify objects in an image and locate each object with a\nbounding box e.g. locate all dogs and cats in an image and draw a bounding box around each."
},
{
"name": "ImageInstanceSegmentation",
"value": "ImageInstanceSegmentation",
"description": "Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level,\ndrawing a polygon around each object in the image."
},
{
"name": "TextClassification",
"value": "TextClassification",
"description": "Text classification (also known as text tagging or text categorization) is the process of sorting texts into categories.\nCategories are mutually exclusive."
},
{
"name": "TextClassificationMultilabel",
"value": "TextClassificationMultilabel",
"description": "Multilabel classification task assigns each sample to a group (zero or more) of target labels."
},
{
"name": "TextNER",
"value": "TextNER",
"description": "Text Named Entity Recognition a.k.a. TextNER.\nNamed Entity Recognition (NER) is the ability to take free-form text and identify the occurrences of entities such as people, locations, organizations, and more."
}
]
}
},
"TensorFlow": {
"type": "object",
"description": "TensorFlow distribution configuration.",
"properties": {
"parameterServerCount": {
"type": "integer",
"format": "int32",
"description": "Number of parameter server tasks.",
"default": 0,
"x-ms-mutability": [
"read",
"create"
]
},
"workerCount": {
"type": "integer",
"format": "int32",
"description": "Number of workers. If not specified, will default to the instance count.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/DistributionConfiguration"
}
],
"x-ms-discriminator-value": "TensorFlow"
},
"TextClassification": {
"type": "object",
"description": "Text Classification task in AutoML NLP vertical.\nNLP - Natural Language Processing.",
"properties": {
"featurizationSettings": {
"$ref": "#/definitions/NlpVerticalFeaturizationSettings",
"description": "Featurization inputs needed for AutoML job.",
"x-nullable": true
},
"limitSettings": {
"$ref": "#/definitions/NlpVerticalLimitSettings",
"description": "Execution constraints for AutoMLJob.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"primaryMetric": {
"type": "string",
"description": "Primary metrics for classification tasks.",
"default": "Accuracy",
"enum": [
"AUCWeighted",
"Accuracy",
"NormMacroRecall",
"AveragePrecisionScoreWeighted",
"PrecisionScoreWeighted"
],
"x-ms-enum": {
"name": "ClassificationPrimaryMetrics",
"modelAsString": true,
"values": [
{
"name": "AUCWeighted",
"value": "AUCWeighted",
"description": "AUC is the Area under the curve.\nThis metric represents arithmetic mean of the score for each class,\nweighted by the number of true instances in each class."
},
{
"name": "Accuracy",
"value": "Accuracy",
"description": "Accuracy is the ratio of predictions that exactly match the true class labels."
},
{
"name": "NormMacroRecall",
"value": "NormMacroRecall",
"description": "Normalized macro recall is recall macro-averaged and normalized, so that random\nperformance has a score of 0, and perfect performance has a score of 1."
},
{
"name": "AveragePrecisionScoreWeighted",
"value": "AveragePrecisionScoreWeighted",
"description": "The arithmetic mean of the average precision score for each class, weighted by\nthe number of true instances in each class."
},
{
"name": "PrecisionScoreWeighted",
"value": "PrecisionScoreWeighted",
"description": "The arithmetic mean of precision for each class, weighted by number of true instances in each class."
}
]
}
}
},
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "TextClassification"
},
"TextClassificationMultilabel": {
"type": "object",
"description": "Text Classification Multilabel task in AutoML NLP vertical.\nNLP - Natural Language Processing.",
"properties": {
"featurizationSettings": {
"$ref": "#/definitions/NlpVerticalFeaturizationSettings",
"description": "Featurization inputs needed for AutoML job.",
"x-nullable": true
},
"limitSettings": {
"$ref": "#/definitions/NlpVerticalLimitSettings",
"description": "Execution constraints for AutoMLJob.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"primaryMetric": {
"$ref": "#/definitions/ClassificationMultilabelPrimaryMetrics",
"description": "Primary metric for Text-Classification-Multilabel task.\nCurrently only Accuracy is supported as primary metric, hence user need not set it explicitly.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "TextClassificationMultilabel"
},
"TextNer": {
"type": "object",
"description": "Text-NER task in AutoML NLP vertical.\nNER - Named Entity Recognition.\nNLP - Natural Language Processing.",
"properties": {
"featurizationSettings": {
"$ref": "#/definitions/NlpVerticalFeaturizationSettings",
"description": "Featurization inputs needed for AutoML job.",
"x-nullable": true
},
"limitSettings": {
"$ref": "#/definitions/NlpVerticalLimitSettings",
"description": "Execution constraints for AutoMLJob.",
"x-nullable": true
},
"validationData": {
"$ref": "#/definitions/MLTableJobInput",
"description": "Validation data inputs.",
"x-nullable": true
},
"primaryMetric": {
"$ref": "#/definitions/ClassificationPrimaryMetrics",
"description": "Primary metric for Text-NER task.\nOnly 'Accuracy' is supported for Text-NER, so user need not set this explicitly.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/AutoMLVertical"
}
],
"x-ms-discriminator-value": "TextNER"
},
"TmpfsOptions": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int32",
"description": "Mention the Tmpfs size"
}
}
},
"TopNFeaturesByAttribution": {
"type": "object",
"properties": {
"top": {
"type": "integer",
"format": "int32",
"description": "The number of top features to include.",
"default": 10,
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "#/definitions/MonitoringFeatureFilterBase"
}
],
"x-ms-discriminator-value": "TopNByAttribution"
},
"TrainingSettings": {
"type": "object",
"description": "Training related configuration.",
"properties": {
"enableDnnTraining": {
"type": "boolean",
"description": "Enable recommendation of DNN models.",
"default": false
},
"enableModelExplainability": {
"type": "boolean",
"description": "Flag to turn on explainability on best model.",
"default": true
},
"enableOnnxCompatibleModels": {
"type": "boolean",
"description": "Flag for enabling onnx compatible models.",
"default": false
},
"enableStackEnsemble": {
"type": "boolean",
"description": "Enable stack ensemble run.",
"default": true
},
"enableVoteEnsemble": {
"type": "boolean",
"description": "Enable voting ensemble run.",
"default": true
},
"ensembleModelDownloadTimeout": {
"type": "string",
"format": "duration",
"description": "During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.\nConfigure this parameter with a higher value than 300 secs, if more time is needed.",
"default": "PT5M"
},
"stackEnsembleSettings": {
"$ref": "#/definitions/StackEnsembleSettings",
"description": "Stack ensemble settings for stack ensemble run.",
"x-nullable": true
}
}
},
"TrialComponent": {
"type": "object",
"description": "Trial component definition.",
"properties": {
"codeId": {
"type": "string",
"description": "ARM resource ID of the code asset.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"command": {
"type": "string",
"description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]",
"x-ms-mutability": [
"read",
"create"
]
},
"distribution": {
"$ref": "#/definitions/DistributionConfiguration",
"description": "Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"environmentId": {
"type": "string",
"description": "[Required] The ARM resource ID of the Environment specification for the job.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
},
"environmentVariables": {
"type": "object",
"description": "Environment variables included in the job.",
"x-nullable": true,
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-ms-mutability": [
"read",
"create"
]
},
"resources": {
"$ref": "#/definitions/JobResourceConfiguration",
"description": "Compute Resource configuration for the job.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"command",
"environmentId"
]
},
"TriggerBase": {
"type": "object",
"properties": {
"endTime": {
"type": "string",
"description": "Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601.\nRecommented format would be \"2022-06-01T00:00:01\"\nIf not present, the schedule will run indefinitely",
"x-nullable": true
},
"startTime": {
"type": "string",
"description": "Specifies start time of schedule in ISO 8601 format, but without a UTC offset.",
"x-nullable": true
},
"timeZone": {
"type": "string",
"description": "Specifies time zone in which the schedule runs.\nTimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11",
"default": "UTC"
},
"triggerType": {
"$ref": "#/definitions/TriggerType",
"description": "[Required]",
"x-ms-mutability": [
"read",
"update",
"create"
]
}
},
"discriminator": "triggerType",
"required": [
"triggerType"
]
},
"TriggerType": {
"type": "string",
"enum": [
"Recurrence",
"Cron"
],
"x-ms-enum": {
"name": "TriggerType",
"modelAsString": true,
"values": [
{
"name": "Recurrence",
"value": "Recurrence"
},
{
"name": "Cron",
"value": "Cron"
}
]
}
},
"TritonModelJobInput": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Enum to determine the input data delivery mode.",
"default": "ReadOnlyMount",
"enum": [
"ReadOnlyMount",
"ReadWriteMount",
"Download",
"Direct",
"EvalMount",
"EvalDownload"
],
"x-ms-enum": {
"name": "InputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnlyMount",
"value": "ReadOnlyMount"
},
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Download",
"value": "Download"
},
{
"name": "Direct",
"value": "Direct"
},
{
"name": "EvalMount",
"value": "EvalMount"
},
{
"name": "EvalDownload",
"value": "EvalDownload"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "[Required] Input Asset URI.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"uri"
],
"allOf": [
{
"$ref": "#/definitions/JobInput"
}
],
"x-ms-discriminator-value": "triton_model"
},
"TritonModelJobOutput": {
"type": "object",
"properties": {
"assetName": {
"type": "string",
"description": "Output Asset Name.",
"x-nullable": true
},
"mode": {
"type": "string",
"description": "Output data delivery mode enums.",
"default": "ReadWriteMount",
"enum": [
"ReadWriteMount",
"Upload",
"Direct"
],
"x-ms-enum": {
"name": "OutputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Upload",
"value": "Upload"
},
{
"name": "Direct",
"value": "Direct"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "Output Asset URI.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/JobOutput"
}
],
"x-ms-discriminator-value": "triton_model"
},
"TruncationSelectionPolicy": {
"type": "object",
"description": "Defines an early termination policy that cancels a given percentage of runs at each evaluation interval.",
"properties": {
"truncationPercentage": {
"type": "integer",
"format": "int32",
"description": "The percentage of runs to cancel at each evaluation interval.",
"default": 0
}
},
"allOf": [
{
"$ref": "#/definitions/EarlyTerminationPolicy"
}
],
"x-ms-discriminator-value": "TruncationSelection"
},
"UnitOfMeasure": {
"type": "string",
"description": "The unit of time measurement for the specified VM price. Example: OneHour",
"enum": [
"OneHour"
],
"x-ms-enum": {
"name": "UnitOfMeasure",
"modelAsString": true,
"values": [
{
"name": "OneHour",
"value": "OneHour"
}
]
}
},
"UpdateWorkspaceQuotas": {
"type": "object",
"description": "The properties for update Quota response.",
"properties": {
"id": {
"type": "string",
"description": "Specifies the resource ID.",
"readOnly": true
},
"type": {
"type": "string",
"description": "Specifies the resource type.",
"readOnly": true
},
"limit": {
"type": "integer",
"format": "int64",
"title": "Limit.",
"description": "The maximum permitted quota of the resource."
},
"unit": {
"$ref": "#/definitions/QuotaUnit",
"description": "An enum describing the unit of quota measurement.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/Status",
"title": "Update Workspace Quota Status.",
"description": "Status of update workspace quota.",
"readOnly": true
}
}
},
"UpdateWorkspaceQuotasResult": {
"type": "object",
"description": "The result of update workspace quota.",
"properties": {
"value": {
"type": "array",
"description": "The list of workspace quota update result.",
"items": {
"$ref": "#/definitions/UpdateWorkspaceQuotas"
},
"readOnly": true
},
"nextLink": {
"type": "string",
"description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.",
"readOnly": true
}
}
},
"UriFileDataVersion": {
"type": "object",
"description": "uri-file data version entity",
"allOf": [
{
"$ref": "#/definitions/DataVersionBaseProperties"
}
],
"x-ms-discriminator-value": "uri_file"
},
"UriFileJobInput": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Enum to determine the input data delivery mode.",
"default": "ReadOnlyMount",
"enum": [
"ReadOnlyMount",
"ReadWriteMount",
"Download",
"Direct",
"EvalMount",
"EvalDownload"
],
"x-ms-enum": {
"name": "InputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnlyMount",
"value": "ReadOnlyMount"
},
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Download",
"value": "Download"
},
{
"name": "Direct",
"value": "Direct"
},
{
"name": "EvalMount",
"value": "EvalMount"
},
{
"name": "EvalDownload",
"value": "EvalDownload"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "[Required] Input Asset URI.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"uri"
],
"allOf": [
{
"$ref": "#/definitions/JobInput"
}
],
"x-ms-discriminator-value": "uri_file"
},
"UriFileJobOutput": {
"type": "object",
"properties": {
"assetName": {
"type": "string",
"description": "Output Asset Name.",
"x-nullable": true
},
"mode": {
"type": "string",
"description": "Output data delivery mode enums.",
"default": "ReadWriteMount",
"enum": [
"ReadWriteMount",
"Upload",
"Direct"
],
"x-ms-enum": {
"name": "OutputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Upload",
"value": "Upload"
},
{
"name": "Direct",
"value": "Direct"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "Output Asset URI.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/JobOutput"
}
],
"x-ms-discriminator-value": "uri_file"
},
"UriFolderDataVersion": {
"type": "object",
"description": "uri-folder data version entity",
"allOf": [
{
"$ref": "#/definitions/DataVersionBaseProperties"
}
],
"x-ms-discriminator-value": "uri_folder"
},
"UriFolderJobInput": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Enum to determine the input data delivery mode.",
"default": "ReadOnlyMount",
"enum": [
"ReadOnlyMount",
"ReadWriteMount",
"Download",
"Direct",
"EvalMount",
"EvalDownload"
],
"x-ms-enum": {
"name": "InputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadOnlyMount",
"value": "ReadOnlyMount"
},
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Download",
"value": "Download"
},
{
"name": "Direct",
"value": "Direct"
},
{
"name": "EvalMount",
"value": "EvalMount"
},
{
"name": "EvalDownload",
"value": "EvalDownload"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "[Required] Input Asset URI.",
"minLength": 1,
"pattern": "[a-zA-Z0-9_]"
}
},
"required": [
"uri"
],
"allOf": [
{
"$ref": "#/definitions/JobInput"
}
],
"x-ms-discriminator-value": "uri_folder"
},
"UriFolderJobOutput": {
"type": "object",
"properties": {
"assetName": {
"type": "string",
"description": "Output Asset Name.",
"x-nullable": true
},
"mode": {
"type": "string",
"description": "Output data delivery mode enums.",
"default": "ReadWriteMount",
"enum": [
"ReadWriteMount",
"Upload",
"Direct"
],
"x-ms-enum": {
"name": "OutputDeliveryMode",
"modelAsString": true,
"values": [
{
"name": "ReadWriteMount",
"value": "ReadWriteMount"
},
{
"name": "Upload",
"value": "Upload"
},
{
"name": "Direct",
"value": "Direct"
}
]
},
"x-ms-mutability": [
"read",
"create"
]
},
"uri": {
"type": "string",
"description": "Output Asset URI.",
"x-nullable": true
}
},
"allOf": [
{
"$ref": "#/definitions/JobOutput"
}
],
"x-ms-discriminator-value": "uri_folder"
},
"Usage": {
"type": "object",
"description": "Describes AML Resource Usage.",
"properties": {
"id": {
"type": "string",
"description": "Specifies the resource ID.",
"readOnly": true
},
"amlWorkspaceLocation": {
"type": "string",
"description": "Region of the AML workspace in the id.",
"readOnly": true
},
"type": {
"type": "string",
"description": "Specifies the resource type.",
"readOnly": true
},
"unit": {
"$ref": "#/definitions/UsageUnit",
"description": "An enum describing the unit of usage measurement.",
"readOnly": true
},
"currentValue": {
"type": "integer",
"format": "int64",
"description": "The current usage of the resource.",
"readOnly": true
},
"limit": {
"type": "integer",
"format": "int64",
"description": "The maximum permitted usage of the resource.",
"readOnly": true
},
"name": {
"$ref": "#/definitions/UsageName",
"description": "The name of the type of usage.",
"readOnly": true
}
}
},
"UsageName": {
"type": "object",
"description": "The Usage Names.",
"properties": {
"value": {
"type": "string",
"description": "The name of the resource.",
"readOnly": true
},
"localizedValue": {
"type": "string",
"description": "The localized name of the resource.",
"readOnly": true
}
}
},
"UsageUnit": {
"type": "string",
"description": "An enum describing the unit of usage measurement.",
"enum": [
"Count"
],
"x-ms-enum": {
"name": "UsageUnit",
"modelAsString": true,
"values": [
{
"name": "Count",
"value": "Count"
}
]
}
},
"UserAccountCredentials": {
"type": "object",
"description": "Settings for user account that gets created on each on the nodes of a compute.",
"properties": {
"adminUserName": {
"type": "string",
"title": "User name.",
"description": "Name of the administrator user account which can be used to SSH to nodes."
},
"adminUserSshPublicKey": {
"type": "string",
"format": "password",
"title": "SSH public key.",
"description": "SSH public key of the administrator user account.",
"x-ms-secret": true
},
"adminUserPassword": {
"type": "string",
"format": "password",
"title": "Password.",
"description": "Password of the administrator user account.",
"x-ms-secret": true
}
},
"required": [
"adminUserName"
]
},
"UserIdentity": {
"type": "object",
"description": "User identity configuration.",
"allOf": [
{
"$ref": "#/definitions/IdentityConfiguration"
}
],
"x-ms-discriminator-value": "UserIdentity"
},
"UsernamePasswordAuthTypeWorkspaceConnectionProperties": {
"type": "object",
"properties": {
"credentials": {
"$ref": "#/definitions/WorkspaceConnectionUsernamePassword"
}
},
"allOf": [
{
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
],
"x-ms-discriminator-value": "UsernamePassword"
},
"VMPriceOSType": {
"type": "string",
"description": "Operating system type used by the VM.",
"enum": [
"Linux",
"Windows"
],
"x-ms-enum": {
"name": "VMPriceOSType",
"modelAsString": true,
"values": [
{
"name": "Linux",
"value": "Linux"
},
{
"name": "Windows",
"value": "Windows"
}
]
}
},
"VMTier": {
"type": "string",
"description": "The type of the VM.",
"enum": [
"Standard",
"LowPriority",
"Spot"
],
"x-ms-enum": {
"name": "VMTier",
"modelAsString": true,
"values": [
{
"name": "Standard",
"value": "Standard"
},
{
"name": "LowPriority",
"value": "LowPriority"
},
{
"name": "Spot",
"value": "Spot"
}
]
}
},
"VirtualMachine": {
"type": "object",
"description": "A Machine Learning compute based on Azure Virtual Machines.",
"properties": {
"properties": {
"$ref": "#/definitions/VirtualMachineSchemaProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/Compute"
}
],
"x-ms-discriminator-value": "VirtualMachine"
},
"VirtualMachineImage": {
"type": "object",
"description": "Virtual Machine image for Windows AML Compute",
"properties": {
"id": {
"type": "string",
"description": "Virtual Machine image path"
}
},
"required": [
"id"
]
},
"VirtualMachineSchemaProperties": {
"type": "object",
"properties": {
"virtualMachineSize": {
"type": "string",
"description": "Virtual Machine size"
},
"sshPort": {
"type": "integer",
"format": "int32",
"description": "Port open for ssh connections."
},
"notebookServerPort": {
"type": "integer",
"format": "int32",
"description": "Notebook server port open for ssh connections."
},
"address": {
"type": "string",
"description": "Public IP address of the virtual machine."
},
"administratorAccount": {
"$ref": "#/definitions/VirtualMachineSshCredentials",
"description": "Admin credentials for virtual machine"
},
"isNotebookInstanceCompute": {
"type": "boolean",
"description": "Indicates whether this compute will be used for running notebooks."
}
}
},
"VirtualMachineSecrets": {
"type": "object",
"description": "Secrets related to a Machine Learning compute based on AKS.",
"properties": {
"administratorAccount": {
"$ref": "#/definitions/VirtualMachineSshCredentials",
"description": "Admin credentials for virtual machine."
}
},
"allOf": [
{
"$ref": "#/definitions/ComputeSecrets"
}
],
"x-ms-discriminator-value": "VirtualMachine"
},
"VirtualMachineSize": {
"type": "object",
"description": "Describes the properties of a VM size.",
"properties": {
"name": {
"type": "string",
"title": "Virtual Machine size name",
"description": "The name of the virtual machine size.",
"readOnly": true
},
"family": {
"type": "string",
"title": "Virtual Machine family name",
"description": "The family name of the virtual machine size.",
"readOnly": true
},
"vCPUs": {
"type": "integer",
"format": "int32",
"title": "Number of vPUs",
"description": "The number of vCPUs supported by the virtual machine size.",
"readOnly": true
},
"gpus": {
"type": "integer",
"format": "int32",
"title": "Number of gPUs",
"description": "The number of gPUs supported by the virtual machine size.",
"readOnly": true
},
"osVhdSizeMB": {
"type": "integer",
"format": "int32",
"title": "OS VHD Disk size",
"description": "The OS VHD disk size, in MB, allowed by the virtual machine size.",
"readOnly": true
},
"maxResourceVolumeMB": {
"type": "integer",
"format": "int32",
"title": "Resource volume size",
"description": "The resource volume size, in MB, allowed by the virtual machine size.",
"readOnly": true
},
"memoryGB": {
"type": "number",
"format": "double",
"title": "Memory size",
"description": "The amount of memory, in GB, supported by the virtual machine size.",
"readOnly": true
},
"lowPriorityCapable": {
"type": "boolean",
"title": "Low priority capable",
"description": "Specifies if the virtual machine size supports low priority VMs.",
"readOnly": true
},
"premiumIO": {
"type": "boolean",
"title": "Premium IO supported",
"description": "Specifies if the virtual machine size supports premium IO.",
"readOnly": true
},
"estimatedVMPrices": {
"$ref": "#/definitions/EstimatedVMPrices",
"title": "Estimated VM prices",
"description": "The estimated price information for using a VM."
},
"supportedComputeTypes": {
"type": "array",
"title": "Supported Compute Types",
"description": "Specifies the compute types supported by the virtual machine size.",
"items": {
"type": "string"
}
}
}
},
"VirtualMachineSizeListResult": {
"type": "object",
"description": "The List Virtual Machine size operation response.",
"properties": {
"value": {
"type": "array",
"description": "The list of virtual machine sizes supported by AmlCompute.",
"items": {
"$ref": "#/definitions/VirtualMachineSize"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"VirtualMachineSshCredentials": {
"type": "object",
"description": "Admin credentials for virtual machine",
"properties": {
"username": {
"type": "string",
"description": "Username of admin account"
},
"password": {
"type": "string",
"format": "password",
"description": "Password of admin account",
"x-ms-secret": true
},
"publicKeyData": {
"type": "string",
"format": "password",
"description": "Public key data",
"x-ms-secret": true
},
"privateKeyData": {
"type": "string",
"format": "password",
"description": "Private key data",
"x-ms-secret": true
}
}
},
"VmPriority": {
"type": "string",
"description": "Virtual Machine priority",
"enum": [
"Dedicated",
"LowPriority"
],
"x-ms-enum": {
"name": "VmPriority",
"modelAsString": true,
"values": [
{
"name": "Dedicated",
"value": "Dedicated"
},
{
"name": "LowPriority",
"value": "LowPriority"
}
]
}
},
"VolumeDefinition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Type of Volume Definition",
"description": "Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe",
"default": "bind",
"enum": [
"bind",
"volume",
"tmpfs",
"npipe"
],
"x-ms-enum": {
"name": "VolumeDefinitionType",
"modelAsString": true,
"values": [
{
"name": "bind",
"value": "bind"
},
{
"name": "volume",
"value": "volume"
},
{
"name": "tmpfs",
"value": "tmpfs"
},
{
"name": "npipe",
"value": "npipe"
}
]
}
},
"readOnly": {
"type": "boolean",
"description": "Indicate whether to mount volume as readOnly. Default value for this is false.",
"x-nullable": true
},
"source": {
"type": "string",
"description": "Source of the mount. For bind mounts this is the host path."
},
"target": {
"type": "string",
"description": "Target of the mount. For bind mounts this is the path in the container."
},
"consistency": {
"type": "string",
"description": "Consistency of the volume",
"x-nullable": true
},
"bind": {
"$ref": "#/definitions/BindOptions",
"description": "Bind Options of the mount",
"x-nullable": true
},
"volume": {
"$ref": "#/definitions/VolumeOptions",
"description": "Volume Options of the mount",
"x-nullable": true
},
"tmpfs": {
"$ref": "#/definitions/TmpfsOptions",
"description": "tmpfs option of the mount",
"x-nullable": true
}
}
},
"VolumeOptions": {
"type": "object",
"properties": {
"nocopy": {
"type": "boolean",
"description": "Indicate whether volume is nocopy",
"x-nullable": true
}
}
},
"Webhook": {
"type": "object",
"description": "Webhook base",
"properties": {
"eventType": {
"type": "string",
"description": "Send callback on a specified notification event",
"x-nullable": true,
"x-ms-mutability": [
"read",
"create"
]
},
"webhookType": {
"$ref": "#/definitions/WebhookType",
"description": "[Required] Specifies the type of service to send a callback",
"x-ms-mutability": [
"read",
"create"
]
}
},
"discriminator": "webhookType",
"required": [
"webhookType"
]
},
"WebhookType": {
"type": "string",
"description": "Enum to determine the webhook callback service type.",
"enum": [
"AzureDevOps"
],
"x-ms-enum": {
"name": "WebhookType",
"modelAsString": true,
"values": [
{
"name": "AzureDevOps",
"value": "AzureDevOps"
}
]
}
},
"WeekDay": {
"type": "string",
"description": "Enum of weekday",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"x-ms-enum": {
"name": "WeekDay",
"modelAsString": true,
"values": [
{
"name": "Monday",
"value": "Monday",
"description": "Monday weekday"
},
{
"name": "Tuesday",
"value": "Tuesday",
"description": "Tuesday weekday"
},
{
"name": "Wednesday",
"value": "Wednesday",
"description": "Wednesday weekday"
},
{
"name": "Thursday",
"value": "Thursday",
"description": "Thursday weekday"
},
{
"name": "Friday",
"value": "Friday",
"description": "Friday weekday"
},
{
"name": "Saturday",
"value": "Saturday",
"description": "Saturday weekday"
},
{
"name": "Sunday",
"value": "Sunday",
"description": "Sunday weekday"
}
]
}
},
"Workspace": {
"type": "object",
"description": "An object that represents a machine learning workspace.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkspaceProperties",
"description": "Additional attributes of the entity.",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
"description": "The managed service identities assigned to this resource."
},
"kind": {
"type": "string"
},
"location": {
"type": "string"
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"WorkspaceConnectionAccessKey": {
"type": "object",
"properties": {
"accessKeyId": {
"type": "string"
},
"secretAccessKey": {
"type": "string",
"format": "password",
"x-ms-secret": true
}
}
},
"WorkspaceConnectionAccountKey": {
"type": "object",
"description": "Account key object for workspace connection credential.",
"properties": {
"key": {
"type": "string",
"format": "password",
"x-ms-secret": true
}
}
},
"WorkspaceConnectionApiKey": {
"type": "object",
"description": "Api key object for workspace connection credential.",
"properties": {
"key": {
"type": "string",
"format": "password",
"x-ms-secret": true
}
}
},
"WorkspaceConnectionManagedIdentity": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"resourceId": {
"type": "string"
}
}
},
"WorkspaceConnectionOAuth2": {
"type": "object",
"description": "ClientId and ClientSecret are required. Other properties are optional\ndepending on each OAuth2 provider's implementation.",
"properties": {
"authUrl": {
"type": "string",
"format": "uri",
"description": "Required by Concur connection category"
},
"clientId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "Client id in the format of UUID"
},
"clientSecret": {
"type": "string",
"format": "password",
"x-ms-secret": true
},
"developerToken": {
"type": "string",
"format": "password",
"description": "Required by GoogleAdWords connection category",
"x-ms-secret": true
},
"password": {
"type": "string",
"format": "password",
"x-ms-secret": true
},
"refreshToken": {
"type": "string",
"format": "password",
"description": "Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho\nwhere user needs to get RefreshToken offline",
"x-ms-secret": true
},
"tenantId": {
"type": "string",
"description": "Required by QuickBooks and Xero connection categories"
},
"username": {
"type": "string",
"description": "Concur, ServiceNow auth server AccessToken grant type is 'Password'\nwhich requires UsernamePassword"
}
}
},
"WorkspaceConnectionPersonalAccessToken": {
"type": "object",
"properties": {
"pat": {
"type": "string",
"format": "password",
"x-ms-secret": true
}
}
},
"WorkspaceConnectionPropertiesV2": {
"type": "object",
"properties": {
"authType": {
"$ref": "#/definitions/ConnectionAuthType",
"description": "Authentication type of the connection target"
},
"category": {
"$ref": "#/definitions/ConnectionCategory",
"description": "Category of the connection"
},
"createdByWorkspaceArmId": {
"type": "string",
"format": "arm-id",
"description": "A type definition that refers the id to an Azure Resource Manager resource.",
"readOnly": true
},
"error": {
"type": "string"
},
"expiryTime": {
"type": "string",
"format": "date-time"
},
"group": {
"$ref": "#/definitions/ConnectionGroup",
"description": "Group based on connection category",
"readOnly": true
},
"isSharedToAll": {
"type": "boolean"
},
"metadata": {
"type": "object",
"description": "Store user metadata for this connection",
"additionalProperties": {
"type": "string"
}
},
"peRequirement": {
"$ref": "#/definitions/ManagedPERequirement"
},
"peStatus": {
"$ref": "#/definitions/ManagedPEStatus"
},
"sharedUserList": {
"type": "array",
"items": {
"type": "string"
}
},
"target": {
"type": "string"
},
"useWorkspaceManagedIdentity": {
"type": "boolean"
}
},
"discriminator": "authType",
"required": [
"authType"
]
},
"WorkspaceConnectionPropertiesV2BasicResource": {
"type": "object",
"description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2"
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult": {
"type": "object",
"description": "Paged collection of WorkspaceConnectionPropertiesV2BasicResource items",
"properties": {
"value": {
"type": "array",
"description": "The WorkspaceConnectionPropertiesV2BasicResource items on this page",
"items": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2BasicResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkspaceConnectionServicePrincipal": {
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string",
"format": "password",
"x-ms-secret": true
},
"tenantId": {
"type": "string"
}
}
},
"WorkspaceConnectionSharedAccessSignature": {
"type": "object",
"properties": {
"sas": {
"type": "string",
"format": "password",
"x-ms-secret": true
}
}
},
"WorkspaceConnectionUpdateParameter": {
"type": "object",
"description": "The properties that the machine learning workspace connection will be updated with.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkspaceConnectionPropertiesV2",
"description": "The properties that the machine learning workspace connection will be updated with."
}
}
},
"WorkspaceConnectionUsernamePassword": {
"type": "object",
"properties": {
"password": {
"type": "string",
"format": "password",
"x-ms-secret": true
},
"securityToken": {
"type": "string",
"format": "password",
"description": "Optional, required by connections like SalesForce for extra security in addition to UsernamePassword",
"x-ms-secret": true
},
"username": {
"type": "string"
}
}
},
"WorkspaceHubConfig": {
"type": "object",
"description": "WorkspaceHub's configuration object.",
"properties": {
"additionalWorkspaceStorageAccounts": {
"type": "array",
"items": {
"type": "string"
}
},
"defaultWorkspaceResourceGroup": {
"type": "string"
}
}
},
"WorkspaceListResult": {
"type": "object",
"description": "The response of a Workspace list operation.",
"properties": {
"value": {
"type": "array",
"description": "The Workspace items on this page",
"items": {
"$ref": "#/definitions/Workspace"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkspacePrivateEndpointResource": {
"type": "object",
"description": "The Private Endpoint resource.",
"properties": {
"id": {
"type": "string",
"description": "e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}",
"readOnly": true
},
"subnetArmId": {
"type": "string",
"description": "The subnetId that the private endpoint is connected to.",
"readOnly": true
}
}
},
"WorkspaceProperties": {
"type": "object",
"description": "The properties of a machine learning workspace.",
"properties": {
"allowPublicAccessWhenBehindVnet": {
"type": "boolean",
"description": "The flag to indicate whether to allow public access when behind VNet."
},
"applicationInsights": {
"type": "string",
"description": "ARM id of the application insights associated with this workspace."
},
"associatedWorkspaces": {
"type": "array",
"items": {
"type": "string"
}
},
"containerRegistry": {
"type": "string",
"description": "ARM id of the container registry associated with this workspace."
},
"description": {
"type": "string",
"description": "The description of this workspace."
},
"discoveryUrl": {
"type": "string",
"description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services"
},
"enableDataIsolation": {
"type": "boolean"
},
"enableServiceSideCMKEncryption": {
"type": "boolean"
},
"encryption": {
"$ref": "#/definitions/EncryptionProperty"
},
"featureStoreSettings": {
"$ref": "#/definitions/FeatureStoreSettings",
"description": "Settings for feature store type workspace."
},
"friendlyName": {
"type": "string",
"description": "The friendly name for this workspace. This name in mutable"
},
"hbiWorkspace": {
"type": "boolean",
"description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service"
},
"hubResourceId": {
"type": "string"
},
"imageBuildCompute": {
"type": "string",
"description": "The compute name for image build"
},
"keyVault": {
"type": "string",
"description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created"
},
"managedNetwork": {
"$ref": "#/definitions/ManagedNetworkSettings"
},
"mlFlowTrackingUri": {
"type": "string",
"description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.",
"readOnly": true
},
"notebookInfo": {
"$ref": "#/definitions/NotebookResourceInfo",
"description": "The notebook info of Azure ML workspace.",
"readOnly": true
},
"primaryUserAssignedIdentity": {
"type": "string",
"description": "The user assigned identity resource id that represents the workspace identity."
},
"privateEndpointConnections": {
"type": "array",
"description": "The list of private endpoint connections in the workspace.",
"items": {
"$ref": "#/definitions/PrivateEndpointConnection"
},
"readOnly": true,
"x-ms-identifiers": [
"name"
]
},
"privateLinkCount": {
"type": "integer",
"format": "int32",
"description": "Count of private connections in the workspace",
"readOnly": true
},
"provisionNetworkNow": {
"type": "boolean",
"description": "Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing."
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.",
"readOnly": true
},
"publicNetworkAccess": {
"$ref": "#/definitions/PublicNetworkAccessType",
"description": "Whether requests from Public Network are allowed."
},
"serverlessComputeSettings": {
"$ref": "#/definitions/ServerlessComputeSettings",
"description": "Settings for serverless compute in a workspace"
},
"serviceManagedResourcesSettings": {
"$ref": "#/definitions/ServiceManagedResourcesSettings",
"description": "The service managed resource settings."
},
"serviceProvisionedResourceGroup": {
"type": "string",
"description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace",
"readOnly": true
},
"sharedPrivateLinkResources": {
"type": "array",
"description": "The list of shared private link resources in this workspace.",
"items": {
"$ref": "#/definitions/SharedPrivateLinkResource"
},
"x-ms-identifiers": [
"name"
]
},
"storageAccount": {
"type": "string",
"description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created"
},
"storageHnsEnabled": {
"type": "boolean",
"description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.",
"readOnly": true
},
"systemDatastoresAuthMode": {
"$ref": "#/definitions/SystemDatastoresAuthMode",
"description": "The auth mode used for accessing the system datastores of the workspace."
},
"tenantId": {
"type": "string",
"description": "The tenant id associated with this workspace.",
"readOnly": true
},
"v1LegacyMode": {
"type": "boolean",
"description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API."
},
"workspaceHubConfig": {
"$ref": "#/definitions/WorkspaceHubConfig",
"description": "WorkspaceHub's configuration object."
},
"workspaceId": {
"type": "string",
"description": "The immutable id associated with this workspace.",
"readOnly": true
}
}
},
"WorkspacePropertiesUpdateParameters": {
"type": "object",
"description": "The parameters for updating a machine learning workspace.",
"properties": {
"applicationInsights": {
"type": "string",
"description": "ARM id of the application insights associated with this workspace."
},
"containerRegistry": {
"type": "string",
"description": "ARM id of the container registry associated with this workspace."
},
"description": {
"type": "string",
"description": "The description of this workspace."
},
"enableDataIsolation": {
"type": "boolean"
},
"encryption": {
"$ref": "#/definitions/EncryptionUpdateProperties"
},
"featureStoreSettings": {
"$ref": "#/definitions/FeatureStoreSettings",
"description": "Settings for feature store type workspace."
},
"friendlyName": {
"type": "string",
"description": "The friendly name for this workspace. This name in mutable"
},
"imageBuildCompute": {
"type": "string",
"description": "The compute name for image build"
},
"managedNetwork": {
"$ref": "#/definitions/ManagedNetworkSettings"
},
"primaryUserAssignedIdentity": {
"type": "string",
"description": "The user assigned identity resource id that represents the workspace identity."
},
"publicNetworkAccess": {
"$ref": "#/definitions/PublicNetworkAccessType",
"description": "Whether requests from Public Network are allowed."
},
"serverlessComputeSettings": {
"$ref": "#/definitions/ServerlessComputeSettings",
"description": "Settings for serverless compute in a workspace"
},
"serviceManagedResourcesSettings": {
"$ref": "#/definitions/ServiceManagedResourcesSettings",
"description": "The service managed resource settings."
},
"systemDatastoresAuthMode": {
"$ref": "#/definitions/SystemDatastoresAuthMode",
"description": "The auth mode used for accessing the system datastores of the workspace."
},
"v1LegacyMode": {
"type": "boolean",
"description": "Enabling v1_legacy_mode may prevent you from using features provided by the v2 API."
}
}
},
"WorkspaceUpdateParameters": {
"type": "object",
"description": "The parameters for updating a machine learning workspace.",
"properties": {
"identity": {
"$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity"
},
"properties": {
"$ref": "#/definitions/WorkspacePropertiesUpdateParameters",
"description": "The properties that the machine learning workspace will be updated with.",
"x-ms-client-flatten": true
},
"sku": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Sku",
"description": "Optional. This field is required to be implemented by the RP because AML is supporting more than one tier"
},
"tags": {
"type": "object",
"description": "The resource tags for the machine learning workspace.",
"additionalProperties": {
"type": "string"
}
}
}
}
},
"parameters": {
"CustomLocationParameter": {
"name": "location",
"in": "path",
"description": "The location name.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._]+$",
"x-ms-parameter-location": "method"
}
}
}