Microsoft.MachineLearningServices workspaces/inferencePools/groups

Article
12/09/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/inferencePools/groups@2024-10-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    environmentConfiguration: {
      environmentId: 'string'
      environmentVariables: [
        {
          key: 'string'
          value: 'string'
        }
      ]
      livenessProbe: {
        failureThreshold: int
        initialDelay: 'string'
        period: 'string'
        successThreshold: int
        timeout: 'string'
      }
      readinessProbe: {
        failureThreshold: int
        initialDelay: 'string'
        period: 'string'
        successThreshold: int
        timeout: 'string'
      }
      startupProbe: {
        failureThreshold: int
        initialDelay: 'string'
        period: 'string'
        successThreshold: int
        timeout: 'string'
      }
    }
    modelConfiguration: {
      modelId: 'string'
    }
    nodeSkuType: 'string'
    properties: [
      {
        key: 'string'
        value: 'string'
      }
    ]
    scaleUnitSize: int
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

GroupEnvironmentConfiguration

Name	Description	Value
environmentId	ARM resource ID of the environment specification for the inference pool.	string
environmentVariables	Environment variables configuration for the inference pool.	StringKeyValuePair[]
livenessProbe	Liveness probe monitors the health of the container regularly.	ProbeSettings
readinessProbe	Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.	ProbeSettings
startupProbe	This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes.	ProbeSettings

GroupModelConfiguration

Name	Description	Value
modelId	The URI path to the model.	string

InferenceGroupProperties

Name	Description	Value
description	Description of the resource.	string
environmentConfiguration	Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit.	GroupEnvironmentConfiguration
modelConfiguration	Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit.	GroupModelConfiguration
nodeSkuType	Gets or sets compute instance type.	string
properties	Property dictionary. Properties can be added, but not removed or altered.	StringKeyValuePair[]
scaleUnitSize	Gets or sets Scale Unit size.	int

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.MachineLearningServices/workspaces/inferencePools/groups

Name	Description	Value
identity	Managed service identity (system assigned and/or user assigned identities)	ManagedServiceIdentity
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.	string
location	The geo-location where the resource lives	string (required)
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/inferencePools
properties	[Required] Additional attributes of the entity.	InferenceGroupProperties (required)
sku	Sku details required for ARM contract for Autoscaling.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ProbeSettings

Name	Description	Value
failureThreshold	The number of failures to allow before returning an unhealthy status.	int
initialDelay	The delay before the first probe in ISO 8601 format.	string
period	The length of time between probes in ISO 8601 format.	string
successThreshold	The number of successful probes before returning a healthy status.	int
timeout	The probe timeout in ISO 8601 format.	string

Sku

Name	Description	Value
capacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.	int
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. Ex - P3. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.	'Basic' 'Free' 'Premium' 'Standard'

StringKeyValuePair

Name	Description	Value
key		string
value		string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

ARM template resource definition

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

{
  "type": "Microsoft.MachineLearningServices/workspaces/inferencePools/groups",
  "apiVersion": "2024-10-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "environmentConfiguration": {
      "environmentId": "string",
      "environmentVariables": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "livenessProbe": {
        "failureThreshold": "int",
        "initialDelay": "string",
        "period": "string",
        "successThreshold": "int",
        "timeout": "string"
      },
      "readinessProbe": {
        "failureThreshold": "int",
        "initialDelay": "string",
        "period": "string",
        "successThreshold": "int",
        "timeout": "string"
      },
      "startupProbe": {
        "failureThreshold": "int",
        "initialDelay": "string",
        "period": "string",
        "successThreshold": "int",
        "timeout": "string"
      }
    },
    "modelConfiguration": {
      "modelId": "string"
    },
    "nodeSkuType": "string",
    "properties": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "scaleUnitSize": "int"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

GroupEnvironmentConfiguration

Name	Description	Value
environmentId	ARM resource ID of the environment specification for the inference pool.	string
environmentVariables	Environment variables configuration for the inference pool.	StringKeyValuePair[]
livenessProbe	Liveness probe monitors the health of the container regularly.	ProbeSettings
readinessProbe	Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.	ProbeSettings
startupProbe	This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes.	ProbeSettings

GroupModelConfiguration

Name	Description	Value
modelId	The URI path to the model.	string

InferenceGroupProperties

Name	Description	Value
description	Description of the resource.	string
environmentConfiguration	Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit.	GroupEnvironmentConfiguration
modelConfiguration	Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit.	GroupModelConfiguration
nodeSkuType	Gets or sets compute instance type.	string
properties	Property dictionary. Properties can be added, but not removed or altered.	StringKeyValuePair[]
scaleUnitSize	Gets or sets Scale Unit size.	int

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.MachineLearningServices/workspaces/inferencePools/groups

Name	Description	Value
apiVersion	The api version	'2024-10-01-preview'
identity	Managed service identity (system assigned and/or user assigned identities)	ManagedServiceIdentity
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.	string
location	The geo-location where the resource lives	string (required)
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.	InferenceGroupProperties (required)
sku	Sku details required for ARM contract for Autoscaling.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.MachineLearningServices/workspaces/inferencePools/groups'

ProbeSettings

Name	Description	Value
failureThreshold	The number of failures to allow before returning an unhealthy status.	int
initialDelay	The delay before the first probe in ISO 8601 format.	string
period	The length of time between probes in ISO 8601 format.	string
successThreshold	The number of successful probes before returning a healthy status.	int
timeout	The probe timeout in ISO 8601 format.	string

Sku

Name	Description	Value
capacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.	int
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. Ex - P3. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.	'Basic' 'Free' 'Premium' 'Standard'

StringKeyValuePair

Name	Description	Value
key		string
value		string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/inferencePools/groups@2024-10-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      description = "string"
      environmentConfiguration = {
        environmentId = "string"
        environmentVariables = [
          {
            key = "string"
            value = "string"
          }
        ]
        livenessProbe = {
          failureThreshold = int
          initialDelay = "string"
          period = "string"
          successThreshold = int
          timeout = "string"
        }
        readinessProbe = {
          failureThreshold = int
          initialDelay = "string"
          period = "string"
          successThreshold = int
          timeout = "string"
        }
        startupProbe = {
          failureThreshold = int
          initialDelay = "string"
          period = "string"
          successThreshold = int
          timeout = "string"
        }
      }
      modelConfiguration = {
        modelId = "string"
      }
      nodeSkuType = "string"
      properties = [
        {
          key = "string"
          value = "string"
        }
      ]
      scaleUnitSize = int
    }
  })
}

Property values

GroupEnvironmentConfiguration

Name	Description	Value
environmentId	ARM resource ID of the environment specification for the inference pool.	string
environmentVariables	Environment variables configuration for the inference pool.	StringKeyValuePair[]
livenessProbe	Liveness probe monitors the health of the container regularly.	ProbeSettings
readinessProbe	Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe.	ProbeSettings
startupProbe	This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes.	ProbeSettings

GroupModelConfiguration

Name	Description	Value
modelId	The URI path to the model.	string

InferenceGroupProperties

Name	Description	Value
description	Description of the resource.	string
environmentConfiguration	Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit.	GroupEnvironmentConfiguration
modelConfiguration	Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit.	GroupModelConfiguration
nodeSkuType	Gets or sets compute instance type.	string
properties	Property dictionary. Properties can be added, but not removed or altered.	StringKeyValuePair[]
scaleUnitSize	Gets or sets Scale Unit size.	int

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

Microsoft.MachineLearningServices/workspaces/inferencePools/groups

Name	Description	Value
identity	Managed service identity (system assigned and/or user assigned identities)	ManagedServiceIdentity
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.	string
location	The geo-location where the resource lives	string (required)
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/inferencePools
properties	[Required] Additional attributes of the entity.	InferenceGroupProperties (required)
sku	Sku details required for ARM contract for Autoscaling.	Sku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.MachineLearningServices/workspaces/inferencePools/groups@2024-10-01-preview"

ProbeSettings

Name	Description	Value
failureThreshold	The number of failures to allow before returning an unhealthy status.	int
initialDelay	The delay before the first probe in ISO 8601 format.	string
period	The length of time between probes in ISO 8601 format.	string
successThreshold	The number of successful probes before returning a healthy status.	int
timeout	The probe timeout in ISO 8601 format.	string

Sku

Name	Description	Value
capacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.	int
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. Ex - P3. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.	'Basic' 'Free' 'Premium' 'Standard'

StringKeyValuePair

Name	Description	Value
key		string
value		string

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Share via

Microsoft.MachineLearningServices workspaces/inferencePools/groups

Bicep resource definition

Resource format

Property values

GroupEnvironmentConfiguration

GroupModelConfiguration

InferenceGroupProperties

ManagedServiceIdentity

Microsoft.MachineLearningServices/workspaces/inferencePools/groups

ProbeSettings

Sku

StringKeyValuePair

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

ARM template resource definition

Resource format

Property values

GroupEnvironmentConfiguration

GroupModelConfiguration

InferenceGroupProperties

ManagedServiceIdentity

Microsoft.MachineLearningServices/workspaces/inferencePools/groups

ProbeSettings

Sku

StringKeyValuePair

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Terraform (AzAPI provider) resource definition

Resource format

Property values

GroupEnvironmentConfiguration

GroupModelConfiguration

InferenceGroupProperties

ManagedServiceIdentity

Microsoft.MachineLearningServices/workspaces/inferencePools/groups

ProbeSettings

Sku

StringKeyValuePair

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Feedback

Additional resources