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

Template format

To create a Microsoft.MachineLearningServices/workspaces/onlineEndpoints resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.MachineLearningServices/workspaces/onlineEndpoints",
  "apiVersion": "2021-03-01-preview",
  "tags": {},
  "location": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  "kind": "string",
  "properties": {
    "authMode": "string",
    "description": "string",
    "keys": {
      "primaryKey": "string",
      "secondaryKey": "string"
    "properties": {},
    "target": "string",
    "traffic": {}
  "resources": []

Property values

The following tables describe the values you need to set in the schema.

Microsoft.MachineLearningServices/workspaces/onlineEndpoints object


In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Online Endpoint name.
type enum Yes For JSON -onlineEndpoints

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2021-03-01-preview
tags object No Resource tags.
location string Yes The geo-location where the resource lives
identity object No Service identity associated with a resource. - ResourceIdentity object
kind string No
properties object Yes Additional attributes of the entity. - OnlineEndpoint object
resources array No deployments

ResourceIdentity object

Name Type Required Value
type enum No Defines values for a ResourceIdentity's type. - SystemAssigned, UserAssigned, SystemAssigned,UserAssigned, None
userAssignedIdentities object No Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

OnlineEndpoint object

Name Type Required Value
authMode enum Yes Inference endpoint authentication mode type. - AMLToken, Key, AADToken
description string No Description of the inference endpoint.
keys object No EndpointAuthKeys to set initially on an Endpoint.
This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API. - EndpointAuthKeys object
properties object No Property dictionary. Properties can be added, but not removed or altered.
target string No ARM resource ID of the compute if it exists.
traffic object No Traffic rules on how the traffic will be routed across deployments.

EndpointAuthKeys object

Name Type Required Value
primaryKey string No The primary key.
secondaryKey string No The secondary key.