Microsoft.MachineLearningServices registries/environments/versions 2025-01-01-preview
Bicep resource definition
The registries/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/registries/environments/versions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/registries/environments/versions@2025-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
autoRebuild: 'string'
build: {
contextUri: 'string'
dockerfilePath: 'string'
}
condaFile: 'string'
description: 'string'
image: 'string'
imageDetails: {
exists: bool
image: {
digest: 'string'
hostname: 'string'
repository: 'string'
tag: 'string'
}
vulnerabilityFindings: {
assetId: 'string'
data: [
{
cve: 'string'
cveUrl: 'string'
dueDate: 'string'
packageDetails: [
{
installedVersion: 'string'
installPath: 'string'
name: 'string'
patchedVersion: 'string'
}
]
patchable: bool
providerId: 'string'
publishDate: 'string'
risk: 'string'
solution: 'string'
title: 'string'
vendorId: 'string'
vendorUrl: 'string'
}
]
generatedTime: 'string'
lastScanDate: 'string'
scanner: 'string'
source: 'string'
}
}
inferenceConfig: {
livenessRoute: {
path: 'string'
port: int
}
readinessRoute: {
path: 'string'
port: int
}
scoringRoute: {
path: 'string'
port: int
}
}
isAnonymous: bool
isArchived: bool
osType: 'string'
properties: {
{customized property}: 'string'
}
stage: 'string'
tags: {
{customized property}: 'string'
}
}
}
Property Values
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 |
---|---|---|
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 |
imageDetails | Environment image details | ImageDetails |
inferenceConfig | Defines configuration specific to inference. | InferenceContainerProperties |
isAnonymous | If the name version are system generated (anonymous registration). | bool |
isArchived | Is the asset archived? | 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 |
ImageDetails
Name | Description | Value |
---|---|---|
exists | Indicates if image exists | bool |
image | Container image details | ImageInfo |
vulnerabilityFindings | Vulnerability findings details | VulnerabilityFindings |
ImageInfo
Name | Description | Value |
---|---|---|
digest | Image digest | string |
hostname | Container registry host name | string |
repository | Repository name | string |
tag | Image tag | string |
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/registries/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: registries/environments |
properties | [Required] Additional attributes of the entity. | EnvironmentVersionProperties (required) |
PackageDetails
Name | Description | Value |
---|---|---|
installedVersion | Installed version. | string |
installPath | Install path. | string |
name | Package or dependency name. | string |
patchedVersion | Patched version. | string |
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) |
VulnerabilityDetails
Name | Description | Value |
---|---|---|
cve | CVE id. | string |
cveUrl | CVE url. | string |
dueDate | DueDate for vulnerability. Provider data or PublishDate + 30 days. | string |
packageDetails | Dependency details. | PackageDetails[] |
patchable | Indicates if there is a known patch for vulnerability. | bool |
providerId | Vulnerability ID from provider. | string |
publishDate | Vulnerability publish date. | string |
risk | Vulnerability Risk value. | 'CRITICAL' 'HIGH' 'LOW' 'MEDIUM' 'UNKNOWN' |
solution | Vulnerability description. | string |
title | Vulnerability name. | string |
vendorId | Vendor vulnerability ID (USN, GH Advisory, etc). | string |
vendorUrl | Vendor vulnerability url. | string |
VulnerabilityFindings
Name | Description | Value |
---|---|---|
assetId | AssetId (Image digest). | string |
data | List of vulnerability findings. | VulnerabilityDetails[] |
generatedTime | Time the report was generated. | string |
lastScanDate | Scan result date. | string |
scanner | Vulnerability scanner name. | string |
source | Data source (internal). | string |
ARM template resource definition
The registries/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/registries/environments/versions resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/registries/environments/versions",
"apiVersion": "2025-01-01-preview",
"name": "string",
"properties": {
"autoRebuild": "string",
"build": {
"contextUri": "string",
"dockerfilePath": "string"
},
"condaFile": "string",
"description": "string",
"image": "string",
"imageDetails": {
"exists": "bool",
"image": {
"digest": "string",
"hostname": "string",
"repository": "string",
"tag": "string"
},
"vulnerabilityFindings": {
"assetId": "string",
"data": [
{
"cve": "string",
"cveUrl": "string",
"dueDate": "string",
"packageDetails": [
{
"installedVersion": "string",
"installPath": "string",
"name": "string",
"patchedVersion": "string"
}
],
"patchable": "bool",
"providerId": "string",
"publishDate": "string",
"risk": "string",
"solution": "string",
"title": "string",
"vendorId": "string",
"vendorUrl": "string"
}
],
"generatedTime": "string",
"lastScanDate": "string",
"scanner": "string",
"source": "string"
}
},
"inferenceConfig": {
"livenessRoute": {
"path": "string",
"port": "int"
},
"readinessRoute": {
"path": "string",
"port": "int"
},
"scoringRoute": {
"path": "string",
"port": "int"
}
},
"isAnonymous": "bool",
"isArchived": "bool",
"osType": "string",
"properties": {
"{customized property}": "string"
},
"stage": "string",
"tags": {
"{customized property}": "string"
}
}
}
Property Values
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 |
---|---|---|
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 |
imageDetails | Environment image details | ImageDetails |
inferenceConfig | Defines configuration specific to inference. | InferenceContainerProperties |
isAnonymous | If the name version are system generated (anonymous registration). | bool |
isArchived | Is the asset archived? | 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 |
ImageDetails
Name | Description | Value |
---|---|---|
exists | Indicates if image exists | bool |
image | Container image details | ImageInfo |
vulnerabilityFindings | Vulnerability findings details | VulnerabilityFindings |
ImageInfo
Name | Description | Value |
---|---|---|
digest | Image digest | string |
hostname | Container registry host name | string |
repository | Repository name | string |
tag | Image tag | string |
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/registries/environments/versions
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2025-01-01-preview' |
name | The resource name | string (required) |
properties | [Required] Additional attributes of the entity. | EnvironmentVersionProperties (required) |
type | The resource type | 'Microsoft.MachineLearningServices/registries/environments/versions' |
PackageDetails
Name | Description | Value |
---|---|---|
installedVersion | Installed version. | string |
installPath | Install path. | string |
name | Package or dependency name. | string |
patchedVersion | Patched version. | string |
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) |
VulnerabilityDetails
Name | Description | Value |
---|---|---|
cve | CVE id. | string |
cveUrl | CVE url. | string |
dueDate | DueDate for vulnerability. Provider data or PublishDate + 30 days. | string |
packageDetails | Dependency details. | PackageDetails[] |
patchable | Indicates if there is a known patch for vulnerability. | bool |
providerId | Vulnerability ID from provider. | string |
publishDate | Vulnerability publish date. | string |
risk | Vulnerability Risk value. | 'CRITICAL' 'HIGH' 'LOW' 'MEDIUM' 'UNKNOWN' |
solution | Vulnerability description. | string |
title | Vulnerability name. | string |
vendorId | Vendor vulnerability ID (USN, GH Advisory, etc). | string |
vendorUrl | Vendor vulnerability url. | string |
VulnerabilityFindings
Name | Description | Value |
---|---|---|
assetId | AssetId (Image digest). | string |
data | List of vulnerability findings. | VulnerabilityDetails[] |
generatedTime | Time the report was generated. | string |
lastScanDate | Scan result date. | string |
scanner | Vulnerability scanner name. | string |
source | Data source (internal). | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The registries/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/registries/environments/versions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/registries/environments/versions@2025-01-01-preview"
name = "string"
body = jsonencode({
properties = {
autoRebuild = "string"
build = {
contextUri = "string"
dockerfilePath = "string"
}
condaFile = "string"
description = "string"
image = "string"
imageDetails = {
exists = bool
image = {
digest = "string"
hostname = "string"
repository = "string"
tag = "string"
}
vulnerabilityFindings = {
assetId = "string"
data = [
{
cve = "string"
cveUrl = "string"
dueDate = "string"
packageDetails = [
{
installedVersion = "string"
installPath = "string"
name = "string"
patchedVersion = "string"
}
]
patchable = bool
providerId = "string"
publishDate = "string"
risk = "string"
solution = "string"
title = "string"
vendorId = "string"
vendorUrl = "string"
}
]
generatedTime = "string"
lastScanDate = "string"
scanner = "string"
source = "string"
}
}
inferenceConfig = {
livenessRoute = {
path = "string"
port = int
}
readinessRoute = {
path = "string"
port = int
}
scoringRoute = {
path = "string"
port = int
}
}
isAnonymous = bool
isArchived = bool
osType = "string"
properties = {
{customized property} = "string"
}
stage = "string"
tags = {
{customized property} = "string"
}
}
})
}
Property Values
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 |
---|---|---|
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 |
imageDetails | Environment image details | ImageDetails |
inferenceConfig | Defines configuration specific to inference. | InferenceContainerProperties |
isAnonymous | If the name version are system generated (anonymous registration). | bool |
isArchived | Is the asset archived? | 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 |
ImageDetails
Name | Description | Value |
---|---|---|
exists | Indicates if image exists | bool |
image | Container image details | ImageInfo |
vulnerabilityFindings | Vulnerability findings details | VulnerabilityFindings |
ImageInfo
Name | Description | Value |
---|---|---|
digest | Image digest | string |
hostname | Container registry host name | string |
repository | Repository name | string |
tag | Image tag | string |
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/registries/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: registries/environments |
properties | [Required] Additional attributes of the entity. | EnvironmentVersionProperties (required) |
type | The resource type | "Microsoft.MachineLearningServices/registries/environments/versions@2025-01-01-preview" |
PackageDetails
Name | Description | Value |
---|---|---|
installedVersion | Installed version. | string |
installPath | Install path. | string |
name | Package or dependency name. | string |
patchedVersion | Patched version. | string |
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) |
VulnerabilityDetails
Name | Description | Value |
---|---|---|
cve | CVE id. | string |
cveUrl | CVE url. | string |
dueDate | DueDate for vulnerability. Provider data or PublishDate + 30 days. | string |
packageDetails | Dependency details. | PackageDetails[] |
patchable | Indicates if there is a known patch for vulnerability. | bool |
providerId | Vulnerability ID from provider. | string |
publishDate | Vulnerability publish date. | string |
risk | Vulnerability Risk value. | 'CRITICAL' 'HIGH' 'LOW' 'MEDIUM' 'UNKNOWN' |
solution | Vulnerability description. | string |
title | Vulnerability name. | string |
vendorId | Vendor vulnerability ID (USN, GH Advisory, etc). | string |
vendorUrl | Vendor vulnerability url. | string |
VulnerabilityFindings
Name | Description | Value |
---|---|---|
assetId | AssetId (Image digest). | string |
data | List of vulnerability findings. | VulnerabilityDetails[] |
generatedTime | Time the report was generated. | string |
lastScanDate | Scan result date. | string |
scanner | Vulnerability scanner name. | string |
source | Data source (internal). | string |