Microsoft.MachineLearningServices workspaces/environments/versions 2021-03-01-preview

• Latest
• 2024-10-01
• 2024-10-01-preview
• 2024-07-01-preview
• 2024-04-01
• 2024-04-01-preview
• 2024-01-01-preview
• 2023-10-01
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-04-01
• 2023-04-01-preview
• 2023-02-01-preview
• 2022-12-01-preview
• 2022-10-01
• 2022-10-01-preview
• 2022-06-01-preview
• 2022-05-01
• 2022-02-01-preview
• 2021-03-01-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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' = {
  parent: resourceSymbolicName
  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:

{
  context: 'string'
  dockerfile: 'string'
  dockerSpecificationType: 'Build'
}

For Image, use:

{
  dockerImageUri: 'string'
  dockerSpecificationType: 'Image'
}

Property values

DockerBuild

Name	Description	Value
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 Constraints: Pattern = [a-zA-Z0-9_] (required)
dockerSpecificationType	[Required] Docker specification must be either Build or Image	'Build' (required)

DockerImage

Name	Description	Value
dockerImageUri	[Required] Image name of a custom base image. <seealso href="/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" />	string Constraints: Pattern = [a-zA-Z0-9_] (required)
dockerSpecificationType	[Required] Docker specification must be either Build or Image	'Image' (required)

DockerImagePlatform

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

DockerSpecification

Name	Description	Value
dockerSpecificationType	Set to 'Build' for type DockerBuild. Set to 'Image' for type DockerImage.	'Build' 'Image' (required)
platform	The platform information of the docker image.	DockerImagePlatform

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.	EnvironmentSpecificationVersionTags

EnvironmentSpecificationVersionProperties

Name	Description	Value

EnvironmentSpecificationVersionTags

Name	Description	Value

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

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.	EnvironmentSpecificationVersion (required)

Route

Name	Description	Value
path	[Required] The path for the route.	string Constraints: 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:

• Resource groups - See resource group deployment commands

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:

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

For Image, use:

{
  "dockerImageUri": "string",
  "dockerSpecificationType": "Image"
}

Property values

DockerBuild

Name	Description	Value
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 Constraints: Pattern = [a-zA-Z0-9_] (required)
dockerSpecificationType	[Required] Docker specification must be either Build or Image	'Build' (required)

DockerImage

Name	Description	Value
dockerImageUri	[Required] Image name of a custom base image. <seealso href="/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" />	string Constraints: Pattern = [a-zA-Z0-9_] (required)
dockerSpecificationType	[Required] Docker specification must be either Build or Image	'Image' (required)

DockerImagePlatform

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

DockerSpecification

Name	Description	Value
dockerSpecificationType	Set to 'Build' for type DockerBuild. Set to 'Image' for type DockerImage.	'Build' 'Image' (required)
platform	The platform information of the docker image.	DockerImagePlatform

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.	EnvironmentSpecificationVersionTags

EnvironmentSpecificationVersionProperties

Name	Description	Value

EnvironmentSpecificationVersionTags

Name	Description	Value

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

Microsoft.MachineLearningServices/workspaces/environments/versions

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

Route

Name	Description	Value
path	[Required] The path for the route.	string Constraints: 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@2021-03-01-preview"
  name = "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:

{
  context = "string"
  dockerfile = "string"
  dockerSpecificationType = "Build"
}

For Image, use:

{
  dockerImageUri = "string"
  dockerSpecificationType = "Image"
}

Property values

DockerBuild

Name	Description	Value
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 Constraints: Pattern = [a-zA-Z0-9_] (required)
dockerSpecificationType	[Required] Docker specification must be either Build or Image	'Build' (required)

DockerImage

Name	Description	Value
dockerImageUri	[Required] Image name of a custom base image. <seealso href="/azure/machine-learning/how-to-deploy-custom-docker-image#use-a-custom-base-image" />	string Constraints: Pattern = [a-zA-Z0-9_] (required)
dockerSpecificationType	[Required] Docker specification must be either Build or Image	'Image' (required)

DockerImagePlatform

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

DockerSpecification

Name	Description	Value
dockerSpecificationType	Set to 'Build' for type DockerBuild. Set to 'Image' for type DockerImage.	'Build' 'Image' (required)
platform	The platform information of the docker image.	DockerImagePlatform

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.	EnvironmentSpecificationVersionTags

EnvironmentSpecificationVersionProperties

Name	Description	Value

EnvironmentSpecificationVersionTags

Name	Description	Value

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

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.	EnvironmentSpecificationVersion (required)
type	The resource type	"Microsoft.MachineLearningServices/workspaces/environments/versions@2021-03-01-preview"

Route

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