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

• Latest
• 2024-10-01-preview
• 2024-07-01-preview
• 2024-04-01-preview
• 2024-01-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/endpoints/deployments@2024-01-01-preview' = {
  name: 'string'
  properties: {
    failureReason: 'string'
    type: 'string'
    // For remaining properties, see EndpointDeploymentResourceProperties objects
  }
}

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:

{
  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'

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)

ManagedOnlineEndpointDeploymentResourceProperties

Name	Description	Value
type	Kind of the deployment.	'managedOnlineEndpoint' (required)

Microsoft.MachineLearningServices/workspaces/endpoints/deployments

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (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/endpoints
properties		EndpointDeploymentResourceProperties (required)

OpenAIEndpointDeploymentResourceProperties

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.OpenAI' (required)
versionUpgradeOption	Deployment model version upgrade option.	'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable'

SpeechEndpointDeploymentResourceProperties

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.Speech' (required)
versionUpgradeOption	Deployment model version upgrade option.	'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable'

ARM template resource definition

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

{
  "type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments",
  "apiVersion": "2024-01-01-preview",
  "name": "string",
  "properties": {
    "failureReason": "string",
    "type": "string"
    // For remaining properties, see EndpointDeploymentResourceProperties objects
  }
}

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:

{
  "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'

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)

ManagedOnlineEndpointDeploymentResourceProperties

Name	Description	Value
type	Kind of the deployment.	'managedOnlineEndpoint' (required)

Microsoft.MachineLearningServices/workspaces/endpoints/deployments

Name	Description	Value
apiVersion	The api version	'2024-01-01-preview'
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
properties		EndpointDeploymentResourceProperties (required)
type	The resource type	'Microsoft.MachineLearningServices/workspaces/endpoints/deployments'

OpenAIEndpointDeploymentResourceProperties

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.OpenAI' (required)
versionUpgradeOption	Deployment model version upgrade option.	'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable'

SpeechEndpointDeploymentResourceProperties

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.Speech' (required)
versionUpgradeOption	Deployment model version upgrade option.	'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/endpoints/deployments@2024-01-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      failureReason = "string"
      type = "string"
      // For remaining properties, see EndpointDeploymentResourceProperties objects
    }
  })
}

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:

{
  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'

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)

ManagedOnlineEndpointDeploymentResourceProperties

Name	Description	Value
type	Kind of the deployment.	'managedOnlineEndpoint' (required)

Microsoft.MachineLearningServices/workspaces/endpoints/deployments

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: workspaces/endpoints
properties		EndpointDeploymentResourceProperties (required)
type	The resource type	"Microsoft.MachineLearningServices/workspaces/endpoints/deployments@2024-01-01-preview"

OpenAIEndpointDeploymentResourceProperties

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.OpenAI' (required)
versionUpgradeOption	Deployment model version upgrade option.	'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable'

SpeechEndpointDeploymentResourceProperties

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.Speech' (required)
versionUpgradeOption	Deployment model version upgrade option.	'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable'