Microsoft.MachineLearningServices workspaces/environments

  • Article

Bicep resource definition

The workspaces/environments 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/environments@2023-10-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    isArchived: bool
    properties: {
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
    }
    tags: {
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
      {customized property}: 'string'
    }
  }
}

Property values

workspaces/environments

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: workspaces
properties [Required] Additional attributes of the entity. EnvironmentContainerProperties (required)

EnvironmentContainerProperties

Name Description Value
description The asset description text. string
isArchived Is the asset archived? bool
properties The asset property dictionary. ResourceBaseProperties
tags Tag dictionary. Tags can be added, removed, and updated. object

ResourceBaseProperties

Name Description Value
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string

ARM template resource definition

The workspaces/environments 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 resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/environments",
  "apiVersion": "2023-10-01",
  "name": "string",
  "properties": {
    "description": "string",
    "isArchived": "bool",
    "properties": {
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string"
    },
    "tags": {
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string",
      "{customized property}": "string"
    }
  }
}

Property values

workspaces/environments

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/workspaces/environments'
apiVersion The resource api version '2023-10-01'
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. EnvironmentContainerProperties (required)

EnvironmentContainerProperties

Name Description Value
description The asset description text. string
isArchived Is the asset archived? bool
properties The asset property dictionary. ResourceBaseProperties
tags Tag dictionary. Tags can be added, removed, and updated. object

ResourceBaseProperties

Name Description Value
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string

Terraform (AzAPI provider) resource definition

The workspaces/environments 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/environments@2023-10-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      isArchived = bool
      properties = {
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
      }
      tags = {
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
        {customized property} = "string"
      }
    }
  })
}

Property values

workspaces/environments

Name Description Value
type The resource type "Microsoft.MachineLearningServices/workspaces/environments@2023-10-01"
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
properties [Required] Additional attributes of the entity. EnvironmentContainerProperties (required)

EnvironmentContainerProperties

Name Description Value
description The asset description text. string
isArchived Is the asset archived? bool
properties The asset property dictionary. ResourceBaseProperties
tags Tag dictionary. Tags can be added, removed, and updated. object

ResourceBaseProperties

Name Description Value
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string
{customized property} string