Share via

Microsoft.MachineLearningServices workspaces/connections/deployments 2024-04-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections/deployments@2024-04-01-preview' = {
  name: 'string'
  properties: {
    model: {
      format: 'string'
      name: 'string'
      source: 'string'
      version: 'string'
    }
    raiPolicyName: 'string'
    versionUpgradeOption: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
}

Property values

CognitiveServicesSku

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

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
model Model used for the endpoint deployment. EndpointDeploymentModel (required)
raiPolicyName The name of RAI policy. string
versionUpgradeOption Deployment model version upgrade option. 'NoAutoUpgrade'
'OnceCurrentVersionExpired'
'OnceNewDefaultVersionAvailable'

Microsoft.MachineLearningServices/workspaces/connections/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/connections
properties EndpointDeploymentResourceProperties (required)
sku CognitiveServicesSku

ARM template resource definition

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

{
  "type": "Microsoft.MachineLearningServices/workspaces/connections/deployments",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "properties": {
    "model": {
      "format": "string",
      "name": "string",
      "source": "string",
      "version": "string"
    },
    "raiPolicyName": "string",
    "versionUpgradeOption": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  }
}

Property values

CognitiveServicesSku

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

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
model Model used for the endpoint deployment. EndpointDeploymentModel (required)
raiPolicyName The name of RAI policy. string
versionUpgradeOption Deployment model version upgrade option. 'NoAutoUpgrade'
'OnceCurrentVersionExpired'
'OnceNewDefaultVersionAvailable'

Microsoft.MachineLearningServices/workspaces/connections/deployments

Name Description Value
apiVersion The api version '2024-04-01-preview'
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ (required)
properties EndpointDeploymentResourceProperties (required)
sku CognitiveServicesSku
type The resource type 'Microsoft.MachineLearningServices/workspaces/connections/deployments'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/connections/deployments@2024-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      model = {
        format = "string"
        name = "string"
        source = "string"
        version = "string"
      }
      raiPolicyName = "string"
      versionUpgradeOption = "string"
    }
  })
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
}

Property values

CognitiveServicesSku

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

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
model Model used for the endpoint deployment. EndpointDeploymentModel (required)
raiPolicyName The name of RAI policy. string
versionUpgradeOption Deployment model version upgrade option. 'NoAutoUpgrade'
'OnceCurrentVersionExpired'
'OnceNewDefaultVersionAvailable'

Microsoft.MachineLearningServices/workspaces/connections/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/connections
properties EndpointDeploymentResourceProperties (required)
sku CognitiveServicesSku
type The resource type "Microsoft.MachineLearningServices/workspaces/connections/deployments@2024-04-01-preview"