Microsoft.MachineLearningServices workspaces/environments/versions 2021-03-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@2021-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    condaFile: 'string'
    description: 'string'
    docker: {
      platform: {
        operatingSystemType: 'string'
      }
      dockerSpecificationType: 'string'
      // For remaining properties, see DockerSpecification objects
    }
    inferenceContainerProperties: {
      livenessRoute: {
        path: 'string'
        port: int
      }
      readinessRoute: {
        path: 'string'
        port: int
      }
      scoringRoute: {
        path: 'string'
        port: int
      }
    }
    isAnonymous: bool
    properties: {
      {customized property}: 'string'
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

DockerSpecification objects

Set the dockerSpecificationType property to specify the type of object.

For Build, use:

  dockerSpecificationType: 'Build'
  context: 'string'
  dockerfile: 'string'

For Image, use:

  dockerSpecificationType: 'Image'
  dockerImageUri: 'string'

Property values

workspaces/environments/versions

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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: environments
properties [Required] Additional attributes of the entity. EnvironmentSpecificationVersion (required)

EnvironmentSpecificationVersion

Name Description Value
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
docker Configuration settings for Docker. DockerSpecification
inferenceContainerProperties Defines configuration specific to inference. InferenceContainerProperties
isAnonymous If the name version are system generated (anonymous registration). bool
properties The asset property dictionary. EnvironmentSpecificationVersionProperties
tags Tag dictionary. Tags can be added, removed, and updated. object

DockerSpecification

Name Description Value
platform The platform information of the docker image. DockerImagePlatform
dockerSpecificationType Set the object type Build
Image (required)

DockerImagePlatform

Name Description Value
operatingSystemType The OS type the Environment. 'Linux'
'Windows'

DockerBuild

Name Description Value
dockerSpecificationType [Required] Docker specification must be either Build or Image 'Build' (required)
context Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified.
The path is relative to the asset path which must contain a single Blob URI value.
{seealso href="https://docs.docker.com/engine/context/working-with-contexts/" /}		 string
dockerfile [Required] Docker command line instructions to assemble an image.
{seealso href="https://repo2docker.readthedocs.io/en/latest/config_files.html#dockerfile-advanced-environments" /}		 string (required)

Constraints:
Pattern = [a-zA-Z0-9_]

DockerImage

Name Description Value
dockerSpecificationType [Required] Docker specification must be either Build or Image 'Image' (required)
dockerImageUri [Required] Image name of a custom base image.
{seealso href="https://docs.microsoft.com/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" /}		 string (required)

Constraints:
Pattern = [a-zA-Z0-9_]

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

Route

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

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

EnvironmentSpecificationVersionProperties

Name Description Value
{customized property} string

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": "2021-03-01-preview",
  "name": "string",
  "properties": {
    "condaFile": "string",
    "description": "string",
    "docker": {
      "platform": {
        "operatingSystemType": "string"
      },
      "dockerSpecificationType": "string"
      // For remaining properties, see DockerSpecification objects
    },
    "inferenceContainerProperties": {
      "livenessRoute": {
        "path": "string",
        "port": "int"
      },
      "readinessRoute": {
        "path": "string",
        "port": "int"
      },
      "scoringRoute": {
        "path": "string",
        "port": "int"
      }
    },
    "isAnonymous": "bool",
    "properties": {
      "{customized property}": "string"
    },
    "tags": {
      "{customized property}": "string"
    }
  }
}

DockerSpecification objects

Set the dockerSpecificationType property to specify the type of object.

For Build, use:

  "dockerSpecificationType": "Build",
  "context": "string",
  "dockerfile": "string"

For Image, use:

  "dockerSpecificationType": "Image",
  "dockerImageUri": "string"

Property values

workspaces/environments/versions

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/workspaces/environments/versions'
apiVersion The resource api version '2021-03-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties [Required] Additional attributes of the entity. EnvironmentSpecificationVersion (required)

EnvironmentSpecificationVersion

Name Description Value
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
docker Configuration settings for Docker. DockerSpecification
inferenceContainerProperties Defines configuration specific to inference. InferenceContainerProperties
isAnonymous If the name version are system generated (anonymous registration). bool
properties The asset property dictionary. EnvironmentSpecificationVersionProperties
tags Tag dictionary. Tags can be added, removed, and updated. object

DockerSpecification

Name Description Value
platform The platform information of the docker image. DockerImagePlatform
dockerSpecificationType Set the object type Build
Image (required)

DockerImagePlatform

Name Description Value
operatingSystemType The OS type the Environment. 'Linux'
'Windows'

DockerBuild

Name Description Value
dockerSpecificationType [Required] Docker specification must be either Build or Image 'Build' (required)
context Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified.
The path is relative to the asset path which must contain a single Blob URI value.
{seealso href="https://docs.docker.com/engine/context/working-with-contexts/" /}		 string
dockerfile [Required] Docker command line instructions to assemble an image.
{seealso href="https://repo2docker.readthedocs.io/en/latest/config_files.html#dockerfile-advanced-environments" /}		 string (required)

Constraints:
Pattern = [a-zA-Z0-9_]

DockerImage

Name Description Value
dockerSpecificationType [Required] Docker specification must be either Build or Image 'Image' (required)
dockerImageUri [Required] Image name of a custom base image.
{seealso href="https://docs.microsoft.com/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" /}		 string (required)

Constraints:
Pattern = [a-zA-Z0-9_]

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

Route

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

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

EnvironmentSpecificationVersionProperties

Name Description Value
{customized property} string

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@2021-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      condaFile = "string"
      description = "string"
      docker = {
        platform = {
          operatingSystemType = "string"
        }
        dockerSpecificationType = "string"
        // For remaining properties, see DockerSpecification objects
      }
      inferenceContainerProperties = {
        livenessRoute = {
          path = "string"
          port = int
        }
        readinessRoute = {
          path = "string"
          port = int
        }
        scoringRoute = {
          path = "string"
          port = int
        }
      }
      isAnonymous = bool
      properties = {
        {customized property} = "string"
      }
      tags = {
        {customized property} = "string"
      }
    }
  })
}

DockerSpecification objects

Set the dockerSpecificationType property to specify the type of object.

For Build, use:

  dockerSpecificationType = "Build"
  context = "string"
  dockerfile = "string"

For Image, use:

  dockerSpecificationType = "Image"
  dockerImageUri = "string"

Property values

workspaces/environments/versions

Name Description Value
type The resource type "Microsoft.MachineLearningServices/workspaces/environments/versions@2021-03-01-preview"
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: environments
properties [Required] Additional attributes of the entity. EnvironmentSpecificationVersion (required)

EnvironmentSpecificationVersion

Name Description Value
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
docker Configuration settings for Docker. DockerSpecification
inferenceContainerProperties Defines configuration specific to inference. InferenceContainerProperties
isAnonymous If the name version are system generated (anonymous registration). bool
properties The asset property dictionary. EnvironmentSpecificationVersionProperties
tags Tag dictionary. Tags can be added, removed, and updated. object

DockerSpecification

Name Description Value
platform The platform information of the docker image. DockerImagePlatform
dockerSpecificationType Set the object type Build
Image (required)

DockerImagePlatform

Name Description Value
operatingSystemType The OS type the Environment. "Linux"
"Windows"

DockerBuild

Name Description Value
dockerSpecificationType [Required] Docker specification must be either Build or Image "Build" (required)
context Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified.
The path is relative to the asset path which must contain a single Blob URI value.
{seealso href="https://docs.docker.com/engine/context/working-with-contexts/" /}		 string
dockerfile [Required] Docker command line instructions to assemble an image.
{seealso href="https://repo2docker.readthedocs.io/en/latest/config_files.html#dockerfile-advanced-environments" /}		 string (required)

Constraints:
Pattern = [a-zA-Z0-9_]

DockerImage

Name Description Value
dockerSpecificationType [Required] Docker specification must be either Build or Image "Image" (required)
dockerImageUri [Required] Image name of a custom base image.
{seealso href="https://docs.microsoft.com/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" /}		 string (required)

Constraints:
Pattern = [a-zA-Z0-9_]

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

Route

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

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

EnvironmentSpecificationVersionProperties

Name Description Value
{customized property} string