Share via

Microsoft.MachineLearningServices workspaces/components 2023-06-01-preview

  • Article

Bicep resource definition

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

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

Property values

ComponentContainerProperties

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

Microsoft.MachineLearningServices/workspaces/components

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ (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. ComponentContainerProperties (required)

ResourceBaseProperties

Name Description Value

ResourceBaseTags

Name Description Value

ARM template resource definition

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

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

Property values

ComponentContainerProperties

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

Microsoft.MachineLearningServices/workspaces/components

Name Description Value
apiVersion The api version '2023-06-01-preview'
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ (required)
properties [Required] Additional attributes of the entity. ComponentContainerProperties (required)
type The resource type 'Microsoft.MachineLearningServices/workspaces/components'

ResourceBaseProperties

Name Description Value

ResourceBaseTags

Name Description Value

Terraform (AzAPI provider) resource definition

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

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

Property values

ComponentContainerProperties

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

Microsoft.MachineLearningServices/workspaces/components

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ (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. ComponentContainerProperties (required)
type The resource type "Microsoft.MachineLearningServices/workspaces/components@2023-06-01-preview"

ResourceBaseProperties

Name Description Value

ResourceBaseTags

Name Description Value