Microsoft.MachineLearningServices workspaces/onlineEndpoints/deployments 2021-03-01-preview

Article
12/09/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/onlineEndpoints/deployments@2021-03-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    appInsightsEnabled: bool
    codeConfiguration: {
      codeId: 'string'
      scoringScript: 'string'
    }
    description: 'string'
    environmentId: 'string'
    environmentVariables: {
      {customized property}: 'string'
    }
    livenessProbe: {
      failureThreshold: int
      initialDelay: 'string'
      period: 'string'
      successThreshold: int
      timeout: 'string'
    }
    model: {
      referenceType: 'string'
      // For remaining properties, see AssetReferenceBase objects
    }
    properties: {
      {customized property}: 'string'
    }
    requestSettings: {
      maxConcurrentRequestsPerInstance: int
      maxQueueWait: 'string'
      requestTimeout: 'string'
    }
    scaleSettings: {
      maxInstances: int
      minInstances: int
      scaleType: 'string'
      // For remaining properties, see OnlineScaleSettings objects
    }
    endpointComputeType: 'string'
    // For remaining properties, see OnlineDeployment objects
  }
  tags: {
    {customized property}: 'string'
  }
}

OnlineScaleSettings objects

Set the scaleType property to specify the type of object.

For Auto, use:

{
  pollingInterval: 'string'
  scaleType: 'Auto'
  targetUtilizationPercentage: int
}

For Manual, use:

{
  instanceCount: int
  scaleType: 'Manual'
}

AssetReferenceBase objects

Set the referenceType property to specify the type of object.

For DataPath, use:

{
  datastoreId: 'string'
  path: 'string'
  referenceType: 'DataPath'
}

For Id, use:

{
  assetId: 'string'
  referenceType: 'Id'
}

For OutputPath, use:

{
  jobId: 'string'
  path: 'string'
  referenceType: 'OutputPath'
}

OnlineDeployment objects

Set the endpointComputeType property to specify the type of object.

For K8S, use:

{
  containerResourceRequirements: {
    cpu: int
    cpuLimit: int
    fpga: int
    gpu: int
    memoryInGB: int
    memoryInGBLimit: int
  }
  endpointComputeType: 'K8S'
}

For Managed, use:

{
  endpointComputeType: 'Managed'
  instanceType: 'string'
  readinessProbe: {
    failureThreshold: int
    initialDelay: 'string'
    period: 'string'
    successThreshold: int
    timeout: 'string'
  }
}

Property values

AssetReferenceBase

Name	Description	Value
referenceType	Set to 'DataPath' for type DataPathAssetReference. Set to 'Id' for type IdAssetReference. Set to 'OutputPath' for type OutputPathAssetReference.	'DataPath' 'Id' 'OutputPath' (required)

AutoScaleSettings

Name	Description	Value
pollingInterval	The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.	string
scaleType	[Required] Type of deployment scaling algorithm	'Auto' (required)
targetUtilizationPercentage	Target CPU usage for the autoscaler.	int

CodeConfiguration

Name	Description	Value
codeId	ARM resource ID of the code asset.	string
scoringScript	[Required] The script to execute on startup. eg. "score.py"	string Constraints: Min length = 1 Pattern = `[a-zA-Z0-9_]` (required)

ContainerResourceRequirements

Name	Description	Value
cpu	The minimum amount of CPU cores to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/	int
cpuLimit	The maximum amount of CPU cores allowed to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/	int
fpga	The number of FPGA PCIE devices exposed to the container. Must be multiple of 2.	int
gpu	The number of GPU cores in the container.	int
memoryInGB	The minimum amount of memory (in GB) to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/	int
memoryInGBLimit	The maximum amount of memory (in GB) allowed to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/	int

DataPathAssetReference

Name	Description	Value
datastoreId	ARM resource ID of the datastore where the asset is located.	string
path	The path of the file/directory in the datastore.	string
referenceType	[Required] Specifies the type of asset reference.	'DataPath' (required)

IdAssetReference

Name	Description	Value
assetId	[Required] ARM resource ID of the asset.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
referenceType	[Required] Specifies the type of asset reference.	'Id' (required)

K8SOnlineDeployment

Name	Description	Value
containerResourceRequirements	Resource requirements for each container instance within an online deployment.	ContainerResourceRequirements
endpointComputeType	[Required] The compute type of the endpoint.	'K8S' (required)

ManagedOnlineDeployment

Name	Description	Value
endpointComputeType	[Required] The compute type of the endpoint.	'Managed' (required)
instanceType	Compute instance type.	string
readinessProbe	Deployment container liveness/readiness probe configuration.	ProbeSettings

ManualScaleSettings

Name	Description	Value
instanceCount	Fixed number of instances for this deployment.	int
scaleType	[Required] Type of deployment scaling algorithm	'Manual' (required)