Microsoft.MachineLearningServices workspaces/serverlessEndpoints 2025-01-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/serverlessEndpoints@2025-01-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authMode: 'string'
    contentSafety: {
      contentSafetyLevel: 'string'
      contentSafetyStatus: 'string'
    }
    modelSettings: {
      modelId: 'string'
    }
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.MachineLearningServices/workspaces/serverlessEndpoints

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-Z][a-zA-Z0-9-]{0,51}$ (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. ServerlessEndpointProperties (required)
sku Sku details required for ARM contract for Autoscaling. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

ContentSafety

Name Description Value
contentSafetyLevel [Required] Specifies the current safety level for content safety. 'Blocking'
'Deferred' (required)
contentSafetyStatus [Required] Specifies the status of content safety. 'Disabled'
'Enabled' (required)

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

ModelSettings

Name Description Value
modelId The unique model identifier that this ServerlessEndpoint should provision. string

ServerlessEndpointProperties

Name Description Value
authMode [Required] Specifies the authentication mode for the Serverless endpoint. 'AAD'
'Key'
'KeyAndAAD' (required)
contentSafety Specifies the content safety options. If omitted, the default content safety settings will be configured ContentSafety
modelSettings The model settings (model id) for the model being serviced on the ServerlessEndpoint. ModelSettings

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'

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

ARM template resource definition

The workspaces/serverlessEndpoints resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.MachineLearningServices/workspaces/serverlessEndpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/serverlessEndpoints",
  "apiVersion": "2025-01-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "authMode": "string",
    "contentSafety": {
      "contentSafetyLevel": "string",
      "contentSafetyStatus": "string"
    },
    "modelSettings": {
      "modelId": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.MachineLearningServices/workspaces/serverlessEndpoints

Name Description Value
apiVersion The api version '2025-01-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-Z][a-zA-Z0-9-]{0,51}$ (required)
properties [Required] Additional attributes of the entity. ServerlessEndpointProperties (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/serverlessEndpoints'

ContentSafety

Name Description Value
contentSafetyLevel [Required] Specifies the current safety level for content safety. 'Blocking'
'Deferred' (required)
contentSafetyStatus [Required] Specifies the status of content safety. 'Disabled'
'Enabled' (required)

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

ModelSettings

Name Description Value
modelId The unique model identifier that this ServerlessEndpoint should provision. string

ServerlessEndpointProperties

Name Description Value
authMode [Required] Specifies the authentication mode for the Serverless endpoint. 'AAD'
'Key'
'KeyAndAAD' (required)
contentSafety Specifies the content safety options. If omitted, the default content safety settings will be configured ContentSafety
modelSettings The model settings (model id) for the model being serviced on the ServerlessEndpoint. ModelSettings

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'

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/serverlessEndpoints@2025-01-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      authMode = "string"
      contentSafety = {
        contentSafetyLevel = "string"
        contentSafetyStatus = "string"
      }
      modelSettings = {
        modelId = "string"
      }
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.MachineLearningServices/workspaces/serverlessEndpoints

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-Z][a-zA-Z0-9-]{0,51}$ (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. ServerlessEndpointProperties (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/serverlessEndpoints@2025-01-01-preview"

ContentSafety

Name Description Value
contentSafetyLevel [Required] Specifies the current safety level for content safety. 'Blocking'
'Deferred' (required)
contentSafetyStatus [Required] Specifies the status of content safety. 'Disabled'
'Enabled' (required)

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

ModelSettings

Name Description Value
modelId The unique model identifier that this ServerlessEndpoint should provision. string

ServerlessEndpointProperties

Name Description Value
authMode [Required] Specifies the authentication mode for the Serverless endpoint. 'AAD'
'Key'
'KeyAndAAD' (required)
contentSafety Specifies the content safety options. If omitted, the default content safety settings will be configured ContentSafety
modelSettings The model settings (model id) for the model being serviced on the ServerlessEndpoint. ModelSettings

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'

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value
  • Last updated on