Share via

Microsoft.MachineLearningServices workspaces/environments/versions 2024-01-01-preview

  • Article

Bicep resource definition

The workspaces/environments/versions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/environments/versions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/environments/versions@2024-01-01-preview' = {
  name: 'string'
  properties: {
    autoDeleteSetting: {
      condition: 'string'
      value: 'string'
    }
    autoRebuild: 'string'
    build: {
      contextUri: 'string'
      dockerfilePath: 'string'
    }
    condaFile: 'string'
    description: 'string'
    image: 'string'
    inferenceConfig: {
      livenessRoute: {
        path: 'string'
        port: int
      }
      readinessRoute: {
        path: 'string'
        port: int
      }
      scoringRoute: {
        path: 'string'
        port: int
      }
    }
    intellectualProperty: {
      protectionLevel: 'string'
      publisher: 'string'
    }
    isAnonymous: bool
    isArchived: bool
    osType: 'string'
    properties: {
      {customized property}: 'string'
    }
    stage: 'string'
    tags: {
      {customized property}: 'string'
    }
  }
}

Property values

AutoDeleteSetting

Name Description Value
condition When to check if an asset is expired 'CreatedGreaterThan'
'LastAccessedGreaterThan'
value Expiration condition value. string

BuildContext

Name Description Value
contextUri [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.
<seealso href="https://docs.docker.com/engine/reference/commandline/build/#extended-description" />		 string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)
dockerfilePath Path to the Dockerfile in the build context.
<seealso href="https://docs.docker.com/engine/reference/builder/" />		 string

EnvironmentVersionProperties

Name Description Value
autoDeleteSetting Specifies the lifecycle setting of managed data asset. AutoDeleteSetting
autoRebuild Defines if image needs to be rebuilt based on base image changes. 'Disabled'
'OnBaseImageUpdate'
build Configuration settings for Docker build context. BuildContext
condaFile Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.
<see href="https://repo2docker.readthedocs.io/en/latest/config_files.html#environment-yml-install-a-conda-environment" />		 string
description The asset description text. string
image Name of the image that will be used for the environment.
<seealso href="/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" />		 string
inferenceConfig Defines configuration specific to inference. InferenceContainerProperties
intellectualProperty Intellectual Property details. Used if environment is an Intellectual Property. IntellectualProperty
isAnonymous If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous bool
isArchived Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived bool
osType The OS type of the environment. 'Linux'
'Windows'
properties The asset property dictionary. ResourceBaseProperties
stage Stage in the environment lifecycle assigned to this environment string
tags Tag dictionary. Tags can be added, removed, and updated. ResourceBaseTags

InferenceContainerProperties

Name Description Value
livenessRoute The route to check the liveness of the inference server container. Route
readinessRoute The route to check the readiness of the inference server container. Route
scoringRoute The port to send the scoring requests to, within the inference server container. Route

IntellectualProperty

Name Description Value
protectionLevel Protection level of the Intellectual Property. 'All'
'None'
publisher [Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name. string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)

Microsoft.MachineLearningServices/workspaces/environments/versions

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: workspaces/environments
properties [Required] Additional attributes of the entity. EnvironmentVersionProperties (required)

ResourceBaseProperties

Name Description Value

ResourceBaseTags

Name Description Value

Route

Name Description Value
path [Required] The path for the route. string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)
port [Required] The port for the route. int (required)

ARM template resource definition

The workspaces/environments/versions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/environments/versions resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/environments/versions",
  "apiVersion": "2024-01-01-preview",
  "name": "string",
  "properties": {
    "autoDeleteSetting": {
      "condition": "string",
      "value": "string"
    },
    "autoRebuild": "string",
    "build": {
      "contextUri": "string",
      "dockerfilePath": "string"
    },
    "condaFile": "string",
    "description": "string",
    "image": "string",
    "inferenceConfig": {
      "livenessRoute": {
        "path": "string",
        "port": "int"
      },
      "readinessRoute": {
        "path": "string",
        "port": "int"
      },
      "scoringRoute": {
        "path": "string",
        "port": "int"
      }
    },
    "intellectualProperty": {
      "protectionLevel": "string",
      "publisher": "string"
    },
    "isAnonymous": "bool",
    "isArchived": "bool",
    "osType": "string",
    "properties": {
      "{customized property}": "string"
    },
    "stage": "string",
    "tags": {
      "{customized property}": "string"
    }
  }
}

Property values

AutoDeleteSetting

Name Description Value
condition When to check if an asset is expired 'CreatedGreaterThan'
'LastAccessedGreaterThan'
value Expiration condition value. string

BuildContext

Name Description Value
contextUri [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.
<seealso href="https://docs.docker.com/engine/reference/commandline/build/#extended-description" />		 string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)
dockerfilePath Path to the Dockerfile in the build context.
<seealso href="https://docs.docker.com/engine/reference/builder/" />		 string

EnvironmentVersionProperties

Name Description Value
autoDeleteSetting Specifies the lifecycle setting of managed data asset. AutoDeleteSetting
autoRebuild Defines if image needs to be rebuilt based on base image changes. 'Disabled'
'OnBaseImageUpdate'
build Configuration settings for Docker build context. BuildContext
condaFile Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.
<see href="https://repo2docker.readthedocs.io/en/latest/config_files.html#environment-yml-install-a-conda-environment" />		 string
description The asset description text. string
image Name of the image that will be used for the environment.
<seealso href="/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" />		 string
inferenceConfig Defines configuration specific to inference. InferenceContainerProperties
intellectualProperty Intellectual Property details. Used if environment is an Intellectual Property. IntellectualProperty
isAnonymous If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous bool
isArchived Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived bool
osType The OS type of the environment. 'Linux'
'Windows'
properties The asset property dictionary. ResourceBaseProperties
stage Stage in the environment lifecycle assigned to this environment string
tags Tag dictionary. Tags can be added, removed, and updated. ResourceBaseTags

InferenceContainerProperties

Name Description Value
livenessRoute The route to check the liveness of the inference server container. Route
readinessRoute The route to check the readiness of the inference server container. Route
scoringRoute The port to send the scoring requests to, within the inference server container. Route

IntellectualProperty

Name Description Value
protectionLevel Protection level of the Intellectual Property. 'All'
'None'
publisher [Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name. string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)

Microsoft.MachineLearningServices/workspaces/environments/versions

Name Description Value
apiVersion The api version '2024-01-01-preview'
name The resource name string (required)
properties [Required] Additional attributes of the entity. EnvironmentVersionProperties (required)
type The resource type 'Microsoft.MachineLearningServices/workspaces/environments/versions'

ResourceBaseProperties

Name Description Value

ResourceBaseTags

Name Description Value

Route

Name Description Value
path [Required] The path for the route. string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)
port [Required] The port for the route. int (required)

Terraform (AzAPI provider) resource definition

The workspaces/environments/versions resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/environments/versions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/environments/versions@2024-01-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      autoDeleteSetting = {
        condition = "string"
        value = "string"
      }
      autoRebuild = "string"
      build = {
        contextUri = "string"
        dockerfilePath = "string"
      }
      condaFile = "string"
      description = "string"
      image = "string"
      inferenceConfig = {
        livenessRoute = {
          path = "string"
          port = int
        }
        readinessRoute = {
          path = "string"
          port = int
        }
        scoringRoute = {
          path = "string"
          port = int
        }
      }
      intellectualProperty = {
        protectionLevel = "string"
        publisher = "string"
      }
      isAnonymous = bool
      isArchived = bool
      osType = "string"
      properties = {
        {customized property} = "string"
      }
      stage = "string"
      tags = {
        {customized property} = "string"
      }
    }
  })
}

Property values

AutoDeleteSetting

Name Description Value
condition When to check if an asset is expired 'CreatedGreaterThan'
'LastAccessedGreaterThan'
value Expiration condition value. string

BuildContext

Name Description Value
contextUri [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.
<seealso href="https://docs.docker.com/engine/reference/commandline/build/#extended-description" />		 string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)
dockerfilePath Path to the Dockerfile in the build context.
<seealso href="https://docs.docker.com/engine/reference/builder/" />		 string

EnvironmentVersionProperties

Name Description Value
autoDeleteSetting Specifies the lifecycle setting of managed data asset. AutoDeleteSetting
autoRebuild Defines if image needs to be rebuilt based on base image changes. 'Disabled'
'OnBaseImageUpdate'
build Configuration settings for Docker build context. BuildContext
condaFile Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.
<see href="https://repo2docker.readthedocs.io/en/latest/config_files.html#environment-yml-install-a-conda-environment" />		 string
description The asset description text. string
image Name of the image that will be used for the environment.
<seealso href="/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" />		 string
inferenceConfig Defines configuration specific to inference. InferenceContainerProperties
intellectualProperty Intellectual Property details. Used if environment is an Intellectual Property. IntellectualProperty
isAnonymous If the name version are system generated (anonymous registration). For types where Stage is defined, when Stage is provided it will be used to populate IsAnonymous bool
isArchived Is the asset archived? For types where Stage is defined, when Stage is provided it will be used to populate IsArchived bool
osType The OS type of the environment. 'Linux'
'Windows'
properties The asset property dictionary. ResourceBaseProperties
stage Stage in the environment lifecycle assigned to this environment string
tags Tag dictionary. Tags can be added, removed, and updated. ResourceBaseTags

InferenceContainerProperties

Name Description Value
livenessRoute The route to check the liveness of the inference server container. Route
readinessRoute The route to check the readiness of the inference server container. Route
scoringRoute The port to send the scoring requests to, within the inference server container. Route

IntellectualProperty

Name Description Value
protectionLevel Protection level of the Intellectual Property. 'All'
'None'
publisher [Required] Publisher of the Intellectual Property. Must be the same as Registry publisher name. string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)

Microsoft.MachineLearningServices/workspaces/environments/versions

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces/environments
properties [Required] Additional attributes of the entity. EnvironmentVersionProperties (required)
type The resource type "Microsoft.MachineLearningServices/workspaces/environments/versions@2024-01-01-preview"

ResourceBaseProperties

Name Description Value

ResourceBaseTags

Name Description Value

Route

Name Description Value
path [Required] The path for the route. string

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_] (required)
port [Required] The port for the route. int (required)