Microsoft.MachineLearningServices workspaces/endpoints 2024-10-01-preview

Article
12/09/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/endpoints@2024-10-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    associatedResourceId: 'string'
    deployments: [
      {
        properties: {
          failureReason: 'string'
          type: 'string'
          // For remaining properties, see EndpointDeploymentResourceProperties objects
        }
      }
    ]
    endpointUri: 'string'
    failureReason: 'string'
    location: 'string'
    name: 'string'
    shouldCreateAiServicesEndpoint: bool
    endpointType: 'string'
    // For remaining properties, see EndpointResourceProperties objects
  }
}

EndpointResourceProperties objects

Set the endpointType property to specify the type of object.

For Azure.ContentSafety, use:

{
  endpointType: 'Azure.ContentSafety'
}

For Azure.OpenAI, use:

{
  endpointType: 'Azure.OpenAI'
}

For Azure.Speech, use:

{
  endpointType: 'Azure.Speech'
}

For managedOnlineEndpoint, use:

{
  authMode: 'string'
  compute: 'string'
  description: 'string'
  endpointType: 'managedOnlineEndpoint'
  mirrorTraffic: {
    {customized property}: int
  }
  scoringUri: 'string'
  traffic: {
    {customized property}: int
  }
}

For serverlessEndpoint, use:

{
  authMode: 'string'
  capacityReservation: {
    capacityReservationGroupId: 'string'
    endpointReservedCapacity: int
  }
  contentSafety: {
    contentSafetyStatus: 'string'
  }
  endpointState: 'string'
  endpointType: 'serverlessEndpoint'
  inferenceEndpoint: {}
  marketplaceSubscriptionId: 'string'
  metadata: any(Azure.Bicep.Types.Concrete.AnyType)
  modelSettings: {
    modelId: 'string'
  }
  offer: {
    offerName: 'string'
    publisher: 'string'
  }
}

EndpointDeploymentResourceProperties objects

Set the type property to specify the type of object.

For Azure.ContentSafety, use:

{
  model: {
    format: 'string'
    name: 'string'
    source: 'string'
    version: 'string'
  }
  raiPolicyName: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  type: 'Azure.ContentSafety'
  versionUpgradeOption: 'string'
}

For Azure.OpenAI, use:

{
  model: {
    format: 'string'
    name: 'string'
    source: 'string'
    version: 'string'
  }
  raiPolicyName: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  type: 'Azure.OpenAI'
  versionUpgradeOption: 'string'
}

For Azure.Speech, use:

{
  model: {
    format: 'string'
    name: 'string'
    source: 'string'
    version: 'string'
  }
  raiPolicyName: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  type: 'Azure.Speech'
  versionUpgradeOption: 'string'
}

For managedOnlineEndpoint, use:

{
  endpointComputeType: 'string'
  model: 'string'
  type: 'managedOnlineEndpoint'
}

Property values

CognitiveServicesSku

Name	Description	Value
capacity		int
family		string
name		string
size		string
tier		string

ContentSafetyEndpointDeploymentResourceProperties

Name	Description	Value
model	Model used for the endpoint deployment.	EndpointDeploymentModel (required)
raiPolicyName	The name of RAI policy.	string
sku		CognitiveServicesSku
type	Kind of the deployment.	'Azure.ContentSafety' (required)
versionUpgradeOption	Deployment model version upgrade option.	'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable'

ContentSafetyEndpointResourceProperties

Name	Description	Value
endpointType	Type of the endpoint.	'Azure.ContentSafety' (required)

EndpointDeploymentModel

Name	Description	Value
format	Model format	string
name	Model name.	string
source	Optional. Deployment model source ARM resource ID.	string
version	Model version.	string

EndpointDeploymentResourceProperties

Name	Description	Value
failureReason	The failure reason if the creation failed.	string
type	Set to 'Azure.ContentSafety' for type ContentSafetyEndpointDeploymentResourceProperties. Set to 'Azure.OpenAI' for type OpenAIEndpointDeploymentResourceProperties. Set to 'Azure.Speech' for type SpeechEndpointDeploymentResourceProperties. Set to 'managedOnlineEndpoint' for type ManagedOnlineEndpointDeploymentResourceProperties.	'Azure.ContentSafety' 'Azure.OpenAI' 'Azure.Speech' 'managedOnlineEndpoint' (required)

EndpointDeploymentResourcePropertiesBasicResource

Name	Description	Value
properties		EndpointDeploymentResourceProperties (required)

EndpointResourceProperties

Name	Description	Value
associatedResourceId	Byo resource id for creating the built-in model service endpoints.	string
deployments	Deployments info.	EndpointDeploymentResourcePropertiesBasicResource[]
endpointType	Set to 'Azure.ContentSafety' for type ContentSafetyEndpointResourceProperties. Set to 'Azure.OpenAI' for type OpenAIEndpointResourceProperties. Set to 'Azure.Speech' for type SpeechEndpointResourceProperties. Set to 'managedOnlineEndpoint' for type ManagedOnlineEndpointResourceProperties. Set to 'serverlessEndpoint' for type ServerlessEndpointResourceProperties.	'Azure.ContentSafety' 'Azure.OpenAI' 'Azure.Speech' 'managedOnlineEndpoint' 'serverlessEndpoint' (required)
endpointUri	Uri of the endpoint.	string
failureReason	The failure reason if the creation failed.	string
location	Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace	string
name	Name of the endpoint.	string
shouldCreateAiServicesEndpoint	Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint.	bool

ManagedOnlineEndpointDeploymentResourceProperties

Name	Description	Value
endpointComputeType	Enum to determine endpoint compute type.	'AzureMLCompute' 'Kubernetes' 'Managed'
model		string
type	Kind of the deployment.	'managedOnlineEndpoint' (required)

ManagedOnlineEndpointResourceProperties

Name	Description	Value
authMode	Enum to determine endpoint authentication mode.	'AADToken' 'AMLToken' 'Key'
compute		string
description		string
endpointType	Type of the endpoint.	'managedOnlineEndpoint' (required)
mirrorTraffic	Dictionary of <integer>	ManagedOnlineEndpointResourcePropertiesMirrorTraffic
scoringUri		string
traffic	Dictionary of <integer>	ManagedOnlineEndpointResourcePropertiesTraffic

ManagedOnlineEndpointResourcePropertiesMirrorTraffic

Name	Description	Value

ManagedOnlineEndpointResourcePropertiesTraffic

Name	Description	Value